Overview‎ > ‎Callbacks‎ > ‎

requestPDFPrintSummary()

This method will request a PDF print summary for a given proof. Once the PDF has been generated a callback URL is notified

Since version: 13.2

Request parameters

* denotes a required field

Parameter

Example

API Version

SessionID*

Session identifier

string

7viklshodc6cnsh4s5vu75mqk0

FileID*

The target proof for which to create the print summary

integer

34572

CallbackUrl*

Callback URL

string


CallbackRetryInterval*

The retry interval in minutes. 


Note:

  • After 1 hour the interval is automatically changed to 60 minutes
  • After 24 hours the event is purged

integer

5

allVersions

Indicates if this should include all versions of the proof

boolean

false

15.20


Response parameters

boolean: true if the request was successful 

Example callback

<?xml version="1.0"?>
    <callback type="pdfprintsummary">
        <file_id>4698000</file_id>
        <proof_name>MyFile.pdf</proof_name>          
        <pdf_url>https://app.proofhq.com/file/printup/code/BH22VmbXWAHXvsTRE</pdf_url>
        <status>success</status> OR <status>failed</status>
        <pass_through/>
    </callback> 

Note: status field was introduced since API version 15.9


Comments