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

<back to all web services

CallsignPropertiesSet

Sets multiple properties for this callsign.

The following routes are available for this service:
POST,GET/callsign/properties/set
CallsignPropertiesSet Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesAccount callsign
CallsignPrefixbodystringNoCallsign prefix (default: blank)
CallsignSuffixbodystringNoCallsign suffix (default: blank)
MaxMessageSizebodyintNoMaximum messages size (default: 120000)
GatewayAccessbodyboolNoControls who can act as a Winlink gateway (default: false)
NoPurgebodyboolNoNo purge flag (default: false)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
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 /callsign/properties/set HTTP/1.1 
Host: cms.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Callsign":"String","CallsignPrefix":"String","CallsignSuffix":"String","MaxMessageSize":0,"GatewayAccess":false,"NoPurge":false,"Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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