MyCalendar list (deprecated)

Returns one or more calendar records for user - deprecated

If you wish to access multiple calendar records you would use the MyCalendar model

For more details about using models see Using data models

For MyCalendar only one model is available:

  • MyCalendar

DEPRECATED - see MyCalendar list

Parameter

Description

Example

More info

API

The API area

calendar.json

Action

Not required

General

Parameters described in overview

user=user&password=user

v3.3 Overview

Modelstructure

Name of model required

Modelstructure=MyCalendar

Using data models

datefrom

Filter by booking date

datefrom=2018-10-29

dateto

Filter by booking date

datefrom=2018-12-10

Response

Returned data

A JSON string containing the data

Example request:
Request for data (list of records using specified model)

http://<SERVER>/jsonapi/calendar.json?user=user&password=user&style=modeldata&modelstructure=MyCalendar&version=3.3&datefrom=2018-10-29&dateto=2018-12-10

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 143,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "calUuid": "FDA00A3205955D458DFAB0D1055D2B40",
      "calTimeStampModified": 1542891467,
      "calRecordVersionNumber": 1,
      "calColour": "FF6600",
      "calDurationDescription": "1 hour",
      "calTimesheets": 0,
      "calEndTimeDisplay": "12:00 AM",
      "calPhaseDescription": "SPV-3033",
      "calJobDescription": "SPV-3033",
      "calStartTimeDisplay": "11:00 PM",
      "calStartDate": "2018-10-29",
      "calStartTime": "23:00:00",
      "calInternalLink": 24742,
      "calWeakLink": 6532,
      "calJobHandler": 242,
      "calPhaseHandler": 242,
      "calTimesheetInternal": 0,
      "calPendingTimesheetInternal": 0,
      "calIsoDateTimeStart": "2018-10-29T23:00:00Z",
      "calIsoDateTimeEnd": "2018-10-29T24:00:00Z",
      "calDurationDecimalHours": 1,
      "calAllDay": false,
      "calRequestStatus": "",
      "calStatus": "",
      "calFeedback": "TODO",
      "calJobPhaseNumberSimple": "12300123.001",
      "calRequisitionSubject": "",
      "calClientName": "999 license"
    },

Note: Custom fields are not returned prior to Synergist 12.2