1. 主页
  2. 文档
  3. Multiview Server API
  4. 基本规则
  5. URL规则
  6. HTTP响应和错误处理

HTTP响应和错误处理

除非设备的Http server在工作时出现了异常,否则设备总会给予您HTTP响应,同时在HTTP Content中包含一个JSON object描述对应API执行的结果。

如果设备未给您任何响应,这表示Http server出现了工作异常。请参考HTTP的错误代码、并进一步检测HTTP响应的错误消息获知详细的出错原因。

请注意:如果您的HTTP API请求地址正确,即使这个API执行失败,设备的Http server仍然会返回一个JSON object描述对应API执行的结果。您应该通过检查返回的JSON object中的字段来确定执行成功与否。

如果HTTP API执行成功,返回的JSON object格式如下:

{
    "result": "ok",
    "msg": "description message",
    "data": {
        ...
    }
}

其中,"result" 是必定存在的字段,它的值"ok"表示请求的HTTP API执行成功。对于执行成功而言,"msg" 并非必定存在,您也可以完全忽略它的存在,它仅仅用于额外描述一些信息。对于有返回结果的HTTP API来说,"data" 字段将会存在,而且它是一个JSON object 或者 array,表示API的返回结果。这将视具体的API而定,请参考具体API的说明。

HTTP响应的Content-Type必定为 application/json。

请注意:在本文档的后续API描述内容中,如非特殊情况的必要说明,将忽略关于API请求错误的说明。

我们要如何帮助您?