Sign In
View Entire Document

Response Structure

The response will be in JSON format. There are some key-value pairs that you can always expect while other keys will optionally exist.

Additional key-value pairs and data items could be added. You should develop your application in such a way that it will not break if new items are added in the response. Do not rely on key position when parsing the response.

Table 1. Response Structure
FieldRequired Description
codeY
  • Request result code.
  • 200 series = Success.
  • Non 200 series = Failure. See ‘msg’ value for details. The request may have been partially successful.
MsgYA string description of the success or failure. Usually only populated when code is not 200.
DataNA list of data items. The exact format is specific to the command requested.

Example Response Structure

{
 "code":"200",
   "msg": "",
 "data":[{"Color":"green","Size":12},{"Color":"blue","Size":9}]
}
PreviousNext