Calendar Display

Get all calendar bookings for a date range

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areacalendar.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.7v3.7 Overview
CompanyYesThe company numbercompany=1
ActionYesThe action to performaction=calendardisplay
DatefromYesStart date, in YYYY-MM-DD formatdatefrom=2017-07-10
DatetoYesEnd date, in YYYY-MM-DD formatdateto=2017-07-31

Example request:

http://<SERVER>/jsonapi/calendar.json?user=user&password=user&version=3.7&datefrom=2017-10-1&dateto=2017-11-12&version=3.7&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": "[email protected]",
      "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": ""
    },