Difference between revisions of "CRM-2 Activities API"
From Opentaps Wiki
Jump to navigationJump to searchm (Protected "CRM-2 Activities API": Sysop page [edit=sysop:move=sysop]) |
(→POST: Associate a contact with an activity in a role.) |
||
| Line 19: | Line 19: | ||
=== POST: Associate a contact with an activity in a role. === | === POST: Associate a contact with an activity in a role. === | ||
Use pattern /contact/add | Use pattern /contact/add | ||
| − | |||
| + | Parameters: | ||
| + | * activityId - An activity identifier. | ||
| + | * contactId - A contact id. | ||
| + | * role(optional) - A role, an arbitrary string. | ||
=== POST: Remove contact association. | === POST: Remove contact association. | ||
Use pattern /contact/remove | Use pattern /contact/remove | ||
| + | |||
| + | Parameters: | ||
| + | * activityId - An activity identifier. | ||
| + | * contactId - A contact id. | ||
| + | * role(optional) - A role, an arbitrary string. | ||
Revision as of 14:59, 19 April 2013
Contents
Activities API allows to perform operations on activities.
The API calls should be prefixed with URL http://crm-2-url/activities.
Available operations are:
GET: Retrieve activities
Use pattern /{numberOfActivities}/{startFrom}
- numberOfActivities - number of activities to return.
- startFrom(optional) - return activities skipping specified number of items. W/o this attribute service returns all activites.
DELETE: Delete an activity
Use pattern /{activityId}
- activityId - An activity identifier.
POST: Create or update activity
There is no special pattern. Post request to /activities.
POST: Associate a contact with an activity in a role.
Use pattern /contact/add
Parameters:
- activityId - An activity identifier.
- contactId - A contact id.
- role(optional) - A role, an arbitrary string.
=== POST: Remove contact association. Use pattern /contact/remove
Parameters:
- activityId - An activity identifier.
- contactId - A contact id.
- role(optional) - A role, an arbitrary string.
