Get a list of items that can be used to drop estimates on to the calendar to create new bookings.
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | calendar.json | |
| General | Yes | Parameters described in overview | user=user&password=user&version=3.9 | Overview |
| Sort | No | Change the view's default sort order | sort=CLIENT | Sorting |
| Filters | No | Filter by a key field | Filters | |
| Company | Yes | The company number | company=1 | |
| Action | Yes | The action to perform | action=unallocated | |
| Persistent Backend Search | No | persistBackendSearch=N | ||
| Direction | No | Ascending or descending sort | direction=1 | ascending is 1, descending is -1 |
| Client | No | Client number | client= | |
| Job | No | Job number | job= | |
| Job Phase | No | Job and phase number | jobphase= |
Example request:
http://<SERVER>/jsonapi/calendar.json?user=user&password=user&version=3.9&action=unallocated&company=3
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 97,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"calBookedSelect": 88.75,
"calChargeCodeSelect": "3/R1",
"calChargeDescSelect": "Rail Engineer 1(mike's skill)",
"calClientSelect": "London eye",
"calDraftSelect": 2,
"calDueDateDescSelect": "Tu 30/04/2019",
"calEstimatedSelect": 0,
"calHandlerSelect": "",
"calHandlerNameSelect": "",
"calHiddenSelect": "S",
"calInitialsSelect": "jjj,MP",
"calJobDescriptionSelect": "mikexxxa Special Campaign Launch",
"calJobPhaseSelect": "3/00001008.001",
"calJobUuidSelect": "81A1872D3C664EDCAFCA3FFE446B70DB",
"calPhaseDescriptionSelect": "Engineering",
"calPrioritySelect": "",
"calRemainingSelect": -88.75,
"calRequestedSelect": "",
"calRequisitionSelect": "",
"calStartDateSelect": "2019-03-01",
"calStartDateDescriptionSelect": "Fr 01/03/2019",
"calStatusSelect": "Live",
"calTaskDescSelect": "",
"calTeamNameSelect": "Team 1 (test)",
"calTimesheetsSelect": 27,
"calTimeSummarySelect": 1013310,
"calUniqueSelect": "3/00001008.001###3/R1",
"calStageSelect": "",
"calStageDescriptionSelect": ""
},
etc. etc.