Example: Reverse JSON POST Request & Response (Addressing API) - 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

JSON POST Request

Using the Addressing API, the following is an example of a JSON POST request for the Reverse Service.

{
  "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"
    },
    "fallbackToGeographic": false,
    "fallbackToPostal": false,
    "matchMode": "",
    "returnOfAdditionalFields": false,
    "originXY": [],
    "customPreferences": {}
  },
  "locations": [
    {
      "addressId": "1",
      "longitude": -73.704719,
      "latitude": 42.682251,
      "country": "USA"
    }
  ]
} 

JSON Response

The following shows the JSON response returned by the previous request.
{
  "responses": [
    {
      "status": "OK",
      "results": [
        {
          "score": 0,
          "address": {
            "formattedAddress": "1 GLOBAL VW, TROY NY 12180-8371, United States",
            "formattedStreetAddress": "1 GLOBAL VW",
            "formattedLocationAddress": "TROY, NY12180-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.704719,
                  42.682251
                ]
              }
            }
          },
          "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": "NONE"
                },
                {
                  "label": "streetType",
                  "matchType": "EXACT"
                },
                {
                  "label": "postalCodeExt",
                  "matchType": "NONE"
                },
                {
                  "label": "streetDirectional",
                  "matchType": "EXACT"
                }
              ]
            },
            "source": {
              "label": "ggs"
            }
          },
          "customFields": {
            "RESBUS": "B",
            "LOTSIZE_METERS": "56129",
            "CSA_NUMBER": "104",
            "TYPE_SHORT": "VW",
            "THOROUGHFARE_TYPE": "VW",
            "PARCEN_ELEVATION_METERS": "53.3",
            "ROAD_CLASS": "01",
            "MATCH_CODE": "NP0",
            "COUNTY": "36083",
            "PB_KEY": "P0000GL41OME",
            "LANGUAGE": "en",
            "ADDRTYPE": "S",
            "INC_IND": "N",
            "BLOCK_2010": "360830523011008",
            "POINT_ID": "105104102",
            "CHECK_DIGIT": "8",
            "METRO_FLAG": "Y",
            "BLOCK": "360830523011008",
            "POST_THOROUGHFARE_TYPE": "VW",
            "QCITY": "361297000",
            "ZIP_FACILITY": "P",
            "TFID": "259333880",
            "APN_ID": "383200 122.-1-4.221",
            "LOT_CODE": "A",
            "LOT_NUM": "0048",
            "CTYST_KEY": "V16572",
            "UACEPOP": "594962",
            "NAME": "GLOBAL",
            "ZIP_CARRTSORT": "D",
            "LORANGE": "1",
            "CLOSE_MATCH": "T",
            "REVERSE_GEOCODE_DISTANCE": "0.0",
            "STREET_SIDE": "L",
            "DATATYPE": "12",
            "INTERSECTION": "F",
            "ZIP_CITY_DELV": "Y",
            "LOC_CODE": "AP05",
            "CART": "C099",
            "NAME_CITY": "TROY",
            "BLOCK_LEFT": "360830523011008",
            "REVERSE_GEOCODE_DISTANCE_UNIT": "METERS",
            "COUNTY_FIPS": "36083",
            "HIRANGE": "1",
            "UACE": "00970",
            "REC_TYPE": "S",
            "URBANICITY": "L",
            "RESOLVED_LINE": "5",
            "PARCEN_ELEVATION": "175",
            "PREF_CITY": "TROY",
            "CBSA_NUMBER": "10580",
            "ALT_FLAG": "B",
            "ADDRLINE_SHORT": "1 GLOBAL VW",
            "LOTSIZE": "604172",
            "CONFIDENCE": "100",
            "DATATYPE_NAME": "MASTER LOCATION",
            "CSA_NAME": "ALBANY-SCHENECTADY, NY COMBINED STATISTICAL AREA",
            "DPBC": "01",
            "PERCENT_GEOCODE": "0.0",
            "LASTLINE_SHORT": "TROY, NY12180-8371",
            "PLACE": "0",
            "CITY_SHORT": "TROY",
            "NAME_SHORT": "GLOBAL",
            "ZIP9": "121808371",
            "IS_ALIAS": "N01",
            "PRECISION_CODE": "RS8A",
            "ZIP10": "12180-8371",
            "CBSA_NAME": "ALBANY-SCHENECTADY-TROY, NY METROPOLITAN STATISTICAL AREA"
          }
        }
      ]
    }
  ]
}