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.
Parameters: invitation (class) – Invitation model object to accept Return type: 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.
Parameters: invitation (class) – Invitation model object to create Return type: 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.
Parameters: invitation (class) – Invitation model object to decline Return type: Invitation
-
delete
(invitation_id)¶ Delete an invitation from Isogeo database.
Parameters: invitation_id (str) – identifier of the invitation
-
get
(invitation_id)¶ Get details about a specific invitation.
Parameters: invitation_id (str) – invitation UUID Return type: Invitation
-
listing
(workgroup_id)¶ Returns pending invitations (including expired) for the specified workgroup.
Parameters: workgroup_id (str) – workgroup UUID Return type: list
-
update
(invitation)¶ Update a invitation owned by a invitation.
Parameters: invitation (class) – Invitation model object to update Return type: Invitation
-