Addressing API: Specifying address processing - 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

Scenario

Use the "global_locator" to process addresses via the Verify service, returning candidates in an uppercase format.

Request

Note that "label" is set to "global_locator", as opposed to the default setting "".

{
  "preferences": {
    "maxResults": 1,
    "returnAllInfo": true,
    "factoryDescription": {
      "label": "global_locator",
      "featureSpecific": {}
    },
    "customPreferences": {
     "ADDRESS_CASING": "UPPER"
   }
  },
  "addresses": [
    {
      "addressLines": [
        "Unit 1/10",
        "Enterprise Drive"
      ],
      "country": "GBR",
      "addressNumber": "",
      "admin1": "",
      "admin2": "",
      "city": "Westhill",
      "postalCode": "AB32 6TQ",
      "postalCodeExt": "",
      "placeName": "Elmar Services Ltd."
    }
  ]
}

Response

{
  "responses": [
    {
      "status": "OK",
      "results": [
        {
          "score": 100,
          "address": {
            "formattedAddress": "ELMAR SERVICES LTD., ENTERPRISE DRIVE, WESTHILL, AB32 6TQ",
            "formattedStreetAddress": "ELMAR SERVICES LTD.ENTERPRISE DRIVE",
            "formattedLocationAddress": "WESTHILL AB32 6TQ",
            "country": {
              "name": "UNITED KINGDOM",
              "isoAlpha3Code": "GBR"
            },
            "admin1": {},
            "city": {
              "longName": "WESTHILL",
              "shortName": "WESTHILL"
            },
            "postalCode": "AB32 6TQ",
            "placeName": "ELMAR SERVICES LTD.",
            "street": "ENTERPRISE DRIVE"
          },
          "addressLines": [
            "ELMAR SERVICES LTD.",
            "UNIT 1/10",
            "ENTERPRISE DRIVE",
            "WESTHILL INDUSTRIAL ESTATE",
            "WESTHILL",
            "AB32 6TQ",
            "UNITED KINGDOM"
          ],
          "explanation": {
            "addressMatch": {
              "type": "STREET",
              "description": [
                {
                  "label": "placeName",
                  "matchType": "NONE"
                },
                {
                  "label": "addressNumber",
                  "matchType": "NONE"
                },
                {
                  "label": "admin1",
                  "matchType": "NONE"
                },
                {
                  "label": "admin2",
                  "matchType": "NONE"
                },
                {
                  "label": "city",
                  "matchType": "EXACT"
                },
                {
                  "label": "neighborhood",
                  "matchType": "ADDED",
                  "returnType": "PREFERRED"
                },
                {
                  "label": "suburb",
                  "matchType": "NONE"
                },
                {
                  "label": "street",
                  "matchType": "EXACT"
                },
                {
                  "label": "postalCode",
                  "matchType": "EXACT"
                },
                {
                  "label": "streetType",
                  "matchType": "NONE"
                },
                {
                  "label": "postalCodeExt",
                  "matchType": "NONE"
                },
                {
                  "label": "streetDirectional",
                  "matchType": "NONE"
                }
              ]
            },
            "source": {
             "label": "global_locator"
            }
          },
          "customFields": {
            "SUBBUILDING": "UNIT 1/10",
            "SUBCITY": "WESTHILL INDUSTRIAL ESTATE",
            "DATASTOREDATASET": "GBR",
            "ACR": "L4-P0S4A6T4R0Z4C4-100",
            "VALIDATIONRULE": "CoBoPoSeXoCeRoPe",
            "OUTERMATCHSCORE": "0",
            "CONFIDENCE": "100",
            "EXTENDEDACR": "L4-D0M2B0U4P0S4Q0X0A6T4E0R0W0Z4Y0C4-100",
            "VALIDATIONDATASET": "GBR",
            "PRECISION_CODE": "S4-PNTSCZA"
          }
        }
      ]
    }
  ]
}