Common API Error Information

Common API error information (response) is shown below.

Status

Returns the status of the request.

400:: If there is an invalid parameter.
401:: Authentication error. Authentication token does not exist, or if there is an error in the authentication token.
403:: Authentication error. If user is not the authorized subscriber.
404:: If the specified URL does not exist, or if there is an error in the URL.
500:: If an unexpected error has occurred.
In this case no response body will be returned.

Data Type	Cardinality
Int	1..1

The error information will be returned as follows.

Response Headers

Content-Length

Request length (Byte) excluding header.

Data Type	Cardinality
String	1..1

Content-Type

Content type

text/plain :: In case the status is 401.
application/json :: In case the status is other than 401

Data Type	Cardinality
String	1..1

Date

Response time

Data Type	Cardinality
String	1..1

WWW-Authenticate

URL for Authentication Service. Only displayed in cases of authentication error.

Data Type	Cardinality
String	0..1

Response Elements (In case status is 401)

Below mentioned text will be returned.

"Authentication required"

Response Elements (If Status is other than 401, 500)

error

Error information container.

Data Type	Cardinality	Parent Element	Child Element(s)
Element	1..1	None	code title message item

Data Type

Cardinality

Parent Element

Child Element(s)

Element

1..1

None

code

title

message

item

code

Error Code

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	error	None

title

Error Summary

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	error	None

message

Error Message

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	error	None

item

Item error (Notification only if there is an item error)

Data Type	Cardinality	Parent Element	Child Element(s)
Element	0..1	error	item_name

item_name

Item name that caused the Error (Parameter name at the time of request)

Data Type	Cardinality	Parent Element	Child Element(s)
String Element	1..1	item	message

message

Error message corresponding to the item.

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	item_name	None

Error Code (code, title, message)

code	title	message	Description
400	Bad Request	Parse error	Request Body is incorrect (The root element is different, not in JSON format).
400	Bad Request	Parameter error.	Parameter error The input content is incorrect
400	Bad Request	Could not find user (%1)	The specified user ID does not exist The specified user ID is %1.
400	Bad Request	Could not match user in domain.	The specified user ID is not the domain user.
400	Bad Request	The contract is not active.	Not in contract.
400	Bad Request	Email address cannot be used.	The specified mail address is disabled.
400	Bad Request	The user was already contractor.	The specified user is already a subscriber.
404	Not Found	Could not find domain. (%1)	The specified domain ID does not exist. The specified domain ID is %1.

Item error (item)

message	Description
Required.	Required item
Size error. (Min:%min, Max:%max)	Size Error %min : Acceptable minimum number of characters (Set Zero if items can be omitted) %max : Acceptable maximum number of characters
Invalid format.	Format is incorrect. When user name is included in the password, When @ symbol is not included in the mail address.
Invalid type.	Invalid value is specified. In case where "D" is set in places where you can only specify "A","B","C".
Not found.	Information corresponding to the specified values are not registered.
Already exists.	Information corresponding to the specified values are already existing.

Example of Response

In case of parameter error


{
  "error": {
    "code": 400,
    "title": "Bad Request",
    "message": "Parameter error.",
    "item": {
      "secure": {
        "name": {
          "first": {
            "message": "Required."
          },
          "last": {
            "message": "Size error. (Min:0, Max:64)"
          }
        }
      }
    }
  }
}

In case of authentication error


Authentication required

In case of authorization error


{
  "error" : {
    "code" : 403,
    "title" : "Forbidden",
    "message" : "Authorization error."
  }
}

In case the specified organization does not exist.


{
  "error" : {
    "code" : 404,
    "title" : "Not Found",
    "message" : "Could not find domain, 304ce7245683491ebaf91ad63c1dd2c."
  }
}