Mercury Network Web Services Documentation


Introduction

Mercury Network Web services allow other divisions and companies to interface with the Mercury Network programmatically.  The integration has no restrictions for platform or language.  Any platform or language that supports calling and receiving data from Web services may be used to access various features of the Mercury Network.


  Web Services

GetOrderFormFields

The GetOrderFormFields Web service authenticates a Mercury Network user and returns the values for fields that use an enumerated list.

Usage

This Web service is called using an HTTP POST to the following URL:

https://​www.mercurynetworkapi.com/​mercuryAPI.asmx/​GetOrderFormFields

Parameters

The following elements should be in an HTML form element:

Username
 — 
Mercury Network Username
Password
 — 
Mercury Network Password

An XML stream is returned that looks something like this:

<?xml version="1.0" encoding="UTF-8"?>
<GetOrderFormFieldsResponse xmlns="http://mercuryvmp.com/">
  <GetOrderFormFieldsResult>
    <ERROR>
      <ERRORCODE/>
      <ERRORDESCRIPTION/>
    </ERROR>
    <FIELD Name="GDSTYPE">
      <VALUECOUNT>​3​</VALUECOUNT>
      <VALUES>
        <VALUE Num="1" Description="2 to 4 Unit Building">​2 to 4 Unit Building​</VALUE>
        <VALUE Num="2" Description="5+ Unit Building">​5+ Unit Building​</VALUE>
        <VALUE Num="3" Description="Apartment">​Apartment​</VALUE>
      </VALUES>
    </FIELD>
    <FIELD Name="LOANTYPE">
      <VALUECOUNT>​5​</VALUECOUNT>
      <VALUES>
        <VALUE Num="1" Description="Conventional">​Conventional​</VALUE>
        <VALUE Num="2" Description="FHA">​FHA​</VALUE>
        <VALUE Num="3" Description="Purchase">​Purchase​</VALUE>
        <VALUE Num="4" Description="Refinance">​Refinance​</VALUE>
        <VALUE Num="5" Description="VA">​VA​</VALUE>
      </VALUES>
    </FIELD>
    <FIELD Name="TYPE_OF_APPRAISAL">
      <VALUECOUNT>​4​</VALUECOUNT>
      <VALUES>
        <VALUE Num="1" Description="Uniform Residential Appraisal (FNMA 1004)">​Uniform Residential Appraisal (FNMA 1004)​</VALUE>
        <VALUE Num="2" Description="Uniform Residential Appraisal w/ REO (FNMA 1004)">​Uniform Residential Appraisal w/ REO (FNMA 1004)​</VALUE>
        <VALUE Num="3" Description="FHA Appraisal (FNMA 1004)">​FHA Appraisal (FNMA 1004)​</VALUE>
        <VALUE Num="4" Description="Single Family Investment (1004, 1007, and 216)">​Single Family Investment (1004, 1007, and 216)​</VALUE>
      </VALUES>
    </FIELD>
    <FIELD Name="ORDERGROUP">
      <VALUECOUNT>​3​</VALUECOUNT>
      <VALUES>
        <VALUE Num="1" Description="AL Alexander City">​2254​</VALUE>
        <VALUE Num="2" Description="AL Auburn">​2253​</VALUE>
        <VALUE Num="3" Description="AL Birmingham">​2255​</VALUE>
      </VALUES>
    </FIELD>
    <FIELD Name="OCCUPANCYTYPE">
      <VALUECOUNT>​3​</VALUECOUNT>
      <VALUES>
        <VALUE Num="1" Description="Owner">​Owner​</VALUE>
        <VALUE Num="2" Description="Tenant">​Tenant​</VALUE>
        <VALUE Num="3" Description="Vacant">​Vacant​</VALUE>
        <VALUE Num="4" Description="New Construction">​New Construction​</VALUE>
        <VALUE Num="5" Description="Owner's Second Home">​Owner's Second Home​</VALUE>
      </VALUES>
    </FIELD>
  </GetOrderFormFieldsResult>
</GetOrderFormFieldsResponse>
Error
 — 
Error details will be provided in the ErrorCode and ErrorDescription elements if unsuccessful.
ErrorCode
 — 
Error number
ErrorDescription
 — 
Error description
Field
 — 
Contains an attribute indicating which fields values are being returned.
ValueCount
 — 
The number of available values for a particular field.
Values
 — 
Contains a list of numbered value elements.
Value
 — 
Each value for a field will be numbered and contain a description.  The Description attribute will be what can be passed in the XML for that field, while the actual value can be displayed to the end user.

Back to top


PlaceMNOrder

The PlaceMNOrder Web service allows for data to be posted via an HTTP Post.  The Web service will create an Appraisal Order on the Mercury Network and send it to the specified appraiser.

Usage

This Web service is called using an HTTP POST to the following URL:

https://​www.mercurynetworkapi.com/​mercuryAPI.asmx/​PlaceMNOrder

Parameters

The following elements should be in an HTML form element:

UserName
 — 
Mercury Network username
Password
 — 
Mercury Network password
XMLPost
 — 
XML data to be posted (Refer to PlaceMNOrder Field List.xlsx)

An XML stream is returned that looks something like this:

<MNOrderResponse>
  <bResult>​true​</bResult>
  <iError>​0​</iError>
  <TrackingID>​12426741​</TrackingID>
  <TrackingNumber>​MERC‑12443769​</TrackingNumber>
  <bIsAssigned>​true​</bIsAssigned>
  <OrderFee>​310​</OrderFee>
  <TransactionFeeMessage>​verbiage​</TransactionFeeMessage>
</MNOrderResponse>
bResult
 — 
True if successful, False if not.  Check iError and szError for error details
iError
 — 
Error number
szError
 — 
Error description
TrackingID
 — 
Mercury Network Tracking ID used to reference order.
TrackingNumber
 — 
Tracking number visible to vendor.
bIsAssigned
 — 
A true or false value will be returned in this element.  If the value is false, the order is in a status called Requires Assignment.  If the value is true, the order is in a status called Awaiting Acceptance.
OrderFee
 — 
When Double-blind Mode or Automatic Order Assignment is enabled, the fee to be paid to the selected appraiser will be returned.  Otherwise, it is simply the median for the job type & county provided in the XML.
TransactionFeeMessage
 — 
This message will only be returned if the customer placing the order is responsible for the Mercury Network transaction fee.  More details on transaction fees are available in the Mercury Network help manual.

Back to top


DuplicateMNOrder

Mercury Network has a function that allows the user to create a secondary order without needing to re‑enter all of their order information and can be used to determine if the order needs to be completed by the appraiser assigned to the original appraiser or a different one.  This method exposes that functionality to anyone integrating directly with Mercury Network.

Usage

This Web service is called using an HTTP GET to the following URL:

https://​www.mercurynetworkapi.com/​mercuryAPI.asmx/​DuplicateMNOrder

Parameters

The following elements should be in an HTML form element:

UserName
 — 
Mercury Network username
Password
 — 
Mercury Network password
XMLPost
 — 
XML data to be posted (Refer to updateappraisalstatusglobal.dtd)

An XML stream is returned that looks something like this:

<?xml version="1.0" encoding="utf-8"?>
<MNOrderResponse>
  <bResult>​true​</bResult>
  <iError>​0​</iError>
  <TrackingID>​12426741​</TrackingID>
  <TrackingNumber>​MERC‑12443769​</TrackingNumber>
  <bIsAssigned>​true​</bIsAssigned>
  <OrderFee>​310​</OrderFee>
  <TransactionFeeMessage>​verbiage​</TransactionFeeMessage>
</MNOrderResponse>
bResult
 — 
True if successful, False if not.  Check iError and szError for error details
iError
 — 
Error number
szError
 — 
Error description
TrackingID
 — 
Mercury Network Tracking ID used to reference order
TrackingNumber
 — 
Tracking number visible to vendor
bIsAssigned
 — 
A true or false value will be returned in this element.  If the value is false, the order is in a status called Requires Assignment.  If the value is true, the order is in a status called Awaiting Acceptance.
OrderFee
 — 
When Double‑blind Mode or Automatic Order Assignment is enabled, the fee to be paid to the selected appraiser will be returned.  Otherwise, it is simply the median for the job type & county provided in the XML.
TransactionFeeMessage
 — 
This message will only be returned if the customer placing the order is responsible for the Mercury Network transaction fee.  More details on transaction fees are available in the Mercury Network help manual.

Back to top


UpdateAppraisalStatusGlobal

The UpdateAppraisalStatusGlobal Web service provides an interface to update the status of an appraisal order.

Usage

This Web service is called using an HTTP GET to the following URL:

https://​www.mercurynetworkapi.com/​mercuryAPI.asmx/​UpdateAppraisalStatusGlobal

Parameters

The following elements should be in a HTML form element:

UserName
 — 
Mercury Network username
Password
 — 
Mercury Network password
XMLPost
 — 
XML data to be posted (Refer to updateappraisalstatusglobal.dtd)

An XML stream is returned that looks something like this:

<UpdateAppraisalStatusGlobalResult xmlns="http://mercuryvmp.com/">
  <bResult>​boolean​</bResult>
  <iError>​int​</iError>
  <szError>​string​</szError>
  <TrackingID>​string​</TrackingID>
  <TrackingNumber>​string​</TrackingNumber>
  <DocFileID>​string​</DocFileID>
</UpdateAppraisalStatusGlobalResult>
bResult
 — 
True if successful, False if not.  Check iError and szError for error details
iError
 — 
Error number
szError
 — 
Error description
TrackingID
 — 
Mercury Network Tracking ID used to reference order
TrackingNumber
 — 
Tracking number visible to vendor
DocFileID
 — 
DocFileID returned after order has been submitted to UCDP.

Back to top


GetCurrentStatus

The GetCurrentStatus Web service authenticates a Mercury Network user and gets the most recent status for the order along with any associated documents.

Usage

This Web service is called using an HTTP GET to the following URL:

https://​www.mercurynetworkapi.com/​mercuryAPI.asmx/​GetCurrentStatus

Parameters

The following elements should be in an HTML form element:

UserName
 — 
Mercury Network username
Password
 — 
Mercury Network password
ProductItemID
 — 
TrackingID returned by PlaceMNOrder web service.

An XML stream is returned that looks something like this:

<?xml version="1.0" encoding="utf-8"?>
<CurrentStatusEx xmlns="http://mercuryvmp.com/">
  <Success>​boolean​</Success>
  <Message>​string​</Message>
  <ProductItemID>​int​</ProductItemID>
  <StatusID>​int​</StatusID>
  <StatusName>​string​</StatusName>
  <StatusComment>​string​</StatusComment>
  <StatusDocuments>
    <StatusDocument>
      <Type>​string​</Type>
      <FileName>​string​</FileName>
      <Base64Document>​string​</Base64Document>
    </StatusDocument>
    <StatusDocument>
      <Type>​string​</Type>
      <FileName>​string​</FileName>
      <Base64Document>​string​</Base64Document>
    </StatusDocument>
  </StatusDocuments>
  <StatusTime>​string​</StatusTime>
</CurrentStatusEx>
Sucess
 — 
True if successful, False if not
Message
 — 
Error message, if there is one
ProductItemID
 — 
TrackingID from PlaceAppraisalOrderEx web service
StatusID
 — 
Unique ID for the current stats
StatusName
 — 
Name of the current status
Type
 — 
Type of the document
FileName
 — 
File name of the document
Base64Document
 — 
Base64 Encoded Document
StatusTime
 — 
Time that the current status was set

Back to top


Doc Details

Mercury Network Web Services Documentation

  • Document 9604
  • Created: 06/25/2014 MJY

The Big Picture

This document outlines exposed .NET Web services on the Mercury Network.