MercuryAPI


Click here for a complete list of operations.

GetCurrentStatus

Authenticates a Mercury Network client and gets the most recent status for the order along with any associated documents.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
Username:
Password:
ProductItemID:

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/GetCurrentStatus"

<?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>
    <GetCurrentStatus xmlns="http://alamode.com/">
      <Username>string</Username>
      <Password>string</Password>
      <ProductItemID>int</ProductItemID>
    </GetCurrentStatus>
  </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>
    <GetCurrentStatusResponse xmlns="http://alamode.com/">
      <GetCurrentStatusResult>
        <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>
            <DocumentPlaceHolder>string</DocumentPlaceHolder>
            <FileURL>string</FileURL>
          </StatusDocument>
          <StatusDocument>
            <Type>string</Type>
            <FileName>string</FileName>
            <Base64Document>string</Base64Document>
            <DocumentPlaceHolder>string</DocumentPlaceHolder>
            <FileURL>string</FileURL>
          </StatusDocument>
        </StatusDocuments>
        <StatusTime>string</StatusTime>
        <OrderFee>double</OrderFee>
        <DueDate>string</DueDate>
        <StatusUniqueID>int</StatusUniqueID>
        <QuotedFee>string</QuotedFee>
        <PDAPIKey>string</PDAPIKey>
        <BaceSubmissionID>string</BaceSubmissionID>
        <Modifications>
          <NeighborhoodHousingType OldValue="string" NewValue="string" />
          <AttachmentType OldValue="string" NewValue="string" />
          <ProjectLegalStructureType OldValue="string" NewValue="string" />
          <ConstructionMethodType OldValue="string" NewValue="string" />
          <AccessoryDwellingUnitTotalCount OldValue="string" NewValue="string" />
          <LivingUnitExcludingADUCount OldValue="string" NewValue="string" />
          <PudIndicator OldValue="string" NewValue="string" />
          <LandOwnedInCommonIndicator OldValue="string" NewValue="string" />
        </Modifications>
      </GetCurrentStatusResult>
    </GetCurrentStatusResponse>
  </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>
    <GetCurrentStatus xmlns="http://alamode.com/">
      <Username>string</Username>
      <Password>string</Password>
      <ProductItemID>int</ProductItemID>
    </GetCurrentStatus>
  </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>
    <GetCurrentStatusResponse xmlns="http://alamode.com/">
      <GetCurrentStatusResult>
        <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>
            <DocumentPlaceHolder>string</DocumentPlaceHolder>
            <FileURL>string</FileURL>
          </StatusDocument>
          <StatusDocument>
            <Type>string</Type>
            <FileName>string</FileName>
            <Base64Document>string</Base64Document>
            <DocumentPlaceHolder>string</DocumentPlaceHolder>
            <FileURL>string</FileURL>
          </StatusDocument>
        </StatusDocuments>
        <StatusTime>string</StatusTime>
        <OrderFee>double</OrderFee>
        <DueDate>string</DueDate>
        <StatusUniqueID>int</StatusUniqueID>
        <QuotedFee>string</QuotedFee>
        <PDAPIKey>string</PDAPIKey>
        <BaceSubmissionID>string</BaceSubmissionID>
        <Modifications>
          <NeighborhoodHousingType OldValue="string" NewValue="string" />
          <AttachmentType OldValue="string" NewValue="string" />
          <ProjectLegalStructureType OldValue="string" NewValue="string" />
          <ConstructionMethodType OldValue="string" NewValue="string" />
          <AccessoryDwellingUnitTotalCount OldValue="string" NewValue="string" />
          <LivingUnitExcludingADUCount OldValue="string" NewValue="string" />
          <PudIndicator OldValue="string" NewValue="string" />
          <LandOwnedInCommonIndicator OldValue="string" NewValue="string" />
        </Modifications>
      </GetCurrentStatusResult>
    </GetCurrentStatusResponse>
  </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/GetCurrentStatus?Username=string&Password=string&ProductItemID=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"?>
<CurrentStatusEx xmlns="http://alamode.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>
      <DocumentPlaceHolder>string</DocumentPlaceHolder>
      <FileURL>string</FileURL>
    </StatusDocument>
    <StatusDocument>
      <Type>string</Type>
      <FileName>string</FileName>
      <Base64Document>string</Base64Document>
      <DocumentPlaceHolder>string</DocumentPlaceHolder>
      <FileURL>string</FileURL>
    </StatusDocument>
  </StatusDocuments>
  <StatusTime>string</StatusTime>
  <OrderFee>double</OrderFee>
  <DueDate>string</DueDate>
  <StatusUniqueID>int</StatusUniqueID>
  <QuotedFee>string</QuotedFee>
  <PDAPIKey>string</PDAPIKey>
  <BaceSubmissionID>string</BaceSubmissionID>
  <Modifications>
    <NeighborhoodHousingType OldValue="string" NewValue="string" />
    <AttachmentType OldValue="string" NewValue="string" />
    <ProjectLegalStructureType OldValue="string" NewValue="string" />
    <ConstructionMethodType OldValue="string" NewValue="string" />
    <AccessoryDwellingUnitTotalCount OldValue="string" NewValue="string" />
    <LivingUnitExcludingADUCount OldValue="string" NewValue="string" />
    <PudIndicator OldValue="string" NewValue="string" />
    <LandOwnedInCommonIndicator OldValue="string" NewValue="string" />
  </Modifications>
</CurrentStatusEx>

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/GetCurrentStatus HTTP/1.1
Host: www.mercurynetworkapi.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Username=string&Password=string&ProductItemID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<CurrentStatusEx xmlns="http://alamode.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>
      <DocumentPlaceHolder>string</DocumentPlaceHolder>
      <FileURL>string</FileURL>
    </StatusDocument>
    <StatusDocument>
      <Type>string</Type>
      <FileName>string</FileName>
      <Base64Document>string</Base64Document>
      <DocumentPlaceHolder>string</DocumentPlaceHolder>
      <FileURL>string</FileURL>
    </StatusDocument>
  </StatusDocuments>
  <StatusTime>string</StatusTime>
  <OrderFee>double</OrderFee>
  <DueDate>string</DueDate>
  <StatusUniqueID>int</StatusUniqueID>
  <QuotedFee>string</QuotedFee>
  <PDAPIKey>string</PDAPIKey>
  <BaceSubmissionID>string</BaceSubmissionID>
  <Modifications>
    <NeighborhoodHousingType OldValue="string" NewValue="string" />
    <AttachmentType OldValue="string" NewValue="string" />
    <ProjectLegalStructureType OldValue="string" NewValue="string" />
    <ConstructionMethodType OldValue="string" NewValue="string" />
    <AccessoryDwellingUnitTotalCount OldValue="string" NewValue="string" />
    <LivingUnitExcludingADUCount OldValue="string" NewValue="string" />
    <PudIndicator OldValue="string" NewValue="string" />
    <LandOwnedInCommonIndicator OldValue="string" NewValue="string" />
  </Modifications>
</CurrentStatusEx>