ListDocuments-Synchronous

Overview

The ListDocuments-Synchronous operation retrieves a list of the documents available in a given package (or LOB phase).

Table 1. Method
Method	URL	Description
POST	/api/v1/Document/account/{accountId}/ListDocuments	The POST method submits the accountId as part of the ListDocuments-Synchronous call

Table 2. Parameters
Name	Type	Constraints	Description
accountId	integer	required	The account used to associate to the request.
contentidentifier	string	required	A string identifying the type of content to be used
passthroughIdentifier	string	optional	The PassthroughIdentifier is an optional user-defined generated parameter. This parameter is case-sensitive. The PassthroughIdentifier MUST be unique for each request within a single Account and API call. If a PassthroughIdentifier has been submitted previously for an account and exists in the database, Expere Document Services will return the original transaction ID. A new transaction ID will not be created. If the PassthroughIdentifier is passed in the request and the parameter is empty (null), Expere Document Services will process the request and return a new transaction ID.
ExternalKey	string	Optional	An identifier defined by the requesting application and passed as a string value. It is typically used to supply an identifier or reference value for a given request and is mapped to the RequestID.
RequestID	string	Optional	A unique identifier for the submitted request. Often used for request tracking purposes.

Sample Request

{
    "ListDocuments": {
        "request": {
            "ContentIdentifier": "TestDynamic.PKG.HomeEquityClosing",
            "AccountIdentifier": "1",
            "PassthroughIdentifier": "MyPassThroughID"
        }
    }
}

Sample Response

{
    "ListDocumentsResult": {
        "PassthroughIdentifier": "MyPassThroughID",
        "Documents": [
            {
                "DocumentID": "PKGD.AssignmentOfRealEstateSecurityInstrument",
                "StoredDocID": "PKGD.AssignmentOfRealEstateSecurityInstrument".
                "DisplayName": "Assignment of Real Estate Security Instrument",
                "Type": "Dynamic",
                "Phase": "Mortgage2Closing",
                "PackageID": "PKG.Mortgage2Closing"
            },
            {
                "DocumentID": "PKGD.AuthorizationDocument",
                "StoredDocID": "PKGD.AuthorizationDocument".
                "DisplayName": "Authorization",
                "Type": "Dynamic",
                "Phase": "Mortgage2Closing",
                "PackageID": "PKG.Mortgage2Closing"
            }
        ]
     }
}