GET | /customfields | Gets Custom Fields for your account. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomFieldCategoryIds | query | IEnumerable<int> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
CustomFields | form | List<CustomFieldModel> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomFieldId | form | int | No | |
DisplayName | form | string | No | |
FieldDataType | form | string | No | |
Languages | form | List<LanguageDTO> | No | |
CustomFieldCategory | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LCID | form | string | No | |
LanguageCode | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK Content-Type: text/jsv 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 } ] }