isogeo_pysdk.api.routes_application module

Isogeo API v1 - API Routes for Applications entities

See: http://help.isogeo.com/api/complete/index.html

class isogeo_pysdk.api.routes_application.ApiApplication(api_client=None)

Bases: object

Routes as methods of Isogeo API used to manipulate applications.

associate_group(application, workgroup, force=0)

Associate a application with a workgroup.

Parameters:
  • application (Application) – Application model object to update
  • workgroup (Workgroup) – object to associate
  • force (bool) – option to force association with multiple groups changing the canHaveManyGroups property
Return type:

tuple

create(application, check_exists=1)

Add a new application to Isogeo.

Parameters:check_exists (int) – check if a application already exists inot the workgroup:
  • 0 = no check
  • 1 = compare name [DEFAULT]
Parameters:application (class) – Application model object to create
Return type:Application
delete(application_id)

Delete a application from Isogeo database.

Parameters:application_id (str) – identifier of the resource to delete
dissociate_group(application, workgroup)

Removes the association between the specified group and the specified application.

Parameters:
  • application (Application) – Application model object to update
  • workgroup (Workgroup) – object to associate
Return type:

tuple

exists(application_id)

Check if the specified application exists and is available for the authenticated user.

Parameters:application_id (str) – identifier of the application to verify
Return type:bool
get(application_id, include=('_abilities', 'groups'))

Get details about a specific application.

Parameters:
  • application_id (str) – application UUID
  • include (tuple) – additionnal subresource to include in the response
Return type:

Application

listing(self, workgroup_id=None, include=('_abilities', ), caching=1)

Get all applications which are accessible by the authenticated user OR applications for a workgroup.

Parameters:
  • workgroup_id (str) – identifier of the owner workgroup. If None, then list applications for the autenticated user
  • include (tuple) – additionnal subresource to include in the response.
  • caching (bool) – option to cache the response
Return type:

list

update(application, caching=1)

Update a application owned by a workgroup.

Parameters:
  • application (class) – Application model object to update
  • caching (bool) – option to cache the response
Return type:

Application

workgroups(self, application_id=None)

Get all groups associated with an application.

Parameters:application_id (str) – identifier of the application
Return type:list