TradesAndPools.asmx

Methods:

LoadMortgagePool

Retrieve requested Mortgage Pool fields.

public string LoadMortgagePool(string sTicket, string poolId, string poolXmlQuery)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

poolId - The MeridianLink Mortgage pool ID.

poolXmlQuery - xml that defines the list of fields to be included in the response.

Return Value

The pool data in LO XML format.

Remark

This function will throw an exception if an invalid pool ID is passed in.

Example
LoadTrade

Retrieve requested Trade Fields and return trade data in LO XML format.

public string LoadTrade(string sTicket, string tradeNum, string tradeXmlQuery)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

tradeNum - The MeridianLink Mortgage trade number.

tradeXmlQuery - xml that defines the list of fields to be included in the response.

Return Value

The trade data in LO XML format.

Remark

This function will throw an exception if an invalid trade number is passed in.

Example
LoadTransaction

Retrieve requested Transaction Fields and return transaction data in LO XML format.

public string LoadTransaction(string sTicket, string transactionNum, string transactionXmlQuery)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

transactionNum - The MeridianLink Mortgage transaction number.

transactionXmlQuery - xml that defines the list of fields to be included in the response.

Return Value

The transaction data in LO XML format.

Remark

This function will throw an exception if an invalid transaction number is passed in.

Example
CreateMortgagePool

Create new Mortgage Pool and return the Pool ID of the newly created pool.

public string CreateMortgagePool(string sTicket)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

Return Value

The Pool ID of the newly created pool.

Remark

Example
CreateTrade

Create new Trade and return the Trade Number of the newly created trade.

public string CreateTrade(string sTicket)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

Return Value

The Trade number of the newly created trade.

Remark

Example
CreateTransaction

Create new Transaction and return the Transaction Number of the newly created transaction.

public string CreateTransaction(string sTicket, string tradeNum)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

tradeNum - The MeridianLink Mortgage trade number this transaction belongs to.

Return Value

The Transaction number of the newly created trade.

Remark

Example
SaveMortgagePool

Update a Mortgage Pool and return an XML response indicating the success of the operation.

public string SaveMortgagePool(string sTicket, string poolId, string poolDataContent)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

poolId - The MeridianLink Mortgage pool ID.

poolDataContent - LO XML format. Only fields that need updating should be sent over.

Return Value

Status string. Reports OK or ERROR status along with any warnings.

Remark

Example
SaveTrade

Update a Trade and return an XML response indicating the success of the operation.

public string SaveTrade(string sTicket, string tradeNum, string tradeXmlContent)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

tradeNum - The MeridianLink Mortgage trade number.

tradeXmlContent - LO XML format. Only fields that need updating should be sent over.

Return Value

Status string. Reports OK or ERROR status along with any warnings.

Remark

Example
SaveTransaction

Update a Trade and return an XML response indicating the success of the operation.

public string SaveTransaction(string sTicket, string transactionNum, string transactionXmlContent)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

transactionNum - The MeridianLink Mortgage transaction number.

transactionXmlContent - LO XML format. Only fields that need updating should be sent over.

Return Value

Status string. Reports OK or ERROR status along with any warnings.

Remark

Example
RemoveLoanFromPool

Removes loan from pool.

public string RemoveLoanFromPool(string sTicket, string loanName, string poolId)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

loanName - The MeridianLink Mortgage loan name.

poolId - The MeridianLink Mortgage pool ID.

Return Value

Status string. Reports OK or ERROR status.

Remark

Example
DisassociateTrade

Remove pool association from trade.

public string DisassociateTrade(string sTicket, string tradeNum)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

tradeNum - The MeridianLink Mortgage trade number.

Return Value

Status string. Reports OK or ERROR status.

Remark

Example
DeleteTransaction

Delete Transaction and remove from trade.

public string DeleteTransaction(string sTicket, string transactionNum)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

transactionNum - The MeridianLink Mortgage transaction number.

Return Value

Status string. Reports OK or ERROR status.

Remark

Example
LinkTransactionToTrade

Link Transaction to Trade.

public string LinkTransactionToTrade(string sTicket, string transactionNum, string tradeNum)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

transactionNum - The MeridianLink Mortgage transaction number.

tradeNum - The MeridianLink Mortgage trade number.

Return Value

Status string. Reports OK or ERROR status.

Remark

Example
UnlinkTransaction

Unlinks a Transaction.

public string UnlinkTransaction(string sTicket, string transactionNum)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

transactionNum - The MeridianLink Mortgage transaction number.

Return Value

Status string. Reports OK or ERROR status.

Remark

Example
ListPools

Search for Mortgage Pool that meet the criteria and return a list of pool IDs.

public string ListPools(string sTicket, int poolStatus, int poolAgency, int poolAmortizationType, string poolNumber, string poolId)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

poolStatus - 0 (Any) | 1 (Open) | 2 (Closed).

poolAgency - 0 (Any) | 1 (Fannie Mae) | 2 (Freddie Mac) | 3 (Ginnie Mae).

poolAmortizationType - 0 (Any) | 1 (Fixed) | 2 (ARM).

poolNumber - The full pool number, including any prefixes or suffixes. Leave blank to match all.

poolId - The pool id. Leave blank to match all.

Return Value

A list of pool IDs that meet the search criteria.

Remark

Example
ListTrades

List trade numbers that meet the search criteria.

public string ListTrades(string sTicket, int tradeStatus, string tradeSecurity, int tradeSecurityType, int tradeContractType, int tradeSettlementMonth, string tradeCoupon, string tradeNum)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

tradeStatus - 0 (Any) | 1 (Open) | 2 (Closed).

tradeSecurity - Trade security description.

tradeSecurityType - 0 (Any) | 1 (TBA) | 2 (Call) | 3 (Put).

tradeContractType - 0 (Any) | 1 (Buy) | 2 (Sell).

tradeSettlementMonth - 0 (Any) | 1 (Jan) | 2 (Feb) | ... | 12 (Dec).

tradeCoupon - The coupon rate of the trade.

tradeNum - The trade number. Leave blank to match all numbers.

Return Value

Search for Trades that meet the criteria and return a list of trade numbers.

Remark

Example