Package Name with Logo Data by Organization Name

Overview

This API mimics the Package Name with Logo Data by Organization ID logic. The only difference is in the request parameters. Organization names may be duplicated for different alias and line of business combinations; therefore, this API requires additional parameters along with the organization name to ensure the intended organization logo data is retrieved.

The Package Name with Logo Data (by Organization Name) 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 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 (derived based on Organization Name/Alias/Line of Business request parameters), 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.

Request

Table 1. Method
Method URL Description
GET https://<hostname>/EZConfig/accounts/{accountId}/packageName/{packageName}/logo?packageAlias={packageAlias}& organizationAlias={organizationAlias}&organizationLineOfBusiness={organizationLineOfBusiness}&organizationName={organizationName} Used to pass the accountId, packageName, packageAlias, organizationAlias, lineOfBusines, and OrganizationName to return XML formatted package data, including logo configuration data added as part of the Organization Policy setup in EZ Config Default Data.
Table 2. Parameters
Name Type Constraints Description
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."
packageName string required The "packageName" parameter is the name assigned to packages created in Expere EZ Config Packages and Packets.
packageAlias string (query) required The "packageAlias" 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.
organizationAlias string required The "organizationAlias" parameter is the identifier assigned to the Organization created in Expere EZ Config Default Data.
organizationLineOfBusiness string (query) required The "organizationLineOfBusiness " parameter is used in combination with the accountId, and organizationAlias parameters to retrieve the appropriate logo data based on the organizationName provided.
organizationName string (query) optional The "organizationName" parameter is used in combination with the accountId, organizationAlias, and lineOfBusiness parameters to retrieve the logo configuration data for the organization requested.

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.

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
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 Name

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