Web Service Documentation / Categories / Basic Account Services / Create Custom Field
Updated on May 9, 2014
This web service adds a custom field. This custom field is used by the data exchange web services during the connection/share process. Note that there is no validation performed on the specified display order.
24.0
POST
/dataExchangeSettings/customField
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials | |
Content-Type | application/xml |
Yes
None
Request/Response | Schema Name |
---|---|
Request | customField.xsd |
Response | response.xsd |
The following example creates a new property-level custom field.
POST /dataExchangeSettings/customField<?xml version="1.0" encoding="UTF-8"?> <customField validCharacters="Any" required="true" name="Lot Number1" whenToPrompt="Property"> <description>Lot Number for the property in ACME Building system.</description> <example>FG 323</example> <url>http://www.acme.com</url> <minChars>1</minChars> <maxChars>12</maxChars> <displayOrder>1</displayOrder> </customField>
The following example indicates that the custom field was successfully created. It also returns the new custom field id of 46 and a link to web service to retrieve the custom field.
<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
<id>46</id>
<links>
<link httpMethod="GET" link="/dataExchangeSettings/customField/46" linkDescription="This is the GET url for this custom field."/>
</links>
</response>