Organization Logo Data by Organization Name

Overview

This API returns logo data configured for the requested Organization Name from the EZ Config Default Data application. 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.

This API is available for direct use, but the intended use case flow is for Expere Document Services (with or without usage of an EZ Config Packages and Packet Package) to use this API to obtain the logo configuration (when requested by Organization Name) and be able to apply the logo when generating documents.

Request

Table 1. Method
Method URL Description
GET https://<hostname>/DefaultData/api/v1/integration/accounts/{accountId}/logo?alias={alias}&lineOfBusiness={lineOfBusiness}&organizationName={organizationName} Used to pass in the accountId, alias, lineOfBusiness, and organizationName to retrieve 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 to validate the user credentials provided have permission to the account provided. If the account value provided does not have permission, the response will return Http Status Code 403 (Forbidden).
alias string (query) optional The "alias" parameter is the content source alias. This parameter is used in combination with the accountId and lineOfBusiness to retrieve the appropriate logo data based on the organizationName provided.
lineOfBusiness string (query) optional The "lineOfBusiness" parameter is used in combination with the accountId and alias 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, alias, and lineOfBusiness parameters to retrieve the logo configuration data for the organization requested.

Response

The response returns the logo configuration data defined in Default Data for the Account, Alias, Line of Business and Organization Name requested.

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

Response Body: provides the image, justification, placement, heightInInches, and widthInInches parameters within the response. 

{
    "image": "BASE64VALUEOFLOGOIMAGEFILE”,
    "justification": "Center",
    "placement": "FirstPageOnly",
    "heightInInches": .75
    "widthInInches": 1.25
}

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