主题
保存服务事项
- 本接口一次只允许添加一个事项
接口说明
请求URL：http[s]://{网关地址}/coosk/restful/serviceItem/saveServiceItem
请求方式： POST
请求内容类型： application/json
响应内容类型： application/json
请求说明
请求头
| 字段名 | 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 应用ID | appId | M | String(128) | 接入网关的应用ID |
| Token | accessToken | M | String | 接入网关的accessToken |
请求体
| 字段名 | 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| fieldValues | M | Array | 字段列表 | |
| 关联服务id列表 | linkedServices | M | Array | 关联服务id列表 |
| 是否显示详情页 | isShow | M | int | 是否显示详情页(1是0否) |
字段列表具体信息fieldValues(返回)
| 字段名 | 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 字段id | columnId | M | String(64) | 字段id |
| 字段值 | columnValue | M | Object | 字段值 |
| 多语言值 | columnValueMultiLang | M | Array | 多语言 |
多语言值列表信息：
| 字段名 | 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 字段值 | langValue | M | Object | 字段值 |
| 多语言国家 | langCountry | M | String(50) | 多语言国家 |
| 多语言名称 | languageName | M | String(20) | 多语言名称 |
| 多语言key | languageKey | O | String(64) | 多语言key |
其中字段值（columnValue） 具体格式根据当前字段的表单类型（formType）填写
（formType：1/2/5）单行文本/多行文本/富文本：
text
{
"columnId": "",
"columnValue": "第三方创建的事项拉拉123",
"columnValueMultiLang": [
{"langValue": "lalalalala", "langCountry": "en_US", "languageName": "英文(美国)","languageKey": "en_US"}
]
}1
2
3
4
5
6
7
2
3
4
5
6
7
（formType：3/4）下拉单选/下拉多选：
text
{
"columnId": "",
"columnValue": ["813729730481094656", "813729730493677568"],
"columnValueMultiLang": [
{"langValue": "", "langCountry": "en_US", "languageName": "英文(美国)","languageKey": "en_US"}
]
}1
2
3
4
5
6
7
2
3
4
5
6
7
下拉多选时，服务部门(SERVICE_DEPT)和服务分类(columnId 为“CAT”开头)的字段columnValue需要传入List<List<String>> 类型
text
{
"columnId": "SERVICE_DEPT",
"columnValue": [["896440106374602752"],["896440127107047424"]],
"columnValueMultiLang": [
{"langValue": "", "langCountry": "en_US", "languageName": "英文(美国)","languageKey": "en_US"}
]
}
{"columnId":"CAT_SERVICE-SUBJECT","columnValue":[["896440106374602752"],["896440127107047424"]],"columnValueMultiLang":[]}1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
（formType：6）附件：
text
{
"columnId": "",
"columnValue": {
file: {
fileName: "",
filePath: "2021-10-09/890286810569076736",
objectType: "serviceIcon",
oldName: "错误.xls",
url: ""
}
"material_comments":"描述"
}
"columnValueMultiLang": [
{
"langValue": {file: {}, material_comments: "23213"},
"langCountry": "en_US",
"languageName": "英文(美国)","languageKey": "en_US"
}
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
（formType：7/8）多行文本/富文本+附件
columnId相同，文本和附件组合
（formType：9）特殊
- 常见问题(不超过10个)示例：
text
{
"columnId": "FAQS",
"columnValue": {
question: "常见问题1",
answer: "dana"
}
"columnValueMultiLang": [
{
"langValue": {question: "1uestion1", answer: "adac asc"},
"langCountry": "en_US",
"languageName": "英文(美国)","languageKey": "en_US"
}
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
- 办理地点(不超过5个)示例：
text
{
"columnId": "DEAL_ADDRESS",
"columnValue": {siteName: "wqswq"}
"columnValueMultiLang": [
{
"langValue": {siteName: "wqswq"},
"langCountry": "en_US",
"languageName": "英文(美国)","languageKey": "en_US"
}
]
}1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
- 咨询电话(不超过5个)示例：
text
{
"columnId": "CONTACT_PHONE",
"columnValue": {phone: "1425527322332", comments: "2121"},
"columnValueMultiLang": [
{"langValue": {phone: "1425527322332", comments: "2121"},
"langCountry": "en_US",
"languageName": "英文(美国)","languageKey": "en_US"}
]
}1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- 办理流程示例：
text
{
"columnId": "PROCESS_FLOW",
"columnValue": {
comments: "描述",
file: {
fileName: "",
filePath: "2021-10-09/890286810569076736",
objectType: "serviceIcon"
}
}
"columnValueMultiLang": [
{
"langValue": "外文描述",
"langCountry": "en_US",
"languageName": "英文(美国)","languageKey": "en_US"
}
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
- 主要业务周期示例：
text
{
"columnId": "BUSINESS_CYCLE",
"columnValue":{type: "2", value: "xwx"},
"columnValueMultiLang": [
{
"langValue": "",
"langCountry": "en_US",
"languageName": "英文(美国)","languageKey": "en_US"
}
]
}
type:1,常年； 2：手动填写1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
- 办理时限示例：
text
{
"columnId": "DEAL_TIME_LIMIT",
"columnValue":{type: "2", value: "xwx"},
"columnValueMultiLang": [
{
"langValue": "",
"langCountry": "en_US",
"languageName": "英文(美国)","languageKey": "en_US"
}
]
}
type:1,当场办结； 2：手动填写1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
- 事项图标（同附件）
请求示例
json
{
"fieldValues": [
{
"columnId": "ITEM_NAME",
"columnValue": "第三方创建的事项拉拉123",
"columnValueMultiLang": [
{"langValue": "lalalalala", "langCountry": "en_US", "languageName": "英文(美国)","languageKey": "en_US"}
]
},
{
"columnId": "DUTY_DEPT_ID",
"columnValue": ["813729730481094656", "813729730493677568"],
"columnValueMultiLang": [
{"langValue": "", "langCountry": "en_US", "languageName": "英文(美国)","languageKey": "en_US"}
]
},
{
"columnId": "多行文本+附件ID",
"columnValue": "这是文字描述",
"columnValueMultiLang": [
{"langValue": "this is comment ", "langCountry": "en_US", "languageName": "英文(美国)","languageKey": "en_US"}
]
},
{
"columnId": "多行文本+附件ID",
"columnValue": {
file: {
fileName: "",
filePath: "2021-10-09/890286810569076736",
objectType: "serviceIcon",
oldName: "错误.xls",
url: ""
}
"material_comments":"描述"
},
"columnValueMultiLang": [
{
"langValue": {file: {}, material_comments: "23213"},
"langCountry": "en_US",
"languageName": "英文(美国)","languageKey": "en_US"
}
]
},
{
"columnId": "CAT_SERVICE-SUBJECT",
"columnValue": [["877997237994479616"]],
"columnValueMultiLang": [
{"langValue": "", "langCountry": "en_US", "languageName": "英文(美国)","languageKey": "en_US"}
]
},
{
"columnId": "FAQS",
"columnValue": {question: "常见问题1", answer: "dana"}
"columnValueMultiLang": [
{"langValue": {question: "1uestion1", answer: "adac asc"},
"langCountry": "en_US",
"languageName": "英文(美国)","languageKey": "en_US"}
]
},
{
"columnId": "FAQS",
"columnValue": {question: "常见问题2", answer: "dana"}
"columnValueMultiLang": [
{"langValue": {question: "1uestion2", answer: "adac asc"},
"langCountry": "en_US",
"languageName": "英文(美国)","languageKey": "en_US"}
]
}
],
"isShow": 1,
"linkedServices": ["877225604140593152", "879303594672480256", "869288569564131328", "873288788102443008"]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
响应说明
响应体
| 字段名 | 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 返回码 | errcode | 是 | String | 0 成功，其他为不成功 |
| 返回码描述 | errmsg | 否 | String | 返回码描述 |
| 返回对象 | data | 是 | string | 创建事项的id |
响应示例
json
{
"errcode": "0",
"errmsg": "success",
"traceId": null,
"data": "893171934659117056"
}1
2
3
4
5
6
2
3
4
5
6
错误码
| 错误码 | 描述 |
|---|---|
| 321001 | 缺少必填项 |
| 321002 | 关联了不存在的服务 |
| 321003 | XXX字段为单选 |
| 321004 | XXX字段为必填项 |
| 321005 | 输入的XXX字段值不存在 |
| 321006 | XXX个数超过限制 |
| 321007 | XXX字段为空 |
| 321008 | XXX超出长度 |
| 321009 | XXX填写不规范 |
| 999 | 统一错误码，详细描述信息参见接口返回 |
Demo
java
// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID,APP_SECRET);
// 创建请求对象
ServiceItem request = new ServiceItem();
request.setUrl("/coosk/restful/serviceItem/saveServiceItem");
request.setIsShow(1);
List<ServiceItemFieldValue> fieldValues =new ArrayList<>();
fieldValues.add(getItemFieldValue("ITEM_NAME","测试事项3",1,"zh_CN","测试事项3"));
fieldValues.add(getItemFieldValue("DUTY_DEPT_ID", Arrays.asList("13424001"),3,"",""));
fieldValues.add(getItemFieldValue("SERVICE_OBJ",Arrays.asList("1"),4,"",""));
fieldValues.add(getItemFieldValue("CAT_SERVICE-SUBJECT",Arrays.asList(Arrays.asList("cec8d580-1ac1-46fa-ae18-f3770968c6ac")),4,"",""));
fieldValues.add(getItemFieldValue("SERVICE_CONTENT","服务内容",2,"zh_CN","服务内容"));
Map<String, Object> paramMap = new HashMap<>();
paramMap.put("type","1");
paramMap.put("value","");
fieldValues.add(getItemFieldValue("BUSINESS_CYCLE",paramMap,9,"",""));
fieldValues.add(getItemFieldValue("DEAL_TYPE","0",3,"",""));
fieldValues.add(getItemFieldValue("LIST_TYPE","0",3,"",""));
fieldValues.add(getItemFieldValue("SCENE_TIMES","0",3,"",""));
fieldValues.add(getItemFieldValue("PRE_CONDITION","前置条件",2,"zh_CN","前置条件"));
Map<String, Object> paramMap2 = new HashMap<>();
paramMap2.put("type","1");
paramMap2.put("value","");
fieldValues.add(getItemFieldValue("DEAL_TIME_LIMIT",paramMap2,9,"",""));
fieldValues.add(getItemFieldValue("INSTRUCTIONS","<p> 办理须知</p>",5,"zh_CN","<p> 办理须知</p>"));
Map<String, Object> paramMap3 = new HashMap<>();
paramMap3.put("comments","<p>办理流程</p>");
Map<String, Object> paramMap4 = new HashMap<>();
paramMap4.put("url",null);
paramMap3.put("file",paramMap4);
fieldValues.add(getItemFieldValue("PROCESS_FLOW",paramMap3,9,"",""));
fieldValues.add(getItemFieldValue("SERVICE_DEPT",Arrays.asList(Arrays.asList("13424011")),4,"zh_CN","<p> 办理须知</p>"));
fieldValues.add(getItemFieldValue("DEAL_TIME","<p>办理时间</p>",5,"zh_CN","<p>办理时间</p>"));
Map<String, Object> paramMap5 = new HashMap<>();
paramMap5.put("phone","12345678998");
paramMap5.put("comments","咨询电话");
fieldValues.add(getItemFieldValue("CONTACT_PHONE",paramMap5,9,"zh_CN",paramMap5));
Map<String, Object> paramMap6 = new HashMap<>();
paramMap6.put("siteName","办理地点");
fieldValues.add(getItemFieldValue("DEAL_ADDRESS",paramMap6,9,"zh_CN",paramMap6));
Map<String, Object> paramMap7 = new HashMap<>();
paramMap7.put("question","问题");
paramMap7.put("answer","答案");
fieldValues.add(getItemFieldValue("FAQS",paramMap7,9,"zh_CN",paramMap7));
request.setFieldValues(fieldValues);
request.setServiceType(0);
request.setLinkedServices(Arrays.asList("1253277216620802048"));
Response response = client.execute(request);
//调用成功，则处理业务逻辑
if (response.isSuccess()) {
//.....
}
private ServiceItemFieldValue getItemFieldValue(String columnId,Object columnValue,int formType,
String langCountry,Object langValue){
ServiceItemFieldValue serviceItemFieldValue = new ServiceItemFieldValue();
serviceItemFieldValue.setColumnId(columnId);
serviceItemFieldValue.setColumnValue(columnValue);
serviceItemFieldValue.setFormType(formType);
if(StringUtils.isNotEmpty(langCountry)&&null!=langValue){
List<MultiLang> itemNameLang= new ArrayList<>();
MultiLang multiLang = new MultiLang();
multiLang.setLangCountry(langCountry);
multiLang.setLangValue(langValue);
itemNameLang.add(multiLang);
serviceItemFieldValue.setColumnValueMultiLang(itemNameLang);
}
return serviceItemFieldValue;
};1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72