Package Name with Logo Data by Organization ID

Overview

The Package Name with Logo Data API returns XML formatted data for a specified package name 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 name 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 Name API logic and includes additional processing to obtain logo configuration defined with the organization in Default Data.

Request

Table 1. Method
Method URL Description
GET https://<hostname>/EZConfig/accounts/{accountId}/packageName/{packageName}/organizations/{organizationId}?alias={alias} Used to pass the account ID ("accountId"), package name ("packageName"), organization ID (“organziationId”), and alias ("alias") 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 packageName.
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."
organizationId integer required The “organizationId” parameter is a unique identifier assigned to the Organization created in Expere EZ Config Default Data.
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 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 Name 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, 400, 401, 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 with Logo Data by Organization ID

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

200

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