Activity details

If you wish to access a single activity record you would normally use the activitydetails model

For more details about using models see Using data models

For activities two models are available:

activitylist
activitydetails

To return a single record the ‘activityid’ parameter should be passed.

Parameter	Description	Example	More info
API	The API area	activities.json
Action	Not required
General	Parameters described in overview	user=user&password=user	v3.3 Overview
Modelstructure	Name of model required	Modelstructure=activitydetails	Using data models
Activityid	ID of a specific activity record	activityid=7957
Response	Returned data	A JSON string containing the data

Example request:
Request for data (a single record using specified model)

http://<SERVER>/jsonapi/activities.json?company=1&version=3.3&user=user&password=user&style=modeldata&modelstructure=activitydetails&Activityid=Activityid=7957

Example response (activitydetails model):

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 1,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "activityuuid": "E0C7A305F779704BBB58F9FC01E02DB5",
      "activityTimeStampModified": 1544456139,
      "activityRecordVersionNumber": 66,
      "activityAlertBeforePeriodDescription": "",
      "activityJobPhaseDescription1stLine": "",
      "activityJobDescription1stLine": "TEMPLATE 1",
      "activityCompletedDescription": "",
      "activityCreated": "Created by Matthew Tanner on 02/10/2018 at 1:43pm",
      "activityDetails1stLine": "Meeting at Boundry Mill",
      "activityHistorySummary": "03/10/18 12:07pm - Completed by Matthew Tanner",
      "activityMailshotResponse": "",
      "activityModified": "Last modified by Michael Irving on 07/12/2018 at 1:11pm",
      "activityRegardingDescription": "TEMPLATE 1",
      "activityRegardingDescription2": "",
      "activityRegardingWhat": "Job: 1/00008276",
      "activitySecondaryOwnersDescription": [
        
      ],
      "activitySecondaryOwnersUserID": [
        
      ],
      "activityCustomField300": "MyText",
      "activityCustomField301": "",
      "activityCustomField302": "0000-00-00",
      "activityCustomField303": false,
      "activityCustomField306": 0,
      "activityCustomField307": 0,
      "activityPriorityDescription": "Med",
      "activityTimeDueDisplay": "8:00 AM",
      "activityCompanyName": "The Professional Services Company",
      "activityCompanyNumber": 1,
      "activityID": 7957,
      "activityJobNumber": "1/00008276",
      "activityJobNumberSimple": "8276",
      "activityJobAndPhase": "",
      "activityJobAndPhaseSimple": "",
      "activityStageCode": "",
      "activityStageDescription": "",
      "activitySubject": "Some notes",
      "activityDetails": "Meeting at Boundry Mill",
      "activityClientCode": "1/ABC",
      "activityClientName": "ABC Soft Drinks Division South Ltd",
      "activityClientPhone": "0161 998 8786",
      "activityClientEmail": "[email protected]",
      "activityActivitytypeCode": "Notes",
      "activityActivitytype": "Meeting notes",
      "activityActivitytypeCompanyNumber": 1,
      "activityActivitytypeCategory": 5,
      "activityTeamCode": "",
      "activityTeamDescription": "",
      "activityOwnerID": 263,
      "activityOwnerName": "Matthew Tanner",
      "activityCompletedBy": "",
      "activityCreatedBy": "Matthew Tanner",
      "activityLastModifiedBy": "Michael Irving",
      "activityClientContactInternalRef": 938,
      "activityClientContactFullName": "Jim Green",
      "activityStatus": "Normal",
      "activityPriorityID": 2,
      "activityCategory": "Draft 1",
      "activityAlertSentBefore": false,
      "activityAlertBeforePeriod": 0,
      "activityImmediateAlert": true,
      "activityAlertCompleted": true,
      "activityCompleted": false,
      "activityAlertSentInstant": true,
      "activityMarketingCampaignID": 0,
      "activityMarketingCampaignPromotionCode": "",
      "activityDateDue": "2018-10-02",
      "activityTimeDue": "08:00:00",
      "activityDueTimezone": "UTCA",
      "activityCompletedByUserID": 0,
      "activityCompletedDate": "0000-00-00",
      "activityCompletedTime": "00:00:00",
      "activityCompletedTimeZone": "",
      "activityTimezoneCompleted": "",
      "activityTimezoneCreated": "GMT",
      "activityTimezoneLastModified": "GMT",
      "activityCreatedByUserID": 263,
      "activityCreationDate": "2018-10-02",
      "activityCreationTime": "13:43:08",
      "activityCreationTimezone": "UTCA",
      "activityLastModifiedByUserID": 268,
      "activityLastModifiedDate": "2018-12-07",
      "activityLastModifiedTime": "13:11:21",
      "activityLastModifiedTimeZone": "UTCA",
      "activityKanbanStatusCode": "TODO",
      "activityKanbanStatusDescription": "To do"
    }
  ]
}

Note: Custom fields are not returned prior to Synergist 12.2