CMS Web Services - v4.0.6550.31684 [cms-b]

<back to all web services

MessageList

Returns a list of all messages pending for this account.

The following routes are available for this service:
POST,GET/message/list
MessageList Parameters:
NameParameterData TypeRequiredDescription
AccountNamebodystringYesThe Winlink account name. Usually a callsign or tactical address.
PasswordbodystringYesPassword for account (tactical address may not have a password)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
MessageListResponse Parameters:
NameParameterData TypeRequiredDescription
MessagesformList<MessageListRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MessageListRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
MessageIdformstringNo
SenderformstringNo
SubjectformstringNo
SizeformintNo
AttachmentsformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /message/list HTTP/1.1 
Host: halifax.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MessageList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
  <AccountName>String</AccountName>
  <Password>String</Password>
</MessageList>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessageListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Messages>
    <MessageListRecord>
      <Attachments>0</Attachments>
      <MessageId>String</MessageId>
      <Sender>String</Sender>
      <Size>0</Size>
      <Subject>String</Subject>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
    </MessageListRecord>
  </Messages>
</MessageListResponse>