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

<back to all web services

PasswordsList

Returns a list of password hashes for use in validating client passwords off-air. Maximum request frequency - 5 minutes.

The following routes are available for this service:
POST,GET/passwords/list
PasswordsList Parameters:
NameParameterData TypeRequiredDescription
ChallengebodystringYesChallenge phrase
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
PasswordsListResponse Parameters:
NameParameterData TypeRequiredDescription
PasswordHashformList<PasswordHashRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PasswordHashRecord Parameters:
NameParameterData TypeRequiredDescription
CallsignformstringNo
PasswordHashformstringNo

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

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

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