JSON工具类的实现
信息资源库1.3接口规范说明书
1.1 新增分组(站点)
对接应用新增分组,将分组信息添加到资源库中
使用场景
当对接应用的信息资源较多,需要分类管理,且分类复杂,则可对不同的分类进行分组。如以网站为分组,将网站下的栏目作为该组的分类。若没有复杂分类,也可不创建分组。
接口调用请求说明
HTTPS请求方式:POST
https://接口服务地址/httpservice/addGroup.do?appkey=APPKEY&accesstoken=ACCESSTOKEN
请求参数列表
名称 |
类型 |
是否必选 |
描述 |
groups |
String |
是 |
分组JSON |
groups参数说明
Array<Group>
提交的JSON格式样例:(注意,格式化前的json使用‘\’作为转义符)
{ "groups": [{ "id": "1", //分组ID "name": "XX市政府", //分组名称 "isParent": 1, //是否为父分组 "parentId": "0", //父分组ID "orderiId": 0 //排序ID }, { "id": "2", "name": "XX市教育局", "isParent": 0, "parentId": "1", "orderId": 0 } ] } |
Group数据结构
名称 |
类型 |
是否必选 |
描述 |
id |
String |
是 |
分组ID,接入应用内部产生的分组标识,如网站ID |
name |
String |
是 |
分组名称,如网站名称 |
isParent |
Integer |
是 |
是否为父分组,0:否;1:是 |
parentId |
String |
是 |
父分组ID |
orderId |
Integer |
是 |
排序号,升序 |
返回结果说明
无数据返回
1.2 新增分类(栏目)
对接应用新增分类,将分类信息添加到资源库中
使用场景
当对接应用的信息资源较多,使用分类管理信息资源,需要将分类信息添加到资源库中,便于其他应用查找资源。如以网站栏目作为分类。若没有分类,也可不创建。
接口调用请求说明
HTTPS请求方式:POST
https://接口服务地址/httpservice/addCategory.do?appkey=APPKEY&accesstoken=ACCESSTOKEN
请求参数列表
名称 |
类型 |
是否必选 |
描述 |
categories |
String |
是 |
分类JSON |
categories参数说明
Array<Category>
提交的JSON格式样例:(注意,格式化前的json使用‘\’作为转义符)
{ "categories": [{ "id": "1", //分类ID "groupId": "2", //分组ID siteid "name": "热点回顾", //分类名称 "isParent": 1, //是否为父分类 treelevel=1;0;没有 "parentId": "0", //父分类ID parentid "orderiId": 0, //排序ID orderby "catalogId": 1 //目录ID 0 }, { "id": "2", "groupId": "2", "name": "今日要闻", "isParent": 0, "parentId": "1", "orderId": 0, "catalogId": 2 } ] } |
Category数据结构
名称 |
类型 |
是否必选 |
描述 |
id |
String |
是 |
分类ID,对接应用内部产生的分类标识,如网站栏目ID |
grouopId |
String |
是 |
分组ID,对接应用内部产生的分组分组标识,如网站ID |
name |
String |
是 |
分类名称,如网站栏目名称 |
isParent |
Integer |
是 |
是否为父分类,0:否;1:是 |
parentId |
String |
是 |
父分类ID |
orderId |
Integer |
是 |
排序号,升序 |
catalogId |
Integer |
是 |
与分类绑定的目录ID。若尚未绑定目录,则值为0 |
返回结果说明
无数据返回
1.3 新增信息资源(文章)
使用场景
对接应用内新增信息资源并成功发布后,同步到资源库中。
接口调用请求说明
HTTPS请求方式:POST
https://接口服务地址/httpservice/addInfo.do?appkey=APPKEY&accesstoken=ACCESSTOKEN
请求参数列表
名称 |
类型 |
是否必选 |
描述 |
groupId |
String |
是 |
分组ID,没有分组则填0 |
categoryId |
String |
是 |
分类ID,没有分类则填0 |
infoId |
String |
是 |
信息资源ID,对接应用内部产生的唯一标识 |
content |
String |
是 |
信息资源内容JSON,格式根据reference参数的值有所不同,参考“content数据结构” |
url |
String |
是 |
信息资源的外网URL |
reference |
Integer |
是 |
是否是引用信息,0:不是;1:是 若是有新增信息的推送消息,则按照推送消息中的reference填写,参考:信息资源更新消息body说明 |
content参数说明(当reference参数为0时)
提交的JSON格式样例:(注意,格式化前的json使用‘\’作为转义符)
{ "infoContent": { "title": "进城务工人员随迁子女教育", //信息资源标题,必填 "author": "杨武", //作者,必填 "showTime": "2018-03-28 15:24:33", //显示时间,必填 "body": {//元数据信息的内容 "phoneNumber": "13303003937", "address": "江苏省南京市", "logoUrl": "cloudfile:/2/2018/07/11/1803291049545202779.jpg" } } } |
content数据结构(当reference参数为0时)
名称 |
类型 |
是否必选 |
描述 |
title |
String |
是 |
标题 |
author |
String |
是 |
作者 |
showTime |
String |
是 |
显示时间,用于排序及展现 |
body |
String |
是 |
内容 l 标准信息资源的内容为富文本内容 l 其他类型信息资源则为字段JSON,字段在元数据中定义 |
content参数说明(当reference参数为1时)
提交的JSON格式样例:(注意,格式化前的json使用‘\’作为转义符)
{ "infoSource": { "appId": 2, //引用源应用ID "groupId": "3", //引用源分组ID "categoryId": "313", //引用源分类ID "infoId": "125" //引用源信息ID } } |
content数据结构(当reference参数为1时)
名称 |
类型 |
是否必选 |
描述 |
appId |
Integer |
是 |
引用源应用ID |
groupId |
String |
是 |
引用源分组ID,没有分组则填0 |
categoryId |
String |
是 |
引用源分类ID,没有分类则填0 |
infoId |
String |
是 |
引用源信息资源ID,对接应用内部产生的唯一标识 |
返回结果说明
无数据返回
总结:1.1站点(客户要求传给他们的JSONG格式)
1.2栏目(客户要求传给他们的JSONG格式)
1.3文章的(客户要求给他们 的JSONG格式)
JSON工具类的实现:
需要的jar包: