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

<back to all web services

ArsfiRegistrationKey

Returns a registration key for the specified callsign.

The following routes are available for this service:
POST,GET/arsfi/registration/key
ArsfiRegistrationKey Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesAccount callsign (no SSID)
PasswordbodystringYesAccount password
KeyTypebodystringYesType of registration key to create (Winmor, V4, Express, etc.)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ArsfiRegistrationKeyResponse Parameters:
NameParameterData TypeRequiredDescription
CallsignformstringNo
RegistrationKeyformstringNo
KeyTypeformstringNo
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/ArsfiRegistrationKey HTTP/1.1 
Host: cms.winlink.org 
Content-Type: application/json
Content-Length: length

{"Callsign":"String","Password":"String","KeyType":"String","Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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