| Requires any of the roles: | admin, oauthadmin |
| GET | /Ams/{ClientID}/CustomForms/{FormID}/Fields | Return Custom Fields. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FormID | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FormFields | form | List<CustomFormField> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Label | form | string | No | |
| ID | form | string | No | |
| ListItems | form | List<string> | No | |
| FieldType | form | string | No | |
| DataType | form | string | No | |
| InputRows | form | string | No | |
| MaxLen | form | string | No | |
| Required | form | bool | No | |
| FullRow | form | bool | No | |
| Description | form | string | No | |
| IsVisibleToPublic | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/CustomForms/{FormID}/Fields HTTP/1.1
Host: ws.yourmembership.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"FormFields":[{"Label":"String","ID":"String","ListItems":["String"],"FieldType":"String","DataType":"String","InputRows":"String","MaxLen":"String","Required":false,"FullRow":false,"Description":"String","IsVisibleToPublic":false}],"FormID":0,"UsingRedis":true,"AppInitTime":"2025-01-15T08:46:14.8092102-05:00","ServerID":"WS-4-27-804","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-01-15T08:57:54.4516259-05:00","Device":"Desktop"}