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

<back to all web services

MessagePickupStationGet

Returns all MPS records for this callsign.

The following routes are available for this service:
POST,GET/mps/get
MessagePickupStationGet Parameters:
NameParameterData TypeRequiredDescription
RequesterbodystringYesCallsign of requestor
CallsignbodystringYesStation callsign
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
MessagePickupStationGetResponse Parameters:
NameParameterData TypeRequiredDescription
MpsListformList<MessagePickupStationRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MessagePickupStationRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
MpsCallsignformstringNo

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 /mps/get HTTP/1.1 
Host: cms.winlink.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

{"MpsList":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","MpsCallsign":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}