GET v1/forms/dataset?apiToken={apiToken}&formIdentifier={formIdentifier}&startTime={startTime}&endTime={endTime}&includeDateTimeOffsets={includeDateTimeOffsets}&includeTransactions={includeTransactions}&formStatus={formStatus}
Returns an ADO.NET DataSet representation of a list of forms of a given type, optionally filtered based on their submit times. Returned data is limited to one year.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| apiToken |
Your API Token |
string |
None. |
| formIdentifier |
(Optional) The type of form to receive the DataSet for |
string |
None. |
| startTime |
(Optional) Filter on forms submitted after the provided time (GMT) |
date |
None. |
| endTime |
(Optional) Filter on forms submitted before the provided time (GMT) |
date |
None. |
| includeDateTimeOffsets |
(Optional) Whether or not the columns for datetime fields will include the offsets entered on the form. If false, will convert them to GMT. |
boolean |
Default value is False |
| includeTransactions |
(Optional) Whether or not to generate data tables for each transaction type. Ignored without formIdentifier supplied |
boolean |
Default value is False |
| formStatus |
(Optional) Filters on forms of the specified status. Supported values are Approved, Rejected, Draft, Pending, and All. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
An XML serialization of the "shredded" form data
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |