Packages For Account

Overview

The Packages For Account API returns a list of packages for the specified account ID from the Expere EZ Config Packages and Packets application. The list includes all packages that exist for any content source aliases to which the account has access.

Request

Table 1. Method
Method	URL	Description
GET	https://<hostname>/PackagesAndPackets/api/v1/integration/accounts/{accountId}/package	Used to pass in the account ID ("accountId") to retrieve a list of packages.

Table 2. Parameters
Name	Type	Constraints	Description
accountId	integer	required	The "accountId" parameter is used to retrieve a list of packages associated with the user's account.

Response

The PackagesForAccount response returns the list of packages through the parameters supplied in the request. 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, 403, 404, or 500 with the respective Reason.


HTTP Status Code	Reason	Response Model	Headers
200	Success

Response Body: provides the packageId, packageName, accountID, lob, contentSourceAlias, and status parameters within the response.

[
  {
    "packageId": 2,
    "packageName": "DepositAccountOpening",
    "accountId": 4,
    "lob": "Deposit",
    "lobId": "Deposit",
    "aliasLongName": "expere://4.Deposit.201731.ORG.WoltersKLuwerFinancialServices.Root/$1",
    "status": false,
    "contentPackageId": "PKG.DepositAccountOpening",
    "aliasShortName": "expere://DepositR1\\.(.*)",
    "expereOrgName": "4.Deposit.201731.ORG.WoltersKluwerFinancialServices.Root"
  },
  {
    "packageId": 3,
    "packageName": "Plan_AccountOpening",
    "accountId": 4,
    "lob": "Deposit",
    "lobId": "Deposit",
    "aliasLongName": "expere://4.Deposit.201731.ORG.WoltersKLuwerFinancialServices.Root/$1",
    "status": false,
    "contentPackageId": "PKG.Plan_AccountOpening",
    "aliasShortName": "expere://DepositR1\\.(.*)",
    "expereOrgName": "4.Deposit.201731.ORG.WoltersKluwerFinancialServices.Root"
  }
]

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

Response Headers: the response header provides

{
  "pragma": "no-cache",
  "date": "Tue, 08 Aug 2017 20:16:38 GMT",
  "server": "Kestrel",
  "x-powered-by": "ASP.NET",
  "transfer-encoding": "chunked",
  "content-type": "application/json; charset=utf-8",
  "cache-control": "no-cache",
  "expires": "-1"
}