Activity Details

Returns a single activity record.

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaactivities.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.7v3.7 Overview
Model StructureYesName of model requiredmodelstructure=activitydetailsUsing data models
ViewNoStored filter appliedUsing views
SortNoChange the view's default sort ordersort=CLIENTSorting
FiltersNoFilter by a key fieldFilters
CompanyYesThe company numbercompany=1
IdentifierYesActivity ID or UUIDactivityid=7957

Example request:

http://<SERVER>/jsonapi/activities.json?company=1&version=3.7&user=user&password=user&modelstructure=activitydetails&activityid=7957

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 219,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "activityuuid": "F94FF187588D104BBC8A5B96A65365C4",
      "activityTimeStampModified": 1588148872,
      "activityRecordVersionNumber": 163,
      "activityAlertBeforePeriodDescription": "",
      "activityJobPhaseDescription1stLine": "Website",
      "activityJobDescription1stLine": "Website",
      "activityCompletedDescription": "Completed by User - Andy on 01/05/2019 at 11:03am",
      "activityCreated": "Created by SYN_Jon on 27/01/2015 at 9:56am",
      "activityDetails1stLine": "Special",
      "activityHistorySummary": "09/04/20 5:07pm - Transferred to Andy Doro for actioning\r09/04/20 5:06pm",
      "activityMailshotResponse": "",
      "activityModified": "Last modified by SYN_Jon on 09/04/2020 at 5:07pm",
      "activityRegardingDescription": "Website",
      "activityRegardingDescription2": "Website",
      "activityRegardingWhat": "Phase: 1/00000673.002",
      "activitySecondaryOwnersDescription": [
        "Michael Irving"
      ],
      "activitySecondaryOwnersUserID": [
        268
      ],
      "activityCustomField435": false,
      "activityCustomField436": "",
      "activityCustomField437": "",
      "activityCustomField438": 0,
      "activityCustomField439": "0000-00-00",
      "activityPriorityDescription": "Med",
      "activityTimeDueDisplay": "8:00 AM",
      "activityTimeDisplay": "2:00 PM",
      "activityCompanyName": "The Professional Services Company",
      "activityCompanyNumber": 1,
      "activityID": 7957,
      "activityJobNumber": "1/00000673",
      "activityJobNumberSimple": "673",
      "activityJobAndPhase": "1/00000673.002",
      "activityJobAndPhaseSimple": "673.002",
      "activityStageCode": "",
      "activityStageDescription": "",
      "activitySubject": "mike test phase",
      "activityDetails": "xxx yyy",
      "activityClientCode": "1/ABAP01",
      "activityClientName": "A B Applications Ltd",
      "activityClientPhone": "0117 655 87999",
      "activityClientEmail": "",
      "activityActivitytypeCode": "RQ2",
      "activityActivitytype": "Req - in owner & watche",
      "activityActivitytypeCompanyNumber": 1,
      "activityActivitytypeCategory": 8,
      "activityTeamCode": "",
      "activityTeamDescription": "",
      "activityOwnerID": 680,
      "activityOwnerName": "Andy Doro",
      "activityCompletedBy": "User - Andy",
      "activityCreatedBy": "SYN_Jon",
      "activityLastModifiedBy": "SYN_Jon",
      "activityClientContactInternalRef": 0,
      "activityClientContactFullName": "",
      "activityStatus": "2nd item",
      "activityPriorityID": 2,
      "activityCategory": "Draft 1",
      "activityAlertSentBefore": false,
      "activityAlertBeforePeriod": 0,
      "activityImmediateAlert": false,
      "activityAlertCompleted": false,
      "activityCompleted": true,
      "activityAlertSentInstant": false,
      "activityMarketingCampaignID": 0,
      "activityMarketingCampaignPromotionCode": "",
      "activityDateDue": "2015-01-27",
      "activityTimeDue": "08:00:00",
      "activityDueTimezone": "UTCA",
      "activityStartDate": "2015-01-27",
      "activityStartTime": "14:00:00",
      "activityStartTimeZone": "UTCA",
      "activityIsoDateTimeStart": "2015-01-27T14:00:00Z",
      "activityIsoDateTimeEnd": "2015-01-27T08:00:00Z",
      "activityCompletedByUserID": 54,
      "activityCompletedDate": "2019-05-01",
      "activityCompletedTime": "11:03:41",
      "activityCompletedTimeZone": "UTCA",
      "activityTimezoneCompleted": "GMT",
      "activityTimezoneCreated": "GMT",
      "activityTimezoneLastModified": "GMT",
      "activityCreatedByUserID": 3,
      "activityCreationDate": "2015-01-27",
      "activityCreationTime": "09:56:13",
      "activityCreationTimezone": "UTCA",
      "activityLastModifiedByUserID": 3,
      "activityLastModifiedDate": "2020-04-09",
      "activityLastModifiedTime": "17:07:41",
      "activityLastModifiedTimeZone": "UTCA",
      "activityKanbanStatusCode": "COMP",
      "activityKanbanStatusDescription": "Done",
      "activitytypeCalendarDisplayOptions": "OWNER\rSECONDARY",
      "activityRequisitionChargeCode": "1/AA",
      "activityRequisitionResourceCode": "1/AG1",
      "activityRequisitionHours": 100
    },

Note: Custom fields are not returned prior to Synergist 12.2