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

<back to all web services

AccountCallsignSearch

Searches for matching callsigns. All callsigns containing the search text are returned.

The following routes are available for this service:
POST,GET/account/callsign/search
AccountCallsignSearch Parameters:
NameParameterData TypeRequiredDescription
SearchTextbodystringYesSearch text
RecordLimitbodyintNoLimit number of returned records (default: 100)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
AccountCallsignSearchResponse Parameters:
NameParameterData TypeRequiredDescription
CallsignsformList<string>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/AccountCallsignSearch HTTP/1.1 
Host: cms.winlink.org 
Content-Type: application/json
Content-Length: length

{"SearchText":"String","RecordLimit":0,"Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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