locationCode by ID 20.0

get https://{host}/li/geocode/20.0/locationCode/{id}

Looks up locationCode-level reference data by locationCodeGeoId.

The Location Code resolution level (GeoResolutionCode 5) represents postal code area in the United Kingdom.

LocationCode-level reference data includes locationCode and locationCodeGeoId geolocation data. The service also returns country-level, admin1-level, admin2-level, and city-level geolocation data.

Responses

Response body

object

countryIso2a

string

length ≤ 2

Country ISO2A code

countryFips

string

length ≤ 4

Country FIPS code

countryRmsCode

string

length ≤ 4

RMS code for Country

countryName

string

length ≤ 512

Name of Country

countryGeoId

integer

Globally unique ID for Country

admin1Code

string

length ≤ 16

Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces.

admin1Name

string

length ≤ 256

Name of administrative level 1

admin1GeoId

int64

Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces.

admin2Code

string

length ≤ 16

Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties.

admin2Name

string

length ≤ 256

Name of administrative level 2

admin2GeoId

int64

Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties.

admin3Code

string

length ≤ 16

Code for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts.

admin3Name

string

length ≤ 256

Name of administrative level 3

admin3GeoId

int64

Globally unique ID for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts.

cityName

string

length ≤ 256

Name of City/Town

cityGeoId

int64

Globally unique ID for City/Town

locationCode

string

length ≤ 16

Location Code

locationCodeGeoId

int64

Globally unique ID for postal code

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-euw1.rms.com/li/geocode/20.0/locationCode/id \
3
     --header 'accept: application/json'


xxxxxxxxxx
20
 
1
{
2
  "countryIso2a": "GB",
3
  "countryFips": "UK",
4
  "countryRmsCode": "GB",
5
  "countryName": "United Kingdom",
6
  "countryGeoId": 826,
7
  "admin1Code": "103",
8
  "admin1Name": "England",
9
  "admin1GeoId": 24554868,
10
  "admin2Code": "103",
11
  "admin2Name": "Dudley",
12
  "admin2GeoId": 30277299,
13
  "admin3Code": "E07CR0",
14
  "admin3Name": "Dudley",
15
  "admin3GeoId": 12695865,
16
  "cityName": "Halesowen",
17
  "cityGeoId": 22165,
18
  "locationCode": "B62 2",
19
  "locationCodeGeoId": 60550885
20
}

200Everything worked as expected.

400The request was unacceptable, likely due to missing a required input.

401No valid API key provided.

404Not found.

500Something went wrong on our end (this happens rarely)