Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
borderColor#ccc
bgColor#FCFCFC
titleColor#FFFFFF
titleBGColor#a0a0a0
borderStylesolid
titleOfficer Status API

URL

https://base.url.org/mvc/api/oms/ext/officer-status?territory=ZZZ


Parameters

Parameter Name

Required

Description

Default

territoryRequiredThe 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)

emailAddressoptional

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)



Responses

200 OK

Results 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 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 ErrorOne or more request string parameters are invalid or an error was encountered by the server while processing the request


Info

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


...