GetProjectFormsList()

Returns a list of project forms that satisfy the given filter parameters.

Quota: 10

Table 1. Parameters
Parameter	Type	Max Length	Required	Description
apiToken	string	20	Y	Your API security token configured in Field View.
projectId	integer		Y	The unique ID of the project.
formTemplateLinkIds	Integer[]		Y	The list of form template link IDs of form templates on the project. The form template link id spans versions of a form template. To get all forms on a project, pass in an empty list. Note: The list of available FormTemplateLinkIds can be found by calling GetProjectFormTemplates().
includeDeleted	boolean			Set this to true to include deleted forms.
createdDateFrom	DateTime			The created date from, forms to retrieve.
createdDateTo	DateTime			The created date to, forms to retrieve.
statusChangedDateFrom	DateTime			The status changed date from, forms to retrieve.
statusChangedDateTo	DateTime			The status changed date to, forms to retrieve.
lastmodifiedDateFrom	DateTime			The last modified date from, forms to retrieve.
lastmodifiedDateTo	DateTime			The last modified date to, forms to retrieve.
lastmodifiedOnServerDateFrom	DateTime			Beginning date of when the form was last modified on the web or synced to the server from mobile.
lastmodifiedOnServerDateTo	DateTime			End date of when the form was last modified on the web or synced to the server from mobile.
includeDeletedLocations	boolean			Set this to true to return forms from deleted locations.
Note: At least one date range is required and none may be greater than 3 months. If you provide more than one date range in the same call, the system returns only results that meet both ranges, thereby potentially narrowing your results. In addition, this query will only return results for modifications to form header fields such as Title, Status, and OwnedBy (see ProjectFormsListInformation listed below). To get results for associated information, use GetProjectFormsAnswers for form answers, GetProjectFormsComments for answer comments, and GetProjectFormsAttachments for answer photos and documents. Merge the results to get a complete picture of what has changed on forms within the date range.

Table 2. Returns
Field	Type	Description
ProjectFormsListInformation	ProjectFormsListInformation	Project forms list information structure.


   <ProjectFormsListResponse>
       <Status>
           <Code>SUCCESS</Code>
           <Message>Success.</Message>
       </Status>
       <ProjectFormsListInformation>
           <FormID></FormID>
           <FormTemplateLinkID></FormTemplateLinkID>
           <Deleted></Deleted>
           <FormType></FormType>
           <FormName></FormName>
           <FormTitle></FormTitle>
           <CreatedDate></CreatedDate>
           <OwnedBy></OwnedBy>
           <OwnedByOrganisation></OwnedByOrganisation>
           <IssuedToOrganisation></IssuedToOrganisation>
           <Status></Status>
           <StatusColour></StatusColour>
           <StatusDate></StatusDate>
           <Location></Location>
           <OpenTasks></OpenTasks>
           <ClosedTasks></ClosedTasks>
           <FormExpiryDate></FormExpiryDate>
           <OverDue></OverDue>
           <Complete></Complete>
           <Closed></Closed>
           <ParentFormID></ParentFormID>
           <LastModified></LastModified>
           <LastModifiedOnServer></LastModifiedOnServer>
           <ClosedBy></ClosedBy>
           <FormTemplateID></FormTemplateID>
           <ParentProcessTaskID></ParentProcessTaskID>
       </ProjectFormsListInformation>
   </ProjectFormsListResponse>

Help for Trimble Products

GetProjectFormsList()