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)[source]¶ Bases:
object
Routes as methods of Isogeo API used to manipulate contacts.
-
associate_metadata
(metadata: isogeo_pysdk.models.metadata.Metadata, contact: isogeo_pysdk.models.contact.Contact, role: str = 'pointOfContact') → requests.models.Response[source]¶ Associate a metadata with a contact.
If the specified contact is already associated, the response is still 200.
Parameters:
-
create
(workgroup_id: str, contact: isogeo_pysdk.models.contact.Contact, check_exists: int = 1) → isogeo_pysdk.models.contact.Contact[source]¶ 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: str, contact_id: str)[source]¶ Delete a contact from Isogeo database.
Parameters:
-
dissociate_metadata
(metadata: isogeo_pysdk.models.metadata.Metadata, contact: isogeo_pysdk.models.contact.Contact) → requests.models.Response[source]¶ Removes the association between a metadata and a contact.
If the specified contact is not associated, the response is 404.
Parameters:
-
exists
(contact_id: str) → bool[source]¶ Check if the specified contact exists and is available for the authenticated user.
Parameters: contact_id (str) – identifier of the contact to verify
-
get
(contact_id: str) → isogeo_pysdk.models.contact.Contact[source]¶ Get details about a specific contact.
Parameters: contact_id (str) – contact UUID
-