getStates

Retrieves a list of states/territories that relate to a given country.

Request

GET /rest/refdata/states

Query Parameters

Parameter	Type	Required	Description
isoCode	string	Yes	2-character ISO country code (from getCountries)

Example

GET /rest/refdata/states?isoCode=AU

Response

200 OK

[
  {
    "stateCode": "ACT",
    "stateName": "Australian Capital Territory"
  },
  {
    "stateCode": "NSW",
    "stateName": "New South Wales"
  },
  {
    "stateCode": "NT",
    "stateName": "Northern Territory"
  }
]

Field	Type	Description
stateCode	string	State/territory code
stateName	string	Full state/territory name

Errors

Exception	Cause
WSInvalidParameterException	Missing or invalid isoCode
WSRefDataServiceException	Service error while fetching states

Version

Check the current data version for a given country:

GET /rest/refdata/states/version

{ "version": 1 }