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

<back to all web services

ProgramVersions

Returns a data structure containing version information for all version reporting programs. Maximum request frequency - 30 minutes.

The following routes are available for this service:
POST,GET/program/versions
ProgramVersions 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
ProgramVersionsResponse Parameters:
NameParameterData TypeRequiredDescription
ProgramVersionListformList<ProgramVersionsRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProgramVersionsRecord Parameters:
NameParameterData TypeRequiredDescription
CallsignformstringNo
ProgramformstringNo
VersionformstringNo
CurrentVersionformstringNo
UserTypeformUserTypeNo
UpdateNeededformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /program/versions HTTP/1.1 
Host: cms.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"UserType":"AnyAll","Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ProgramVersionList":[{"Callsign":"String","Program":"String","Version":"String","CurrentVersion":"String","UserType":"AnyAll","UpdateNeeded":false}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}