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

<back to all web services

AboutUser

Returns a collection of details about the user's account.

The following routes are available for this service:
POST,GET/about/user
AboutUser Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesCallsign
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
AboutUserResponse Parameters:
NameParameterData TypeRequiredDescription
CallsignformstringNo
PasswordformstringNo
CallsignPrefixformstringNo
CallsignSuffixformstringNo
IsTacticalformboolNo
IsGroupAddressformboolNo
AlternateEmailAddressformstringNo
PasswordRecoveryAddressformstringNo
NoPurgeformboolNo
GatewayAccessformboolNo
LockedOutformboolNo
MaxMessageSizeformintNo
PendingMessagesformintNo
LastAccessformDateTimeNo
ActivityformList<ActivityRecord>No
DonationsformList<DonationRecord>No
EmailAliasListformList<EmailAliasRecord>No
GatewayChannelsformList<ChannelRecord>No
GroupAddressesformList<GroupAddressRecord>No
IPAddressesformList<IPAddressRecord>No
MpsListformList<MessagePickupStationRecord>No
PositionReportsformList<PositionReportRecord>No
SessionRecordsformList<SessionRecord>No
SysopDataformSysopRecordNo
TrafficLogsformList<TrafficRecord>No
VersionListformList<VersionRecord>No
WhiteListformList<WhitelistRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ActivityRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
SourceformstringNo
ChannelformstringNo
ClientTypeformintNo
LinkTypeformintNo
ProtocolformintNo
MessagesInboundformintNo
MessagesOutboundformintNo
BytesInboundformintNo
BytesOutboundformintNo
ConnectTimeformintNo
DonationRecord Parameters:
NameParameterData TypeRequiredDescription
TransactionIdformstringNo
TimestampformDateTimeNo
CallsignformstringNo
NameformstringNo
EmailAddressformstringNo
AmountformdoubleNo
TransactionTypeformstringNo
RegistrationKeyformstringNo
VoidformboolNo
NotesformstringNo
EmailAliasRecord Parameters:
NameParameterData TypeRequiredDescription
CallsignformstringNo
AliasformstringNo
AddressformstringNo
ChannelRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
BaseCallsignformstringNo
GridSquareformstringNo
FrequencyformintNo
ModeformintNo
BaudformintNo
PowerformintNo
HeightformintNo
GainformintNo
DirectionformintNo
OperatingHoursformstringNo
ServiceCodeformstringNo
GroupAddressRecord Parameters:
NameParameterData TypeRequiredDescription
GroupCallsignformstringNo
AddressformstringNo
SubjectContainsformstringNo
EnteredByformstringNo
IPAddressRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
IPAddressformstringNo
MessagePickupStationRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
MpsCallsignformstringNo
PositionReportRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
ReportedByformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
HeadingformstringNo
SpeedformstringNo
CommentformstringNo
MarineformboolNo
YotrepsformboolNo
LatitudeNMEAformstringNo
LongitudeNMEAformstringNo
SessionRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
ApplicationformstringNo
VersionformstringNo
CmsformstringNo
ServerformstringNo
ClientformstringNo
SidformstringNo
ModeformstringNo
FrequencyformintNo
KilometersformintNo
DegreesformintNo
LastCommandformstringNo
MessagesSentformintNo
MessagesReceivedformintNo
BytesSentformintNo
BytesReceivedformintNo
HoldingSecondsformintNo
IdTagformstringNo
SysopRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
GridSquareformstringNo
SysopNameformstringNo
StreetAddress1formstringNo
StreetAddress2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
PostalCodeformstringNo
EmailformstringNo
PhonesformstringNo
WebsiteformstringNo
CommentsformstringNo
TrafficRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
SiteformstringNo
EventformstringNo
MessageIdformstringNo
ClientTypeformintNo
CallsignformstringNo
GatewayformstringNo
SourceformstringNo
SenderformstringNo
SubjectformstringNo
SizeformintNo
AttachmentsformintNo
VersionRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
ProgramformstringNo
VersionformstringNo
CommentsformstringNo
WhitelistRecord Parameters:
NameParameterData TypeRequiredDescription
AddressformstringNo
AllowformboolNo

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

<AboutUser 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>
</AboutUser>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AboutUserResponse 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>
  <Activity>
    <ActivityRecord>
      <BytesInbound>0</BytesInbound>
      <BytesOutbound>0</BytesOutbound>
      <Callsign>String</Callsign>
      <Channel>String</Channel>
      <ClientType>0</ClientType>
      <ConnectTime>0</ConnectTime>
      <LinkType>0</LinkType>
      <MessagesInbound>0</MessagesInbound>
      <MessagesOutbound>0</MessagesOutbound>
      <Protocol>0</Protocol>
      <Source>String</Source>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
    </ActivityRecord>
  </Activity>
  <AlternateEmailAddress>String</AlternateEmailAddress>
  <Callsign>String</Callsign>
  <CallsignPrefix>String</CallsignPrefix>
  <CallsignSuffix>String</CallsignSuffix>
  <Donations>
    <DonationRecord>
      <Amount>0</Amount>
      <Callsign>String</Callsign>
      <EmailAddress>String</EmailAddress>
      <Name>String</Name>
      <Notes>String</Notes>
      <RegistrationKey>String</RegistrationKey>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <TransactionId>String</TransactionId>
      <TransactionType>String</TransactionType>
      <Void>false</Void>
    </DonationRecord>
  </Donations>
  <EmailAliasList>
    <EmailAliasRecord>
      <Address>String</Address>
      <Alias>String</Alias>
      <Callsign>String</Callsign>
    </EmailAliasRecord>
  </EmailAliasList>
  <GatewayAccess>false</GatewayAccess>
  <GatewayChannels>
    <ChannelRecord>
      <BaseCallsign>String</BaseCallsign>
      <Baud>0</Baud>
      <Callsign>String</Callsign>
      <Direction>0</Direction>
      <Frequency>0</Frequency>
      <Gain>0</Gain>
      <GridSquare>String</GridSquare>
      <Height>0</Height>
      <Mode>0</Mode>
      <OperatingHours>String</OperatingHours>
      <Power>0</Power>
      <ServiceCode>String</ServiceCode>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
    </ChannelRecord>
  </GatewayChannels>
  <GroupAddresses>
    <GroupAddressRecord>
      <Address>String</Address>
      <EnteredBy>String</EnteredBy>
      <GroupCallsign>String</GroupCallsign>
      <SubjectContains>String</SubjectContains>
    </GroupAddressRecord>
  </GroupAddresses>
  <IPAddresses>
    <IPAddressRecord>
      <Callsign>String</Callsign>
      <IPAddress>String</IPAddress>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
    </IPAddressRecord>
  </IPAddresses>
  <IsGroupAddress>false</IsGroupAddress>
  <IsTactical>false</IsTactical>
  <LastAccess>0001-01-01T00:00:00</LastAccess>
  <LockedOut>false</LockedOut>
  <MaxMessageSize>0</MaxMessageSize>
  <MpsList>
    <MessagePickupStationRecord>
      <Callsign>String</Callsign>
      <MpsCallsign>String</MpsCallsign>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
    </MessagePickupStationRecord>
  </MpsList>
  <NoPurge>false</NoPurge>
  <Password>String</Password>
  <PasswordRecoveryAddress>String</PasswordRecoveryAddress>
  <PendingMessages>0</PendingMessages>
  <PositionReports>
    <PositionReportRecord>
      <Callsign>String</Callsign>
      <Comment>String</Comment>
      <Heading>String</Heading>
      <Latitude>0</Latitude>
      <LatitudeNMEA>String</LatitudeNMEA>
      <Longitude>0</Longitude>
      <LongitudeNMEA>String</LongitudeNMEA>
      <Marine>false</Marine>
      <ReportedBy>String</ReportedBy>
      <Speed>String</Speed>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <Yotreps>false</Yotreps>
    </PositionReportRecord>
  </PositionReports>
  <SessionRecords>
    <SessionRecord>
      <Application>String</Application>
      <BytesReceived>0</BytesReceived>
      <BytesSent>0</BytesSent>
      <Client>String</Client>
      <Cms>String</Cms>
      <Degrees>0</Degrees>
      <Frequency>0</Frequency>
      <HoldingSeconds>0</HoldingSeconds>
      <IdTag>String</IdTag>
      <Kilometers>0</Kilometers>
      <LastCommand>String</LastCommand>
      <MessagesReceived>0</MessagesReceived>
      <MessagesSent>0</MessagesSent>
      <Mode>String</Mode>
      <Server>String</Server>
      <Sid>String</Sid>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <Version>String</Version>
    </SessionRecord>
  </SessionRecords>
  <SysopData>
    <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>
  </SysopData>
  <TrafficLogs>
    <TrafficRecord>
      <Attachments>0</Attachments>
      <Callsign>String</Callsign>
      <ClientType>0</ClientType>
      <Event>String</Event>
      <Gateway>String</Gateway>
      <MessageId>String</MessageId>
      <Sender>String</Sender>
      <Site>String</Site>
      <Size>0</Size>
      <Source>String</Source>
      <Subject>String</Subject>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
    </TrafficRecord>
  </TrafficLogs>
  <VersionList>
    <VersionRecord>
      <Callsign>String</Callsign>
      <Comments>String</Comments>
      <Program>String</Program>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <Version>String</Version>
    </VersionRecord>
  </VersionList>
  <WhiteList>
    <WhitelistRecord>
      <Address>String</Address>
      <Allow>false</Allow>
    </WhitelistRecord>
  </WhiteList>
</AboutUserResponse>