MyCalendar List

Returns all MyCalendar records for a date range and user.

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areacalendar.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.9Overview
FiltersNoFilter by a key fieldFilters
CompanyYesThe company numbercompany=1
ActionYesThe action to performaction=mycalendar

Example request:

http://<SERVER>/jsonapi/calendar.json?userid=54&user=user&password=user&version=3.9&datefrom=2019-05-27&dateto=2019-07-08&company=1&action=mycalendar

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 1,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "calAllDay": true,
      "calClientName": "Internal",
      "calColourHex": "000000",
      "calCompany": 1,
      "calDurationDescription": "1 day",
      "calEndTimeDisplay": "5:30 PM",
      "calFeedback": "TODO",
      "calHoursPerDay": 0,
      "calInternalLink": 0,
      "calIsoDateTimeEnd": "2019-07-07T17:30:00",
      "calIsoDateTimeStart": "2019-07-07T09:00:00",
      "calJobDescription1stLine": "Auto created holiday job",
      "calJobPhaseNumberSimple": "HOLJON.001",
      "calJobNumberSimple": "HOLJON",
      "calRequisitionId": 0,
      "calRequisitionSubject": "",
      "calPhaseDescription1stLine": "Auto created holiday job",
      "calRequestStatus": "",
      "calStartDate": "2019-07-07",
      "calStartTimeDisplay": "9:00 AM",
      "calStatus": "Tentative",
      "calTimesheetsCount": 0,
      "calUuid": "E24CB8752078A8439F75FDCFA7A3DDAC"
    }
  ]
}

Note: Custom fields are not returned prior to Synergist 12.2