Getting Started

Error Codes

Common error codes and response examples you may encounter when calling the RDPLINE API.

Common error response

Every error response consists of success, status, message, errorCode. The data field is included only in successful responses.

Field

Description

success

Always false in an error response.

status

The HTTP status code.

message

An English message describing the cause of the error. It tells you which parameter is invalid and why.

errorCode

A string indicating the category of the error. Its values are fixed, making it a reliable branching criterion for error handling in your application.

Error response example

{  "success": false,  "status": 400,  "message": "The required parameter is missing: page",  "errorCode": "INVALID_ARGUMENT"}

errorCode list

errorCode indicates the broad category of an error, while the specific cause is distinguished by message. For example, parameter-related errors are returned as INVALID_ARGUMENT, and message tells you which parameter caused the problem.

errorCode

HTTP

When it occurs

message

INVALID_ARGUMENT

400

Request parameter errors such as missing required values, format or range errors, fields that do not match the query mode, an invalid cursor, an invalid search sort value, exceeding the page × size limit, or a body parsing failure

Missing required parameter

The required parameter is missing: <parameter>

e.g. The required parameter is missing: page

Invalid value, format, or combination

The parameter is invalid: <parameter>

e.g. The parameter is invalid: publishedAtStart

UNAUTHENTICATED

401

The API Key is missing, or the API Key is invalid

Missing API Key / Invalid or expired API Key

PERMISSION_DENIED

403

No valid ACTIVE contract exists, or the company identifier cannot be verified, so access is denied

Company is unauthorized or does not exist. / No active client contract found.

RESOURCE_EXHAUSTED

429

Rate limit exceeded

Too many requests. Please retry later.

INTERNAL

500

Internal server error

An unexpected error occurred.

UNAVAILABLE

503

The service is temporarily unavailable due to a backend or search engine failure

Service is temporarily unavailable. Please try again later.

DEADLINE_EXCEEDED

504

The search engine response timed out

The search provider did not respond in time. Please try again later.