Gets all calendar loading values
Calendar Loading
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | calendar.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Filters | No | Filter by a key field | Filters | |
| Company | Yes | The company number | company=1 | |
| Action | Yes | The action to perform | action=calendarloading |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/diary.json?&action=calendarloading&datefrom=2020-11-02&dateto=2020-11-16&version=6&company=1
Example request (legacy username/password):
http://<SERVER>/jsonapi/diary.json?&action=calendarloading&datefrom=2020-11-02&dateto=2020-11-16&version=6&company=1&user=<username>&password=<password>
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 12,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"calLoadingDuration": 15,
"calLoadingStart": "2020-11-09T09:00:00",
"calLoadingRemaining": 25,
"calLoadingResourceUserID": "5",
"calLoadingStatusColour": "G"
},
{
"calLoadingDuration": 7.5,
"calLoadingStart": "2020-11-16T09:00:00",
"calLoadingRemaining": 32.5,
"calLoadingResourceUserID": "5",
"calLoadingStatusColour": "G"
}
]
}