MercuryAPI Web Service

MercuryAPI

Click here for a complete list of operations.

UploadPDF

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
UserName:
Password:
Base64PDF:
bSendToBorrower:
SendToBorrowerNotes:
SubjectAddress:
SubjectCity:
SubjectState:
SubjectZip:
LoanType:
MajorForm:
BorrowerName:
BorrowerEmail:
AppraisedValue:
Neighborhood:
AppraisalDate:
SalePrice:
LoanPurpose:
PriorDate:
LenderName:
PriorPrice:
LenderAddress:
LenderCity:
LenderState:
LenderZip:
AppraiserName:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /mercuryapi.asmx HTTP/1.1
Host: www.mercurynetworkapi.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://alamode.com/UploadPDF"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UploadPDF xmlns="http://alamode.com/">
      <UserName>string</UserName>
      <Password>string</Password>
      <Base64PDF>string</Base64PDF>
      <bSendToBorrower>boolean</bSendToBorrower>
      <SendToBorrowerNotes>string</SendToBorrowerNotes>
      <SubjectAddress>string</SubjectAddress>
      <SubjectCity>string</SubjectCity>
      <SubjectState>string</SubjectState>
      <SubjectZip>string</SubjectZip>
      <LoanType>string</LoanType>
      <MajorForm>string</MajorForm>
      <BorrowerName>string</BorrowerName>
      <BorrowerEmail>string</BorrowerEmail>
      <AppraisedValue>decimal</AppraisedValue>
      <Neighborhood>string</Neighborhood>
      <AppraisalDate>dateTime</AppraisalDate>
      <SalePrice>decimal</SalePrice>
      <LoanPurpose>string</LoanPurpose>
      <PriorDate>dateTime</PriorDate>
      <LenderName>string</LenderName>
      <PriorPrice>decimal</PriorPrice>
      <LenderAddress>string</LenderAddress>
      <LenderCity>string</LenderCity>
      <LenderState>string</LenderState>
      <LenderZip>string</LenderZip>
      <AppraiserName>string</AppraiserName>
    </UploadPDF>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UploadPDFResponse xmlns="http://alamode.com/">
      <UploadPDFResult>
        <iRet>int</iRet>
        <szError>string</szError>
        <DataCourierFileID>int</DataCourierFileID>
        <szErrorDetails>string</szErrorDetails>
      </UploadPDFResult>
    </UploadPDFResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /mercuryapi.asmx HTTP/1.1
Host: www.mercurynetworkapi.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UploadPDF xmlns="http://alamode.com/">
      <UserName>string</UserName>
      <Password>string</Password>
      <Base64PDF>string</Base64PDF>
      <bSendToBorrower>boolean</bSendToBorrower>
      <SendToBorrowerNotes>string</SendToBorrowerNotes>
      <SubjectAddress>string</SubjectAddress>
      <SubjectCity>string</SubjectCity>
      <SubjectState>string</SubjectState>
      <SubjectZip>string</SubjectZip>
      <LoanType>string</LoanType>
      <MajorForm>string</MajorForm>
      <BorrowerName>string</BorrowerName>
      <BorrowerEmail>string</BorrowerEmail>
      <AppraisedValue>decimal</AppraisedValue>
      <Neighborhood>string</Neighborhood>
      <AppraisalDate>dateTime</AppraisalDate>
      <SalePrice>decimal</SalePrice>
      <LoanPurpose>string</LoanPurpose>
      <PriorDate>dateTime</PriorDate>
      <LenderName>string</LenderName>
      <PriorPrice>decimal</PriorPrice>
      <LenderAddress>string</LenderAddress>
      <LenderCity>string</LenderCity>
      <LenderState>string</LenderState>
      <LenderZip>string</LenderZip>
      <AppraiserName>string</AppraiserName>
    </UploadPDF>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UploadPDFResponse xmlns="http://alamode.com/">
      <UploadPDFResult>
        <iRet>int</iRet>
        <szError>string</szError>
        <DataCourierFileID>int</DataCourierFileID>
        <szErrorDetails>string</szErrorDetails>
      </UploadPDFResult>
    </UploadPDFResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /mercuryapi.asmx/UploadPDF?UserName=string&Password=string&Base64PDF=string&bSendToBorrower=string&SendToBorrowerNotes=string&SubjectAddress=string&SubjectCity=string&SubjectState=string&SubjectZip=string&LoanType=string&MajorForm=string&BorrowerName=string&BorrowerEmail=string&AppraisedValue=string&Neighborhood=string&AppraisalDate=string&SalePrice=string&LoanPurpose=string&PriorDate=string&LenderName=string&PriorPrice=string&LenderAddress=string&LenderCity=string&LenderState=string&LenderZip=string&AppraiserName=string HTTP/1.1
Host: www.mercurynetworkapi.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<retUploadXAP2 xmlns="http://alamode.com/">
  <iRet>int</iRet>
  <szError>string</szError>
  <DataCourierFileID>int</DataCourierFileID>
  <szErrorDetails>string</szErrorDetails>
</retUploadXAP2>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /mercuryapi.asmx/UploadPDF HTTP/1.1
Host: www.mercurynetworkapi.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

UserName=string&Password=string&Base64PDF=string&bSendToBorrower=string&SendToBorrowerNotes=string&SubjectAddress=string&SubjectCity=string&SubjectState=string&SubjectZip=string&LoanType=string&MajorForm=string&BorrowerName=string&BorrowerEmail=string&AppraisedValue=string&Neighborhood=string&AppraisalDate=string&SalePrice=string&LoanPurpose=string&PriorDate=string&LenderName=string&PriorPrice=string&LenderAddress=string&LenderCity=string&LenderState=string&LenderZip=string&AppraiserName=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<retUploadXAP2 xmlns="http://alamode.com/">
  <iRet>int</iRet>
  <szError>string</szError>
  <DataCourierFileID>int</DataCourierFileID>
  <szErrorDetails>string</szErrorDetails>
</retUploadXAP2>