OMS Spouse API
Spouse API
​This API will return the personal data for the spouse of the requested person.
URL
https://base.url.org/api/relationship/spouse/[person ID]
Parameters
Parameter Name | Required | Description | Default |
---|---|---|---|
person ID | required | the six-digit numeric ID of the officer |
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 |