The Separated API allows users to define a date range and return any officers in the territory that have left officer-ship (resigned, terminated). URLmvchttps://base.url.org/api/oms/officers/separated?territory={territory}&startDate={from date}&endDate={to date}
ParametersParameter Name | Required | Description | Default |
|---|
territory | required | the alpha ID of the territory (ex. USW) | — | startDate | optionalrequired | the earlier end of the date range to search. The date format is yyyy-MM-dd | Seven (7) days prior to the current date— | endDate | optionalrequired | the latter end of the date range to search. The date format is yyyy-MM-dd | Seven (7) days after the current date— |
Responses| 200 OK | Returned with the list of separated officers that are found within the specified date rangeResults 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 user account The current account in the request header does not have permission to access this resourceaccess to the territory requested in the request URL | | 404 Not Found | Returned if NO separated officers are found within the specified date rangeresults 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 |
|