1.6.通信协议报文格式
请求报文,根据各业务接口说明,GET接口基本为param格式,POST接口为JSON格式,编码统一采用UTF-8
响应报文统一为JSON格式
后面各业务接口所说的响应报文,只针对其中data和total中的内容进行说明,code和msg对每个接口都会返回,就不在每个接口中说明
|
序号 |
参数名称 |
类型 |
必填 |
备注 |
|
1 |
code |
字符串 |
是 |
结果代码,200-表示成功;400-表示失败 |
|
2 |
msg |
字符串 |
是 |
结果信息,当结果代码等于200时,返回“操作成功”,否则返回失败原因信息。 |
|
3 |
data |
JSON |
是 |
数据体,空或者JSON数组或JSON对象 |
|
4 |
total |
JSON |
否 |
对有统计要求的接口,会返回统计数,有返回该参数时为JSON对象 |
例如:
{
"code": 200,
"msg": "操作成功",
"data": {"unitId":"1", "deptName":"行政部"}
}
{
"code": 400,
"msg": 失败原因描述,
"data": null
}
Created with the Personal Edition of HelpNDoc: Free help authoring environment