Document

Overview

The Document API returns a response that contains documents corresponding phases (autoselection rule sources) for the specified Expere content organization and line of business.

Request

Table 1. Method
Method	URL	Description
GET	https://<hostname>/PackagesAndPackets/api/v1/integration/accounts/{accountId}/Documents/{expereOrgNameValue}/{expereLobId}/{phaseId}	Used to return a list of documents for a specific phase within an Expere organization and line of business.

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 the list of phases (packages) for the line of business Id (expereLobId) specified. ("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.
expereLobId	string	required	The "expereLobId" parameter is used in conjunction with the "expereOrgNameValue" to retrieve the list of phases associated to the line of business ID specified ("expereLobId" is a required parameter). 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
phaseId	string (query)	optional	The "phaseID" parameter is optional. Use this field to return a list of documents for the specified Expere organization/LOB/phase. If left null, all documents for all phases for the Expere org/LOB specified are returned.
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 Document response returns the list of 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 documentID and phaseName parameters within the response.

[
  {
    "documentId": 0,
    "documentName": "PKGD.CertificationOfBeneficialOwnersDeposit",
    "ruleSource": "IndividualRetirementAccount_AccountOpening",
    "packageId": 0,
    "displayName": "Certification Of Beneficial Owners Deposit"
  },
  {
    "documentId": 0,
    "documentName": "PKGD.CustomerInformation",
    "ruleSource": "IndividualRetirementAccount_AccountOpening",
    "packageId": 0,
    "displayName": "Customer Information"
  },
  {
    "documentId": 0,
    "documentName": "PKGD.Application",
    "ruleSource": "IndividualRetirementAccount_AccountOpening",
    "packageId": 0,
    "displayName": "Application"
  }
]

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

Response Headers: the response header provides

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