Calendar display compact

Get all calendar bookings for a date range - reduced field set

Calendar display

Get all calendar bookings for a date range

Parameter

Description

Examples

More info

Action

Get calendar bookings

action=calendardisplaycompact

Parameters described in overview

Overview

Company

Company number

company=1

Datefrom

Start date, in YYYY-MM-DD format

datefrom=2017-07-10

Dateto

End date, in YYYY-MM-DD format

dateto=2017-07-31

Example request:
Request to display calendar

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

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",
          "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",
          "calJobAndPhase": "1/00003091.001",
          "calJobPhaseNumberSimple": "3091.001",
          "calRequisitionSubject": "",
          "calNumberOfDays": 1,
          "calPhaseDescription1stLine": "Estimating",
          "calRequestStatus": "",
          "calResourceId": "3",
          "calStatus": "",
          "calTimeSummaryInternal": 1012731,
          "calLinkedBookings": 1
        }
      ]
    }