Returns a single activity record.
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | activities.json | |
| General | Yes | Parameters described in overview | user=user&password=user | Overview |
| Model Structure | Yes | Name of model required | modelstructure=activitydetails | Using data models |
| View | No | Stored filter applied | Using views | |
| Sort | No | Change the view's default sort order | sort=CLIENT | Sorting |
| Filters | No | Filter by a key field | Filters | |
| Company | Yes | The company number | company=1 | |
| Identifier | Yes | Activity ID or UUID | activityid=7957 |
Example request:
http://<SERVER>/jsonapi/activities.json?company=1&version=3.9&user=user&password=user&modelstructure=activitydetails&activityid=9371
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"activityuuid": "6502121115D6D249BA548DDAEDD89A85",
"activityTimeStampModified": 1636990928,
"activityRecordVersionNumber": 171,
"activityAlertBeforePeriodDescription": "",
"activityJobPhaseDescription1stLine": "Phase 3",
"activityJobDescription1stLine": "My Job",
"activityCompletedDescription": "",
"activityCreated": "Created by User on 18/03/2020 at 2:19pm",
"activityDetails1stLine": "[pic]3.jpg~7817[/pic]",
"activityHistorySummary": "29/10/21 2:42pm - Email to:,
"activityMailshotResponse": "",
"activityModified": "Last modified by Mike Pender on 15/11/2021 at 3:42pm",
"activityRegardingDescription": "My Job",
"activityRegardingDescription2": "Phase 3",
"activityRegardingWhat": "Phase: 1/00000688.003",
"activitySecondaryOwnersDescription": [
"Aaron Dyson, Adele Clarke, SYN_Jon"
],
"activitySecondaryOwnersUserID": [
568,
499,
3
],
"activityCustomField436": "",
"activityCustomField437": "",
"activityCustomField438": 334,
"activityCustomField439": "2021-03-25",
"activityCustomField582": "Parent 1",
"activityCustomField628": "00:00:00",
"activityCustomField636": true,
"activityCustomField637": "",
"activityCustomField639": "",
"activityPriorityDescription": "Med",
"activityTimeDueDisplay": "10:00 AM",
"activityTimeDisplay": "9:00 AM",
"activityCompanyName": "The Professional Services Company",
"activityCompanyNumber": 1,
"activityID": 9371,
"activityJobNumber": "1/00000688",
"activityJobNumberSimple": "688",
"activityJobAndPhase": "1/00000688.003",
"activityJobAndPhaseSimple": "688.003",
"activityStageCode": "",
"activityStageDescription": "",
"activitySubject": "Activity with image and @mention",
"activityDetails": "[pic]3.jpg~7817[/pic]\r\n[user]Mike Pender~5[/user] ",
"activityClientCode": "1/BASS",
"activityClientName": "Bassy Brewers",
"activityClientPhone": "111 111 1111",
"activityClientEmail": "[email protected]",
"activityActivitytypeCode": "1/KWT",
"activityActivitytype": "Req KW",
"activityActivitytypeCategory": 8,
"activityTeamCode": "1/ADMI",
"activityTeamDescription": "Administration",
"activityOwnerID": 382,
"activityOwnerName": "Andrew Jones",
"activityCompletedBy": "",
"activityCreatedBy": "User",
"activityLastModifiedBy": "Mike Pender",
"activityClientContactInternalRef": 6500,
"activityClientContactFullName": "Jim Hartley",
"activityStatus": "",
"activityPriorityID": 2,
"activityCategory": "Draft 2",
"activityAlertSentBefore": false,
"activityAlertBeforePeriod": 0,
"activityImmediateAlert": false,
"activityAlertCompleted": false,
"activityCompleted": false,
"activityAlertSentInstant": true,
"activityMarketingCampaignID": 0,
"activityMarketingCampaignPromotionCode": "",
"activityDateDue": "2020-03-18",
"activityTimeDue": "10:00:00",
"activityDueTimezone": "UTCA",
"activityStartDate": "2020-03-18",
"activityStartTime": "09:00:00",
"activityStartTimeZone": "",
"activityIsoDateTimeStart": "2020-03-18T09:00:00Z",
"activityIsoDateTimeEnd": "2020-03-18T10:00:00Z",
"activityCompletedByUserID": 0,
"activityCompletedDate": "0000-00-00",
"activityCompletedTime": "00:00:00",
"activityCompletedTimeZone": "",
"activityTimezoneCompleted": "",
"activityTimezoneCreated": "GMT",
"activityTimezoneLastModified": "GMT",
"activityCreatedByUserID": 54,
"activityCreationDate": "2020-03-18",
"activityCreationTime": "14:19:38",
"activityCreationTimezone": "UTCA",
"activityLastModifiedByUserID": 5,
"activityLastModifiedDate": "2021-11-15",
"activityLastModifiedTime": "15:42:08",
"activityLastModifiedTimeZone": "UTCA",
"activityKanbanStatusCode": "TODO",
"activityKanbanStatusDescription": "To do ⚡",
"activitytypeCalendarDisplayOptions": "",
"activityRequisitionChargeCode": "",
"activityRequisitionResourceCode": "",
"activityRequisitionHours": 0
}
]
}
NOTE: Embedded data
In the example above the activity details field returns links to embedded data:
"activityDetails": "[pic]3.jpg~7817[/pic]\r\n[user]Mike Pender~5[/user] ",
This is an embedded image and an @mention name.
If you wish to access this data you will need make additional API calls
e.g.
for the image:
http:///jsonapi/attachments.json?&user=user&password=user&version=3.8&company=1&attachment=7817&action=attachmentview
For the name:
http:///jsonapi/users.json?user=user&password=user&style=modeldata&modelstructure=userslist&version=3.7&userid=5