| GET | /api/forms | Query for Coruson Forms |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FormRevisionId | query | Guid | No | Filter by the Form Revision Id. |
| FormId | query | Guid | No | Filter by FormId. |
| FormName | query | String | No | Filter by the name of the Form. |
| Owner | query | String | No | Filter by the owner of the Form. |
| Revision | query | Integer | No | Filter by the current revision number of the Form. |
| Status | query | FormStatus | Yes | Filter by the current status of the Form.Allowable Values
|
| IsDistributed | query | BooleanFilter | Yes | Filter by whether the form has being distributed to the current authenticated user.Allowable Values
|
| OrderBy | query | FormOrder | Yes | Property to order by in Ascending order. Default is 'Name'.Allowable Values
|
| OrderByDesc | query | FormOrder | Yes | Property to order by in Descending order.Allowable Values
|
| ThenBy | query | FormOrder | Yes | Second Property to order by in Ascending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored.Allowable Values
|
| ThenByDesc | query | FormOrder | Yes | Second Property to order by in Descending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | Integer | No | Number of items to skip before returning results. Minimum suitable value is 0 and is also the default value. |
| Take | form | Integer | No | Number of items to return per page. Must be a number in the range 1-100. Default value is 100. |
| OrderBy | form | Enum | No | Order By |
| OrderByDesc | form | Enum | No | Order By Descending |
| ThenBy | form | Enum | No | Then By |
| ThenByDesc | form | Enum | No | Then By Descending |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Forms | form | List<Form> | 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 |
|---|---|---|---|---|
| FormRevisionId | form | Guid | No | |
| FormId | form | Guid | No | |
| FormName | form | string | No | |
| Owner | form | string | No | |
| Revision | form | int | No | |
| Status | form | FormStatus | No | |
| IsDistributed | form | bool | No | |
| FormFields | form | List<FormField> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FieldId | form | Guid | No | |
| FormRevisionId | form | Guid | No | |
| FormName | form | string | No | |
| Label | form | string | No | |
| FieldType | form | FieldType | No | |
| FieldBankFieldId | form | Guid | No | |
| CollectionType | form | FieldCollectionType | No | |
| CollectionId | form | Guid? | No | |
| CollectionName | form | string | No | |
| SectionId | form | Guid | No | |
| PersistentSectionId | form | Guid? | No | |
| SectionName | form | string | No | |
| RepeaterSections | form | List<RepeaterSection> | 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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/GetForms HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: text/jsv
Content-Length: length
{
FormRevisionId: 00000000-0000-0000-0000-000000000000,
Skip: 0,
Version: 0,
FormId: 00000000-0000-0000-0000-000000000000,
Take: 0,
FormName: String,
Owner: String,
Revision: String,
Status: All,
IsDistributed: All,
OrderBy: Default,
OrderByDesc: Default,
ThenBy: Default,
ThenByDesc: Default
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Forms:
[
{
FormName: String,
Owner: String,
Revision: 0,
Status: All,
IsDistributed: False,
FormFields:
[
{
FormName: String,
Label: String,
FieldType: All,
CollectionType: All,
CollectionId: 00000000-0000-0000-0000-000000000000,
CollectionName: String,
PersistentSectionId: 00000000-0000-0000-0000-000000000000,
SectionName: String,
RepeaterSections:
[
{
SectionTemplateName: String
}
]
}
]
}
],
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
}
]
}