Returns a single activity record
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 | ||
| Parameters described in overview | user=user&password=user&version=3.1 | v3.1 Overview | |
| Modelstructure | Name of model required | Modelstructure=activitydetails | Using models & views |
| Activityid | ID of a specific activity record | activityid=4833 | |
| Response | Returned data | A JSON string containing the data |
Example
Request for data (a single record using specified model)
http:///jsonapi/activities.json?company=1&version=3.1&user=user&password=user&style=modeldata&modelstructure=activitydetails&Activityid=Activityid=7005
Example response (activitydetails model):
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"activityuuid": "B655BD6D7C9BCF43A932C67F55871C53",
"activityTimeStampModified": 1520443094,
"activityRecordVersionNumber": 17,
"activityAlertBeforePeriodDescription": "",
"activityJobPhaseDescription1stLine": "Test dates enterable",
"activityJobDescription1stLine": "Brochure re-design",
"activityCompletedDescription": "",
"activityCreated": "Created by SYN_Jon on 08/09/2016 at 2:39pm",
"activityDetails1stLine": "Penatibus cras odio. Mauris magnis tincidunt. Nullam impor vehicula. Tempus sunt in ante platea ac. Accumsan integer porti ut. Amet vel amet. ",
"activityHistorySummary": "07/03/18 5:17pm - Status changed to 'Normal'\r07/03/18 5:17pm - Transferred to Tamerlane for actioning\r07/03/18 5:16pm - Type changed to ' Meeting notes'\r11/02/18 8:35pm - Category changed to 'blue'\r11/02/18 8:35pm - Type changed to ' DQS Note Type 01x'\r",
"activityMailshotResponse": "",
"activityModified": "Last modified by Syn Mike Dev on 07/03/2018 at 5:17pm",
"activityRegardingDescription": "Brochure re-design",
"activityRegardingDescription2": "Test dates enterable",
"activityRegardingWhat": "Phase: 1/JN088004.002",
"activitySecondaryOwnersDescription": [
],
"activitySecondaryOwnersUserID": [
],
"activityCustomField300": "Fred Smith",
"activityCustomField301": "Lookup 1",
"activityCustomField302": "2018-03-21",
"activityCustomField303": true,
"activityCustomField306": 2,
"activityCustomField307": 200,
"activityPriorityDescription": "Med",
"activityTimeDueDisplay": "8:00 AM",
"activityCompanyName": "The Professional Services Company",
"activityCompanyNumber": 1,
"activityID": 7005,
"activityJobNumber": "1/JN088004",
"activityJobNumberSimple": "JN088004",
"activityJobAndPhase": "1/JN088004.002",
"activityJobAndPhaseSimple": "JN088004.002",
"activityStageCode": "",
"activityStageDescription": "",
"activitySubject": "Meeting on site - agenda",
"activityDetails": "Penatibus cras odio. Mauris magnis tincidunt. Nullam imperdiet lacinia. Odio a luctus egestas egac. amet. ",
"activityClientCode": "1/FORDM5",
"activityClientName": "Ford motor company",
"activityClientPhone": "0161 234 5678",
"activityClientEmail": "[email protected]",
"activityActivitytypeCode": "Notes",
"activityActivitytype": "Meeting notes",
"activityActivitytypeCompanyNumber": 1,
"activityActivitytypeCategory": 5,
"activityTeamCode": "",
"activityTeamDescription": "",
"activityOwnerID": 189,
"activityOwnerName": "Tamerlane",
"activityCompletedBy": "",
"activityCreatedBy": "SYN_Jon",
"activityLastModifiedBy": "Syn Mike Dev",
"activityClientContactInternalRef": 0,
"activityClientContactFullName": "",
"activityStatus": "Normal",
"activityPriorityID": 2,
"activityCategory": "blue",
"activityAlertSentBefore": false,
"activityAlertBeforePeriod": 0,
"activityImmediateAlert": true,
"activityAlertCompleted": true,
"activityCompleted": false,
"activityAlertSentInstant": false,
"activityMarketingCampaignID": 0,
"activityMarketingCampaignPromotionCode": "",
"activityDateDue": "2016-09-08",
"activityTimeDue": "08:00:00",
"activityDueTimezone": "UTCA",
"activityCompletedByUserID": 0,
"activityCompletedDate": "0000-00-00",
"activityCompletedTime": "00:00:00",
"activityCompletedTimeZone": "",
"activityTimezoneCompleted": "",
"activityTimezoneCreated": "GMT",
"activityTimezoneLastModified": "GMT",
"activityCreatedByUserID": 3,
"activityCreationDate": "2016-09-08",
"activityCreationTime": "14:39:22",
"activityCreationTimeZone": "UTCA",
"activityLastModifiedByUserID": 5,
"activityLastModifiedDate": "2018-03-07",
"activityLastModifiedTime": "17:17:47",
"activityLastModifiedTimeZone": "UTCA"
}
]
}
Note: Custom fields are not returned prior to Synergist 12.2