主要使用场景:系统字典类
获取区域信息
获取接口访问凭证:accessToken
url | http://www.hzjy.edu.cn/api/user/openapi/area/get-area-info?area_code=410000&accessToken={{accessToken}} |
请求方式 | get |
是否需要鉴权 | 是 |
请求数限制 | 否 |
接口方向 | 第三方应用->开放平台 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
area_code |
必选 |
string |
区域编码,多个使用英文逗号,分隔;多个时返回的结构体不同,请注意 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
code |
必选 |
string |
结果编码 | |
2 |
message |
必选 |
string |
结果描述 | |
3 |
result |
必选 |
json |
json对象 | |
3.1 |
area_code |
必选 |
string |
区域编码 | |
3.2 |
area_name |
必选 |
string |
区域名称 | |
3.3 |
area_level |
必选 |
int |
区域等级 省:1 市:2 区:3 | |
3.4 |
area_order |
必选 |
int |
区域排序 | |
3.5 |
parent_code |
必选 |
string |
父级区域编号 |
请求示例\r\nhttp://www.hzjy.edu.cn/api/user/openapi/area/get-area-info?area_code=410000&accessToken={{accessToken}}\r\n\r\n返回示例1\r\n{\r\n \"code\": \"000000\",\r\n \"message\": \"请求成功\",\r\n \"result\": {\r\n \"area_code\": \"410000\",\r\n \"area_name\": \"河南省\",\r\n \"area_level\": \"1\",\r\n \"area_order\": \"849\",\r\n \"parent_code\": \"0\"\r\n }\r\n}\r\n\r\n返回示例2\r\n{\r\n \"code\": \"000000\",\r\n \"message\": \"请求成功\",\r\n \"result\": {\r\n \"420000\": {\r\n \"area_code\": \"420000\",\r\n \"area_name\": \"湖北省\",\r\n \"area_level\": \"1\",\r\n \"area_order\": \"908\",\r\n \"parent_code\": \"0\"\r\n },\r\n \"420100\": {\r\n \"area_code\": \"420100\",\r\n \"area_name\": \"武汉市\",\r\n \"area_level\": \"2\",\r\n \"area_order\": \"2829\",\r\n \"parent_code\": \"420000\"\r\n }\r\n }\r\n}
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:text |
1.1 |
text |
必选 |
Json |
- |
text消息体 |
1.1.1 |
content |
必选 |
String |
消息内容 |
{ "msgtype": "text", "text": { "content": "zhxy msg text test 12" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:link |
2 |
link |
必选 |
Json |
- |
link消息体 |
2.1 |
pcUrl |
必选 |
String |
PC端消息点击链接地址 |
|
2.2 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
2.3 |
title |
必选 |
String |
消息标题 |
|
2.4 |
busiId |
必选 |
String |
对应业务的id |
|
2.5 |
content |
必选 |
String |
消息描述 |
|
2.6 |
picUrl |
必选 |
String |
图文消息的图片链接,支持JPG、PNG格式,较好的效果为大图640*320,小图80*80。如不填,在客户端不显示图片 |
{ "msgtype": "link", "link": { "pcUrl": "http://www.baidu.com", "appUrl": "http://www.baidu.com", "picUrl": "http://xxx.yyy.com/zzz.jpg", "content": "百度一下", "title": "百度", "busiId":"AQWER1234" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:oa |
2 |
busiId |
必选 |
String |
- |
该条oa消息在业务系统对应的id |
3 |
pcUrl |
必选 |
String |
消息点击链接地址 |
|
4 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
5 |
oa |
必选 |
Json |
- |
oa类型消息体 |
5.1 |
head |
必选 |
Json |
255 |
消息头部Json |
5.1.1 |
text |
必选 |
String |
255 |
消息的头部标题 |
5.1.2 |
bgColor |
可选 |
String |
消息头部的背景颜色。长度限制为8个英文字符,其中前2为表示透明度,后6位表示颜色值。不要添加0x。默认值:FFCC0000 |
|
5.2 |
body |
可选 |
Json |
消息体 |
|
5.2.1 |
title |
可选 |
String |
消息体的标题 |
|
5.2.2 |
content |
可选 |
String |
消息体的正文 |
|
5.2.3 |
imageUrl |
可选 |
String |
消息体中的图片url |
|
5.2.4 |
fileCount |
可选 |
String |
自定义的附件数目。此数字仅供显示,不作验证 |
|
5.2.5 |
author |
可选 |
String |
自定义的作者名字 |
|
5.2.6 |
form |
可选 |
Json数组 |
消息体的表单,最多6个 |
|
5.2.7 |
key |
可选 |
String |
消息体的关键字 |
|
5.2.8 |
value |
可选 |
String |
消息体的关键字对应的值 |