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 an incorrect geocodeType "a".

GET http://10.24.48.217:8082/Geocode/rest
/GeocodeService/geocode.json?mainAddress=
330%20Front%20St.%20W%20TORONTO%20ON%20M5V%203B7
&country=can&geocodeType=a HTTP/1.1  

The server returns the following error:

HTTP/1.1 400 Bad Request
            Server: Apache-Coyote/1.1
            exceptionCode: INVALID_CLIENT_INPUT
            exceptionMsg: Invalid geocodeType value: A
            Date: Wed, 20 Sep 2017 14:33:03 GMT
            Content-Type: application/json
            Content-Length: 99
            Connection: close
            
            {"errors":[{"errorCode":"INVALID_CLIENT_INPUT","errorDescription":"Invalid geocodeType value: A"}]}