Back to API references

SOAP API method IndividualPdf_snapshot

Description

The snapshot of the pdf.

Parameters

Name Type Description
id * int Unique identifier (id) of the object IndividualPdf. The method only applies to the individualpdf with this id.
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
pdfdocumentsnapshot Structure of type 'pdfdocumentsnapshot'

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'pdfdocumentsnapshot'

Name Type Description
id int The ID of the snapshot.
source string The source of the snapshot.
pagecount int The number of pages in the snapshot.
name string The name of the snapshot.
faxheader string The headerline above the fax.
language string The language in which this snapshot is displayed.