OMS Active Officer API

Active Officer API

This API provides the ability to search for active and, optionally, retired officers by last name and/or email address.

URL
https://base.url.org/api/oms/officers/active?territory=ZZZ

Parameters

Parameter Name	Required	Description	Default
territory	Required	The territory value “ZZZ” is the three-character territory abbreviation (ie, USE = USA Eastern Territory)
includeRetired	optional	"true" to include retired personnel in the results, "false" to not include retired personnel	(boolean, default = false)
lastName	optional	search for personnel with the specified last name	(string, default = NULL)
emailAddress	optional	search for personnel with the specified email address	(string, default = NULL)
start	optional	optional pagination value to specify which index the result set should start	(integer, default = 0)
limit	optional	optional pagination value to specify the maximum number of results to the call should return in a single request. There is no setting to retrieve all of the results, but there's no limit on the number that can be retrieved (up to the maximum value supported by a 32-bit signed integer -- 2147483647).	(integer, default = 25)

Examples

Each object in the result set has the following properties:

appointments - an array of current appointments. Fields of note on each appointment object are:

end the end date of the appointment
name the name of the position as displayed in OMS
start the start date of the appointment

birthDate - the person's data of birth
displayName - the person's full name with rank
firstName - the person's first name
lastName - the person's last name
nickName - the person's nick name
officeEmailAddress - the person's office email address, typically their email that ends with "@***.salvationarmy.org"
officerId - the internal OMS ID of the officer record associated with the person
officerStatus - the officer's current status in OMS, either "Active" or "Retired"
officerUNID - the officer's careers ID
personId - the internal OMS ID of the person record
photoUrl - the URL to retrieve the full size image for the person
rank - the officer's current rank

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

The API does have paging implemented using the start, limit, or a combination of the two parameters. Defaults are as follows: start = 0, limit = 25