UDN-企业互联网技术人气社区

板块导航

浏览  : 591
回复  : 0

[发布平台] 开放平台返回格式规范

[复制链接]
zhangzhp3的头像 楼主
发表于 2016-3-24 15:35:36 | 显示全部楼层 |阅读模式
为方便调用方对API的返回结果进行处理,开放平台的返回结果使用统一的格式。
返回格式
json类型的格式如下:
            
    {"statuscode":"0","data":"","errormsg":"","errordetailmsg":""}            
  
字段
  
说明
statuscode
状态码,遵循编码规范
data
调用成功的返回结果
errormsg
异常信息
errordetailmsg
异常详细信息描述
1、避免直接抛出异常;
2、不管api成功或失败,返回结果都包含上述信息;3、状态码遵循编码规范;
4、为了满足通过开放平台调用和直接NC调用有统一的方式,开放平台和NC的返回结果都要满足上述要求;
状态码
10表示调用成功,其他都表示调用失败;
2、状态码采用6位数字表示,有效范围为100000-999999
100000-199999,为开放平台异常;
200000-999999,为NC异常;
3、建议状态码采用2+2+2的方式来去编码,如领域编码+组件编码+业务异常编码;
如开放平台的状态码:
  
状态吗
  
描述

0
调用成功

100101
找不到相关API服务,请核对API服务!
  
  
  
  
  
1001:权限验证
100102
找不到相关资源,请核对资源信息!
100103
请求超时,或时间戳参数异常!
100104
没有权限,验证失败,请检查AppKeyAccessToken
100105
没有该资源的权限,请向管理员提交资源权限认证!
100106
找不到相关项目,请核对项目标识!
100201
参数验证错误,请检查参数(如是否包含必输参数)
  
  
1002:参数异常
100202
参数类型错误
100203
不支持的编码异常,请检查参数编码是否正确!
100301
http请求调用异常!
  
  
1003Http请求异常
100302
http请求服务器未找到该API资源
100303
http请求服务发生内部错误
100401
soap请求调用异常
1004soap请求异常
100501
请求返回结果为空
  
1005:返回结果异常
100502
请求返回结果类型错误
199999
请求失败!未知错误!
         
处理流程
调用方获得api的返回结果后,处理流程如下:
result-process-flow.jpg


您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

关于我们
联系我们
  • 电话:010-86393388
  • 邮件:udn@yonyou.com
  • 地址:北京市海淀区北清路68号
移动客户端下载
关注我们
  • 微信公众号:yonyouudn
  • 扫描右侧二维码关注我们
  • 专注企业互联网的技术社区
版权所有:用友网络科技股份有限公司82041 京ICP备05007539号-11 京公网网备安1101080209224 Powered by Discuz!
快速回复 返回列表 返回顶部