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)[source]

Bases: object

Routes as methods of Isogeo API used to manipulate workgroups (conditions).

coordinate_systems[source]

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: isogeo_pysdk.models.workgroup.Workgroup, check_exists: int = 1) → isogeo_pysdk.models.workgroup.Workgroup[source]

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]
delete(workgroup_id: str)[source]

Delete a workgroup from Isogeo database.

Parameters:workgroup_id (str) – identifier of the workgroup
exists(workgroup_id: str) → bool[source]

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

Parameters:workgroup_id (str) – identifier of the workgroup to verify
get[source]

Get details about a specific workgroup.

Parameters:
  • workgroup_id (str) – workgroup UUID
  • include (list) – additionnal subresource to include in the response
invitations[source]

Returns active invitations (including expired) for the specified workgroup. Just a shortcut.

Parameters:workgroup_id (str) – workgroup UUID
invite(workgroup_id: str, invitation: isogeo_pysdk.models.invitation.Invitation) → dict[source]

Invite new user to a workgroup. Just a shortcut.

Parameters:
  • workgroup_id (str) – workgroup UUID
  • invitation (Invitation) – Invitation object to send
limits[source]

Returns limits for the specified workgroup.

Parameters:workgroup_id (str) – workgroup UUID
listing[source]

Get workgroups.

Parameters:
  • include (list) – additionnal subresource to include in the response
  • caching (bool) – option to cache the response
memberships[source]

Returns memberships for the specified workgroup.

Parameters:workgroup_id (str) – workgroup UUID
statistics[source]

Returns statistics for the specified workgroup.

Parameters:workgroup_id (str) – workgroup UUID
statistics_by_tag[source]

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
update(workgroup: isogeo_pysdk.models.workgroup.Workgroup, caching: bool = 1) → isogeo_pysdk.models.workgroup.Workgroup[source]

Update a workgroup owned by a workgroup.

Parameters:
  • workgroup (class) – Workgroup model object to update
  • caching (bool) – option to cache the response