CMS Web Services - v4.0.6532.13712 [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/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 .xml suffix or ?format=xml

HTTP + XML

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

POST /arsfi/registration/key HTTP/1.1 
Host: cms.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ArsfiRegistrationKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
  <Callsign>String</Callsign>
  <KeyType>String</KeyType>
  <Password>String</Password>
</ArsfiRegistrationKey>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArsfiRegistrationKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Callsign>String</Callsign>
  <KeyType>String</KeyType>
  <RegistrationKey>String</RegistrationKey>
</ArsfiRegistrationKeyResponse>