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

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

HTTP + CSV

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: halifax.winlink.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Callsign":"String","Key":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Callsign":"String","Password":"String","CallsignPrefix":"String","CallsignSuffix":"String","IsTactical":false,"IsGroupAddress":false,"AlternateEmailAddress":"String","PasswordRecoveryAddress":"String","NoPurge":false,"GatewayAccess":false,"LockedOut":false,"MaxMessageSize":0,"PendingMessages":0,"LastAccess":"\/Date(-62135596800000-0000)\/","Activity":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","Source":"String","Channel":"String","ClientType":0,"LinkType":0,"Protocol":0,"MessagesInbound":0,"MessagesOutbound":0,"BytesInbound":0,"BytesOutbound":0,"ConnectTime":0}],"Donations":[{"TransactionId":"String","Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","Name":"String","EmailAddress":"String","Amount":0,"TransactionType":"String","RegistrationKey":"String","Void":false,"Notes":"String"}],"EmailAliasList":[{"Callsign":"String","Alias":"String","Address":"String"}],"GatewayChannels":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","BaseCallsign":"String","GridSquare":"String","Frequency":0,"Mode":0,"Baud":0,"Power":0,"Height":0,"Gain":0,"Direction":0,"OperatingHours":"String","ServiceCode":"String"}],"GroupAddresses":[{"GroupCallsign":"String","Address":"String","SubjectContains":"String","EnteredBy":"String"}],"IPAddresses":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","IPAddress":"String"}],"MpsList":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","MpsCallsign":"String"}],"PositionReports":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","ReportedBy":"String","Latitude":0,"Longitude":0,"Heading":"String","Speed":"String","Comment":"String","Marine":false,"Yotreps":false,"LatitudeNMEA":"String","LongitudeNMEA":"String"}],"SessionRecords":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Application":"String","Version":"String","Cms":"String","Server":"String","Client":"String","Sid":"String","Mode":"String","Frequency":0,"Kilometers":0,"Degrees":0,"LastCommand":"String","MessagesSent":0,"MessagesReceived":0,"BytesSent":0,"BytesReceived":0,"HoldingSeconds":0,"IdTag":"String"}],"SysopData":{"Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","GridSquare":"String","SysopName":"String","StreetAddress1":"String","StreetAddress2":"String","City":"String","State":"String","Country":"String","PostalCode":"String","Email":"String","Phones":"String","Website":"String","Comments":"String"},"TrafficLogs":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Site":"String","Event":"String","MessageId":"String","ClientType":0,"Callsign":"String","Gateway":"String","Source":"String","Sender":"String","Subject":"String","Size":0,"Attachments":0}],"VersionList":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","Program":"String","Version":"String","Comments":"String"}],"WhiteList":[{"Address":"String","Allow":false}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}