EDocsService.asmx

Methods:

ListDocTypes

Retrieves a list of EDocs Doctypes the user has access to.

public string ListDocTypes(string sTicket)
Parameters
sTicket - Ticket returned by AuthService.asmx.
Return Value
An LOXML formatted string. The result includes a status attribute [ERROR | COMPLETE]. ERROR responses include an error message. COMPLETE responses include an LOXML list of DocTypes.
Remark
If the DocType list is successfully retrieved then the following is the response format:
     <LOXmlFormatversion="1.0">
     <resultstatus="COMPLETE">
         <docType>
             <id>{The ID of the DocType}</id>
             <docTypeName>{The name of the DocType}</docTypeName>
             <folderName>{The name of the folder holding the DocType}</folderName>
         </docType>
         
     </result>
     </LOXmlFormat>

If an error occurs then the following is the response format:
     <LOXmlFormatversion="1.0">
     <resultstatus="ERROR">
     <message>{ERROR MESSAGE HERE}</message>
     </result>
     </LOXmlFormat>
UploadPDFDocument

Adds the PDF document to the specified loan file's EDocs repository.

public string UploadPDFDocument(string sTicket, string sLNm, string documentType, string notes, string sDataContent)
Parameters
sTicket - Authentication string returned by AuthService.asmx
sLNm - MeridianLink Mortgage Loan Number
documentType - The PDF file's document type name
notes - Notes to attach to the PDF document
sDataContent - The PDF content encoded in base 64.
Return Value
Status string.
If the operation saves without an error then following string will be returned:
<resultstatus="OK" />

If the save failed, the following string will be returned:
<resultstatus="Error" ><error>{ERROR MESSAGE HERE}</error></result>

Remark

The loan number will be used as a unique id between MeridianLink Mortgage and the 3rd party system. Therefore, the user should proceed with extra care when changing the loan number in MeridianLink Mortgage.

Example
UploadPDFDocumentToApp

Adds the PDF document to the EDocs repository of a specified loan on the specified app.

public string UploadPDFDocumentToApp(string sTicket, string sLNm, Guid aAppId, string documentType, string notes, string sDataContent)
Parameters
sTicket - Authentication string returned by AuthService.asmx
sLNm - MeridianLink Mortgage Loan Number
aAppId - The Application Id to contain the file.
documentType - The PDF file's document type name
notes - Notes to attach to the PDF document
sDataContent - The PDF content encoded in base 64.
Return Value
Status string.
If the operation saves without an error then following string will be returned:
<resultstatus="OK" />

If the save failed, the following string will be returned:
<resultstatus="Error" ><error>{ERROR MESSAGE HERE}</error></result>

Remark

The loan number will be used as a unique id between MeridianLink Mortgage and the 3rd party system. Therefore, the user should proceed with extra care when changing the loan number in MeridianLink Mortgage.

Example
UploadPDFDocumentAsService

Adds the PDF document to the specified loan file's EDocs repository as a service.

public string UploadPDFDocumentAsService(string sTicket, string sLNm, string documentType, string notes, string sDataContent, TypeOfService serviceType)
Parameters
sTicket - Authentication string returned by AuthService.asmx
sLNm - MeridianLink Mortgage Loan Number
documentType - The PDF file's document type name
notes - Notes to attach to the PDF document
sDataContent - The PDF content encoded in base 64.
serviceType - The type of service currently in use

Return Value
Status string.
If the operation saves without an error then following string will be returned:
<resultstatus="OK" />

If the save failed, the following string will be returned:
<resultstatus="Error" ><error>{ERROR MESSAGE HERE}</error></result>

Remark

The loan number will be used as a unique id between MeridianLink Mortgage and the 3rd party system. Therefore, the user should proceed with extra care when changing the loan number in MeridianLink Mortgage.

Example
UploadPDFDocumentToAppAsService

Adds the PDF document to the specified loan file's EDocs repository on the specified app as a service.

public string UploadPDFDocumentToAppAsService(string sTicket, string sLNm, Guid aAppId, string documentType, string notes, string sDataContent, TypeOfService serviceType)
Parameters
sTicket - Authentication string returned by AuthService.asmx
sLNm - MeridianLink Mortgage Loan Number
aAppId - The Application Id to contain the file.
documentType - The PDF file's document type name
notes - Notes to attach to the PDF document
sDataContent - The PDF content encoded in base 64.
serviceType - The type of service currently in use

Return Value
Status string.
If the operation saves without an error then following string will be returned:
<resultstatus="OK" />

If the save failed, the following string will be returned:
<resultstatus="Error" ><error>{ERROR MESSAGE HERE}</error></result>

Remark

The loan number will be used as a unique id between MeridianLink Mortgage and the 3rd party system. Therefore, the user should proceed with extra care when changing the loan number in MeridianLink Mortgage.

Example
DownloadEdocsByShippingTemplate

Returns a PDF document containing EDocs on the given loan file. Does not preserve electronic signatures.

public byte[] DownloadEdocsByShippingTemplate(string sTicket, string sShippingTemplateName, string sLNm, bool includeScreenedDocs, bool includeDocsWithoutStatus)
Parameters

sTicket - Authentication string returned by AuthService.asmx

sShippingTemplateName - The shipping template determining which EDocs to include

sLNm - The MeridianLink Mortgage Loan Number for the loan file from which to download the EDocs

includeScreenedDocs - Whether to include EDocs with a status of "Screened"

includeDocsWithoutStatus - Whether to include EDocs with no status

Return Value

A PDF document containing the processed EDocs, encoded in base 64.

Remark

The loan number will be used as a unique id between MeridianLink Mortgage and the 3rd party system. Therefore, the user should proceed with extra care when changing the loan number in MeridianLink Mortgage.

Example
DownloadEdocsPdfById

Downloads a requested EDoc in PDF, specified by its GUID.

public byte[] DownloadEdocsPdfById(string sTicket, Guid docId)
Parameters

sTicket - Authentication string returned by AuthService.asmx

docId - The ID of the document to download

Return Value

A PDF document of the requested EDoc, encoded in base 64.

Remark

Example

ListEdocsByLoanNumber

Lists the EDocs on a loan file.

public string ListEdocsByLoanNumber(string sTicket, string sLNm)

Parameters

sTicket - Authentication string returned by AuthService.asmx

sLNm - The MeridianLink Mortgage Loan Number for the loan file from which to get the list of EDocs

Return Value

An XML string representing the EDocs on the loan. The XML has the following format:

                    <result status="OK">
                    <list>
                    <edoc docid={GUID representing EDoc}
                    doc_type={Document Type} 
                    folder_name={Folder Name} 
                    application={Application Name} 
                    description={EDoc description} 
                    doc_type_id={An integer representing the Document Type}
                    doc_status={An integer representing the Document Status}
                    created_date={The Document's Creation Date}/ >
                    <edoc docid=.../ >
                    <edoc docid=.../ >
                      ...
                    </list>
                    </result>

In the case of an error, the XML will be in the following format:

                    <result status="ERROR">
                    <error>{Description of Error}</error>
                    </result>

Remark

The loan number will be used as a unique id between MeridianLink Mortgage and the 3rd party system. Therefore, the user should proceed with extra care when changing the loan number in MeridianLink Mortgage.

Example

ListEdocsByReferenceNumber

Lists the EDocs on a loan file.

public string ListEdocsByReferenceNumber(string authTicket, string loanRefNum)

Parameters

authTicket - Authentication string returned by AuthService.asmx

loanRefNum - The MeridianLink Mortgage Loan Reference Number for the loan file from which to get the list of EDocs

Return Value

An XML string representing the EDocs on the loan. The XML has the following format:

                    <result status="OK">
                    <list>
                    <edoc docid={GUID representing EDoc}
                    doc_type={Document Type} 
                    folder_name={Folder Name} 
                    application={Application Name} 
                    description={EDoc description} 
                    doc_type_id={An integer representing the Document Type}
                    doc_status={An integer representing the Document Status}
                    created_date={The Document's Creation Date}/ >
                    <edoc docid=.../ >
                    <edoc docid=.../ >
                      ...
                    </list>
                    </result>

In the case of an error, the XML will be in the following format:

                    <result status="ERROR">
                    <error>{Description of Error}</error>
                    </result>

Example

ListModifiedEDocsByAppCode

Gives a list of recently modified EDocs.

public string ListModifiedEDocsByAppCode(string sTicket, string appCode, string modifiedDate)

Parameters

sTicket - Authentication string returned by AuthService.asmx

appCode - Appcode for the EDocs

modifiedDate - This method returns EDocs modified after this date.

Return Value

An XML string containing a list of recently modified EDocs. The XML will be in the following format:

                    <modified_edocs last_modified_date={Time that the last modified EDoc was modified}>
                    <eDoc LoanNumber={Loan Number}
                    FolderName={Folder Name} 
                    DocTypeName={Document Type Name} 
                    BorrowerName={Borrower Name} 
                    Description={EDoc Description} 
                    Comment={Comments on EDoc} 
                    NumPages={Number of Pages}
                    LastModifiedDate={Date the EDoc was last modified} 
                    DocumentId={A Unique ID for the EDoc} 
                    <eDoc LoanNumber=.../ >
                    <eDoc LoanNumber=.../ >
                    ...
                    </modified_edocs>

Remark

Example