AVB LINQ Public API

CustomFieldDefinitionRequest

Custom Fields

The following routes are available for this service:
PUT	/customfields/config	Creates or updates Custom Field definitions for your account.

**CustomFieldDefinitionRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CustomFieldDefinitionValues	body	List<CustomFieldDefinitionValueRequest>	No

**CustomFieldDefinitionValueRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CustomFieldId	body	int?	No
DisplayName	body	string	Yes
FieldDataType	body	string	Yes	Allowed values: Text Integer Date Decimal Checkbox Currency Dropdown
ShowOnWebsite	body	bool	No
WebsiteTitle	body	string	No
WebsiteSortOrder	body	int?	No
CategoryId	body	int?	No	Optional category ID, typically with a value of 1. Only applies for Create.
ClearOverride	body	bool?	No	Optional flag to request the clearning of an overridden global custom field for a dealer
BrandIds	body	List<int>	No	Associated BrandIDs

**CustomFieldDefinitionResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /customfields/config HTTP/1.1 
Host: avb-pos.avbportal.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomFieldDefinitionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.API.DTO">
  <CustomFieldDefinitionValues>
    <CustomFieldDefinitionValueRequest>
      <BrandIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </BrandIds>
      <CategoryId>0</CategoryId>
      <ClearOverride>false</ClearOverride>
      <CustomFieldId>0</CustomFieldId>
      <DisplayName>String</DisplayName>
      <FieldDataType>String</FieldDataType>
      <ShowOnWebsite>false</ShowOnWebsite>
      <WebsiteSortOrder>0</WebsiteSortOrder>
      <WebsiteTitle>String</WebsiteTitle>
    </CustomFieldDefinitionValueRequest>
  </CustomFieldDefinitionValues>
</CustomFieldDefinitionRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomFieldDefinitionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.API.DTO">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CustomFieldDefinitionResponse>