Places (Search) API Developer's Guide

Error Object Structure

The error object contains information on an error that occurred when the user tried to request a resource. For example:

{
  "status": 401,
  "message": "Missing authentication parameters"
}

A more detailed example:

The error object has the following attributes:

Attribute	Type	Description
status	Number (integer)	The HTTP response status code of the request
message	String	The message relating to the most important error to show to the user.
incidentId	String; optional	Unique incident identifier.
errCode	String; optional	The error code relating to the most important error to show to the user.
details	Object(map of String to Array[SubError]); optional	An object containing error details relating to the request.

Response Status Codes

400 Bad Request: The request can not be fulfilled because the request contained bad syntax or didn't contain required parameter or header.
401 Unauthorized: The client needs to authenticate in order to access the resource. Bearer token header, app_id or app_code are missing, empty or invalid.
403 Forbidden: The client is not allowed to access this resource for some reasons.
404 Not Found: Requested resource was not found, though its existence in the future is possible.
405 Method Not Allowed: The method used in the request is not supported by the resource.
406 Not Accepted: The server can not generate content which is acceptable to the client according to the request's Accept header.
408 Request Timeout: The client did not complete its request in a reasonable timeframe.
410 Gone: The resource is gone and will always be gone; the client should not request the resource again.
415 Unsupported Media Type: The server can not process the request body because it is of an unsupported MIME type. Please refer to HTTP Request Headers for details.
429 Too Many Requests: Request quota has been exceeded. Please contact locationapi@here.com to upgrade your plan.
500 Internal Server Error: The server encountered an unexpected condition which prevented it from fulfilling the request.
501 Not Implemented: The server can not process the request method
503 Service Unavailable: The resource is temporarily unavailable.

Important: In case you receive an error message informing you that your credentials (app_id and app_code) do not grant you access to a specified feature, contact your HERE representative.

SubError

Error detail item object.

Attribute	Type	Description
message	String	The error message
errCode	String	The error code