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

<back to all web services

AccountGatewayAccessGet

Gets the state of the gateway access setting.

The following routes are available for this service:
POST,GET/account/gatewayAccess/get
AccountGatewayAccessGet Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesAccount callsign
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
AccountGatewayAccessGetResponse Parameters:
NameParameterData TypeRequiredDescription
GatewayAccessformboolNo
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 /account/gatewayAccess/get HTTP/1.1 
Host: cms.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

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