Difference between revisions of "API schedules"
From Charitylog Manual
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[API Details|Go to API overview]] | [[API Details|Go to API overview]] | ||
| − | These are Roster job cards. This endpoint is primarily for our mobile roster app, Call Round, | + | These are Roster job cards. |
| + | |||
| + | NB, this endpoint cannot currently be used for schedule creation, which is only possible using the Confirm Work Schedules option in the web app. This is because this endpoint is primarily intended for our mobile roster app, Call Round, which gets lists of jobs and updates them, typically to complete or cancel them. It can also be useful for reporting. | ||
| + | |||
| + | If you want to use this endpoint for your own time and attendance solution, these calls may help: | ||
| + | |||
| + | * All jobs in a date range, with an id and completion status: | ||
| + | [GET] https<nowiki/>://api.dizions.co.uk/v2/schedules/date_active/2021-04-01,2021-04-30/field/id;status | ||
| + | |||
| + | * Jobs with for worker 220 in a date range, with an id and completion status: | ||
| + | [GET] https<nowiki/>://api.dizions.co.uk/v2/schedules/worker/220/date_active/2021-04-01,2031-04-30/field/id;status | ||
| + | |||
| + | |||
| + | * A report of completed jobs in a date range, broken down by the client's district and gender | ||
| + | [GET] https<nowiki/>://api.dizions.co.uk/v2/schedules/metric/client_district/dimension/client_gender/date_active/2021-04-01,2021-04-30/status/completed | ||
| + | |||
| + | * A list of available fields: | ||
| + | [GET] https<nowiki/>://api.dizions.co.uk/v2/schedules/friendly_names | ||
Latest revision as of 17:28, 12 February 2021
These are Roster job cards.
NB, this endpoint cannot currently be used for schedule creation, which is only possible using the Confirm Work Schedules option in the web app. This is because this endpoint is primarily intended for our mobile roster app, Call Round, which gets lists of jobs and updates them, typically to complete or cancel them. It can also be useful for reporting.
If you want to use this endpoint for your own time and attendance solution, these calls may help:
- All jobs in a date range, with an id and completion status:
[GET] https://api.dizions.co.uk/v2/schedules/date_active/2021-04-01,2021-04-30/field/id;status
- Jobs with for worker 220 in a date range, with an id and completion status:
[GET] https://api.dizions.co.uk/v2/schedules/worker/220/date_active/2021-04-01,2031-04-30/field/id;status
- A report of completed jobs in a date range, broken down by the client's district and gender
[GET] https://api.dizions.co.uk/v2/schedules/metric/client_district/dimension/client_gender/date_active/2021-04-01,2021-04-30/status/completed
- A list of available fields:
[GET] https://api.dizions.co.uk/v2/schedules/friendly_names
