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

<back to all web services

GatewayListing

Returns a formatted gateway listing (to be saved as a text file). Maximum request frequency - 5 minutes.

The following routes are available for this service:
POST,GET/gatewayListing
POST,GET/gateway/listing
GatewayListing Parameters:
NameParameterData TypeRequiredDescription
ServiceCodesbodystringNoOne or more service codes (default: PUBLIC)
HistoryHoursbodyintNoNumber of hours of history to include (default: 6)
ListingTypebodyGatewayListingTypeNoThe type of listing - Packet, Pactor, Winmor, RobustPacket, or Airmail (default: Pactor)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
GatewayListingResponse Parameters:
NameParameterData TypeRequiredDescription
ListingformstringNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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

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

{
	Listing: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}