Protocol
Description
We use RESTful standard API to transport data within HTTP protocol. The body data is encoded with application/json format.
Request
| Type | Description |
|---|---|
Content Type | application/json |
HTTP Method | POST/GET |
URL | |
Path | Variables are inserted in path to describe hierarchy |
Query | Search conditions are append to the query parameters |
Body | Contains strutrual data for submitting/query result |
Request Body
| Name | Type | Description |
|---|---|---|
limit | number | The number of items to return. |
skip | number | The number of items to skip before starting to collect the result set. |
Response
Typically an object or an array of objects
Last updated