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

<back to all web services

ArsfiRegistrationList

Returns a list of valid registration records for the specified callsign.

The following routes are available for this service:
POST/arsfi/registration/list
ArsfiRegistrationList Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesCallsign of person (no SID)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ArsfiRegistrationListResponse Parameters:
NameParameterData TypeRequiredDescription
RegistrationsformList<RegistrationRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
RegistrationRecord Parameters:
NameParameterData TypeRequiredDescription
RegistrationTypeformstringNo
RegistrationKeyformstringNo

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 /arsfi/registration/list HTTP/1.1 
Host: wien.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

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