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

<back to all web services

SysopGet

Returns a sysop record.

The following routes are available for this service:
POST,GET/status/sysop/get
POST,GET/sysop/get
SysopGet Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesSysop callsign (no SSID)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
SysopGetResponse Parameters:
NameParameterData TypeRequiredDescription
SysopformSysopRecordNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SysopRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
GridSquareformstringNo
SysopNameformstringNo
StreetAddress1formstringNo
StreetAddress2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
PostalCodeformstringNo
EmailformstringNo
PhonesformstringNo
WebsiteformstringNo
CommentsformstringNo

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 /status/sysop/get HTTP/1.1 
Host: cms.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<SysopGetResponse 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>
  <Sysop>
    <Callsign>String</Callsign>
    <City>String</City>
    <Comments>String</Comments>
    <Country>String</Country>
    <Email>String</Email>
    <GridSquare>String</GridSquare>
    <Phones>String</Phones>
    <PostalCode>String</PostalCode>
    <State>String</State>
    <StreetAddress1>String</StreetAddress1>
    <StreetAddress2>String</StreetAddress2>
    <SysopName>String</SysopName>
    <Timestamp>0001-01-01T00:00:00</Timestamp>
    <Website>String</Website>
  </Sysop>
</SysopGetResponse>