AVB LINQ Public API

<back to all web services

CustomFieldListRequest

Custom Fields
The following routes are available for this service:
GET/customfieldsGets Custom Fields for your account.
CustomFieldListRequest Parameters:
NameParameterData TypeRequiredDescription
CustomFieldCategoryIdsqueryIEnumerable<int>No
CustomFieldListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CustomFieldsformList<CustomFieldModel>No
CustomFieldModel Parameters:
NameParameterData TypeRequiredDescription
CustomFieldIdformintNo
DisplayNameformstringNo
FieldDataTypeformstringNo
LanguagesformList<LanguageDTO>No
CustomFieldCategoryformstringNo
LanguageDTO Parameters:
NameParameterData TypeRequiredDescription
LCIDformstringNo
LanguageCodeformstringNo

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

HTTP + CSV

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

GET /customfields HTTP/1.1 
Host: avb-pos.avbportal.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"customFields":[{"customFieldId":0,"displayName":"String","fieldDataType":"String","languages":[{}],"customFieldCategory":"String"}]}