ru.redcom.lib.integration.api.client.dadata

Enum APIErrorCode

java.lang.Object

java.lang.Enum<APIErrorCode>

ru.redcom.lib.integration.api.client.dadata.APIErrorCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<APIErrorCode>

public enum APIErrorCode
extends java.lang.Enum<APIErrorCode>

Several documented errors from DaData API specification.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_REQUEST_FORMAT Status Code 400.
CREDENTIALS_INVALID Status Code 403.
CREDENTIALS_MISSING Status Code 401.
INSUFFICIENT_BALANCE Status Code 402.
TOO_MANY_ITEMS Status Code 413.
TOO_MANY_REQUESTS Status Code 429.
UNSUPPORTED_METHOD Status Code 405.

Method Summary

Modifier and Type	Method and Description
static APIErrorCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static APIErrorCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BAD_REQUEST_FORMAT

public static final APIErrorCode BAD_REQUEST_FORMAT

Status Code 400.
Generic status for various client request errors.

Example reasons:

• Invalid JSON format
• Missing required fields
• Unsupported request item type
• Misaligned record structure

CREDENTIALS_MISSING

public static final APIErrorCode CREDENTIALS_MISSING

Status Code 401.
Credentials (API key or Secret key) is missing from request headers.

INSUFFICIENT_BALANCE

public static final APIErrorCode INSUFFICIENT_BALANCE

Status Code 402.
Account profile balance is insufficient to process the request.

CREDENTIALS_INVALID

public static final APIErrorCode CREDENTIALS_INVALID

Status Code 403.
Returned on invalid credentials (API key or Secret key is of wrong format or unknown to service).

UNSUPPORTED_METHOD

public static final APIErrorCode UNSUPPORTED_METHOD

Status Code 405.
Returned on requests with method other than POST.

TOO_MANY_ITEMS

public static final APIErrorCode TOO_MANY_ITEMS

Status Code 413.
Request contains too many items.

May be returned when request contains more than 10 items or records to process.

TOO_MANY_REQUESTS

public static final APIErrorCode TOO_MANY_REQUESTS

Status Code 429.
Too many requests per second.

May be returned during periods of service congestion.

Method Detail

values

public static APIErrorCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (APIErrorCode c : APIErrorCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static APIErrorCode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null