Response Results
Upon receiving an API request, Yeastar Workplace responds with an HTTP status code that indicates the request result, and a JSON response body that contains information requested by the API call.
Success response example
For a successful request, Yeastar Workplace returns an HTTP status code
200
, and a response body that contains the information
requested by the API call, as the following table shows:
Parameter | Type | Description |
---|---|---|
data | Object | The detailed information that is requested by the API call. |
status | String | The result of a request. In a success response, the status is
Success . |
requestId | String | The ID of the request, which can be used to quickly locate the request. |
Response example
HTTP/1.1 200 OK
{
"data": {
"pageSize": 2,
"pageNo": 1,
"total": 10,
"list": [
{
meeting room details
},
{
meeting room details
}
]
},
"status": "Success",
"requestId": "7879eec466c049f37e1fbf375d00eb32"
}
Error response example
For an unsuccessful request, Yeastar Workplace returns an
HTTP 4xx
status code or HTTP
500
status code, and the detailed error
message that can help you to quickly address the error and modify the request.
Parameter | Type | Description |
---|---|---|
status | String | The result of a request. In an error response, the status is
Failed . |
requestId | String | The ID of the request, which can be used to quickly locate the request. |
errMsg | String | The cause of the error. |
detailMsg | String | The detailed and specific information about the error. |
Response example
The following example shows an error response to a request that uses an incorrect HTTP method.
HTTP/1.1 405 Not Allowed
{
"status": "Failed",
"requestId": "9aa422cb576124f2d834c3c1fc31b136",
"errMsg": "ACCESS_DENIED",
"detailMsg": "Request method 'PUT' not supported"
}