OMS Separated Officer API


Separated Officer API

The Separated API allows 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/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 OKResults were found that match the request and are included in the response body
401 UnauthorizedThe current account in the request header does not have access to the API
403 ForbiddenThe current account in the request header does not have access to the territory requested in the request URL
404 Not FoundReturned if NO results were found that match the specified criteria
500 Internal Server ErrorOne or more request string parameters are invalid or an error was encountered by the server while processing the request