响应结果

响应结果

如无特殊说明,文档中给出的响应结果均为 JSON 格式,并遵循 HTTP 状态码语义。

通常情况下,响应结果将以 2xx(一般为 200)的 HTTP 状态码返回,形如:

{   "errcode": 0,   "errmsg": "ok",   "ret": true,   "data": {       /* DATA */   } }

这表示接口调用成功(请求参数无异常、服务器无内部错误),但并不表示业务逻辑执行成功。业务方判断接口的业务逻辑是否执行成功,需要结合 retdata 等字段(需要注意的是,这个两个字段未必在所有接口中都会返回)进行判断,具体情况需要参考各自的基础服务内部文档。

如果接口调用失败,会返回除 2xx 之外的其他 HTTP 状态码,返回数据结果也为标准 JSON 格式,可根据返回数据中的 errcodeerrmsg 字段判断具体错误。

更多信息请参考本文档下有关异常处理的章节。