Spectrum Global Type Ahead - web_services - 23.1

Spectrum Web Services Guide
Product type
Software
Portfolio
Integrate
Product family
Spectrum
Product
Spectrum > Web Services
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Web Services Guide
First publish date
2007
Last updated
2024-10-17
Published on
2024-10-17T00:33:46.811413

Spectrum Global Type Ahead automatically suggests addresses as you type and immediately returns candidates based on your input. You can then select your candidate from the presented candidate list.

Spectrum Global Type Ahead is part of Spectrum Global Addressing Management.

Resource URL

JSON endpoint:

http://server:port/rest/GlobalTypeAheadValidation/result.json

Example with JSON Response

The following example requests a JSON response:

http://server:8080/rest/GlobalTypeAhead/result.json?Data.AddressLine1=Victori

The JSON returned by this request would be:

{
  "output_port": [
    {
      "FirmName": "The Victoria",
      "AddressLine1": "West Street",
      "LastLine": "DUNSTABLE, LU6 1ST",
      "FormattedAddress": "The Victoria, 69, West Street, DUNSTABLE,
       LU6 1ST",
      "PostalCode": "LU6 1ST",
      "City": "DUNSTABLE",
      "Country": "UNITED KINGDOM",
      "Type": "2",
      "Ranges": [],
      "user_fields": []
    },
    {
      "FirmName": "The Victoria",
      "AddressLine1": "Wilmslow Road",
      "LastLine": "MANCHESTER, M20 3BW",
      "FormattedAddress": "The Victoria, 438, Wilmslow Road, MANCHESTER,
       M20 3BW",
      "PostalCode": "M20 3BW",
      "City": "MANCHESTER",
      "Country": "UNITED KINGDOM",
      "Type": "2",
      "Ranges": [],
      "user_fields": []
    },
    {
      "FirmName": "The Victoria, 42-43",
      "AddressLine1": "Promenade",
      "LastLine": "SOUTHPORT, PR9 0DS",
      "FormattedAddress": "The Victoria, 42-43, Promenade, SOUTHPORT,
       PR9 0DS",
      "PostalCode": "PR9 0DS",
      "City": "SOUTHPORT",
      "Country": "UNITED KINGDOM",
      "Type": "2",
      "Ranges": [],
      "user_fields": []
    },
    {
      "FirmName": "The Victoria, 2a",
      "AddressLine1": "Hough Side Road",
      "LastLine": "PUDSEY, LS28 9BR",
      "FormattedAddress": "The Victoria, 2a, Hough Side Road, PUDSEY,
       LS28 9BR",
      "PostalCode": "LS28 9BR",
      "City": "PUDSEY",
      "Country": "UNITED KINGDOM",
      "Type": "2",
      "Ranges": [],
      "user_fields": []
    },
    {
      "FirmName": "The Victoria",
      "AddressLine1": "Ainsworth Road",
      "LastLine": "Radcliffe, MANCHESTER, M26 4FD",
      "FormattedAddress": "The Victoria, 119, Ainsworth Road, Radcliffe, MANCHESTER,
       M26 4FD",
      "Locality": "Radcliffe",
      "PostalCode": "M26 4FD",
      "City": "MANCHESTER",
      "Country": "UNITED KINGDOM",
      "Type": "2",
      "Ranges": [],
      "user_fields": []
    }
  ]
}