Lookup Service: Request - 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
Last updated
2024-10-17
Published on
2024-10-17T16:12:58.390251

Within the Addressing API, the Lookup Service returns geocoded candidates when given a unique key.

Preferences

For more detail about preferences and keys, see Addressing API Objects: LookupRequest.

Note: Currently, there are no custom preferences for the Lookup Service.
"preferences": {
                    "maxResults": 1,
                    "returnAllInfo": true,
                    "factoryDescription": {
                    "label": "",
                          "featureSpecific": {}
You can try this in the Geo Addressing SDK Sample application (http://{server}:{port}/{context}/):
  1. Click Addressing v1 > Lookup.
  2. Enter a PreciselyID Key such as P0000GL638OL , ensure Type is set to PreciselyID Lookup, and enter USA as the country.
  3. Click Submit and view the response.

To create a lookup in your application, follow this snippet.

{
  "type": "PB_KEY",
  "preferences": {
    "maxResults": 2,
    "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": "P0000GL638OL"
        },
        {
          "key": "country",
          "value": "USA"
        }
      ]
    }
  ]
}