Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/SearchEFormSubmission

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/SearchEFormSubmission

 

Search saved eForm submissions for current user

 

 

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/SearchEFormSubmission

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  SearchSubmissionType

 

mandatory

restriction enum (xs:string)

- Unknown (0)

- Default (1)

- Final (2)

- Draft (3)

Type of submission to search for

â–  MaxRows

xs:int

mandatory

Maximum number of submissions to return from server

â–¡ SubmissionId

xs:string

nillable

GUID string template:

[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

Sets the submissionId guid of the submission to be searched for

â–¡ FetchSubmission

xs:boolean

nillable

Define if the full submission data should also be loaded

 

 

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/SearchEFormSubmissionResponse

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ Results

 

nillable

Gets the full text query result rows.

≡ WSEFormSubmission

 

list nillable


â–  SubmissionNo

xs:int

mandatory

Number of the submission

â–  FormNo

xs:int

mandatory

Number of the form the submission was created with

â–  VersionNo

xs:int

mandatory

Version of the form the submission was created with

â–  SubmissionType

 

mandatory

restriction enum (xs:string)

- Unknown (0)

- Default (1)

- Final (2)

- Draft (3)

Type of the submission

â–¡ CreatedByUser

xs:string

mandatory nillable

Username of the user that saved/created the submission

â–  CreatedByUserNo

xs:int

mandatory

User that saved/created the submission

â–  Created

xs:dateTime

mandatory

DateTime when the submission was last modified

â–  SubmissionId

xs:string

mandatory

GUID string template:

[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

Guid of the submission - unique reference to load it

â–¡ Name

xs:string

mandatory nillable

user given name of the submission, may be empty

â–¡ Submission

xs:string

nillable

the submission data

â–  AllRowsReturned

xs:boolean

 

indicate if all rows were returned or the maximum hitcount was exceeded

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.