/
OMS Appointment Data by Unit API
OMS Appointment Data by Unit API
- Jason Reel (Deactivated)
Owned by Jason Reel (Deactivated)
Children API
This API will appointment data by the org tree unit ID.
URL
https://base.url.org/api/orgTree/unit/{{ ID }}/child-positions?asOf={{ date:”yyyy-MM-dd” }}&primaryOnly={{ true/false }}
Parameters
Parameter Name | Required | Description | Default |
|---|---|---|---|
| ID | required | the numeric ID of the org tree unit | |
| asOf | optional | reference date for the appointments and when not used the results will default to the current date | Current date |
| primaryOnly | optional | limits the results to just primary appointments (true) or includes all appointments (false) and it defaults to true. | true |
Responses
200 OK | Results were found that match the request and are included in the response body |
| 401 Unauthorized | The current account in the request header does not have access to the API |
403 Forbidden | The current account in the request header does not have access to the territory requested in the request URL |
404 Not Found | Returned if NO results were found that match the specified criteria |
| 500 Internal Server Error | One or more request string parameters are invalid or an error was encountered by the server while processing the request |