MercuryAPI
Click here for a complete list of operations.
GetCurrentStatusXSiteClientEx
Authenticates an XSite 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.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/GetCurrentStatusXSiteClientEx" <?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> <GetCurrentStatusXSiteClientEx xmlns="http://alamode.com/"> <SessionKey>string</SessionKey> <ProductItemID>int</ProductItemID> </GetCurrentStatusXSiteClientEx> </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> <GetCurrentStatusXSiteClientExResponse xmlns="http://alamode.com/"> <GetCurrentStatusXSiteClientExResult> <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> </StatusDocument> <StatusDocument> <Type>string</Type> <FileName>string</FileName> <Base64Document>string</Base64Document> <DocumentPlaceHolder>string</DocumentPlaceHolder> </StatusDocument> </StatusDocuments> <StatusTime>string</StatusTime> <OrderFee>double</OrderFee> <DueDate>string</DueDate> <StatusUniqueID>int</StatusUniqueID> <QuotedFee>string</QuotedFee> <PDAPIKey>string</PDAPIKey> <BaceSubmissionID>string</BaceSubmissionID> </GetCurrentStatusXSiteClientExResult> </GetCurrentStatusXSiteClientExResponse> </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> <GetCurrentStatusXSiteClientEx xmlns="http://alamode.com/"> <SessionKey>string</SessionKey> <ProductItemID>int</ProductItemID> </GetCurrentStatusXSiteClientEx> </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> <GetCurrentStatusXSiteClientExResponse xmlns="http://alamode.com/"> <GetCurrentStatusXSiteClientExResult> <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> </StatusDocument> <StatusDocument> <Type>string</Type> <FileName>string</FileName> <Base64Document>string</Base64Document> <DocumentPlaceHolder>string</DocumentPlaceHolder> </StatusDocument> </StatusDocuments> <StatusTime>string</StatusTime> <OrderFee>double</OrderFee> <DueDate>string</DueDate> <StatusUniqueID>int</StatusUniqueID> <QuotedFee>string</QuotedFee> <PDAPIKey>string</PDAPIKey> <BaceSubmissionID>string</BaceSubmissionID> </GetCurrentStatusXSiteClientExResult> </GetCurrentStatusXSiteClientExResponse> </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/GetCurrentStatusXSiteClientEx?SessionKey=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> </StatusDocument> <StatusDocument> <Type>string</Type> <FileName>string</FileName> <Base64Document>string</Base64Document> <DocumentPlaceHolder>string</DocumentPlaceHolder> </StatusDocument> </StatusDocuments> <StatusTime>string</StatusTime> <OrderFee>double</OrderFee> <DueDate>string</DueDate> <StatusUniqueID>int</StatusUniqueID> <QuotedFee>string</QuotedFee> <PDAPIKey>string</PDAPIKey> <BaceSubmissionID>string</BaceSubmissionID> </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/GetCurrentStatusXSiteClientEx HTTP/1.1 Host: www.mercurynetworkapi.com Content-Type: application/x-www-form-urlencoded Content-Length: length SessionKey=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> </StatusDocument> <StatusDocument> <Type>string</Type> <FileName>string</FileName> <Base64Document>string</Base64Document> <DocumentPlaceHolder>string</DocumentPlaceHolder> </StatusDocument> </StatusDocuments> <StatusTime>string</StatusTime> <OrderFee>double</OrderFee> <DueDate>string</DueDate> <StatusUniqueID>int</StatusUniqueID> <QuotedFee>string</QuotedFee> <PDAPIKey>string</PDAPIKey> <BaceSubmissionID>string</BaceSubmissionID> </CurrentStatusEx>