Package with Logo Data by Organization ID

Overview

The Package with Logo Data API returns XML formatted data for a specified package ID from the Expere EZ Config Packages and Packets application and includes logo data for a specified Organization ID from the Default Data application. This API gathers all package and packet data for the given package ID and logo configuration data for the given organization ID, and formats the data 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. This API mimics the Package API logic and includes additional processing to obtain logo configuration defined with the organization in Default Data (calls Organization Logo Data by Organization Id API).

Request

Table 1. Method
Method	URL	Description
GET	https://<hostname>/EZConfig/accounts/{accountId}/packages/{packageId}/organizations/{organizationId}	Used to pass the account ID ("accountId"), package ID ("packageId"), and organization ID (“organizationId”) to return XML formatted package data including logo configuration data added as part of the Organization Policy setup in EZ Config Default Data. The parameter values are validated to check that the accountId has access to the packageId.

Table 2. Parameters
Name	Type	Constraints	Description
packageId	integer	required	The "packageId" parameter is a unique identifier assigned to packages created in Expere EZ Config Packages and Packets.
accountId	integer	required	The "accountId" parameter is used to validate that the account provided has permissions to the packageId value provided. If the account value provided does not have permissions to the packageId, the response will return Http Status Code 403 (Forbidden).
organizationId	integer	required	The “organizationId” parameter is a unique identifier assigned to the Organization created in Expere EZ Config Default Data.

Response

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

Rules

This API applies the same rules as outlined in the Package API. In addition, this API applies the following rules to add Logo data:

Logo configuration is defined per organization in Default Data and resolved to the document level in the packet. The DocumentRef element includes an AncillaryOutputOption OutputType=Logo and corresponding elements for properties specified.
The Logo AncillaryOutputOption and corresponding elements will not be added in the following cases:
- The requested organization does not have a logo defined in Default Data.
- The requested package has the logo toggle set to OFF for a given Package document in Packages and Packets.

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


HTTP Status Code	Reason	Response Model	Headers
200	Success

Sample Response Body: This is a sample response showing data that includes OutputType, copies, watermark options, barcode options, and logo options. In the DocumentRef element for documents in the packet, the AncillaryOutputOption is included for each of these options. In this sample response, the Package Document PKGD.TermsAndConditions has the logo toggle set of OFF; therefore, the output options for logo are not included for this document in either packet.

<InlinePackage xmlns="http://schemas.bankerssystems.com/2004/ExpereAPI/ExpereIEServices">
	<InlinePackageDocs>
		<InlinePackageDoc>
			<PackageDocName>PKGD.RegEDisclosure</PackageDocName>
			<SourcePackageName>PKG.DepositAccountOpening</SourcePackageName>
		</InlinePackageDoc>
		<InlinePackageDoc>
			<PackageDocName>PKGD.TermsAndConditions</PackageDocName>
			<SourcePackageName>PKG.DepositAccountOpening</SourcePackageName>
		</InlinePackageDoc>
	</InlinePackageDocs>
	<PacketTypes>
		<PacketType PacketName="Packet1-IndividualPDFs-1Copy">
			<DocumentRefs>
				<DocumentRef DocumentID="PKGD.RegEDisclosure">
					<AncillaryOutputOption>
						<OutputType>Barcode</OutputType>
						<Barcode>
							<Type>barcode2D</Type>
							<Pattern>Page_%page%_DocID_PR3</Pattern>
							<UseCoverPage>true</UseCoverPage>
							<FirstPageOnly>false</FirstPageOnly>
							<HorizontalAlignment>Center</HorizontalAlignment>
						</Barcode>
					</AncillaryOutputOption>
					<AncillaryOutputOption>
						<OutputType>Watermark</OutputType>
						<Watermark>
							<Text>Copy</Text>
							<Location>center</Location>
							<Rotate>true</Rotate>
						</Watermark>
					</AncillaryOutputOption>
					<AncillaryOutputOption>
						<OutputType>Logo</OutputType>
						<Logo>
							<Image>iVBORw0KGgoAAAANSUhEUgAAA…</Image>
							<Justification>Center</Justification>
							<Placement>AllPages</Placement>
							<HeightInches>1.25</HeightInches>
						</Logo>
					</AncillaryOutputOption>					
				</DocumentRef>
				<DocumentRef DocumentID="PKGD.TermsAndConditions">
					<AncillaryOutputOption>
						<OutputType>Barcode</OutputType>
						<Barcode>
							<Type>barcode2D</Type>
							<Pattern>Page_%page%_DocID_PR3</Pattern>
							<UseCoverPage>true</UseCoverPage>
							<FirstPageOnly>false</FirstPageOnly>
							<HorizontalAlignment>Center</HorizontalAlignment>
						</Barcode>
					</AncillaryOutputOption>
					<AncillaryOutputOption>
						<OutputType>Watermark</OutputType>
						<Watermark>
							<Text>Copy</Text>
							<Location>center</Location>
							<Rotate>true</Rotate>
						</Watermark>
					</AncillaryOutputOption>
				</DocumentRef>
			</DocumentRefs>
		</PacketType>
		<PacketType PacketName="Packet2-MergedPDF-2Copies">
			<AncillaryOutputOption>
				<OutputType>PdfMerge</OutputType>
			</AncillaryOutputOption>
			<DocumentRefs>
				<DocumentRef DocumentID="PKGD.RegEDisclosure">
					<AncillaryOutputOption>
						<OutputType>Barcode</OutputType>
						<Barcode>
							<Type>barcode2D</Type>
							<Pattern>Page_%page%_DocID_PR3</Pattern>
							<UseCoverPage>true</UseCoverPage>
							<FirstPageOnly>false</FirstPageOnly>
							<HorizontalAlignment>Center</HorizontalAlignment>
						</Barcode>
					</AncillaryOutputOption>
					<AncillaryOutputOption>
						<OutputType>Watermark</OutputType>
						<Watermark>
							<Text>Lender Copy</Text>
							<Location>top</Location>
							<Rotate>false</Rotate>
						</Watermark>
					</AncillaryOutputOption>
					<AncillaryOutputOption>
						<OutputType>Logo</OutputType>
						<Logo>
							<Image>iVBORw0KGgoAAAANSUhEUgAAA…</Image>
							<Justification>Center</Justification>
							<Placement>AllPages</Placement>
							<HeightInches>1.25</HeightInches>
						</Logo>
					</AncillaryOutputOption>					
				</DocumentRef>
				<DocumentRef DocumentID="PKGD.RegEDisclosure">
					<AncillaryOutputOption>
						<OutputType>Barcode</OutputType>
						<Barcode>
							<Type>barcode2D</Type>
							<Pattern>Page_%page%_DocID_PR3</Pattern>
							<UseCoverPage>true</UseCoverPage>
							<FirstPageOnly>false</FirstPageOnly>
							<HorizontalAlignment>Center</HorizontalAlignment>
						</Barcode>
					</AncillaryOutputOption>
					<AncillaryOutputOption>
						<OutputType>Watermark</OutputType>
						<Watermark>
							<Text>Customer Copy</Text>
							<Location>bottom</Location>
							<Rotate>false</Rotate>
						</Watermark>
					</AncillaryOutputOption>
					<AncillaryOutputOption>
						<OutputType>Logo</OutputType>
						<Logo>
							<Image>iVBORw0KGgoAAAANSUhEUgAAA…</Image>
							<Justification>Center</Justification>
							<Placement>AllPages</Placement>
							<HeightInches>1.25</HeightInches>
						</Logo>
					</AncillaryOutputOption>					
				</DocumentRef>
				<DocumentRef DocumentID="PKGD.TermsAndConditions">
					<AncillaryOutputOption>
						<OutputType>Barcode</OutputType>
						<Barcode>
							<Type>barcode2D</Type>
							<Pattern>Page_%page%_DocID_PR3</Pattern>
							<UseCoverPage>true</UseCoverPage>
							<FirstPageOnly>false</FirstPageOnly>
							<HorizontalAlignment>Center</HorizontalAlignment>
						</Barcode>
					</AncillaryOutputOption>
					<AncillaryOutputOption>
						<OutputType>Watermark</OutputType>
						<Watermark>
							<Text>Lender Copy</Text>
							<Location>top</Location>
							<Rotate>false</Rotate>
						</Watermark>
					</AncillaryOutputOption>
				</DocumentRef>
				<DocumentRef DocumentID="PKGD.TermsAndConditions">
					<AncillaryOutputOption>
						<OutputType>Barcode</OutputType>
						<Barcode>
							<Type>barcode2D</Type>
							<Pattern>Page_%page%_DocID_PR3</Pattern>
							<UseCoverPage>true</UseCoverPage>
							<FirstPageOnly>false</FirstPageOnly>
							<HorizontalAlignment>Center</HorizontalAlignment>
						</Barcode>
					</AncillaryOutputOption>
					<AncillaryOutputOption>
						<OutputType>Watermark</OutputType>
						<Watermark>
							<Text>Customer Copy</Text>
							<Location>bottom</Location>
							<Rotate>false</Rotate>
						</Watermark>
					</AncillaryOutputOption>
				</DocumentRef>
			</DocumentRefs>
		</PacketType>
	</PacketTypes>
</InlinePackage>

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

Response Headers: the response header provides


  
  cache-control: no-store,no-cache
  content-type: application/json; charset=utf-8
  date: Fri, 30 Aug 2019 13:50:02 GMT
  pragma: no-cache
  server: Kestrel
  transfer-encoding": "chunked",
  x-frame-options: SAMEORIGIN
  x-powered-by: ASP.NET