Products For Account

Overview

The products API returns a list of products for the specified account ID from the Expere EZ Config Default Data application. The list includes all products that exist for any content source aliases and line of business combination to which the account has access.

Request

Table 1. Method
Method URL Description
GET https://<hostname>/DefaultData/api/v1/integration/accounts/{accountId}/products?alias={alias}&lineOfBusiness={lineOfBusiness} Used to pass in the user's account ID ("accountId") to retrieve a list of products.
The following request parameter combinations may be used:
  • accountId
  • accountId and alias
  • accountId, alias, and lineOfBusiness
Table 2. Parameters
Name Type Constraints Description
accountID integer required The "accountID" parameter is used to retrieve a list of products associated with the user's account.
alias string (query) optional The "alias" parameter is the content source alias and can be used in combination with the accountId parameter to retrieve a list of products for the specified values.
lineOfBusiness string (query) optional The "lineOfBusiness" parameter can be used in combination with the accountId and alias parameters to retrieve a list of products for the specified values.
Note: The use of the lineOfBusiness parameterwithout the alias parameter is not supported and will be ignored.

Response

The products response returns the list of products through the parameters supplied in the request. Note that deleted products 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

Response Body: provides the productId, productName, alias and lineOfBusiness parameters within the response. 

[
  {
    "productId": 2,
    "productName": "2-year Revolving POD",
    "alias": "expere://CommercialR1\\.(.*)",
    "lineOfBusiness": "Commmercial"
  },
  {
    "productId": 5,
    "productName": "10-Year Term Fixed",
    "alias": "expere://CommercialR1\\.(.*)",
    "lineOfBusiness": "Commmercial"
  },
  {
    "productId": 9,
    "productName": "Working Capital LOC",
    "alias": "expere://CommercialR1\\.(.*)",
    "lineOfBusiness": "Commmercial"
  }
]

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-cache
  content-type: application/json; charset=utf-8
  date: Fri, 02 Nov 2018 13:50:02 GMT
  pragma: no-cache
  server: Kestrel
  transfer-encoding": "chunked",
  x-frame-options: DENY
  x-powered-by: ASP.NET