Difference between revisions of "CRM-2 Contacts API"

Latest revision as of 00:02, 25 January 2014

Contacts API

A Contact is a person or a company, similar to the contacts in your iPhone/Android address book. It may have name, company name, and multiple points of contact, including emails, phone numbers, user logins, twitter, facebook, etc. per contact. It may also be associated with one or more User entities for accessing the system. Each Contact is associated with a clientDomain.

The API calls follow the general RESTful pattern of CRM-2 API.

The base URL is https://crm2.opentaps.com/contact

GET: Get a List of Contacts

contactId
emailAddress
attribute Map

POST: Create a contact

firstName
lastName
companyName
emailsNumber (used to iterate the following parameter where N is an index number)
- emailN (the email address)
- emailPurposeN (can be one of : PRIMARY, OTHER, ORDER, BILLING_AR, PAYMENT_AR, SHIPMENT)
attribute Map (described as a series of attribute_${key}=${value} parameters)

The operation returns a JSON response with the created contact eg:

 {"result":{"resultValue":{"contactId":"5166b967e4b0f6e6cd09e653","firstName":"test","clientDomain":"mydomain.com","emails":[{"email":"test@example.com","purpose":"PRIMARY"}],"attributes":{"somekey":"somevalue"}}}}

PUT: Update a contact

firstName
lastName
companyName
emailsNumber (used to iterate the following parameter where N is an index number)
- emailN (the email address)
- emailPurposeN (can be one of : PRIMARY, OTHER, ORDER, BILLING_AR, PAYMENT_AR, SHIPMENT)
attribute Map (described as a series of attribute_${key}=${value} parameters)

Note that when updating:

the attributes are always overwritten so not gving any attribute will remove the existing ones
emails are only overwritten if at least one email is given or emailsNumber is set to 0 in which case the existing ones will be removed
firstName, lastName, companyName are only updated when given, they must be given and set to an empty value to be removed

The operation returns a JSON response with the new values of the updated contact eg:

 {"result":{"resultValue":{"contactId":"5166b967e4b0f6e6cd09e653","firstName":"test","clientDomain":"mydomain.com","emails":[{"email":"test@example.com","purpose":"PRIMARY"}],"attributes":{"somekey":"somevalue"}}}}

DELETE: Delete a Contact

contactid

Deletes the referenced contact and removes all activities associated with the Contact.

Import Contact API

A similar API is available to easily import contacts, it only allows POST operations but will create the contacts or update if one is found matching the given attributes.

The base URL is http://crm-2-url/crm2/contact-import

POST: Create or update Contact

firstName
lastName
companyName
emailsNumber (used to iterate the following parameter where N is an index number)
- emailN (the email address)
- emailPurposeN (can be one of : PRIMARY, OTHER, ORDER, BILLING_AR, PAYMENT_AR, SHIPMENT)
attribute Map (described as a series of attribute_${key}=${value} parameters)

Only the attributes given as attribute_XXX are used to find an existing contact for update, if they are not given and / or a contact matching those is not found the operation will create a new contact.

The operation returns a JSON response with the contact ID of the created or updated record, eg:

 { "contact": { "contactId": XXX } }

The attribute Map is described as a series of attribute_${key}=${value} parameters. For example, attribute_opentapsPartyId=12345 will become {opentapsPartyId:12345}

Contact Group API

Contact Groups are groups of Contacts. For example, you may have a Group called "Company X" for everybody who works at Company X or "Friends" for your personal friends.

A Contact Group has a group name and a list of contacts.

The base URL is https://crm2.opentaps.com/contact-group The API available are: