GET api/forms/GetForms?state={state}&sinceDate={sinceDate}&page={page}&perPage={perPage}&sort={sort}&count={count}
Gets all active (version) forms that meet the search parameters.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| state |
"New" to get forms that have not been updated; "Updated" to get only forms that have been updated; "All" to get all forms. |
string |
None. |
| sinceDate |
the search will include results that were created or updated since this date time. |
date |
None. |
| page |
the number of the page to get. |
integer |
None. |
| perPage |
the number of results on each page. |
integer |
None. |
| sort |
the name of a property in the model used to sort; include a "-" before the name to sort in descending order. |
string |
None. |
| count |
1 to include the total count in a header. |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
An Http response message with the folliwing status codes: 200 = success (always includes a list of forms; however this list can be empty), 400 = bad request (the request is malformed or with invalid data), 500 = something went wrong (the request was not processed)
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. |