Back to API references

SOAP API method PdfDocumentError_document

Description

The document in which the error occured.

Parameters

Name Type Description
id * int Unique identifier (id) of the object PdfDocumentError. The method only applies to the pdfdocumenterror 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
pdfdocument Structure of type 'pdfdocument'

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 'pdfdocument'

Name Type Description
status string Status of the document.
pagecount int The number of pages in the document.
size int The size of the document.
faxheader string The headerline above the fax.
temporary boolean Is this document set as a temporary document. The document will be removed when there are no
id int The ID of the document.
templateID int The template ID of the document
name string The name of the document.
description string The description of the document.
archived boolean Is this an archived document?.
created timestamp The date and time when the document was created.
modified timestamp The date and time when the document was last modified.
language string The language of the document.
timezone string Get the time zone of the document. If the timezone is not set, it returns