OMS Retired Officers API

Appointments API

The Retirement API is designed to return a list of retired officers. 

URL
https://base.url.org/api/retirement/territory/{territory ID}

Example Parameters

Parameter Name

Required

Description

Default

territory ID

required

the numeric ID of the territory


Responses

200 OK

Returned with the list of appointments that are found within the specified date range

401 Unauthorized

The current account in the request header does not have access to the API

403 Forbidden

The user account does not have permission to access this resource

404 Not Found

Returned if NO appointments are found within the specified date range

500 Internal Server Error

One or more request string parameters are invalid or an error was encountered by the server while processing the request