Example: Batch Request & Response Key Lookup - geo_addressing_sdk - 5.0

Geo Addressing SDK Developer Guide

Product type
Software
Portfolio
Locate
Product family
Geo Addressing
Product
Geo Addressing SDK
Version
5.0
Language
English
Product name
Geo Addressing SDK
Title
Geo Addressing SDK Developer Guide
Copyright
2023
First publish date
2007
ft:lastEdition
2024-07-12
ft:lastPublication
2024-07-12T13:44:57.839102

Batch Key Lookup Request:
{
  "type": "PB_KEY",
  "preferences": {
    "maxResults": 1,
    "returnAllInfo": true,
    "factoryDescription": {
      "label": "",
      "featureSpecific": {}
    },
    "clientLocale": "",
    "clientCoordSysName": "",
    "distance": {
      "value": 150,
      "distanceUnit": "METER"
    },
    "streetOffset": {
      "value": 7,
      "distanceUnit": "METER"
    },
    "cornerOffset": {
      "value": 7,
      "distanceUnit": "METER"
    },
    "customPreferences": {}
  },
  "keys": [
    {
      "keyValues": [
        {
          "key": "PBKEY",
          "value": "P0001AJNB8E3"
        },
        {
          "key": "country",
          "value": "DEU"
        }
      ]
    },
        {
      "keyValues": [
        {
          "key": "PBKEY",
          "value": "P0001AJNB8DB"
        },
        {
          "key": "country",
          "value": "DEU"
        }
      ]
    }
  ]
}
Batch Key Lookup Response:
{
  "responses": [
    {
      "status": "OK",
      "results": [
        {
          "score": 0,
          "address": {
            "formattedAddress": "1. Hamm WEG 1, 26607 Aurich, Germany",
            "formattedStreetAddress": "1. Hammweg 1",
            "formattedLocationAddress": "26607 Aurich",
            "addressNumber": "1",
            "country": {
              "name": "Germany",
              "isoAlpha2Code": "DE",
              "isoAlpha3Code": "DEU",
              "isoNumericCode": "276"
            },
            "admin1": {
              "longName": "Niedersachsen",
              "shortName": "NI"
            },
            "admin2": {
              "longName": "Aurich",
              "shortName": "Aurich"
            },
            "city": {
              "longName": "Aurich",
              "shortName": "Aurich"
            },
            "postalCode": "26607",
            "street": "1. Hamm"
          },
          "addressLines": [
            "1. Hamm WEG 1",
            "26607 Aurich",
            "Germany"
          ],
          "location": {
            "explanation": {
              "type": "ADDRESS_POINT"
            },
            "feature": {
              "type": "Feature",
              "properties": {
                "crsName": "epsg:4326"
              },
              "geometry": {
                "type": "Point",
                "coordinates": [
                  7.615426,
                  53.504086
                ]
              }
            }
          },
          "explanation": {
            "addressMatch": {
              "description": [
                {
                  "label": "placeName",
                  "matchType": "NONE"
                },
                {
                  "label": "addressNumber",
                  "matchType": "NONE"
                },
                {
                  "label": "admin1",
                  "matchType": "NONE"
                },
                {
                  "label": "admin2",
                  "matchType": "NONE"
                },
                {
                  "label": "city",
                  "matchType": "NONE"
                },
                {
                  "label": "neighborhood",
                  "matchType": "NONE"
                },
                {
                  "label": "suburb",
                  "matchType": "NONE"
                },
                {
                  "label": "street",
                  "matchType": "NONE"
                },
                {
                  "label": "postalCode",
                  "matchType": "NONE"
                },
                {
                  "label": "streetType",
                  "matchType": "NONE"
                },
                {
                  "label": "postalCodeExt",
                  "matchType": "NONE"
                },
                {
                  "label": "streetDirectional",
                  "matchType": "NONE"
                }
              ]
            },
            "source": {
              "label": "ggs"
            }
          },
          "customFields": {
            "MAIN_ADDRESS": "1. Hamm",
            "PB_KEY": "P0001AJNB8E3",
            "LANGUAGE": "de",
            "RESULT_CODE": "S8A",
            "PRECISION_CODE": "S8A",
            "POST_THOROUGHFARE_TYPE": "WEG",
            "THOROUGHFARE_TYPE": "WEG",
            "GEOHASH": "u1t2mk17uk90",
            "STREETDATATYPE": "15",
            "DATA_PROVIDER": "MASTERLOCATION",
            "PRODUCT_CODE": "DE8"
          },
          "parsed": [
            {}
          ]
        }
      ]
    },
    {
      "status": "OK",
      "results": [
        {
          "score": 0,
          "address": {
            "formattedAddress": "STRAßE 152 1, Rosenthal, 13158 Berlin, Germany",
            "formattedStreetAddress": "Straße 152 1",
            "formattedLocationAddress": "13158 Berlin",
            "addressNumber": "1",
            "country": {
              "name": "Germany",
              "isoAlpha2Code": "DE",
              "isoAlpha3Code": "DEU",
              "isoNumericCode": "276"
            },
            "admin1": {
              "longName": "Berlin",
              "shortName": "BE"
            },
            "admin2": {
              "longName": "Berlin",
              "shortName": "Berlin"
            },
            "city": {
              "longName": "Berlin",
              "shortName": "Berlin"
            },
            "neighborhood": {
              "longName": "Rosenthal",
              "shortName": "Rosenthal"
            },
            "postalCode": "13158",
            "street": "152"
          },
          "addressLines": [
            "STRAßE 152 1",
            "Rosenthal",
            "13158 Berlin",
            "Germany"
          ],
          "location": {
            "explanation": {
              "type": "ADDRESS_POINT"
            },
            "feature": {
              "type": "Feature",
              "properties": {
                "crsName": "epsg:4326"
              },
              "geometry": {
                "type": "Point",
                "coordinates": [
                  13.384768,
                  52.59654
                ]
              }
            }
          },
          "explanation": {
            "addressMatch": {
              "description": [
                {
                  "label": "placeName",
                  "matchType": "NONE"
                },
                {
                  "label": "addressNumber",
                  "matchType": "NONE"
                },
                {
                  "label": "admin1",
                  "matchType": "NONE"
                },
                {
                  "label": "admin2",
                  "matchType": "NONE"
                },
                {
                  "label": "city",
                  "matchType": "NONE"
                },
                {
                  "label": "neighborhood",
                  "matchType": "NONE"
                },
                {
                  "label": "suburb",
                  "matchType": "NONE"
                },
                {
                  "label": "street",
                  "matchType": "NONE"
                },
                {
                  "label": "postalCode",
                  "matchType": "NONE"
                },
                {
                  "label": "streetType",
                  "matchType": "NONE"
                },
                {
                  "label": "postalCodeExt",
                  "matchType": "NONE"
                },
                {
                  "label": "streetDirectional",
                  "matchType": "NONE"
                }
              ]
            },
            "source": {
              "label": "ggs"
            }
          },
          "customFields": {
            "MAIN_ADDRESS": "152",
            "PB_KEY": "P0001AJNB8DB",
            "LANGUAGE": "de",
            "RESULT_CODE": "S8A",
            "PRECISION_CODE": "S8A",
            "POST_SEP": " ",
            "PRE_THOROUGHFARE_TYPE": "STRAßE",
            "THOROUGHFARE_TYPE": "STRAßE",
            "GEOHASH": "u33e0wfmp9wq",
            "STREETDATATYPE": "15",
            "DATA_PROVIDER": "MASTERLOCATION",
            "PRODUCT_CODE": "DE8"
          },
          "parsed": [
            {}
          ]
        }
      ]
    }
  ]
}