| GET | /api/fieldbank | Get all fields in the fieldbank (including archived). |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FieldId | query | Guid | No | Filter by FieldBankField Id. |
| FieldName | query | string | No | Filter by the name of the FieldBank Field. |
| IsActive | query | BooleanFilter | Yes | Filter by the status of the field.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Fields | form | List<FieldBankField> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalResults | form | int | No | |
| Skip | form | int | No | |
| Take | form | int | No | |
| Links | form | List<Link> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusDescription | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| RequestUrl | form | string | No | |
| Method | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FieldId | form | Guid | No | |
| FieldName | form | string | No | |
| FieldType | form | FieldType | No | |
| CollectionType | form | FieldCollectionType | No | |
| CollectionId | form | Guid? | No | |
| CollectionName | form | string | No | |
| RepeaterSections | form | List<RepeaterSection> | No | |
| IsActive | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SectionTemplateId | form | Guid | No | |
| SectionTemplateName | form | string | 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.
POST /csv/reply/GetFieldBankFields HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: text/csv
Content-Length: length
{"FieldId":"00000000-0000-0000-0000-000000000000","Version":0,"FieldName":"String","IsActive":"All"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Fields":[{"FieldName":"String","FieldType":"All","CollectionType":"All","CollectionId":"00000000-0000-0000-0000-000000000000","CollectionName":"String","RepeaterSections":[{"SectionTemplateName":"String"}],"IsActive":false}],"TotalResults":0,"StatusDescription":"String","Skip":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Take":0,"Links":[{"Name":"String","RequestUrl":"String","Method":"String"}]}