Activity list

Returns one or more activity records

If you wish to access multiple activity records you would normally use the activitylist model

For more details about using models see Using data models

For activities two models are available:

  • activitylist
  • activitydetails

If a list of records is required a ‘view’ parameter should be passed. If no ‘view’ parameter is passed all records for the synergist company are returned.

Parameter Description Example More info
API The API area activities.json
Action Not required
Parameters described in overview user=user\&password=user [v3.3 Overview](ref:v30xxx-overview)
Modelstructure Name of model required Modelstructure=activitylist [Using data models](ref:using-models)
View Stored filter applied view=-1700 [Using views](ref:models)
Sort Change the view's default sort order sort=CLIENT [Sorting](ref:sorting)
Filter by a key field client=1/F667 [Filters](ref:filters)
Response Returned data A JSON string containing the data

Example request:
Request for data (list of records using specified model)

http://<SERVER>/jsonapi/activities.json?company=1&version=3.3&user=user&password=user&style=modeldata&modelstructure=activitylist&view=-1700&rows=2&page=1

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 217,
  "totalpages": 109,
  "responsemessage": "",
  "pagerows": 2,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "activityuuid": "34912CA9753A494F8EB70BF0CD385CB7",
      "activityTimeStampModified": 1516878190,
      "activityRecordVersionNumber": 139,
      "activityAttachmentCount": "2",
      "activityCreated": "Created by SYN_Jon on 09/05/2017 at 2:48pm",
      "activityDetails1stLine": "",
      "activityRegardingDescription": "",
      "activityRegardingDescription2": "",
      "activityRegardingWhat": "Campaign: test of new site",
      "activityCustomField300": "",
      "activityCustomField301": "",
      "activityCustomField302": "0000-00-00",
      "activityCustomField303": false,
      "activityCustomField306": 0,
      "activityCustomField307": 0,
      "activityPriorityDescription": "High",
      "activityOwnerID": 3,
      "activityOwnerName": "Mike",
      "activityClientCode": "",
      "activityClientName": "",
      "activityCompleted": false,
      "activityViewDate": "0000-00-00",
      "activityViewTime": "00:00:00",
      "activityViewTimezone": "",
      "activityJobNumber": "",
      "activityJobNumberSimple": "",
      "activityJobAndPhase": "",
      "activityJobAndPhaseSimple": "",
      "activitySubject": "test",
      "activityActivitytype": "Meeting",
      "activityID": 7476,
      "activityCreationDate": "2017-05-09"
    },
etc. etc.
}

Note: Custom fields are not returned prior to Synergist 12.2