Detailed response

DFINERY Export API determines the success or failure of a request through HTTP response code and detailed response code.

HTTP response codes

Response Code
Explanation

200 - OK

The request was successfully received by the server.

400 - Bad Request

The request could not be processed. This is the response returned when a required parameter was not sent or the parameter format is incorrect. Please check the request parameters.

429 - Too Many Requests

An unusually high number of requests have been sent. Please try again later.

500 - Server Error

An error occurred inside the server.

Detailed response

If an API call fails, you can get detailed information about the error through the detailed response result.

Response Code
Result
Message
Explanation

200

fail

client_connection_closed

The client connection was terminated.

400

fail

invalid_parameter

The requested parameters provided are invalid or malformed.

400

fail

exceed_date_range_limit

The requested start date exceeds the allowed range.

401

fail

unauthorized_token

Invalid Export token.

429

fail

too_many_api_requests

The number of requested API calls exceeded the limit.

500

fail

unknown_error

An unexpected error occurred within the system.

500

fail

query_error

The requested database query failed and was not executed.

Example response

Success

If successful, you will receive data in CSV format including the header as a response. For more details, please refer to each API documentation.

exceed_date_range_limit

400 BAD REQUEST
{
    "result": "fail",
    "message": "exceed_date_range_limit"
}

unknown_error

500 INTERNAL_SERVER_ERROR
{
    "result": "fail",
    "message": "unknown_error"
}

Last updated