LinesOfBusiness

Overview

The LinesOfBusiness API returns a list of all lines of business associated with the Expere organization name. This API interrogates all Phas.xml files found in the content library for the Expere organization name specified and returns the lines of business in the response. It returns only the lines of business for the Expere organization name specified; it does not include lines of business from other precedence levels.

Request

Table 1. Method
Method	URL	Description
GET	https://<hostname>/PackagesAndPackets/api/v1/integration/accounts/{accountId}/expere/lineofbusiness/{expereOrgNameValue}	Used to pass in the Expere organization name ("expereOrgNameValue") to retrieve a list of the lines of business associated with the Expere organization.

Table 2. Parameters
Name	Type	Constraints	Description
expereOrgNameValue	string	required	The "expereOrgNameValue" parameter is used to determine which Expere content organization to interrogate to retrieve a list of lines of business. ("expereOrgNameValue" is a required parameter). If the parameter is not provided, the response message will return 404-Not Found . The “expereOrgNameValue” consists of the Account, Library Name, Version, and Expere Content Organization, which can be extracted from the Alias Destination (Long) Name. Example - Alias Destination Name: expere://1.LendingABC.201721.ORG.WoltersKluwerFinancialServices.Root/$1 The bolded portion of the Alias Destination Name is the expereOrgNameValue.
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).

Response

The LinesOfBusiness response returns the list of lines of business for the "expereOrgNameValue" parameter 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 lineOfBusinessID, lineOfBusinessName, and phasesDescription parameters within the response.

[
  {
    "lineOfBusinessID": "PHAS.HealthSavingsAccount",
    "lineOfBusinessName": "HealthSavingsAccount",
    "phasesDescription": "The Health Savings Account Line of Business consists of products to open and maintain consumer purpose Health Savings Accounts."
  },
  {
    "lineOfBusinessID": "PHAS.IndividualRetirementAccount",
    "lineOfBusinessName": "IndividualRetirementAccount",
    "phasesDescription": "The Individual Retirement Account Line of Business consists of products to opening and maintain consumer purpose Individual Retirement Accounts."
  },
  {
    "lineOfBusinessID": "PHAS.Deposit",
    "lineOfBusinessName": "Deposit",
    "phasesDescription": "The Deposit Line of Business consists of products covering checking, savings and other depository accounts for consumer and commercial purpose."
  }
]

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

Response Headers: the response header provides

{
  "date": "Mon, 31 Jul 2017 18:53:03 GMT",
  "server": "Kestrel",
  "x-powered-by": "ASP.NET",
  "transfer-encoding": "chunked",
  "content-type": "application/json; charset=utf-8"
}