Get all calendar bookings for a date range
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | calendar.json | |
| General | Yes | Parameters described in overview | user=user&password=user&version=3.9 | Overview |
| Company | Yes | The company number | company=1 | |
| Action | Yes | The action to perform | action=calendardisplay | |
| Datefrom | Yes | Start date, in YYYY-MM-DD format | datefrom=2017-07-10 | |
| Dateto | Yes | End date, in YYYY-MM-DD format | dateto=2017-07-31 |
Example request:
http://<SERVER>/jsonapi/calendar.json?user=user&password=user&version=3.9&datefrom=2017-10-1&dateto=2017-11-12&version=3.9&company=1&action=calendardisplay
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 3,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"calAllDay": false,
"calChargeCodeDescription": "33@44",
"calClientCode": "1/C4036",
"calClientName": "999 license",
"calColourHex": "FFFFFF",
"calDescription": "",
"calDurationDescription": "1.75 hours",
"calFeedback": "TODO",
"calHoursPerDay": 1.75,
"calDiaryInternal": 200822,
"calIsoDateTimeEnd": "2019-01-08T10:45:00",
"calIsoDateTimeStart": "2019-01-08T09:00:00",
"calJobDescription1stLine": "Estimating",
"calJobHandlerName": "Aaron Cronshaw",
"calJobAndPhase": "1/00003091.001",
"calJobPhaseNumberSimple": "3091.001",
"calJobProjectName": "",
"calJobNumberSimple": "3091",
"calNotes": "",
"calRequisitionDetails": "",
"calRequisitionId": 0,
"calRequisitionSubject": "",
"calNumberOfDays": 1,
"calPhaseDescription1stLine": "Estimating",
"calPhaseProjectName": "",
"calRequestStatus": "",
"calResourceId": "3",
"calResourceName": "SYN_Jon",
"calStatus": "",
"calTaskDescription": "",
"calTimeSummaryInternal": 1012731,
"calWeakLink": 6744,
"calStageCode": "",
"calStageDesc": ""
},