Reporting.asmx

Methods:

AddBatchExportToQueue

Add a batch export to the batch export queue.

public string AddBatchExportToQueue(string sTicket, string sCustomReportName, string sBatchExportType)
Parameters

sTicket - Ticket returned by AuthService.asmx.

sCustomReportName - The name of the MeridianLink Mortgage custom report to use to determine which loans to include in the batch export. Data contents of the export will be determined by the batch export format.

sBatchExportType - The type of batch export to run. The type is included in the corresponding link within the Batch Export Report Formats list in MeridianLink Mortgage.

    Example - Batch export format: NC Call Report; sBatchExportType: NCCallReport

Return Value

An LOXML formatted string. The result includes a status attribute [ERROR | OK]. ERROR responses include an error message. OK responses include a batchExportID.

Remark

If the batch export is successfully queued up then the following is the response format:
    <LOXmlFormat version="1.0">
    <result status="OK">
    <batchExportID>[0-9A-Z]{3}-[0-9A-Z]{4}-[0-9A-Z]{4} </batchExportID>
    </result>
    </LOXmlFormat>

Example batchExportID: AGO-ER3C-M74X

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

Pass the batchExportID to the RetrieveBatchExport method to get the result.
AddBatchExportToQueueWithLoanList

Add a batch export to the batch export queue.

public string AddBatchExportToQueueWithLoanList(string sTicket, string sLoanList, string sBatchExportType)
Parameters

sTicket - Ticket returned by AuthService.asmx.

sLoanList - An LOXML formatted list of MeridianLink Mortgage loan files to include in the batch export. Example LOXML loan list

sBatchExportType - The type of batch export to run. The type is included in the corresponding link within the Batch Export Report Formats list in MeridianLink Mortgage.

    Example - Batch export format: NC Call Report; sBatchExportType: NCCallReport

Return Value

An LOXML formatted string. The result includes a status attribute [ERROR | OK]. ERROR responses include an error message. OK responses include a batchExportID.

Remark

If the batch export is successfully queued up then the following is the response format:
    <LOXmlFormat version="1.0">
    <result status="OK">
    <batchExportID>[0-9A-Z]{3}-[0-9A-Z]{4}-[0-9A-Z]{4} </batchExportID>
    </result>
    </LOXmlFormat>

Example batchExportID: AGO-ER3C-M74X

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

Pass the batchExportID to the RetrieveBatchExport method to get the result.
RetrieveBatchExport

Retrieve the status and contents of a batch export that was previously queued.

public string RetrieveBatchExport(string sTicket, string sBatchExportID)
Parameters

sTicket - Ticket returned by AuthService.asmx.

sBatchExportID - A batchExportID returned by AddBatchExportToQueue, or an ID belonging to a batch export that was manually queued by the authenticated user.

Return Value

An LOXML formatted string. The result includes a status attribute [ERROR | PENDING | COMPLETE]. ERROR responses include an error message.

PENDING means that the batch export is waiting to be processed.

COMPLETE responses include the output file contents in base64-encoded format. The contents element also includes an outputtype attribute to indicate the actual file type (XML | CSV | XLSX | TXT).

Remark

The authenticated user is required to be the same one who queued the batch export being retrieved. Examples:

COMPLETE:
    <LOXmlFormat version="1.0">
    <result status="COMPLETE">
    <batchExportID>AGO-ER3C-M74X </batchExportID>
    <message>Batch export finished. </message>
    <contents outputtype="CSV" encoding="base64"> {Batch export file contents} </contents>
    </result>
    </LOXmlFormat>

PENDING:
    <LOXmlFormat version="1.0">
    <result status="PENDING">
    <batchExportID>AGO-ER3C-M74X </batchExportID>
    <message>The batch export is in the queue.</message>
    </result>
    </LOXmlFormat>

ERROR:
    <LOXmlFormat version="1.0">
    <result status="ERROR">
    <batchExportID>AGO-ER3C-M74X </batchExportID>
    <message>The requested batch export could not be processed. Please contact your MeridianLink Mortgage system administrator for more information.</message>
    </result>
    </LOXmlFormat>
RetrieveCustomReport
Returns a custom report in CSV format.

public string RetrieveCustomReport(string sTicket, string sQueryNm, bool includeAllWithAccess)
Parameters

sTicket - Authenticated ticket returned by AuthService.asmx.

sQueryNm - The MeridianLink Mortgage custom report name.

includeAllWithAccess - If true then the report will include all loans up to the loan access level of the authenticated user (Corporate | Branch | Individual). Otherwise the report will only include loans that the user is explicitly assigned to (Individual level).

Return Value

A string containing the contents of the custom report in comma separated value (CSV) format.

If there is any error then an error message will be returned instead. E.G. If the custom report query does not exist:

    <LOXmlFormat version="1.0">
    <result status="ERROR">
    <message>Unable to find query.</message>
    </result>
    </LOXmlFormat>

Example
```
      string userName = "LQB_user";
      string password = "LQB_password";
      
      AuthService authService = new AuthService();
      string sTicket = authService.GetUserAuthTicket(userName, password);
      
      Reporting reportingService = new Reporting();
      
      string sQueryNm = "MyLQBCustomReport";
      bool includeAllWithAccess = false;
      
      string csv = reportingService.RetrieveCustomReport(sTicket, sQueryNm, includeAllWithAccess);
      
```
RunSynchronousBatchExport

MERIDIANLINK MORTGAGE INTERNAL USE ONLY. Process a batch export immediately, without queuing.

public string RunSynchronousBatchExport(string sTicket, string sCustomReportName, string sBatchExportType, string sKey)
Parameters

sTicket - Ticket returned by AuthService.asmx.

sCustomReportName - The name of the LendingQB custom report to use to determine which loans to include in the batch export. Data contents of the export will be determined by the batch export format.

sBatchExportType - The type of batch export to run. The type is included in the corresponding link within the Batch Export Report Formats list in LendingQB.
    Example - Batch export format: NC Call Report; sBatchExportType: NCCallReport
sKey - An application key that must be input to run this function.

Return Value

An LOXML formatted string. The result includes a status attribute [ERROR | COMPLETE]. ERROR responses include an error message. COMPLETE responses include the output file contents in base64-encoded format. The contents element also includes an outputtype attribute to indicate the actual file type (XML | CSV | XLSX | TXT).

Remark

If the batch export is successfully processed then the following is the response format:
    <LOXmlFormat version="1.0">
    <result status="COMPLETE">
    <batchExportID>AGO-ER3C-M74X </batchExportID>
    <message>Batch export finished. </message>
    <contents outputtype="CSV" encoding="base64"> {Batch export file contents} </contents>
    </result>
    </LOXmlFormat>

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

MERIDIANLINK MORTGAGE INTERNAL USE ONLY. Process a batch export immediately, without queuing.

public string RunSynchronousBatchExport(string sTicket, string sLoanList, string sBatchExportType, string sKey)
Parameters

sTicket - Ticket returned by AuthService.asmx.

sLoanList - An LOXML formatted list of LendingQB loan files to include in the batch export. Example LOXML loan list

sBatchExportType - The type of batch export to run. The type is included in the corresponding link within the Batch Export Report Formats list in LendingQB.
    Example - Batch export format: NC Call Report; sBatchExportType: NCCallReport
sKey - An application key that must be input to run this function.

Return Value

An LOXML formatted string. The result includes a status attribute [ERROR | COMPLETE]. ERROR responses include an error message. COMPLETE responses include the output file contents in base64-encoded format. The contents element also includes an outputtype attribute to indicate the actual file type (XML | CSV | XLSX | TXT).

Remark

If the batch export is successfully processed then the following is the response format:
    <LOXmlFormat version="1.0">
    <result status="COMPLETE">
    <batchExportID>AGO-ER3C-M74X </batchExportID>
    <message>Batch export finished. </message>
    <contents outputtype="CSV" encoding="base64"> {Batch export file contents} </contents>
    </result>
    </LOXmlFormat>

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