YM REST Services

UsernameAvailabilityRequest

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin	Required permission:	/admin/members/

The following routes are available for this service:
GET	/Ams/{ClientID}/CheckUsername	Return whether the given username has already been used for the given client.

**UsernameAvailabilityRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Username	query	string	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**UsernameAvailability** Parameters:
Name	Parameter	Data Type	Required	Description
Available	form	bool	No
ErrorMessage	form	string	No

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

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsernameAvailability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <Available>false</Available>
  <ErrorMessage>String</ErrorMessage>
</UsernameAvailability>