Calendar Display Compact

Gets all calendar bookings for a date range with a reduced field set.

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areacalendar.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.7v3.7 Overview
FiltersNoFilter by a key fieldFilters
CompanyYesThe company numbercompany=16
ActionYesThe action to performaction=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 it's related phase/stage

Example request:

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

Example response:

{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synversion": "12.690",
"synapiversion": 3.7,
"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"
}
]
}