isogeo_pysdk.api.routes_workgroup module¶
Isogeo API v1 - API Routes for Workgroups entities
See: http://help.isogeo.com/api/complete/index.html#tag-workgroup
-
class
isogeo_pysdk.api.routes_workgroup.
ApiWorkgroup
(api_client=None)¶ Bases:
object
Routes as methods of Isogeo API used to manipulate workgroups.
-
coordinate_systems
(self, workgroup_id, caching=1)¶ Returns coordinate-systems for the specified workgroup. It’s just an alias for the ApiCoordinateSystem.listing method.
Parameters: - workgroup_id (str) – workgroup UUID
- caching (bool) – option to cache the response
Return type: list
-
create
(workgroup, check_exists=1)¶ Add a new workgroup to Isogeo.
Parameters: - workgroup (class) – Workgroup model object to create
- check_exists (int) –
check if a workgroup already exists:
- 0 = no check
- 1 = compare name [DEFAULT]
Return type:
-
delete
(workgroup_id)¶ Delete a workgroup from Isogeo database.
Parameters: workgroup_id (str) – identifier of the workgroup
-
exists
(workgroup_id)¶ Check if the specified workgroup exists and is available for the authenticated user.
Parameters: workgroup_id (str) – identifier of the workgroup to verify Return type: bool
-
get
(self, workgroup_id, include=('_abilities', 'limits'))¶ Get details about a specific workgroup.
Parameters: - workgroup_id (str) – workgroup UUID
- include (tuple) – additionnal subresource to include in the response
Return type:
-
invitations
(self, workgroup_id)¶ Returns active invitations (including expired) for the specified workgroup. Just a shortcut.
Parameters: workgroup_id (str) – workgroup UUID Return type: dict
-
invite
(workgroup_id, invitation)¶ Invite new user to a workgroup. Just a shortcut.
Parameters: - workgroup_id (str) – workgroup UUID
- invitation (Invitation) – Invitation object to send
Return type: dict
-
limits
(self, workgroup_id)¶ Returns limits for the specified workgroup.
Parameters: workgroup_id (str) – workgroup UUID Return type: dict
-
listing
(self, include=('_abilities', 'limits'), caching=1)¶ Get workgroups.
Parameters: - include (list) – additionnal subresource to include in the response
- caching (bool) – option to cache the response
Return type: list
-
memberships
(self, workgroup_id)¶ Returns memberships for the specified workgroup.
Parameters: workgroup_id (str) – workgroup UUID Return type: dict
-
statistics
(self, workgroup_id)¶ Returns statistics for the specified workgroup.
Parameters: workgroup_id (str) – workgroup UUID Return type: dict
-
statistics_by_tag
(self, workgroup_id, tag)¶ Returns statistics for the specified workgroup. See: http://help.isogeo.com/api/complete/index.html#operation–groups–gid–statistics-tag–tag–get
Be careful: if an invalid character is present into the response (e.g. contact.name = ‘bureau GF-3A’), a ConnectionError / ReadTimeout will be raised.
Parameters: - workgroup_id (str) – workgroup UUID
- tag (str) – tag name. Must be one of: catalog, contact, coordinate-system, format, keyword:inspire-theme, keyword, owner
Return type: dict
-