Web Service Documentation / Categories / Basic Account Services / Get Custom Field List

Get Custom Field List

Updated on December 10, 2013

Description

This web service returns a list of custom fields that are used by your account. These custom fields allow you to gather more data from your customers as they send connection and share requests to you.

Version

23.0

HTTP Method

GET

Resource URL

/dataExchangeSettings/customField/list

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

None

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves a list of custom fields that you have defined.

GET  /dataExchangeSettings/customField/list

Example Response

The following example returns a list of custom fields that you have defined. The list contains web service links for you to call to retrieve information for each custom field. Each link contains a hint that refers to the name of the custom field.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link hint="Lot Number" httpMethod="GET" link="/dataExchangeSettings/customField/2" linkDescription="This is the GET url for this custom ID."/>
          <link hint="Jurisdiction ID" httpMethod="GET" link="/dataExchangeSettings/customField/1" linkDescription="This is the GET url for this custom ID."/>
     </links>
</response>
LIVE