GeocodeCapabilitiesResponse Object - 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

The following table defines the response elements returned from the Capabilities service.

Name Type Description
serviceName String The name of a supported service.
serviceDescription String A description of the service.
coreVersion String The core version of Geo Addressing SDK.
geocodingEngines String The installed country geocode engine(s).
supportedCountries String The countries supported by each installed country geocoder engine.
geocoderVersions Map The version number of the geocode engine.
supported Operations Operation object. An array that defines the supported operations for the specified input country or for all countries consisting of the following fields:
name String Name of the operation.
requiredInputs InputParameter Lists the required input fields for the operation. Includes the following elements:
  • name (String)
  • description (String)
  • type (String)
  • defaultValue (String)
  • lowBoundary (String)
  • highBoundary (String)
  • allowedValuesWithDescriptions (Map)
optionalInputs InputParameter Lists the optional input fields for the operation. Includes the following elements:
  • name (String)
  • description (String)
  • type (String)
  • defaultValue (String)
  • lowBoundary (String)
  • highBoundary (String)
  • allowedValuesWithDescriptions (Map)
outputs OutputParameter Lists the operation's output fields. Includes the following elements:
  • name (String)
  • description (String)
  • type (String)
supportLevels SupportLevel Lists the support levels for the operation. Includes the following elements:
  • supportedDataLevel (Integer)
Data Postal Centroid=1
Postcode centroids are present in dictionaries (does not distinguish post code 2).
Data Geographic Centroid=2
Geographic centroids are present in dictionaries (does not distinguish the type of geographic centroid).
Data Street Segment=4
Street segment information present in dictionaries.
Data Address Point=8
Point level data present in dictionaries.


                The data level will contain the sum of all available data keys.  For example,
                
                Value — Type of data15      —  all (postal + geographic + segment + point)                  
                   14      —  all but postal
                   13      —  all but geographic                  
                   12      —  point + segment
                   11      —  point + geographic + postal                  
                   10      —  point + geographic                    
                    9       —  point + postal                    
                    8       —  point only                    
                    7       —  all but point                    
                    6       —  segment + geographic                    
                    5       —  segment + postal                    
                    4       —  segment only                    
                    3       —  postal + geographic                    
                    2       —  geographic only                    
                    1       —  postal only            
                

  • countries — (String) Countries
  • updatedRequiredInputs — (InputParameter) Country-specific required input fields
  • updatedOptionalInputs — (InputParameter) Country-specific optional input fields
  • updatedOptionalOutputs — (OutputParameter) Country-specific output fields
customObjects list of type CustomObject.
name String The name(s)s of the custom object fields that were user-specified in Preferences.
description String The description of the user-specified custom object fields.
properties list of type CustomObjectMember Where CustomObjectMember contains the following elements:
  • name — (String) Indicates name of parameter.
  • input — (InputParameter) Indicates the property is an input parameter.
  • output —(OutputParameter) Indicates the property is an output parameter.