GET residentapi/states?countryCode={countryCode}&onlyMilitary={onlyMilitary}

Get all States

Request Information

URI Parameters

NameDescriptionTypeAdditional information
countryCode

string

Required

onlyMilitary

boolean

False

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfState
NameDescriptionTypeAdditional information
Total

integer

None.

Elements

Collection of State

None.

Response Formats

application/json, text/json

Sample:
{
  "total": 1,
  "elements": [
    {
      "code": "sample string 1",
      "countryCode": "sample string 2",
      "name": "sample string 3",
      "isMilitary": true
    },
    {
      "code": "sample string 1",
      "countryCode": "sample string 2",
      "name": "sample string 3",
      "isMilitary": true
    }
  ]
}