YM REST Services

<back to all web services

UsernameAvailabilityRequest

Requires Authentication
Requires any of the roles:admin, oauthadminRequired permission:/admin/members/
The following routes are available for this service:
GET/Ams/{ClientID}/CheckUsernameReturn whether the given username has already been used for the given client.
UsernameAvailabilityRequest Parameters:
NameParameterData TypeRequiredDescription
UsernamequerystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
UsernameAvailability Parameters:
NameParameterData TypeRequiredDescription
AvailableformboolNo
ErrorMessageformstringNo

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.

GET /Ams/{ClientID}/CheckUsername HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Available":false,"ErrorMessage":"String"}