API documentation

Activity Class Reference

Description

Renders an activity.

Protected Member Functions

 _render ($activity)
 Renders an activity for API output. More...
 

Member Function Documentation

_render (   $activity)
protected

Renders an activity for API output.

{
"id": 42,
"entityType": "Activities",
"rev": "5",
"name": "Skype client",
"description": "string value",
"activityType": Activity_Type,
"lead": Lead, // DEPRECATED
"leads": [ Lead, ... ],
"startTime": "2010-09-28T12:30:00+0000", // ATOM/rfc3339 format. optional. NULL if no startTime exists.
"endTime": "2010-09-28T13:30:00+0000", // ATOM/rfc3339 format. optional. NULL if no endTime exists.
"isAllDay": false,
"isFlagged": true,
"status": 1,
"logDescription": "Everything went smoothly", // DEPRECATED
"logNote": Note,
"loggedBy": {
"id": 5,
"entityType": "Users",
"rev": 6
},
"participants": [ User, Contact, Account, ... ],
"followup": Activity, // if this activity has a followup activity, it will be shown in stub form
"followupTo": Activity, // if this activity was a followup to a previous activity, it will be shown in stub form
"deletedTime": "2010-09-28T13:30:00+0000" // ATOM/rfc3339 format. Only present when deleted.
"modifiedTime": "2010-04-26T15:25:10+0000", // ATOM/rfc3339 format. If modified_time is blank the created_time value is returned in its place.
"createdTime": "2010-04-26T15:25:10+0000", // ATOM/rfc3339 format.
}
For Olark web chats, there will be an additional "olark" key containing the transcript information:
"olark": {
"id": "JCBVTEIUCr2PQ3RgYLn01nvU82704778",
"visitorData": {
"city": "Ann Arbor",
"kind": "Visitor",
"countryCode": "US",
"operatingSystem": "Linux",
"ip": "24.11.193.231",
"region": "MI",
"id": "...",
"referrer": "",
"emailAddress": "operatoremail@domain.com",
"country": "United States",
"organization": "org",
"fullName": "Operator Name",
"customFields": {
"instanceId": "...",
"provisionDate": "Nov 17, 2010, 12:00 AM",
"plan": null,
"enableOlark": "1"
},
"browser": "Firefox 14.0.1"
},
"chatItems": [
{
"body": "chat body",
"timestamp": "1343330379.65",
"kind": "MessageToOperator",
"nickname": "Nick Name (nickname@domain.com)"
},
]
}

Possible values for the "status" key:

0 = STATUS_SCHEDULED
1 = STATUS_LOGGED
2 = STATUS_CANCELLED
-1 = STATUS_OVERDUE (note: STATUS_OVERDUE implies STATUS_SCHEDULED)
Returns
array