Separated Officer API
URL
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 | — |
startDate | 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 |
endDate | optional | 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 range |
403 Forbidden | The user account does not have permission to access this resource |
404 Not Found | Returned if NO separated officers are found within the specified date range |