Skip to content

Common Response Structure


Field Type Description
code Number Response code, identical to the HTTP status code. Always 200 when there is no error.
content String, Number, Array, Boolean, JSON Response data. The data type returned depends on the business logic of the specific API.
pageInfo JSON Pagination information for all list API responses.
pageInfo.count Number Number of items on the current page.
pageInfo.pageIndex Number Page number.
pageInfo.pageSize Number Number of items per page.
pageInfo.totalCount Number Total number of items matching the query criteria.
errorCode String Error code returned. Empty indicates no error.
message String Detailed description corresponding to the returned error code.
success Boolean Indicates whether the API call succeeded: true for success, false for failure.
traceId String Trace ID, used to track each request.

Feedback

Is this page helpful?