Returns FileQueryResult object containing the list of files matching the search criteria. If nothing is meet or any error in search parameters, a message describing the error is returned. Return object (FileSummary) provides some parameters like FileId, Status, OwnerEmail, unsigned document count, signed document count and date created of the matched file.
The request body is of type FileQuery.
Request Body Parameters
| Name | Description | Data Type |
|---|
| p_ApiCode | The API code of the site. This can be found through your Sertifi web interface under Administration -> Account Settings. | xml:string |
| parameters | A file can be searched using following parameters:
- FileNumericId1
An Integer metadata for the file and which is set using SetSignatureRequestParameters
- FileDateSigned
Time at which packetized file was signed. Time format should be in sortable DateTime pattern yyyy'-'MM'-'dd'T'HH':'mm':'ss, eg: 2008-06-15T21:15:07 | ArrayOfSearchParameter |
The response body is of type FileQueryResponse.
<soap:Envelope xmlns:soap="
http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="
http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="
http://www.w3.org/2001/XMLSchema">
<soap:Body>
<FileQueryResponse xmlns="
http://apps.sertifi.net/services/">
<FileQueryResult>
<FileQueryResult>
<Result>
<FileSummary>
<FileId>.AgDIRSpMJx9x7XnYdjuhhXUH0</FileId>
<FileStatus>Active</FileStatus>
<OwnerEmail>
[email protected]</OwnerEmail>
<Unsigned>1</Unsigned>
<Signed>0</Signed>
<DateCreated>2018-08-13T14:14:28.2</DateCreated>
<DateLastAction>0001-01-01T00:00:00</DateLastAction>
<Participants>
<FileParticipant>
<Email>
[email protected]</Email>
<Roles>
<FileRole>
<Type>CC</Type>
<Sequence>0</Sequence>
</FileRole>
<FileRole>
<Type>Signer</Type>
<Sequence>1</Sequence>
</FileRole>
<FileRole>
<Type>Signer</Type>
<Sequence>2</Sequence>
</FileRole>
</Roles>
</FileParticipant>
<FileParticipant>
<Email>
[email protected]</Email>
<Roles>
<FileRole>
<Type>Signer</Type>
<Sequence>1</Sequence>
</FileRole>
</Roles>
</FileParticipant>
<FileParticipant>
<Email>
[email protected]</Email>
<Roles>
<FileRole>
<Type>CC</Type>
<Sequence>0</Sequence>
</FileRole>
</Roles>
</FileParticipant>
<FileParticipant>
<Email>
[email protected]</Email>
<Roles>
<FileRole>
<Type>Signer</Type>
<Sequence>2</Sequence>
</FileRole>
</Roles>
</FileParticipant>
</Participants>
</FileSummary>
</Result>
</FileQueryResult>
</FileQueryResult>
</FileQueryResponse>
</soap:Body>
</soap:Envelope>
Response Body Parameters
