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

<back to all web services

GatewayChannelCount

Returns the number of active gateway channels for the specified period.

The following routes are available for this service:
POST,GET/gateway/channel/count
GatewayChannelCount Parameters:
NameParameterData TypeRequiredDescription
HistoryHoursbodyintNoNumber of hours of history to include (default: 6)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
GatewayChannelCountResponse Parameters:
NameParameterData TypeRequiredDescription
GatewayCountformintNo
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 /gateway/channel/count HTTP/1.1 
Host: cms.winlink.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

{"GatewayCount":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}