CMS Web Services - v4.0.6459.17834 [cms-a]

<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 .jsv suffix or ?format=jsv

HTTP + JSV

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: cms.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AccountName: String,
	Password: String,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Messages: 
	[
		{
			Timestamp: 0001-01-01,
			MessageId: String,
			Sender: String,
			Subject: String,
			Size: 0,
			Attachments: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}