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

<back to all web services

GroupAddressGroupCallsignList

Returns a list of (unique) group callsigns -- optionally filtered by GroupFilter (starts with).

The following routes are available for this service:
POST,GET/groupAddress/group/callsign/list
GroupAddressGroupCallsignList Parameters:
NameParameterData TypeRequiredDescription
GroupFilterbodystringNoOne or more characters
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
GroupAddressGroupCallsignListResponse Parameters:
NameParameterData TypeRequiredDescription
GroupListformList<string>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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 /groupAddress/group/callsign/list HTTP/1.1 
Host: perth.winlink.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

{"GroupList":["String"],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}