Package Name

Overview

The PackageName API returns XML formatted data for a specified package name from the Expere EZ Config Packages and Packets application. This API gathers all package and packet data for the given package name and formats it specifically for use with Expere requests (Select, Generate, and SelectAndGenerate) using the InlinePackage element, which uses the package/packet data to select and/or generate documents.

Request

Table 1. Method
Method URL Description
GET https://<hostname>/EZConfig/accounts/{accountId}/packageName/{packageName}?alias={alias} Used to pass the account ID ("accountId"), package name ("packageName"), and alias ("alias") to return XML formatted package data. The parameter values are validated to check that the accountId has access to the packageName and alias.
Table 2. Parameters
Name Type Constraints Description
packageName string required The "packageName" parameter is the name assigned to packages created in Expere EZ Config Packages and Packets.
accountId integer required The "accountId" parameter is used with the packageName and alias to find the correct package for the accountID packageName value provided. If the account value provided does not have permissions to the accountID provided, the response will return Http Status Code 400 (Bad Request) with a message "Authorization failed, user is not authorized for integration API."
alias string required The "alias" parameter is the content source alias. This parameter is used in combination with the accountId and packageName to retrieve the inline package data based on the packageName provided.

Response

The Documents response returns XML formatted package and packet data for the requested package name. Note that deleted packages are not included in the returned results.

Rules

  • Packets are returned in order based on created date (oldest -> newest).
  • Documents within each packet are ordered based on the sequential order set in the Packages and Packets application.
  • Metadata titles and values are entered in Expere EZ Config per each document in the package. If multiple rule sources are selected for a given document, the Metadata title and value is repeated per each document/rule source combination, but is included only once in the Expere Document Service response.
  • Barcode options are defined per package and resolved to the document level in the packet.
    • If Metadata titles are used in the barcode pattern, the Pattern element value is resolved to replace the metadata titles with the corresponding document metadata value.
    • If there are multiple copies requested for a document with barcode options defined, the barcode elements are repeated for each document copy in the packet.
  • Output Type option is defined per each packet.
    • For the Individual PDFs option, the OutputType element is not included in the response, as that is the default value for this option.
    • For the Merged PDF or Individual and Merged options, the AncillaryOutputOption OutputType is included for each PacketType element with values that correspond to the Merged PDF or Individual and Merged selections made on the Packet Details page.
    • For the RTF – Commercial Only option, the DocFormat attribute is included with each DocumentRef element.
  • Copies and watermarks defined at the packet are translated to the document level to support a different watermark for each copy of the document in the packet. If copies and watermarks are also set for a given document within the packet, those properties are used instead of the packet level. For each document included in the packet, the DocumentRef element is repeated for the number of copies specified. If a watermark is specified for a given copy, the DocumentRef element includes an AncillaryOutputOption OutputType=Watermark and corresponding elements for properties specified.

Response Message: the response message displays an HTTP Status Code of either 200, 400, 401, 403, 404, or 500 with the respective Reason.

HTTP Status Code Reason Response Model Headers
200 Success
400 Bad Request
Note: The Error Code 400 is returned if multiple packages are found based on the Account ID, Package Name, and Alias. Refer to the log for details.
Important: Do not use duplicate Package Names within a given alias across Lines of Business.

Sample Response Body: See Package.

Response Code: provides the user with the appropriate HTTP status code based on the request:

200

Response Headers: the response header provides 

{
  "date": "Thu, 07 Sep 2017 16:59:14 GMT",
  "server": "Kestrel",
  "x-powered-by": "ASP.NET",
  "transfer-encoding": "chunked",
  "content-type": "text/xml; charset=utf-8"
}