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

<back to all web services

TrafficLogsSourceGet

Returns a list of records showing details of traffic sent by the specified source.

The following routes are available for this service:
POST,GET/traffic/logs/source/get
TrafficLogsSourceGet Parameters:
NameParameterData TypeRequiredDescription
SourcebodystringYesCallsign or other source identifier such as WEBMAIL, SMTP, SERVICE, etc.
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
TrafficLogsSourceGetResponse Parameters:
NameParameterData TypeRequiredDescription
TrafficListformList<TrafficRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TrafficRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
SiteformstringNo
EventformstringNo
MessageIdformstringNo
ClientTypeformintNo
CallsignformstringNo
GatewayformstringNo
SourceformstringNo
SenderformstringNo
SubjectformstringNo
SizeformintNo
AttachmentsformintNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /traffic/logs/source/get HTTP/1.1 
Host: halifax.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Source":"String","Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TrafficList":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Site":"String","Event":"String","MessageId":"String","ClientType":0,"Callsign":"String","Gateway":"String","Source":"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"}}}