Separated Officer API
The Separated API is intended to allow users to define a date range and return any officers in the territory that have left officer-ship (resigned, terminated).
URL
https://base.url.org/mvc/api/oms/officers/separated?territory={territory}&startDate={from date}&endDate={to date}
Parameters
Parameter Name | Required | Description | Default |
|---|---|---|---|
territory | required | the alpha ID of the territory (ex. USW) | — |
startDate | required | the earlier end of the date range to search. The date format is yyyy-MM-dd | — |
endDate | required | the latter end of the date range to search. The date format is yyyy-MM-dd | — |
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 |