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

<back to all web services

ProgramVersionsLatest

Returns a data structure containing the most recent version for each program. Maximum request frequency - 30 minutes.

The following routes are available for this service:
POST,GET/program/versions/latest
ProgramVersionsLatest Parameters:
NameParameterData TypeRequiredDescription
UserTypebodyUserTypeNoOne of Client, Sysop, or AnyAll (default: AnyAll)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ProgramVersionsLatestResponse Parameters:
NameParameterData TypeRequiredDescription
ProgramVersionListformList<LatestProgramVersionRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
LatestProgramVersionRecord Parameters:
NameParameterData TypeRequiredDescription
ProgramformstringNo
VersionformstringNo
UserTypeformUserTypeNo

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

{
	UserType: AnyAll,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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