获取自定义属性字段列表

Get custom fields list获取自定义属性字段列表

Fields（属性字段）接口允许检索在一个业务单元里所有定义的收件人自定义属性字段（自定义收件人属性）信息.

请求数据格式

请求 URL 参数:
参数 类型 描述
apiKey string 你的 API key, 用来验证身份. 必填.

示例:

https://api.esv2.com/v2/Api/Fields?apiKey=test_api_key1

应答

应答数据元素:
参数/属性 类型 描述
Fields array[complex] Field元素组成的数组.
Field 子元素:
参数/属性 类型 描述
Id int 自定义属性ID.
Name string 自定义属性名称.
FriendlyName string 用于展示的“友好的”自定义属性字段名称.
Type string 自定义属性类型.属于以下之一：Text, Number, Money, Date, Datetime, SingleSelect, Boolean, Url.
DefaultValue mixed 默认的自定义属性值.内容取决于属性类型.选填.
Description string 自定义属性字段的文字描述.选填.
Visible boolean 如为True,自定义属性将对收件人可见，如展示在用户偏好中心Preference Center中.
Required boolean 如为True,当添加收件人到列表时是必须有的属性值.

示例

请求:
GET https://api.esv2.com/v2/Api/Fields?apiKey=test_api_key1 HTTP/1.1

Accept-Encoding: gzip,deflate
Host: api.esv2.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
OK 应答:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 5.2
X-AspNet-Version: 4.0.30319
Set-Cookie: TEMP_DATA=c0d53e6c-d043-474f-b899-c7bc080f637d; path=/
X-Powered-By: ASP.NET
Date: Mon, 02 Feb 2015 17:06:10 GMT
Content-Length: 1877<ApiResponse
xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
 <Data>
  <Fields>
   <Field>
    <Id>1</Id>
    <Name>booltest</Name>
    <FriendlyName>Test Boolean Field</FriendlyName>
    <Type>Boolean</Type>
    <DefaultValue>1</DefaultValue>
    <Description>This is a test boolean field with default value.</Description>
    <Visible>True</Visible>
    <Required>False</Required>
   </Field>
   <Field>
    <Id>2</Id>
    <Name>reqtext</Name>
    <FriendlyName>Required Text Field</FriendlyName>
    <Type>Text</Type>
    <DefaultValue />
    <Description>This is a test text value which is required.</Description>
    <Visible>False</Visible>
    <Required>True</Required>
   </Field>
   <Field>
    <Id>3</Id>
    <Name>numtest</Name>
    <FriendlyName>Test Number Field</FriendlyName>
    <Type>Number</Type>
    <Description>This is a test number field.</Description>
    <Visible>False</Visible>
    <Required>False</Required>
   </Field>
  </Fields>
 </Data>
</ApiResponse>