isogeo_pysdk.api.routes_contact module
Isogeo API v1 - API Routes for Contacts entities
See: http://help.isogeo.com/api/complete/index.html
- class isogeo_pysdk.api.routes_contact.ApiContact(api_client=None)
Bases:
object
Routes as methods of Isogeo API used to manipulate contacts.
- associate_metadata(metadata, contact, role='pointOfContact')
Associate a metadata with a contact.
If the specified contact is already associated, the response is still 200.
- Parameters
- Example
# retrieve a metadata md = isogeo.metadata.get(METADATA_UUID) # retrieve a contact ctct = isogeo.contact.get(CONTACT_UUID) # associate a contact to a metadata isogeo.contact.associate_metadata(metadata = md, contact = ctct)
- Return type
- create(workgroup_id, contact, check_exists=1)
Add a new contact to a workgroup.
- Parameters
- Returns
the created contact or the existing contact if case oof a matching name or email or a tuple with response error code
- Return type
- delete(workgroup_id, contact_id)
Delete a contact from Isogeo database.
- dissociate_metadata(metadata, contact)
Removes the association between a metadata and a contact.
If the specified contact is not associated, the response is 404.
- exists(contact_id)
Check if the specified contact exists and is available for the authenticated user.
- get(contact_id)
Get details about a specific contact.
- listing(workgroup_id=None, include=('count',), caching=1)
Get workgroup contacts.