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

<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 .xml suffix or ?format=xml

HTTP + XML

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: perth.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProgramVersions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
  <UserType>AnyAll</UserType>
</ProgramVersions>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProgramVersionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <ProgramVersionList>
    <ProgramVersionsRecord>
      <Callsign>String</Callsign>
      <CurrentVersion>String</CurrentVersion>
      <Program>String</Program>
      <UpdateNeeded>false</UpdateNeeded>
      <UserType>AnyAll</UserType>
      <Version>String</Version>
    </ProgramVersionsRecord>
  </ProgramVersionList>
</ProgramVersionsResponse>