1.2.5 Response format of the API
A response for a request contains a status line, response header, and response body.
- Organization of this subsection
(1) Status description
A status line contains the elements listed below.
Item |
Description |
Reference |
---|---|---|
Protocol |
Displays the communication protocol used by the API. |
-- |
Protocol version |
Displays the version of the communication protocol used by the API. |
-- |
Status code |
Result of the request in a status code. |
See the status codes of each API. For details, see 1.2.6 HTTP status codes description. |
Message |
Displays the content of the status code |
|
--: Not applicable. |
(2) Response headers descriptions
Header |
Description |
---|---|
Cache-Control |
Controls the response information in the cache for the API where the GET method was specified. |
Content-Type |
Data format of response data. |
Language |
Language code of response data. |
WWW-Authenticate |
Outputs the authenticated HSSO token. |
Warning |
When the API completes successfully but there is a problem with the status of the server, details display in U.S. English (only U.S. English is allowed in the HTTP standard specification). |
(3) Response body description
The response body includes the response data returned when an API function is called. The data format of the response data is defined in the request header. The format of the response data depends on the API function. See the description for each API function.