Web Service Documentation / Categories / Basic Account Services / Get Custom Field
Updated on May 9, 2014
This web service returns information for a specific custom field.
23.0
GET
/dataExchangeSettings/customField/(customFieldId)
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
Parameter Name | Description |
---|---|
customFieldId | Id to the custom field |
Request/Response | Schema Name |
---|---|
Request | None |
Response | customField.xsd |
The following example retrieves the custom field with the id of 45.
GET /dataExchangeSettings/customField/45
The following example returns information for the custom field.
<?xml version="1.0" encoding="UTF-8"?>
<customField validCharacters="Any" required="true" name="Lot Number" 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>