Phases(Packages)

Overview

The Phases(Packages) API returns a list of phases (packages) for the specified alias, line of business ID, and account ID. This API interrogates all Phas.[LOB].xml files found in the content library for the Expere organization name specified and returns the phases (packages) in the response for the specified Line of Business ID. The API first looks at the Expere organization name specified and returns phases (packages) from the phas.[LOB].xml. It also walks up the Expere organization content hierarchy and includes phases (packages) for phas.[LOB].xml files that do not exist at the specified Expere organization name.

Request

Table 1. Method
Method	URL	Description
GET	https://<hostname>/PackagesAndPackets/api/v1/integration/accounts/{accountId}/expere/phase?aliasShortName={aliasShortName}&expereLobId={expereLobId}	Used to pass in the alias ("aliasShortName"), line of business ("expereLobId"), and account ID ("accountId") to retrieve a list of phases (packages). The parameter values are validated to check that the accountId has access to the alias and expereLobId.

Table 2. Parameters
Name	Type	Constraints	Description
aliasShortName	string (query)	optional	The "aliasShortName" parameter is used to obtain the Alias Destination Name used as input to the request to determine which Expere content library to interrogate to retrieve the list of phases (packages) for the line of business Id (expereLobId). If the parameter is not provided, the response message will return 404-Not Found.
expereLobId	string (query)	optional	The "expereLobId" parameter is used in conjunction with the "aliasShortName" to retrieve the list of phases associated to the line of business ID specified. If the parameter is not provided, the response message will return 404-Not Found. Note: this parameter is the ID which requires the "PHAS." prefix. Example: PHAS.Mortgage2Upfront
accountId	integer	required	The "accountID" parameter is used to retrieve a list of aliases associated with the user's account. The "accountId" parameter is used to validate that the accnoount provided has permissions to the alias and expereLobId values provided. If the account value provided does not have permission, the response will return Http Status Code 403 (Forbidden).

Response

The GetListOfPhases response returns the list of phases (packages) through the parameters supplied in the request.

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 phaseDescription, fromOppsa, name, and packageID parameters within the response.

[
  {
    "phaseDescription": "Content that is utilized in workflows that support working with customers to apply for and open accounts.",
    "name": "HealthSavingsAccount_AccountOpening",
    "packageID": "PKG.HealthSavingsAccount_AccountOpening"
  },
  {
    "phaseDescription": "Content that is utilized in workflows that support working with customers to apply for and open Plan and Deposit accounts.",
    "name": "Plan_AccountOpening",
    "packageID": "PKG.Plan_AccountOpening"
  },
  {
    "phaseDescription": "Content that is utilized to accept a contribution into an existing HSA.",
    "name": "HealthSavingsAccount_Contribution",
    "packageID": "PKG.HealthSavingsAccount_Contribution"
  },
  {
    "phaseDescription": "Content that is utilized to document a distribution from an HSA.",
    "name": "HealthSavingsAccount_Distribution",
    "packageID": "PKG.HealthSavingsAccount_Distribution"
  },
  {
    "phaseDescription": "Content that is utilized to request a transfer or direct rollover from another HSA or IRA.",
    "name": "HealthSavingsAccount_RequestAssets",
    "packageID": "PKG.HealthSavingsAccount_RequestAssets"
  },
  {
    "phaseDescription": "Content that is utilized to make an account change such as designate or change a beneficiary.",
    "name": "HealthSavingsAccount_AccountServicing",
    "packageID": "PKG.HealthSavingsAccount_AccountServicing"
  }
]

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": "Thu, 27 Jul 2017 20:17:33 GMT",
  "server": "Kestrel",
  "x-powered-by": "ASP.NET",
  "transfer-encoding": "chunked",
  "content-type": "application/json; charset=utf-8",
  "cache-control": "no-cache",
  "expires": "-1"
}