接口返回码
更新时间:2018-03-30 14:05:09 更新人员:叶洋

文档状态:
摘要
全局接口约定,正常访问接口后,返回的数据中常携带一个返回码。
本文在此对各种返回码做出简要解释。
-
数据返回码的位置
访问接口将返回一个Json对象,其中一个属性名为 code 的即是返回码(返回状态码)。
系统接口约定,返回码为0时接口正常访问,其它情况值为非0。
-
返码状态码表
| 状态码 | 提示语 | 说明 |
| ■ 通用 |
| 00000 | 成功 | |
| 00001 | 失败 | |
| ■ 接口地址路由验证 |
| 10001 | 接口不存在 | |
| 10002 | 路由参数格式错误 | |
| ■ 接口版本验证 |
| 11001 | 未使用接口版本号 | |
| 11002 | 接口版本错误 | 数据格式错误、长度、数据类型、字符使用范围不满足时提示 |
| 11003 | 该版本的接口已过期,请开发者尽快升级 | |
| ■ 商户验证 |
| 12001 | 未使用商户密钥 | |
| 12002 | 商户校验错误 | |
| 12003 | 商户密钥错误 | |
| 12004 | 商户已被禁止使用 | |
| 12005 | 商户授权使用已过期限 | |
| 12006 | 商户请求源地址IP不被允许 | 未允许的主机地址不能访问接口 |
| 12007 | 商户信息检验有误 | |
| ■ 商户接口访问权限验证 |
| 13001 | 该商户未授权访问此接口 | |
| ■ 用户登录验证 |
| 14001 | 用户还未登录系统 | 用户未登录 |
| 14002 | 用户token格式校验错误 | |
| 14003 | 用户错误或状态已过期 | 检查token时发现找不到对应的用户,产生原因,其它地方登录更新了token,用的错误的token |
| 14004 | 用户已在其它地方登录,当前登录状态已失效 | |
| 14005 | 用户已登录 | |
| ■ 用户接口访问权限验证 |
| 15001 | 该用户权限状态已关闭 | |
| 15002 | 该用户没有进入系统的许可权限 | |
| 15003 | 该用户未行授权访问此接口 | |
| ■ 数据签名验证 |
| 16001 | 数据未签名 | |
| 16002 | 数据签名格式错误 | |
| 16003 | 数据签名效验错误 | |
| ■ 请求参数验证 |
| 17001 | 参数数据类型错误 | |
| 17002 | 子项参数设定错误 | |
| 17003 | 请求参数数据校验错误 | |
| 17004 | 缺失必要请求参数 | |
| ■ 业务处理用户受限 |
| 18001 | 业务只允许超级管理员执行 | |
| 18002 | 业务需要更高级别权限的管理者才能处理 | |
| 18003 | 该操作只能由其上级管理员执行 | |
| 18004 | 该业务操作不允许当前用户执行 | |
| 18005 | 未信任的业务操作 | |
| ■ 用户与帐户相关提示 |
| 20001 | 用户不存在 | |
| 20002 | 用户注册失败 | |
| 20003 | 用户登录失败 | |
| 20004 | 用户退出失败 | |
| 20005 | 用户密码重置失败 | |
| 20006 | 帐号未注册 | |
| 21001 | 用户模型数据校验失败 | |
| 21002 | 提交数据验证错误 | |
| ■ 资源类提示码(自定义) |
| 30000 | 自定义常规提示无业务逻辑意义 | |
| 30001 | 自定义提示[1] | |
| 30002 | 自定义提示[2] | |
| 30003 | 自定义提示[3] | |
| 30004 | 自定义提示[4] | |
| 30005 | 自定义提示[5] | |
| 30006 | 自定义提示[6] | |
| 30007 | 自定义提示[7] | |
| 30008 | 自定义提示[8] | |
| 30009 | 自定义提示[9] | |
| ■ 资源列表查询 |
| 31001 | 暂无数据 | 查询列表时无数据 |
| 31002 | 查询条件错误 | 给出了错误的查询条件 |
| 31003 | 该资源数据已被保护,您无权查询 | 业务权限保护 |
| ■ 资源创建 |
| 31101 | 资源创建失败 | 单个资源创建失败 |
| 31102 | 资源创建时数据逻辑错误 | 具有具体的错误原因及提示 |
| 31103 | 欲求创建的资源级别高于自身,创建请求已被驳回 | 试图创建高于自身权限所能创建的资源时 |
| 31104 | 检测到所提交资源已被创建成功,此次属于重复提交,已被截断新建行为 | |
| 31105 | 资源在其它地方被创建锁定 | 在对指定的唯一的资源创建之时,若同样的数据在别的地方被创建时提示 |
| ■ 资源删除 |
| 31201 | 资源删除失败 | 单个资源删除时失败 |
| 31202 | 资源删除时发生数据异常 | 删除时要关联删除数据无法匹配等 |
| 31203 | 该资源数据已被保护,您无法执行删除 | 无权删除,或数据有期限在期限之前禁止删除,或锁定保护 |
| 31204 | 欲删除的资源不存在或已被删除 | 删除一个不存在的资源时 |
| 31205 | 删除资源时发生严重错误,无法恢复 | |
| ■ 资源更新 |
| 31301 | 资源更新失败 | |
| 31302 | 资源更新时数据逻辑错误 | |
| 31303 | 该资源数据被保护,您无权修改 | |
| 31304 | 您要修改的资源不存在或已被删除 | |
| 31305 | 资源未发生任何变更 | |
| ■ 资源查询 |
| 31401 | 所指定的资源查询失败 | |
| 31402 | 指定的查询条件错误 | |
| 31403 | 所查资源受到指定保护,您无法查看该资源详情 | |
| 31404 | 资源不存在 | 单个资源信息读取 |
| ■ 业务提示码 |
| 32001 | 请求已过期 | |
| 32002 | 游标获取失败 | |
| ■ 运单业务类 |
| 400xxx | 运单类4开头 | |
| ■ 财务类处理 |
| 500xxx | 财务类5开头 | |
| ■ 数据类处理 |
| 600xxx | 数据类6开头 | |
| ■ 订单与支付相关 |
| 800xxx | 订单与支付类8开头 | |