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

<back to all web services

ArsfiRegistrationLookup

Returns the registration key for the specified callsign and registration type if it exists and has not been voided.

The following routes are available for this service:
POST/arsfi/registration/lookup
ArsfiRegistrationLookup Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesCallsign of person
RegistrationTypebodystringYesType of registration (Winmor, V4, etc.)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ArsfiRegistrationLookupResponse Parameters:
NameParameterData TypeRequiredDescription
RegistrationKeyformstringNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /arsfi/registration/lookup HTTP/1.1 
Host: halifax.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Callsign: String,
	RegistrationType: String,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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