Loan.asmx

ListClosingCostTemplateName

Return a list of closing cost template name.

public string ListClosingCostTemplateName(string sTicket)

Parameters

sTicket - Authentication string returned by AuthService.asmx.

Return Value

Return a xml string contains list of closing cost name.

Remark

Will throw exception if the user does not have permission to access closing cost template.

RetrieveClosingCostTemplateFeeList

Return non-zero fee set in the closing cost template.

public string RetrieveClosingCostTemplateFeeList(string sTicket, string closingCostName)

Parameters

sTicket - Authentication string returned by AuthService.asmx.

closingCostName - Name of the closing cost template to be retrieved

Return Value

Return a xml string contains list of non-zero fee in closing cost.

Example:

<closing_cost_template_fee_list gfe_version="Gfe2010">
  <fee line_number="801" description="Loan Origination Fee" percent_fee="1.000" percent_base="LoanAmount" base_dollar_fee="0.00" is_apr="True" is_fha="False" is_poc="False" is_paid_to_broker="False" gfe2010_section="B1" / >
  <fee line_number="802" description="Loan Discount" percent_fee="0.000" percent_base="TotalLoanAmount" base_dollar_fee="-500.00" is_apr="True" is_fha="False" is_poc="False" is_paid_to_broker="False" gfe2010_section="B2" / >
  <fee line_number="804" description="Appraisal Fee" percent_fee="0" percent_base="LoanAmount" base_dollar_fee="450.00" is_apr="False" is_fha="False" is_poc="False" is_paid_to_broker="False" gfe2010_section="B3" / >
  </ closing_cost_template_fee_list >

Attributes of Fee

line_number - The GFE Hudline number
description - Description of fee
percent_fee - Percentage fee
percent_base - Base amount for the percentage fee.

Possible Values:
- LoanAmount - Loan Amount
- SalesPrice - Purchase Price
- AppraisalValue - Appraised Value
- TotalLoanAmount - Loan Amount + UFMIP
base_dollar_fee - Dollar Amount Fee
is_apr - Is APR Item (True | False)
is_fha - Is FHA Allowable (True | False)
is_poc - Is POC (True | False)
is_paid_to_broker - Is Paid To Broker (True | False)
gfe2010_section - Section on the 2010 GFE

Possible Values:
- LeaveBlank
- B1 - Our Origination Charge
- B2 - Credit Or Charge
- B3 - Required Services that we select
- B4 - Title services or lender's title insurance
- B5 - Owner's title insurance
- B6 - Required services that you can shop for
- B7 - Government recording charges
- B8 - Transfer taxes
- B9 - Initial deposit for your escrow account
- B10 - Daily interest charges
- B11 - Homeowner's insurance
- NotApplicable -

Remark

Will throw exception if the user does not have permission to access closing cost template.

ClearModifiedLoanByName

Remove a particular loan name from the list of recently modified loans.

public void ClearModifiedLoanByName(string sTicket, string loanName)

Parameters

sTicket - Authentication string returned by AuthService.asmx.

loanName - Loan number to remove from modified file list

Return Value

Remark

Example

ClearModifiedLoansList

Clear the list of recently modified loans with a Modified Date older than the given date.

public void ClearModifiedLoansList(string sTicket, DateTime lastModifiedDate)

Parameters

sTicket - Authentication string returned by AuthService.asmx.

lastModifiedDate - Any loan with modified date before this will remove from the list.

Return Value

Remark

Example

Create

Create a new loan in MeridianLink Mortgage and return a generated loan name.

public string Create(string sTicket, string sTemplateNm)

Parameters

sTicket - Authentication string returned by AuthService.asmx.

sTemplateNm - Name of the loan template to create new loan from. If you want to create loan from blank template, then pass in empty string. If new loan is create base on existing template then sTemplateNm must match existing template name.

Return Value

A loan number of newly create file.

Remark

Example

CreateWithCalyxPointFile

Create a new loan from a Calyx Point file and return a generated loan name.

public string CreateWithCalyxPointFile(string sTicket, string base64content)

Parameters

sTicket - Authentication string returned by AuthService.asmx.

base64content - A content of Calyx Point file encode in base 64.

Return Value

A loan number of newly create file.

Remark

Example

CreateWithFannieMaeFile

Create a new loan from a Fannie Mae file and return a generated loan name.

public string CreateWithFannieMaeFile(string sTicket, string content)

Parameters

sTicket - Authentication string returned by AuthService.asmx.

content - A content of Fannie Mae file.

Return Value

A loan number of newly create file.

Remark

Example

CreateWithOptions

Create a new file in MeridianLink Mortgage.

public string CreateWithOptions(string sTicket, string optionsXml)

Parameters

sTicket - Authentication string returned by AuthService.asmx.

optionsXml - LOXml format, accepting the following fields, all of which are optional:

IsLead - A boolean value (true|false) indicating whether the created file should be a lead.
IsTestFile - A boolean value (true|false) indicating whether the created file should be a test file.
TemplateNm - A string value indicating the name of the template to create the file from.

Example:

<field id="IsLead"> true </field>
<field id="TemplateNm"> SampleTemplate </field>

</LOXmlFormat>

Return Value

LOXml loan result format, which will contain data about the created loan or a service error.

Example of successful creation:

<loan>

</loan>

</result>

</LOXmlFormat>

Example of service error:

<Error> Unable to find loan template. </Error>

</Errors>

</result>

</LOXmlFormat>

Remark

If no parameters are desired, optionsXml may be left blank.
In optionsXml, the fields IsLead and IsTestFile are mutually exclusive, meaning creation of test lead files is not currently supported.

GetAuditLog

Retrieves the audit logs for a loan in CSV format.

public string GetAuditLog(string authTicket, string loanNumber)

Parameters

authTicket - Authentication string returned by AuthService.asmx

sLNm - MeridianLink Mortgage Loan Number

Return Value

The audit log for the given loan in CSV format.

IsLoanExisted

Detect if loan number already existed.

public bool IsLoanExisted(string sTicket, string sLNm)

Parameters

sTicket - Authentication string returned by AuthService.asmx

sLNm - MeridianLink Mortgage Loan Number

Return Value

True if loan existed in the system.

Remark

Example

ListModifiedLoansByAppCode

Retrieve a list of recently modified loans. This method is used if the client wants to poll the LO/PML system on a fixed interval (try to keep this interval big) for recently modified files so that they can be imported into a 3rd-party LOS. THIS METHOD ONLY RETURN LOANS MODIFIED IN LAST 90 DAYS.

public string ListModifiedLoansByAppCode(string sTicket, string appCode)

Parameters

sTicket - Authentication string returned by AuthService.asmx.

appCode - Unique identifier of the modified loan list.

Return Value

An xml list of modified loans. The xml has following format.

<modified_loans>
                      <loan name="Loan Name" 
                      old_name="Old name if loan is delete" 
                      valid="True|False" 
                      aBNm="Borrower Full Name" 
                      sSpAddr="Property Address" 
                      LastModifiedD="Last Modified Date" />
        ...
        ...
                      </modified_loans>

Remark

The tracking of modified loan is not enabled by default. To have it enabled you need to contact our integration team, and they will turn on the tracking feature.

Example

Load

Retrieve loan file.

public string Load(string sTicket, string sLNm, string sXmlQuery, int format)

Parameters

sTicket - Authentication string returned by AuthService.asmx

sLNm - MeridianLink Mortgage Loan Number.

sXmlQuery - a xml defines the list of fields to be included in the response. Refer to lo_xmlquery_blank.xml for an example. Only applicable if format is LO XML Format. For other format just pass empty string

format - file format return by this method.

0 - LO XML Format

3 - Calyx Point Format

4 - Fannie Mae 3.2 Format

9 - MISMO 2.6 Format

Return Value

* If the return format is LO XML Format. See lo_xmlquery_data.xml for an example response.

* If the specified format is Calyx Point Format then it will return the following.

<PointFormat><Borrower><![CDATA[....Base64 string encode of .brw file.
                      ]]></Borrower><Coborrower><![CDATA[....Base64 string encode of .cb file. This element only exists if there is a coborrower.
                      ]]></Coborrower></PointFormat>

* If the specified format is Fannie Mae then it will return a text represent the Fannie Mae 3.2 format.
* If the specified format is MISMO 2.6 then it will return a MISMO 2.6 formatted XML string.

Remark

This function will throw an exception if an invalid loan number is passed in. Using the LO XML Format, you must specify a list of loan values that you are interested in. 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

string userName = "lo_user";
                      string password = "password";
      
      AuthService authService = new AuthService();
                      string sTicket = authService.GetUserAuthTicket(userName, password);
      
      Loan loanService = new Loan();
      
                      string sLNm = "xxxxx";
                      string sXmlQuery = GenerateXmlFieldList();
      
                      string ret = loanService.Load(sTicket, sLNm, sXmlQuery, 0);

PrepareLoanForResubmission

Change loan so user can re-run pricing.

public string PrepareLoanForResubmission(string sTicket, string sLNm)

Parameters

sTicket - Authentication string returned by AuthService.asmx

sLNm - MeridianLink Mortgage Loan Number

Return Value

Status string.
If PrepareLoanForResubmission without an error then following string will return.
<resultstatus="OK" />

If PrepareLoanForResubmission failed.
<resultstatus="Error" ><error>{ERROR MESSAGE HERE}</error></result>

Remark

Example

Save

Update the loan file with new information.

public string Save(string sTicket, string sLNm, string sDataContent, int format)

Parameters

sTicket - Authentication string returned by AuthService.asmx

sLNm - MeridianLink Mortgage Loan Number

sDataContent - LO XML format. See lo_xmlquery_data.xml for example. Only fields that need updating should be sent over.

format - file format of sDataContent. Currently only supports the LO XML format and Fannie Mae 3.2 format.

0 - LO XML Format

4 - Fannie Mae 3.2 Format

Return Value

Status string.
If save without an error then following string will return.
    <resultstatus="OK" />

If save okay but has warning then following string will return.
    <resultstatus="OKWithWarning" ><warning>{WARNING MESSAGE HERE}</warning></result>

If save failed.
    <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

GetPdfByLoanName

Retrieve a PDF document for a particular loan file.

public string GetPdfByLoanName(string sTicket, string sLNm, string sPdfName)

Parameters

sTicket - Authentication string returned by AuthService.asmx

sLNm - MeridianLink Mortgage Loan Number

sPdfName - Unique name of the PDF form. See a list of available forms at PDF List.

Return Value

The PDF content will encode in base64 format.

Remark

Example

RunQuickPricer

DEPRECATED - Use RunQuickPricerV1 in QuickPricer.asmx for new integrations.

public string RunQuickPricer(string sTicket, string sXmlData)

Parameters

sTicket - Authentication string returned by AuthService.asmx

sXmlData - Quick Pricer Format. See LOQuickPricerFormat.xsd

Return Value

Pricing Result in xml. See an example at SampleQuickPricerResult.xml

Remark

Example

UploadPDFDocument

[DEPRECATED] Please use the method in EDocsService.asmx instead.

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

Example

BreakBrokerRateLock

Breaks the broker rate lock on a specified loan.

public string BreakBrokerRateLock(string sTicket, string sLNm, string reason)

Parameters

sTicket - Authentication string returned by AuthService.asmx

sLNm - MeridianLink Mortgage Loan Number

reason - Reason for breaking the lock

Return Value

Status string.
If the rate lock is broken without an error then following string will be returned:
<resultstatus="OK" />

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

Remark

Example

GenerateClosestCounselingOrganization

Generates the 10 closest counseling organizations and populates them to the loan.

public string GenerateClosestCounselingOrganization(string sTicket, string sLNm)

Parameters

sTicket - Authentication string returned by AuthService.asmx

sLNm - MeridianLink Mortgage Loan Number

Return Value

XML string.
If the update was successful, an xml string in LOXml format will be returned with the new values for the settlementserviceproviders collection.

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

ConvertLeadToLoan

Convert a lead to a loan and return a loan number.

public string ConvertLeadToLoan(string sTicket, string sLNm, string sXmlData)

Parameters

sTicket - Authentication string returned by AuthService.asmx

sLNm - MeridianLink Mortgage Loan Number

sXmlData - LO XML format. Example below. {RemoveLeadPrefix VALUE} must be true or false. {sTemplateNm VALUE} is the string representation of the template name used in the conversion. This field can be empty if the settings are correct.

<field id="RemoveLeadPrefix"> {RemoveLeadPrefix VALUE} </field>
<field id="sTemplateNm"> {sTemplateNm VALUE} </field>

</LOXmlFormat>

Return Value

Status string.
If lead to loan conversion functions without an error then following string will return.
     <result status="OK" > <LoanNumber>{RETURNED LOAN NUMBER} </LoanNumber> </result>

If lead to loan conversion functions but has a warning then following string will return.
    <result status="OKWithWarning" > <Warnings> <Warning>{WARNING MESSAGE HERE} </Warning> </Warnings> <LoanNumber>{RETURNED LOAN NUMBER} </LoanNumber> </result>

If lead to loan conversion fails, the following string will return.
     <result status="Error"> <Errors> <Error>{ERROR MESSAGE HERE} </Error> </Errors> </result>