/list/{listId}?field=(delete|update|add)
目录 |
/list/{listId}?field=(delete|update|add)
- 更新联系人列表
URL
- {HOST}/services /list/{listId}?field=(delete|update|add)
支持格式
- XML(Atom)
HTTP 请求方式
- POST
认证方式
请求数限制
- true
请求参数
字段名称 | 是否必填 | 字段类型 | 说明 |
---|---|---|---|
auth | 是 | String | BASIC/APIKEY/ OAUTH 三种认证方式信息中的一种 |
alt | 是 | String | 通过该参数,你可以改变返回值的格式,目前支持的返回值格式包括:atom(默认) ,暂不支持json |
title | 是 | String | 列表名称(内) |
subtitle | 是 | String | 列表名称(外) |
um:attribute | 否 | String |
列表属性 name 列表属性英文名称 label 列表属性中文名称 visible=(true|false) 属性是否显示在列表 public =(true|false) 是否公用属性 sn 属性在列表中的显示顺序 type 属性类别(text=文本|checkbox=复选框|radio=单选框|select=列表|textarea=文本域|number=数字类型) |
um:option | 否 | String |
在 um:attribute 属性 type=select 时使用该字段. name 属性英文名称 label 属性中文名称 default (true|false) 是否默认选中 |
field | true | String |
add = 添加
update = 更新 delete = 删除 |
请求字符串
<?xml version="1.0" encoding="UTF-8"?> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:um="http://www.unimarketing.com.cn/xmlns/"> <title>技术小组</title> <subtitle>DJ技术小组测试</subtitle> <um:attribute name="inCity" label="所在城市" visible="true" public="true" sn="20" type="select"> <um:option name="sichuang" label="四川_成都" default="false">sichuang</um:option> <um:option name="beijing" label="北京_北京" default="true">beijing</um:option> </um:attribute> </entry>
返回结果
<?xml version="1.0" encoding="UTF-8"?> <entry xmlns="http://www.w3.org/2005/Atom"> <id>http://services.unimarketing.com.cn/list/7128</id> <title type="text">API测试</title> <subtitle type="text">API测试</subtitle> </entry>
字段说明
字段名称 | 意义 | 数据类型 | 备注 |
---|---|---|---|
id | 联系人列表ID | String |
http://services.unimarketing.com.cn/list/7128
7128 为列表ID |
title | 联系人列表名称(内) | String | |
subtitle | 联系人列表名称(外) | String |
调用示例(Java 示例)
package cn.unisoftware.api.client.example.contact; import java.util.ArrayList; import java.util.List; import org.apache.commons.lang.builder.ToStringBuilder; import org.apache.commons.lang.builder.ToStringStyle; import cn.unisoftware.api.client.UnimailClient; import cn.unisoftware.api.client.model.ContactFieldEnum; import cn.unisoftware.api.client.model.ContactListAttr; import cn.unisoftware.api.client.model.ContactListReq; import cn.unisoftware.api.client.model.ContactListRes; import cn.unisoftware.api.client.model.FieldOption; import cn.unisoftware.api.client.model.FieldTypeEnum; import cn.unisoftware.api.client.utils.AtomConstants; /** * @description 更新联系人列表信息 * @author DJ * @test 【true】 */ public class UpdateContactList { /** * @param args * @throws Exception */ public static void main(String[] args) throws Exception { UnimailClient unimailClient = UnimailClient.getClient(false, UnimailClient.AuthMode.BASIC, new String[] { AtomConstants.userName, AtomConstants.userPwd }); ContactListReq conReq = new ContactListReq(); conReq.setListId(7137l); //【必填】 列表ID conReq.setField("update"); //【必填】 更新 conReq.setListName("技术小组"); //列表名称 conReq.setListSubName("DJ技术小组测试"); //列表子名称 Listlists = new ArrayList (); ContactListAttr cla = new ContactListAttr(); cla.setNameAttr("inCity"); cla.setLabelAttr("所在城市"); cla.setVisibleAttr("true"); cla.setPublicAttr("true"); cla.setSnAttr("20"); cla.setTypeAttr(FieldTypeEnum.SELECT.getCodeEn()); // 下拉框 List listOptions = new ArrayList (); FieldOption fp = new FieldOption(); fp.setIsDefault("false"); fp.setCode("sichuang"); fp.setLabel("四川_成都"); fp.setValue("sichuang"); listOptions.add(fp); fp = new FieldOption(); fp.setIsDefault("true"); fp.setLabel("北京_北京"); fp.setCode("beijing"); fp.setValue("beijing"); listOptions.add(fp); cla.setListOptions(listOptions); lists.add(cla); conReq.setListAttr(lists); ContactListRes res = unimailClient.updateContactList(conReq); System.out.println(ToStringBuilder.reflectionToString(res,ToStringStyle.MULTI_LINE_STYLE)); } }