Basic Structure of API Response
Response Object
When the data comes as a single result set.
In API V2, all Waiker responses have the following response format.
The actual data is contained within the data object, and the API documentation only describes the data portion.
| Field | Type | Description | Example Value |
|---|---|---|---|
| code | String | Response Code | OK |
| status | Integer | http status code | 200, 404, etc |
| message | String | Response Message | SUCCESS, FAIL |
| timestamp | String | Message Response Time | 2024-09-11 06:36:58.373705 +00:00 |
| data | Object | Actual Information | data object |
Pagination Response Object
When the data comes in the form of a list.
| Field | Type | Description | Example Value |
|---|---|---|---|
| code | String | Response Code | OK |
| status | Integer | http Status Code | 200, 404, etc. |
| message | String | Response Message | SUCCESS, FAIL |
| timestamp | String | Message Response Time | 2024-09-11 06:36:58.373705 +00:00 |
| page | Integer | Requested Page | 1 |
| size | Integer | Number of Results Requested | 10 |
| totalPage | Integer | Total Pages | 10 |
| totalCount | Integer | Total Number of Results | 1000 |
| data | Object | Actual Information | data object |