GET address/provinces/{countryCode}

Get provinces / state codes for given countryCode

Request Information

URI Parameters

NameDescriptionTypeAdditional information
countryCode

Standard ISO-3166 2-Character country code

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of AddressProvinceState
NameDescriptionTypeAdditional information
Id

Identifier

integer

None.

ProvinceStateCode

Province or state code

string

Max length: 3

Description

Province or State name

string

None.

CountryCode

Standard ISO-3166 2-Character country code

string

Max length: 2

Region

Specifies Region (North America, Europe, Latin America)
0 – North America
1 – Europe
2 – Latin America

AddressRegionType

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "ProvinceStateCode": "sample string 2",
    "Description": "sample string 3",
    "CountryCode": "sample string 4",
    "Region": 0
  },
  {
    "Id": 1,
    "ProvinceStateCode": "sample string 2",
    "Description": "sample string 3",
    "CountryCode": "sample string 4",
    "Region": 0
  }
]

application/xml, text/xml

Sample:
<ArrayOfAddressProvinceState xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AddressProvinceState>
    <Id>1</Id>
    <ProvinceStateCode>sample string 2</ProvinceStateCode>
    <Description>sample string 3</Description>
    <CountryCode>sample string 4</CountryCode>
    <Region>NA</Region>
  </AddressProvinceState>
  <AddressProvinceState>
    <Id>1</Id>
    <ProvinceStateCode>sample string 2</ProvinceStateCode>
    <Description>sample string 3</Description>
    <CountryCode>sample string 4</CountryCode>
    <Region>NA</Region>
  </AddressProvinceState>
</ArrayOfAddressProvinceState>