Skip to content

Public Response Structure


Field Type Description
code Number Status code returned, consistent with the HTTP status code; fixed to 200 when no error.
content String, Number, Array, Boolean, JSON Data returned. The specific type depends on the actual API business logic.
pageInfo JSON Pagination information for all list API responses.
pageInfo.count Number Number of items in the current page.
pageInfo.pageIndex Number Page index.
pageInfo.pageSize Number Page size.
pageInfo.totalCount Number Total number of items matching the criteria.
errorCode String Error status code returned; empty indicates no error.
message String Detailed description corresponding to the error code.
success Boolean Fixed to true, indicating the API call succeeded.
traceId Boolean traceId, used to track each request.

Feedback

Is this page helpful?