Capabilities GET Request
A GET request to the Capabilities service returns
information covering:
- supported services
- available geocoding engines
- supported countries
- supported operations and associated required and optional inputs
- custom fields
Base URI
http://<server>:<port>/rest/GlobalGeocode/capabilities.[content type]?[query parameters]where:
.[content type] indicates that the specified content type will be used
by default. Optional.
- json
- Default content type is JSON, unless superseded by HTTP content negotiation
- xml
- Default content type is XML, unless superseded by HTTP content negotiation
[query parameters] are described in the following section.
Query Parameters
There are several options for the type of information returned based on the query
parameters:
- Include a country code to get the capabilities for the specified country;
- Include a country code and an operation to get the description of that operation; or,
- Exclude all query parameters to get the capabilities for all countries.
The query parameters for the Capabilities service are defined in the following table.
| Name | Description |
|---|---|
| country | Specified the ISO 3166-1 alpha-3 country code. Note: For a listing of the ISO
country codes, see Country Reference Listing and ISO 3166-1 Country Codes
|
| operation | Type of geocoding service operation. One of the following:
|