Returns one or more calendar records for user
MyCalendar - list bookings
Get all MyCalendar bookings for a date range, for a user
Parameter | Description | Examples | More info |
---|---|---|---|
Action | Get MyCalendar bookings | action=mycalendar | |
Parameters described in 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 | |
User ID | User ID for the calendar required | userid=3 |
Example request:
Request for data
http://<SERVER>/jsonapi/calendar.json?user=user&password=user&version=3.3&datefrom=2019-04-01&dateto=2019-04-07&company=[1]&action=mycalendar&userid=3
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 5,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"calAllDay": false,
"calClientName": "SnakeByte Software",
"calColourHex": "FF6600",
"calDurationDescription": "1.5 hours",
"calEndTimeDisplay": "11:30 AM",
"calFeedback": "TODO",
"calHoursPerDay": 1.5,
"calIsoDateTimeEnd": "2019-04-04T11:30:00",
"calIsoDateTimeStart": "2019-04-04T10:00:00",
"calJobDescription1stLine": "This is a test again",
"calJobPhaseNumberSimple": "752.001",
"calRequisitionSubject": "",
"calPhaseDescription1stLine": "test dfh",
"calRequestStatus": "",
"calStartDate": "2019-04-04",
"calStartTimeDisplay": "10:00 AM",
"calStatus": "",
"calTimesheetsCount": 0,
"calUuid": "BB73807164844A4C81C08E7AEAA13222"
},
etc. etc.
Note: Custom fields are not returned prior to Synergist 12.2