CRM-2 Activities API - Revision history

Sichen at 23:21, 11 March 2014

2014-03-11T23:21:34Z

2014-01-24T23:05:24Z

‎Task API

2014-01-24T23:04:55Z

‎Activities API

2014-01-20T20:20:28Z

‎GET: Search for Task

2014-01-20T20:20:17Z

‎POST: Create a Task

2014-01-20T20:19:48Z

‎Task API

2014-01-20T20:12:42Z

‎Task API

2014-01-17T00:14:30Z

2013-04-20T00:12:23Z

‎GET: Retrieve activities

2013-04-19T15:21:56Z

‎Activities API allows to perform operations on activities.

← Older revision		Revision as of 23:21, 11 March 2014
Line 77:		Line 77:
	* fromScheduledDateTime -- if filled in, a range of date time for scheduled date/time		* fromScheduledDateTime -- if filled in, a range of date time for scheduled date/time
	* toScheduledDateTime		* toScheduledDateTime
		+
		+	=== Task Status ===
		+
		+	A task can go through the following status:
		+	* Created
		+	* Started
		+	* Completed
		+	* Cancelled
		+
		+	The API doesn't restrict your updating of the status, but the normal flow would be
		+	* Created can be Started or Cancelled
		+	* Started can be Completed or Cancelled
		+	* Completed or Cancelled tasks cannot be changed

@@ Line 59: / Line 59: @@
 == Task API ==
-Task is a specialized kind of Activity with a scheduled date/time and a person (Contact) that it's been assigned to.  Like other activities, it also has status, notes, and activities associated with it, and some of those activities could be tasks in turn.
+Task is a specialized kind of Activity with a scheduled date/time and a person (Contact) that it's been assigned to.  Like other activities, it also has status, notes, and activities associated with it, and some of those activities could be tasks in turn.  Also like activities, it could be associated with contacts or with legacy orders/quotes/invoices/payments.
 A task is uniquely identified by an activityId, just like other activities.  Most operations on tasks are the same as those for activities in general and can be accessed with the activities API above, with the following exceptions at URL https://crm2.opentaps.com/task:

@@ Line 1: / Line 1: @@
 == Activities API ==
-The Activities API is used for operations on Activities.  An Activity is pretty flexible and could be anything -- a note, a tweet, an email, a task (see below.)  The API calls should be prefixed with URL <tt>https://crm2.opentaps.com/activities</tt>.
+An Activity is pretty flexible and could be anything -- a note, a tweet, an email, a task (see below.)  An activity could be linked to a contact or to an external object, such as an order or quote in a legacy order management system or an invoice or payment in a legacy accounting system.
 Available operations are:

@@ Line 72: / Line 72: @@
 You can search for a task with the GET operation, with parameters:
- * assignedToContactId -- an Array of Contact IDs your task has been assigned to, or leave empty for any
+* assignedToContactId -- an Array of Contact IDs your task has been assigned to, or leave empty for any
- * fromScheduledDateTime -- if filled in, a range of date time for scheduled date/time
+* fromScheduledDateTime -- if filled in, a range of date time for scheduled date/time
- * toScheduledDateTime
+* toScheduledDateTime

@@ Line 64: / Line 64: @@
 Create a task by POST.  In addition to the activities fields, tasks support
- * scheduledDateTime
+* scheduledDateTime
- * assignedToContactId
+* assignedToContactId
 Tasks do not support activityTypeId.  Any task created with this POST will have activityTypeId of TASK.

← Older revision		Revision as of 20:19, 20 January 2014
Line 57:		Line 57:
	== Task API ==		== Task API ==

−	Task is a specialized kind of Activity with a scheduled date/time and a person (Contact) that it's been assigned to. Like other activities, it also has status, notes, and activities associated with it, and some of those activities could be tasks in turn.	+	Task is a specialized kind of Activity with a scheduled date/time and a person (Contact) that it's been assigned to. Like other activities, it also has status, notes, and activities associated with it, and some of those activities could be tasks in turn.
		+
		+	A task is uniquely identified by an activityId, just like other activities. Most operations on tasks are the same as those for activities in general and can be accessed with the activities API above, with the following exceptions at URL https://crm2.opentaps.com/task:
		+
		+	=== POST: Create a Task ===
		+
		+	Create a task by POST. In addition to the activities fields, tasks support
		+	* scheduledDateTime
		+	* assignedToContactId
		+
		+	Tasks do not support activityTypeId. Any task created with this POST will have activityTypeId of TASK.
		+
		+	=== GET: Search for Task ===
		+
		+	You can search for a task with the GET operation, with parameters:
		+	* assignedToContactId -- an Array of Contact IDs your task has been assigned to, or leave empty for any
		+	* fromScheduledDateTime -- if filled in, a range of date time for scheduled date/time
		+	* toScheduledDateTime

← Older revision		Revision as of 20:12, 20 January 2014
Line 57:		Line 57:
	== Task API ==		== Task API ==

−	Task is a specialized kind of Activity with	+	Task is a specialized kind of Activity with a scheduled date/time and a person (Contact) that it's been assigned to. Like other activities, it also has status, notes, and activities associated with it, and some of those activities could be tasks in turn.

@@ Line 1: / Line 1: @@
-== Activities API allows to perform operations on activities. ==
+== Activities API ==
-The API calls should be prefixed with URL <tt>http://crm-2-url/activities</tt>.
+The Activities API is used for operations on Activities.  An Activity is pretty flexible and could be anything -- a note, a tweet, an email, a task (see below.)  The API calls should be prefixed with URL <tt>https://crm2.opentaps.com/activities</tt>.
 Available operations are:
@@ Line 54: / Line 54: @@
 * contactId - A contact id.
 * role(optional) - A role, an arbitrary string.

@@ Line 16: / Line 16: @@
 * clientDomain - Customer's client domain.
-Return JSON. Sample of output
+Return JSON.
 === DELETE: Delete an activity ===

@@ Line 7: / Line 7: @@
 === GET: Retrieve activities ===
 Use pattern /{numberOfActivities}/{startFrom}
 * numberOfActivities - number of activities to return.
 * startFrom(optional) - return activities starting from specified sequence number. W/o this attribute service returns all activites.
 Return JSON. Sample of output
@@ Line 41: / Line 47: @@
 === 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. ===
@@ Line 50: / Line 66: @@
 Parameters:
 * activityId - An activity identifier.
 * contactId - A contact id.
@@ Line 58: / Line 76: @@
 Parameters:
 * activityId - An activity identifier.
 * contactId - A contact id.
 * role(optional) - A role, an arbitrary string.