Below are some sample Responses for ID Lookup:
ID lookup successfully: Below is a sample response showing successful response
returned by the ID Lookup service. When the service returns a successful response, the
HTTP response code is 200.
{
"responses": [
{
"status": "OK",
"results": [
{
"score": 0,
"address": {
"formattedAddress": "1 GLOBAL VW, TROY NY 12180-8371, United States",
"formattedStreetAddress": "1 GLOBAL VW",
"formattedLocationAddress": "TROY, NY 12180-8371",
"addressNumber": "1",
"country": {
"name": "United States",
"isoAlpha2Code": "US",
"isoAlpha3Code": "USA",
"isoNumericCode": "840"
},
"admin1": {
"longName": "New York",
"shortName": "NY"
},
"admin2": {
"longName": "RENSSELAER COUNTY",
"shortName": "RENSSELAER COUNTY"
},
"city": {
"longName": "TROY",
"shortName": "TROY"
},
"postalCode": "12180",
"postalCodeExt": "8371",
"street": "GLOBAL"
},
"addressLines": [
"1 GLOBAL VW",
"TROY NY 12180-8371",
"United States"
],
"location": {
"explanation": {
"type": "ADDRESS_POINT",
"description": "BUILDING",
"designation": "CENTROID"
},
"feature": {
"type": "Feature",
"properties": {
"crsName": "epsg:4326"
},
"geometry": {
"type": "Point",
"coordinates": [
-73.704443,
42.682242
]
}
}
},
"explanation": {
"addressMatch": {
"description": [
{
"label": "placeName",
"matchType": "NONE"
},
{
"label": "addressNumber",
"matchType": "NONE"
},
{
"label": "admin1",
"matchType": "EXACT"
},
{
"label": "admin2",
"matchType": "NONE"
},
{
"label": "city",
"matchType": "EXACT"
},
{
"label": "neighborhood",
"matchType": "NONE"
},
{
"label": "suburb",
"matchType": "NONE"
},
{
"label": "street",
"matchType": "EXACT"
},
{
"label": "postalCode",
"matchType": "EXACT"
},
{
"label": "streetType",
"matchType": "EXACT"
},
{
"label": "postalCodeExt",
"matchType": "EXACT"
},
{
"label": "streetDirectional",
"matchType": "EXACT"
},
{
"label": "unitMatch",
"matchType": "EXACT"
}
]
},
"source": {
"label": "ggs"
}
},
"customFields": {
"POBOX_ZONE": "N",
"CSA_NUMBER": "104",
"TYPE_SHORT": "VW",
"THOROUGHFARE_TYPE": "VW",
"ROAD_CLASS": "01",
"MATCH_CODE": "V000",
"COUNTY": "36083",
"PB_KEY": "P0000GL41OME",
"LANGUAGE": "en",
"NON_DELIVERABLE": "N",
"POINT_ID": "105104102",
"CHECK_DIGIT": "8",
"METRO_FLAG": "Y",
"BLOCK": "360830523011008",
"POST_THOROUGHFARE_TYPE": "VW",
"QCITY": "361297000",
"ZIP_FACILITY": "P",
"LOT_CODE": "A",
"LOT_NUM": "0052",
"GEOHASH": "dredff441fxf",
"CTYST_KEY": "V16572",
"NAME": "GLOBAL",
"ZIP_CARRTSORT": "D",
"LORANGE": "1",
"CLOSE_MATCH": "T",
"ZIP_VALID": "Y",
"STREET_SIDE": "L",
"DATATYPE": "12",
"INTERSECTION": "F",
"ZIP_CITY_DELV": "Y",
"LOC_CODE": "AP05",
"GLOBAL_LOCATION_CODE": "662",
"CART": "C099",
"NAME_CITY": "TROY",
"BLOCK_LEFT": "360830523011008",
"COUNTY_FIPS": "36083",
"PRECISION_LEVEL": "19",
"HIRANGE": "1",
"REC_TYPE": "S",
"RESOLVED_LINE": "0",
"PREF_CITY": "TROY",
"CBSA_NUMBER": "10580",
"ALT_FLAG": "B",
"SEGMENT_DIRECTION": "F",
"ADDRLINE_SHORT": "1 GLOBAL VW",
"CONFIDENCE": "96",
"HIZIP4": "8371",
"DATATYPE_NAME": "MASTER LOCATION",
"ORIG_DPBC": "01",
"SEGMENT_PARITY": "L",
"LOZIP4": "8371",
"CSA_NAME": "ALBANY-SCHENECTADY, NY COMBINED STATISTICAL AREA",
"DPBC": "01",
"LASTLINE_SHORT": "TROY, NY 12180-8371",
"CITY_SHORT": "TROY",
"NAME_SHORT": "GLOBAL",
"ZIP9": "121808371",
"IS_ALIAS": "N01",
"PRECISION_CODE": "S8H------A",
"ZIP10": "12180-8371",
"CBSA_NAME": "ALBANY-SCHENECTADY-TROY, NY METROPOLITAN STATISTICAL AREA",
"RANGE_PARITY": "O"
}
}
]
}
]
}ID lookup partially: Below is a sample response showing partial response returned by the ID Lookup service. When the service returns a partial response, the HTTP response code is 206.
206 status code indicates that the service could not return the complete set of data
requested.
{
"responses": [
{
"errorMessage": "Not able to identify ABC country (DIS-LI-1016)",
"status": "INVALID_REQUEST"
},
{
"status": "OK",
"results": [
{
"score": 0,
"address": {
"formattedAddress": "1 GLOBAL VW, TROY NY 12180-8371, United States",
"formattedStreetAddress": "1 GLOBAL VW",
"formattedLocationAddress": "TROY, NY 12180-8371",
"addressNumber": "1",
"country": {
"name": "United States",
"isoAlpha2Code": "US",
"isoAlpha3Code": "USA",
"isoNumericCode": "840"
},
"admin1": {
"longName": "New York",
"shortName": "NY"
},
"admin2": {
"longName": "RENSSELAER COUNTY",
"shortName": "RENSSELAER COUNTY"
},
"city": {
"longName": "TROY",
"shortName": "TROY"
},
"postalCode": "12180",
"postalCodeExt": "8371",
"street": "GLOBAL"
},
"addressLines": [
"1 GLOBAL VW",
"TROY NY 12180-8371",
"United States"
],
"location": {
"explanation": {
"type": "ADDRESS_POINT",
"description": "BUILDING",
"designation": "CENTROID"
},
"feature": {
"type": "Feature",
"properties": {
"crsName": "epsg:4326"
},
"geometry": {
"type": "Point",
"coordinates": [
-73.704443,
42.682242
]
}
}
},
"explanation": {
"addressMatch": {
"description": [
{
"label": "placeName",
"matchType": "NONE"
},
{
"label": "addressNumber",
"matchType": "NONE"
},
{
"label": "admin1",
"matchType": "EXACT"
},
{
"label": "admin2",
"matchType": "NONE"
},
{
"label": "city",
"matchType": "EXACT"
},
{
"label": "neighborhood",
"matchType": "NONE"
},
{
"label": "suburb",
"matchType": "NONE"
},
{
"label": "street",
"matchType": "EXACT"
},
{
"label": "postalCode",
"matchType": "EXACT"
},
{
"label": "streetType",
"matchType": "EXACT"
},
{
"label": "postalCodeExt",
"matchType": "EXACT"
},
{
"label": "streetDirectional",
"matchType": "EXACT"
},
{
"label": "unitMatch",
"matchType": "EXACT"
}
]
},
"source": {
"label": "ggs"
}
},
"customFields": {
"POBOX_ZONE": "N",
"CSA_NUMBER": "104",
"TYPE_SHORT": "VW",
"THOROUGHFARE_TYPE": "VW",
"ROAD_CLASS": "01",
"MATCH_CODE": "V000",
"COUNTY": "36083",
"PB_KEY": "P0000GL41OME",
"LANGUAGE": "en",
"NON_DELIVERABLE": "N",
"POINT_ID": "105104102",
"CHECK_DIGIT": "8",
"METRO_FLAG": "Y",
"BLOCK": "360830523011008",
"POST_THOROUGHFARE_TYPE": "VW",
"QCITY": "361297000",
"ZIP_FACILITY": "P",
"LOT_CODE": "A",
"LOT_NUM": "0052",
"GEOHASH": "dredff441fxf",
"CTYST_KEY": "V16572",
"NAME": "GLOBAL",
"ZIP_CARRTSORT": "D",
"LORANGE": "1",
"CLOSE_MATCH": "T",
"ZIP_VALID": "Y",
"STREET_SIDE": "L",
"DATATYPE": "12",
"INTERSECTION": "F",
"ZIP_CITY_DELV": "Y",
"LOC_CODE": "AP05",
"GLOBAL_LOCATION_CODE": "662",
"CART": "C099",
"NAME_CITY": "TROY",
"BLOCK_LEFT": "360830523011008",
"COUNTY_FIPS": "36083",
"PRECISION_LEVEL": "19",
"HIRANGE": "1",
"REC_TYPE": "S",
"RESOLVED_LINE": "0",
"PREF_CITY": "TROY",
"CBSA_NUMBER": "10580",
"ALT_FLAG": "B",
"SEGMENT_DIRECTION": "F",
"ADDRLINE_SHORT": "1 GLOBAL VW",
"CONFIDENCE": "96",
"HIZIP4": "8371",
"DATATYPE_NAME": "MASTER LOCATION",
"ORIG_DPBC": "01",
"SEGMENT_PARITY": "L",
"LOZIP4": "8371",
"CSA_NAME": "ALBANY-SCHENECTADY, NY COMBINED STATISTICAL AREA",
"DPBC": "01",
"LASTLINE_SHORT": "TROY, NY 12180-8371",
"CITY_SHORT": "TROY",
"NAME_SHORT": "GLOBAL",
"ZIP9": "121808371",
"IS_ALIAS": "N01",
"PRECISION_CODE": "S8H------A",
"ZIP10": "12180-8371",
"CBSA_NAME": "ALBANY-SCHENECTADY-TROY, NY METROPOLITAN STATISTICAL AREA",
"RANGE_PARITY": "O"
}
}
]
}
]
}Invalid request for Lookup API: The response received when an ID lookup returns
invalid. The response code for this scenario is
400.
{
"errors": [
{
"status": "INVALID_REQUEST",
"errorMessage": "Not able to identify ABC country (DIS-LI-1016)"
}
]
}