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

<back to all web services

ArsfiRegistrationValid

Returns true if the specified registration exists and has not been voided.

The following routes are available for this service:
POST,GET/arsfi/registration/valid
ArsfiRegistrationValid Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesCallsign of person (no SID)
RegistrationKeybodystringYesRegistration key
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ArsfiRegistrationValidResponse Parameters:
NameParameterData TypeRequiredDescription
ValidformboolNo
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 /csv/reply/ArsfiRegistrationValid HTTP/1.1 
Host: cms.winlink.org 
Content-Type: text/csv
Content-Length: length

{"Callsign":"String","RegistrationKey":"String","Key":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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