OMS Appointments (Moves) API
- Jason Reel (Deactivated)
The Appointments API is designed to return a list of those with appointment changes within a specified date range.
URL
https://base.url.org/api/appointment/territory/{territory ID}?from={from date}&to={to date}
Example Parameters
Parameter Name | Required | Description | Default |
|---|---|---|---|
territory ID | required | the numeric ID of the territory | — |
from date | optional | the earlier end of the date range to search. The date format is yyyy-MM-dd | Seven (7) days prior to the current date |
to date | optional | the latter end of the date range to search. The date format is yyyy-MM-dd | Seven (7) days after the current date |
includes | optional | when equals "person.status.shortCode" includes person status in results | — |
includeInactives | optional | when equals "true" includes inactive person status' in results (retired, etc) | — |
API Use Examples
https://base.url.org/api/appointment/territory/59
Retrieves the set of appointment changes for territory with ID = 59 where the appointment starts within the previous seven (7) days through the next seven (7) days (14 days total).
https://base.url.org/api/appointment/territory/59?from=2018-06-01&to=2018-06-30
Retrieves the set of appointment changes for territory with ID = 59 that takes place during the month of June, 2018.
https://base.url.org/api/appointment/territory/59?from=2018-06-28
Retrieves the set of appointment changes for territory with ID = 59 where the appointment start on or within 14 days of 6/28/2018 (or 7/11/2018). When the to date parameter is omitted, the date range defaults to 14 days.
https://base.url.org/api/appointment/territory/58?from=2019-06-01&to=2019-06-30&includeInactives=true&includes=person.status.shortCode
Retreives the set of appointment changes for territory with ID = 58 that takes place during the month of June, 2019 and will add the status on the person record which should indicate the person's current status (ACT, RET, PTG, RES, TER). Also the unit object will be NULL along with the appointmentName as well.
Responses
200 OK | Returned with the list of appointments that are found within the specified date range |
401 Unauthorized | The current account in the request header does not have access to the API |
403 Forbidden | The user account does not have permission to access this resource |
404 Not Found | Returned if NO appointments are found within the specified date range |
500 Internal Server Error | One or more request string parameters are invalid or an error was encountered by the server while processing the request |