Search API

Status Codes

Status codes are returned for all Search API functions and are especially helpful when troubleshooting errors.

General Status Codes

Status Code Description
0 A successful search call.
400 Error with input - The error message will start with: "Illegal argument from request:" followed by the specific error condition.
403 Key related error - The error message will attempt to explain why there was an error with the key and should provide a link to the Developer Network.
500 Unknown error - The error message will start with: "Error processing request:" followed by the message from the exception.
601 A Search's internal geocode is invalid for some reason, probably an incorrect location has been passed
602 A Search's internal geocode failed, most likely the address doesn't exist
603 A Search's internal routing failed, most likely an invalid location or internal error
609 No search data was provided, please supply a Map, Hosted, or Remote data object to search
610 A Search generated an ambiguous geocode result, more that one possible result has been found for your address

Hosted Data Status Codes

Status Code Description
611 Hosted Data general error
612 Hosted Data format is invalid or missing a value
613 Hosted Data object was expected, and is missing

Remote Data Status Codes

Status Code Description
620 Remote Data General Error
621 Remote data format is invalid or missing a value

Paging Data Status Codes

Status Code Description
640 Paging General Error
641 Missing paging key, please provide
642 Invalid or expired paging key

Radius Search Status Codes

Status Code Description
650 Radius search error, no origin provided or invalid origin

Rectangle Search Status Codes

Status Code Description
660 Missing bounding box, please supply a boundingBox or two locations
661 Invalid bounding box. The boundingBox, or locations, provided do not contain incorrect values to make a valid upper left and lower right bounding box

Polygon Search Status Codes

Status Code Description
670 Polygon shape is missing, please provide the polygon shape points, or a list of 3+ locations for the search boundary
671 Locations used in the polygon search are invalid. You probably have less than three locations.
672 An error in relation to the donut hole of a polygon

Corridor Search Status Codes

Status Code Description
680 Missing corridor shape, please provide a valid corridor shape with the request
681 Invalid Session Id for a route, either the id is invalid or expired.

Shape Status Codes

Status Code Description
690 Shape was missing when expected, check the message to determine the missing shape
691 Shape passed was invalid, please check you shape format and make sure it matches the passed shapeFormat parameter