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

<back to all web services

VersionList

Returns a list of programs used by clients and their versions. If Program is speciifed the results will be for that particular program only. Maximum request frequency - 10 minutes.

The following routes are available for this service:
POST,GET/version/list
VersionList Parameters:
NameParameterData TypeRequiredDescription
ProgrambodystringNoName of program (e.g., RMS Packet)
HistoryHoursbodyintNoNumber of hours of history to include (default: 24)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
VersionListResponse Parameters:
NameParameterData TypeRequiredDescription
VersionListformList<VersionRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
VersionRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
ProgramformstringNo
VersionformstringNo
CommentsformstringNo

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

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

{
	VersionList: 
	[
		{
			Timestamp: 0001-01-01,
			Callsign: String,
			Program: String,
			Version: String,
			Comments: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}