Calendar Display Compact

Parameter	Mandatory	Description	Examples	More Info
API	Yes	The API area	calendar.json
General	Yes	Parameters described in overview	`Authorization: Bearer <access_token>` header — see Synergist API Authentication	Structure of an API call
Filters	No	Filter by a key field		Filters
Company	Yes	The company number	company=16
Action	Yes	The action to perform	action=calendardisplaycompact

Note: the returned value calTaskDateIndicator will be set to either "BEFORE" or "AFTER" if the bookings start/end dates are outside the date range for its related phase/stage

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/diary.json?&action=calendardisplaycompact&datefrom=2019-01-01&dateto=2021-07-31&version=6&company=16

Example request (legacy username/password):

http://<SERVER>/jsonapi/diary.json?&action=calendardisplaycompact&datefrom=2019-01-01&dateto=2021-07-31&version=6&company=16&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 1,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synapiversion": 3.8,
  "data": [
    {
      "calAllDay": false,
      "calChargeCodeDescription": "Planning",
      "calClientCode": "16/HGHG",
      "calClientName": "3D Animatronics B2B",
      "calColourHex": "000099",
      "calCompany": 16,
      "calDurationDescription": "0.25 hour",
      "calFeedback": "on",
      "calHoursPerDay": 0.25,
      "calImportant": true,
      "calDiaryInternal": 205916,
      "calIsoDateTimeEnd": "2019-03-08T10:15:00",
      "calIsoDateTimeStart": "2019-03-08T10:00:00",
      "calJobDescription1stLine": "Website re-design - new features etc",
      "calJobAndPhase": "16/0050015.001",
      "calJobPhaseNumberSimple": "50015.001",
      "calJobNumberSimple": "50015",
      "calRequisitionId": 0,
      "calRequisitionSubject": "",
      "calNumberOfDays": 1,
      "calPhaseDescription1stLine": "Website re-design",
      "calRequestStatus": "",
      "calResourceId": "5",
      "calStatus": "",
      "calTaskDateIndicator": "AFTER",
      "calTimeSummaryInternal": 1012865,
      "calLinkedBookings": 0,
      "calStageCode": "16/W0000000918",
      "calStageDesc": "Design"
    }
  ]
}