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

<back to all web services

MessageExists

Returns a list of all messages pending for this account.

The following routes are available for this service:
POST,GET/message/exists
MessageExists Parameters:
NameParameterData TypeRequiredDescription
MessageIdbodystringYesThe ID of the message
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
MessageExistsResponse Parameters:
NameParameterData TypeRequiredDescription
ExistsformboolNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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

HTTP + CSV

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

POST /message/exists HTTP/1.1 
Host: wien.winlink.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"MessageId":"String","Key":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Exists":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}