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

<back to all web services

SysopList

Returns a list of all sysop records.

The following routes are available for this service:
POST,GET/sysop/list
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
SysopListResponse Parameters:
NameParameterData TypeRequiredDescription
SysopListformList<SysopRecord>No
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 .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 /sysop/list HTTP/1.1 
Host: wien.winlink.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

{"SysopList":[{"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"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}