Appraisal Quality Management (AQM) API Documentation

The AQM API is a web service that allows clients with existing third party software to utilize Mercury Network's Appraisal Quality Management, or AQM system.  AQM highlights risks and performs quality control due diligence on your appraisal reports.  AQM documents your QC process with an end-to-end audit trail and includes a revision request tool for compliant communication with your appraiser.

1. The integration partner calls NewDCAQM and submits MISMO XML.  This process creates a new DataCourier file and submits the file to AQM using the customer's AQM preferences.
2. The AQM results URL is sent via XML to the partner's web service.
3. The partner navigates to the passed URL.
   1. The URL loads to the AQM interface where the partner can comment on the rules.
   2. Comments and actions made on the rules are returned via XML to the partner's web service.
4. Once the AQM has been calculated, an AQI will be passed via a base64 encoded PDF in XML to the partner's web service.

Back to top

The NewDCAQM Web method allows for data to be posted via HTTP POST.  The web method will create a new DataCourier file and submit the MISMO XML to AQM.

Usage:

API URL:

Request:

<x>POST /Mercuryapi.asmx/NewDCAQM HTTP/1.1</x>
<x>Host: www.mercurynetworkapiqa.com</x>
<x>Content-Type: application/x-www-form-urlencoded</x>
<x>Content-Length: length</x>

<x>Username=string&Password=string&XMLPost=string</x>

<STATUS>
  <SUBMITTINGPARTYNAME>​SubmittingParty​</SUBMITTINGPARTYNAME>
  <ORDERID>123456789​</ORDERID>
  <LONGLOANNUMBER>789654321​</LONGLOANNUMBER>
  <XMLFILE>BASE64XML​</XMLFILE>
  <PDFFILE>BASE64PDF​</PDFFILE>
</STATUS>

Request Parameters (All fields are required):

Response:

<AQMResult xmlns="http://mercuryvmp.com/" xmlns:xsd="http://www.w3.org/​2001/​XMLSchema" xmlns:xsi="http://www.w3.org/​2001/​XMLSchema‑instance">
  <bResult>true​</bResult>
  <iError>0​</iError>
  <szError/​>
  <TrackingID>6796​</TrackingID>
  <TrackingNumber>27th March Order Test​</TrackingNumber>
  <Message>Appraisal submitted to ActioNsight AQM.​</Message>
</AQMResult>

Response Parameters:

Back to top

The AQM Postback provides a link that will auto log the user in and provide the detailed outcome from the AQM analysis.

<AQMResults>
  <TrackingID>6746​</TrackingID>
  <Source>DC​</Source>
  <StatusTimeStamp>​2014-05-08 10:06:58.803​</StatusTimeStamp>
  <Message>AQM preliminary results returned by ActioNsight.​</Message>
  <Link>https://datacourier.mercuryvmp.com/​Common/​AQMForms/​AQMVarianceResults​.aspx?vkey=5a4248da-​f2f7-​42fc-​b1ef-​12f2acd838c9​</Link>
</AQMResults>

Parameters

Sample Response XML(ACK):

<AQMIntegrationResponse>
  <Success>True​</Success>
  <ErrorNumber>0​</ErrorNumber>
  <ErrorMessage/>
</AQMIntegrationResponse>

Sample Response XML(NACK):

<AQMIntegrationResponse>
  <Success>False​</Success>
  <ErrorNumber>100​</ErrorNumber>
  <ErrorMessage>An unexpected error occurred.​</ErrorMessage>
</AQMIntegrationResponse>

Response Parameters:

Back to top

The AQM Comment Postback returns the options and comments inputted into the AQM UI interface.

<AQMActionResults>
  <TrackingID>6748​</TrackingID>
  <Source>DC​</Source>
  <StatusTimeStamp>2014-05-08 10:11:03.811​</StatusTimeStamp>
  <AQMActionList>
    <Rule ID="NGH-1006​">
      <Action>Pass​</Action>
      <Comment>These are Pass Comments.​</Comment>
    </Rule>
    <Rule ID="NGH-1040​">
      <Action>Incurable​</Action>
      <Comment>These are incurable comments.​</Comment>
    </Rule>
    <Rule ID="NGH-1055">
      <Action>RequestRevision​</Action>
      <Comment>The market supply on page one is inconsistent with absorption rate and days on market on the 1004MC.  Please re-examine your findings.​</Comment>
    </Rule>
  </AQMActionList>
</AQMActionResults>

Parameters:

Back to top

The AQI Postback will return the calculated results from the AQM in a base64 encoded document.

<AQIResults>
  <TrackingID>6753​</TrackingID>
  <Source>DC​</Source>
  <StatusComment>AQI results returned by ActioNsight​</StatusComment>
  <Document Name="AQI_45239.pdf">
    <Content>Base64PDF​</Content>
  </Document>
  <StatusTimeStamp>2014/05/08 12:18:50.125​</StatusTimeStamp>
</AQIResults>

Back to top