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 .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetForms
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetForms xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Version>0</Version>
<Skip>0</Skip>
<Take>0</Take>
<OrderBy>Default</OrderBy>
<OrderByDesc>Default</OrderByDesc>
<ThenBy>Default</ThenBy>
<ThenByDesc>Default</ThenByDesc>
<FormRevisionId>00000000-0000-0000-0000-000000000000</FormRevisionId>
<FormId>00000000-0000-0000-0000-000000000000</FormId>
<FormName>String</FormName>
<Owner>String</Owner>
<Revision>String</Revision>
<Status>All</Status>
<IsDistributed>All</IsDistributed>
</GetForms>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetFormsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <StatusDescription>String</StatusDescription> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> <TotalResults>0</TotalResults> <Skip>0</Skip> <Take>0</Take> <Links> <Link> <Name>String</Name> <RequestUrl>String</RequestUrl> <Method>String</Method> </Link> </Links> <Forms> <Form> <FormRevisionId>00000000-0000-0000-0000-000000000000</FormRevisionId> <FormId>00000000-0000-0000-0000-000000000000</FormId> <FormName>String</FormName> <Owner>String</Owner> <Revision>0</Revision> <Status>All</Status> <IsDistributed>false</IsDistributed> <FormFields> <FormField> <FieldId>00000000-0000-0000-0000-000000000000</FieldId> <FormRevisionId>00000000-0000-0000-0000-000000000000</FormRevisionId> <FormName>String</FormName> <Label>String</Label> <FieldType>All</FieldType> <FieldBankFieldId>00000000-0000-0000-0000-000000000000</FieldBankFieldId> <CollectionType>All</CollectionType> <CollectionId>00000000-0000-0000-0000-000000000000</CollectionId> <CollectionName>String</CollectionName> <SectionId>00000000-0000-0000-0000-000000000000</SectionId> <PersistentSectionId>00000000-0000-0000-0000-000000000000</PersistentSectionId> <SectionName>String</SectionName> <RepeaterSections> <RepeaterSection> <SectionTemplateId>00000000-0000-0000-0000-000000000000</SectionTemplateId> <SectionTemplateName>String</SectionTemplateName> </RepeaterSection> </RepeaterSections> </FormField> </FormFields> </Form> </Forms> </GetFormsResponse> </soap:Body> </soap:Envelope>