DesktopService Web Service

DesktopService

Click here for a complete list of operations.

GetMessageList

Test

The test form is only available for requests from the local machine.

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 /BMSDesktop/DesktopService.asmx HTTP/1.1
Host: testbms.blastiq.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.orica.net/GetMessageList"

<?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>
    <GetMessageList xmlns="http://www.orica.net/">
      <machineID>string</machineID>
      <email>string</email>
      <since>dateTime</since>
    </GetMessageList>
  </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>
    <GetMessageListResponse xmlns="http://www.orica.net/">
      <GetMessageListResult>int</GetMessageListResult>
      <messages>
        <MessageChunk>
          <pkey>int</pkey>
          <originator>string</originator>
          <dateCreate>dateTime</dateCreate>
          <dateExpiry>dateTime</dateExpiry>
          <regions>
            <string>string</string>
            <string>string</string>
          </regions>
          <isInternal>int</isInternal>
          <publish>boolean</publish>
          <subject>string</subject>
          <culture>string</culture>
          <importance>int</importance>
          <fileType>string</fileType>
          <lastUpdated>dateTime</lastUpdated>
          <deleted>boolean</deleted>
          <fileID>string</fileID>
          <fileDate>dateTime</fileDate>
        </MessageChunk>
        <MessageChunk>
          <pkey>int</pkey>
          <originator>string</originator>
          <dateCreate>dateTime</dateCreate>
          <dateExpiry>dateTime</dateExpiry>
          <regions>
            <string>string</string>
            <string>string</string>
          </regions>
          <isInternal>int</isInternal>
          <publish>boolean</publish>
          <subject>string</subject>
          <culture>string</culture>
          <importance>int</importance>
          <fileType>string</fileType>
          <lastUpdated>dateTime</lastUpdated>
          <deleted>boolean</deleted>
          <fileID>string</fileID>
          <fileDate>dateTime</fileDate>
        </MessageChunk>
      </messages>
    </GetMessageListResponse>
  </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 /BMSDesktop/DesktopService.asmx HTTP/1.1
Host: testbms.blastiq.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>
    <GetMessageList xmlns="http://www.orica.net/">
      <machineID>string</machineID>
      <email>string</email>
      <since>dateTime</since>
    </GetMessageList>
  </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>
    <GetMessageListResponse xmlns="http://www.orica.net/">
      <GetMessageListResult>int</GetMessageListResult>
      <messages>
        <MessageChunk>
          <pkey>int</pkey>
          <originator>string</originator>
          <dateCreate>dateTime</dateCreate>
          <dateExpiry>dateTime</dateExpiry>
          <regions>
            <string>string</string>
            <string>string</string>
          </regions>
          <isInternal>int</isInternal>
          <publish>boolean</publish>
          <subject>string</subject>
          <culture>string</culture>
          <importance>int</importance>
          <fileType>string</fileType>
          <lastUpdated>dateTime</lastUpdated>
          <deleted>boolean</deleted>
          <fileID>string</fileID>
          <fileDate>dateTime</fileDate>
        </MessageChunk>
        <MessageChunk>
          <pkey>int</pkey>
          <originator>string</originator>
          <dateCreate>dateTime</dateCreate>
          <dateExpiry>dateTime</dateExpiry>
          <regions>
            <string>string</string>
            <string>string</string>
          </regions>
          <isInternal>int</isInternal>
          <publish>boolean</publish>
          <subject>string</subject>
          <culture>string</culture>
          <importance>int</importance>
          <fileType>string</fileType>
          <lastUpdated>dateTime</lastUpdated>
          <deleted>boolean</deleted>
          <fileID>string</fileID>
          <fileDate>dateTime</fileDate>
        </MessageChunk>
      </messages>
    </GetMessageListResponse>
  </soap12:Body>
</soap12:Envelope>