Exception Codes
If the server throws an exception, the REST web service will return the exception code and an accompanying exception message over the network to the client. The exception code provides a general error description; the exception message provides a more specific indication of the cause of the exception.
In the following example a GET request to the Geocode service contains "Line" which is an incorrect parameter.
GET http://endpoint/Geocode/rest/GeocodeService/geocode.json?
mainAddress=42%20Venus%20Drive&Line=Shrewsbury&country=USA HTTP/1.1 The server returns the following error:
HTTP/1.1 500 Internal Server Error
Server: Apache-Coyote/1.1
Date: Wed, 25 Feb 2015 20:52:18 GMT
exceptionCode: INVALID_CLIENT_INPUT
exceptionMsg: Unknown query parameter Line
Content-Length: 0
Connection: close | Exception Codes (datatype = String) | Description |
|---|---|
| REQUIRED_PARAMETER_MISSING | A required parameter is missing. |
| DATA_NOT_LICENSED | The license file for an address dictionary is not installed. |
| INTERNAL_ERROR | A general error occurred with the geocoding engine. |
| MAPMARKER_EXCEPTION | A general exception occurred in the MapMarker geocoding engine. |
| MAPMARKER_FATAL_EXCEPTION | A fatal exception occurred in the MapMarker geocoding engine. |
| INVALID_CLIENT_INPUT | An invalid input was encountered in the request. |
| NO_COUNTRY_SPECIFIED | The country field is missing from the request. |
| COUNTRY_NOT_SUPPORTED | The requested operation is not supported for the specified country. |
| GEOSTAN_FATAL_EXCEPTION | A fatal exception occurred in the GeoStan geocoding engine. |