Reporting
The following operations are supported. For a formal definition, please review the Service Description.
-
AddBatchExportToQueue
This method adds a batch export to the batch export queue. [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. Output is a string in LOXML format. The result includes a status attribute [ERROR | OK]. ERROR responses include an error message. OK responses include a batchExportID. -
AddBatchExportToQueueWithLoanList
This method adds a batch export to the batch export queue. [sTicket] Ticket returned by AuthService.asmx. [sLoanList] An LOXML formatted list of MeridianLink Mortgage loan files to include in the batch export. [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. Output is a string in LOXML format. The result includes a status attribute [ERROR | OK]. ERROR responses include an error message. OK responses include a batchExportID. -
RetrieveBatchExport
This method retrieves the status and contents of a batch export that was previously queued. [sTicket] Ticket returned by AuthService.asmx. [sBatchExportID] A batchExportID returned by AddBatchExportToQueue, or an ID belonging to a batch export that was manually queued. The authenticated user is required to be the same user who requested the batch export. Output is a string in LOXML format. 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). -
RetrieveCustomReport
This method returns a CSV string containing the requested custom report data. [sTicket] 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). -
RunSynchronousBatchExport
MERIDIANLINK MORTGAGE INTERNAL USE ONLY. This method processes a batch export immediately, rather than queuing. [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. [sKey] An application key that must be input to run this function. Output is a string in LOXML format. 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). -
RunSynchronousBatchExportWithLoanList
MERIDIANLINK MORTGAGE INTERNAL USE ONLY. This method processes a batch export immediately, rather than queuing. [sTicket] Ticket returned by AuthService.asmx. [sLoanList] An LOXML formatted list of MeridianLink Mortgage loan files to include in the batch export. [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. [sKey] An application key that must be input to run this function. Output is a string in LOXML format. 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).