Overview‎ > ‎Proofs‎ > ‎

getProofsByView()

Return the proofs identified by a given view. This works similar to a view in the ProofHQ web application but rather returns a collection of objects.

Since version: 16.18

Request parameters
* denotes a required field

Parameter

Example

API version

SessionID*

The session Id obtained from doLogin()

string

7viklshodc6cnsh4s5vu75mqk0

  

ListViewID*

  There are 7 views that you can choose from
  • 1 - Active proofs
  • 2 - Locked proofs
  • 3 - Archived proofs
  • 4 - Proofs to manage
  • 5 - Proofs awaiting decision
  • 6 - Late proofs
  • 7 - Files

string

1

  

IncludeArchived

If archived proofs should be included in the returned list

boolean

true
false

  

StartFrom

Results offset

Default: 0

integer

5

  

ItemsPerPage

The number of results to return from the StartFrom

Default: 30

integer

 35  
Email Filter proofs by recipient email string recipient@example.com 17.4

Response parameters

SOAPFileObjectArray:

array of SOAPFileObject

Comments