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

<back to all web services

GatewayStatus

Returns an array of data structures showing the status of Winlink gateways.

The following routes are available for this service:
POST,GET/gateway/status
POST,GET/gatewayStatus
GatewayStatus Parameters:
NameParameterData TypeRequiredDescription
HistoryHoursbodyintNoNumber of hours of history to include (default: 6, maximun: 48)
ServiceCodesbodystringNoOne or more service codes (default: PUBLIC)
ModebodyGatewayOperatingModeNoOne of Packet, Pactor, Winmor, RobustPacket, AllHf, or AnyAll (default: AnyAll)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
GatewayStatusResponse Parameters:
NameParameterData TypeRequiredDescription
GatewaysformList<GatewayStatusRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
GatewayStatusRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
BaseCallsignformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
HoursSinceStatusformintNo
LastStatusformstringNo
CommentsformstringNo
RequestedModeformGatewayOperatingModeNo
GatewayChannelsformList<GatewayChannelRecord>No
GatewayChannelRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
SupportedModesformstringNo
ModeformintNo
GridsquareformstringNo
FrequencyformintNo
OperatingHoursformstringNo
BaudformstringNo
RadioRangeformstringNo
AntennaformstringNo
ServiceCodeformstringNo

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

{
	HistoryHours: 0,
	ServiceCodes: String,
	Mode: AnyAll,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Gateways: 
	[
		{
			Timestamp: 0001-01-01,
			Callsign: String,
			BaseCallsign: String,
			Latitude: 0,
			Longitude: 0,
			HoursSinceStatus: 0,
			LastStatus: String,
			Comments: String,
			RequestedMode: AnyAll,
			GatewayChannels: 
			[
				{
					Timestamp: 0001-01-01,
					SupportedModes: String,
					Mode: 0,
					Gridsquare: String,
					Frequency: 0,
					OperatingHours: String,
					Baud: String,
					RadioRange: String,
					Antenna: String,
					ServiceCode: String
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}