5.2.5 Response format

The following describes the format of a response:

httpVersion statusCode
responseHeader
 
messageBody

Table 5‒5: Response format in detail
Item	Description
`httpVersion`	As the version of the communication protocol used by an API, `HTTP/1.1` is returned.
`statusCode`	Returns a status code that indicates the result of the processed request.
`responseHeader`	Returns the data format of the response, which was specified in the request header.
`messageBody`	Returns the message body data as follows: Data format: JSON Encoding: UTF-8

Organization of this subsection

(1) Status codes
(2) Response header

(1) Status codes

The following table lists status codes to be returned when an API is run. Possible returned status codes are different for each API. For details, see the description of each API.

Table 5‒6: Status codes
Status code	Message	Description
`200`	For details, see the description of each API.	The request was processed successfully.
`400`	`Bad-request`	The request is invalid.
`401`	`Unauthorized`	Could not be authenticated. Information for authentication or authorization is invalid.
`403`	`Forbidden`	There is no permission to run the request.
`404`	`Not-found`	The requested resource is not found or no operation is found for the resource. Or a specified parameter is invalid.
`406`	`Not-acceptable`	The specified response format is not supported.
`411`	`Length Required`	When the `POST` method is used, the `Content-Length` property of the request header is omitted.
`413`	`Payload Too Large`	The size of the request body exceeds the upper limit.
`415`	`Unsupported media type`	The specified request format is not supported.
`500`	`Server-error`	An error occurred with the server processing.
`503`	`Service Unavailable`	The Intelligent Integrated Management Base service is unavailable. This might be caused by a temporal congestion or other reason.

To Page Top

(2) Response header

The following table describes response headers controlled by the Intelligent Integrated Management Base.

Table 5‒7: Response header
Header	Description
`Cache-Control`	Specify the following so that the API response is not cached. --- Cache-Control: no-store, no-cache, max-age=0 Pragma: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT
`Content-Type`	The data format of the response data. `application/json` is always returned as a fixed value.
`WWW-Authenticate`	Indicates that authentication is required when authentication with login information added to a REST API (Basic authentication) is used. --- WWW-Authenticate: Basic realm="JP1 Authentication Realm"

To Page Top