isogeo_pysdk.api.routes_invitation module

Isogeo API v1 - API Routes for Invitations entities

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

class isogeo_pysdk.api.routes_invitation.ApiInvitation(api_client=None)

Bases : object

Routes as methods of Isogeo API used to manipulate invitations.

accept(invitation=<class 'isogeo_pysdk.models.invitation.Invitation'>)

Accept the invitation to join an Isogeo Workgroup.

Paramètres:

invitation (class) – Invitation model object to accept

Type renvoyé:

Invitation

create(workgroup_id, invitation={'_created': None, '_id': None, '_modified': None, 'email': None, 'expiresIn': None, 'group': None, 'role': None})

Add a new invitation to Isogeo.

Paramètres:

invitation (class) – Invitation model object to create

Type renvoyé:

Invitation

Example:

>>> # create the invitation locally
>>> invit = Invitation(
    email="prenom.nom@organisation.com",
    role="admin"
    )
>>> # send the invitation
>>> isogeo.invitation.create(WORKGROUP_UUID, new_invit)

decline(invitation=<class 'isogeo_pysdk.models.invitation.Invitation'>)

Decline the invitation to join an Isogeo Workgroup.

Paramètres:

invitation (class) – Invitation model object to decline

Type renvoyé:

Invitation

delete(invitation_id)

Delete an invitation from Isogeo database.

Paramètres:

invitation_id (str) – identifier of the invitation

get(invitation_id)

Get details about a specific invitation.

Paramètres:

invitation_id (str) – invitation UUID

Type renvoyé:

Invitation

listing(workgroup_id)

Returns pending invitations (including expired) for the specified workgroup.

Paramètres:

workgroup_id (str) – workgroup UUID

Type renvoyé:

list

update(invitation)

Update a invitation owned by a invitation.

Paramètres:

invitation (class) – Invitation model object to update

Type renvoyé:

Invitation