Auto Print

AutoPrintRequest is a type of request made by a vendor to generate a file for an individual order line item or combine all sheets of an order into a single file. This gives the vendor the ability to provide a link to the end user to "print" each order line item individually or "print" an entire order.

A single OrderNumber element is the only required input, representing the order number from a transaction previously opened. An optional AssetId element can be included. If an AssetId element is provided, the final document will contain only that order line item. If the AssetId represents a package asset, all of the child transactions will be included. If the AssetId is omitted, all sheets of the order will be combined into a single file. Sheets are combined in order, according to the order line id that was submitted on the TransactionOpen request. If multiple copies of an asset were purchased, they are grouped together in the final PDF.

Zero or more Personalization elements can be included and, if provided, will be used in the personalization string that is added to the footer on each page of the final document.

An optional quantities attribute on the AutoPrintRequest element can be specified if the vendor would like finer control over how the final PDF is assembled. The value of the quantities attribute can be all or oneOfEach; the default is all. For example, if a customer purchased 3 sheets of Asset 12345 and 1 sheet of Asset 54321, auto-printing "all" would combine the 4 sheets together in the final PDF. Auto-printing "one of each" would combine one sheet of Asset 12345 and one sheet of Asset 54321 in the final PDF.

The AutoPrintResponse contains a DownloadURL element, which contains an expiring URL to a PDF of sheet(s) in the specified order.

Request / Response Examples

AutoPrintRequest Example:

<?xml version="1.0"?>
<!DOCTYPE DAMRequest SYSTEM "https://haldms.halleonard.com/dam_dtd/DAMRequestVersion5.dtd">
<DAMRequest>
    <RequestHdr>
        <DAMVersion>5.0</DAMVersion>
        <VendorId>123</VendorId>
        <VendorKey>theKey123</VendorKey>
    </RequestHdr>
    <AutoPrintRequest>
        <OrderNumber>12345</OrderNumber>
        <AssetId>1000</AssetId>
        <Personalization>custname:Joe Customer</Personalization>
    </AutoPrintRequest>
</DAMRequest>

AutoPrintResponse Example:

<?xml version="1.0"?>
<!DOCTYPE DAMResponse SYSTEM "https://haldms.halleonard.com/dam_dtd/DAMResponseVersion5.dtd">
<DAMResponse>
    <ResponseHdr>
        <DAMVersion>5.0</DAMVersion>
        <VendorId>123</VendorId>
    </ResponseHdr>
    <AutoPrintResponse>
        <DownloadURL>https://halleonard-pdf-restricted.s3.amazonaws.com/personalized%2F1583163583_order_12345.pdf?Signature=nW8s2E0Q3B3hFZafeyhuJdloTZw%3D&amp;Expires=1444321294&amp;response-content-type=application%2Fpdf&amp;response-content-disposition=inline%3B%20filename%3D%22order_12345.pdf%22&amp;AWSAccessKeyId=AKIAJVO53SLKDT33PEPQ</DownloadURL>
    </AutoPrintResponse>
</DAMResponse>