PrivateMessage


Click here for a complete list of operations.

GetMessages

Gets message for a user. itemsOnPage can be max 200.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
page:
itemsOnPage:
userToken:
apiKey:

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 /dev/PrivateMessage.asmx HTTP/1.1
Host: frontur.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://frontur.com/api/GetMessages"

<?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>
    <GetMessages xmlns="http://frontur.com/api">
      <page>int</page>
      <itemsOnPage>int</itemsOnPage>
      <userToken>string</userToken>
      <apiKey>string</apiKey>
    </GetMessages>
  </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>
    <GetMessagesResponse xmlns="http://frontur.com/api">
      <GetMessagesResult>
        <PrivateMessage>
          <MessageId>int</MessageId>
          <Subject>string</Subject>
          <Body>string</Body>
          <FromUser>string</FromUser>
          <Created>dateTime</Created>
          <Read>boolean</Read>
          <Replyed>boolean</Replyed>
        </PrivateMessage>
        <PrivateMessage>
          <MessageId>int</MessageId>
          <Subject>string</Subject>
          <Body>string</Body>
          <FromUser>string</FromUser>
          <Created>dateTime</Created>
          <Read>boolean</Read>
          <Replyed>boolean</Replyed>
        </PrivateMessage>
      </GetMessagesResult>
    </GetMessagesResponse>
  </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 /dev/PrivateMessage.asmx HTTP/1.1
Host: frontur.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>
    <GetMessages xmlns="http://frontur.com/api">
      <page>int</page>
      <itemsOnPage>int</itemsOnPage>
      <userToken>string</userToken>
      <apiKey>string</apiKey>
    </GetMessages>
  </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>
    <GetMessagesResponse xmlns="http://frontur.com/api">
      <GetMessagesResult>
        <PrivateMessage>
          <MessageId>int</MessageId>
          <Subject>string</Subject>
          <Body>string</Body>
          <FromUser>string</FromUser>
          <Created>dateTime</Created>
          <Read>boolean</Read>
          <Replyed>boolean</Replyed>
        </PrivateMessage>
        <PrivateMessage>
          <MessageId>int</MessageId>
          <Subject>string</Subject>
          <Body>string</Body>
          <FromUser>string</FromUser>
          <Created>dateTime</Created>
          <Read>boolean</Read>
          <Replyed>boolean</Replyed>
        </PrivateMessage>
      </GetMessagesResult>
    </GetMessagesResponse>
  </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 /dev/PrivateMessage.asmx/GetMessages?page=string&itemsOnPage=string&userToken=string&apiKey=string HTTP/1.1
Host: frontur.com

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfPrivateMessage xmlns="http://frontur.com/api">
  <PrivateMessage>
    <MessageId>int</MessageId>
    <Subject>string</Subject>
    <Body>string</Body>
    <FromUser>string</FromUser>
    <Created>dateTime</Created>
    <Read>boolean</Read>
    <Replyed>boolean</Replyed>
  </PrivateMessage>
  <PrivateMessage>
    <MessageId>int</MessageId>
    <Subject>string</Subject>
    <Body>string</Body>
    <FromUser>string</FromUser>
    <Created>dateTime</Created>
    <Read>boolean</Read>
    <Replyed>boolean</Replyed>
  </PrivateMessage>
</ArrayOfPrivateMessage>

HTTP POST

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

POST /dev/PrivateMessage.asmx/GetMessages HTTP/1.1
Host: frontur.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

page=string&itemsOnPage=string&userToken=string&apiKey=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfPrivateMessage xmlns="http://frontur.com/api">
  <PrivateMessage>
    <MessageId>int</MessageId>
    <Subject>string</Subject>
    <Body>string</Body>
    <FromUser>string</FromUser>
    <Created>dateTime</Created>
    <Read>boolean</Read>
    <Replyed>boolean</Replyed>
  </PrivateMessage>
  <PrivateMessage>
    <MessageId>int</MessageId>
    <Subject>string</Subject>
    <Body>string</Body>
    <FromUser>string</FromUser>
    <Created>dateTime</Created>
    <Read>boolean</Read>
    <Replyed>boolean</Replyed>
  </PrivateMessage>
</ArrayOfPrivateMessage>