ClubReady Api

CheckUsernameRequest

The following routes are available for this service:
POST	/users/checkusername	Check username availability

**CheckUsernameRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	query	string	Yes	Api Key - grants access to resources
StoreId	query	integer	No	StoreId OR ChainId is required
ChainId	query	integer	No	StoreId OR ChainId is required
Username	query	string	Yes	Username should be between 4 and 255 characters long
RestrictedId	body	int?	No
RestrictedResourceType	body	RestrictedResourceType	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
StoreId	form	int?	No
ChainId	form	int?	No

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

**CheckUsernameResponse** Parameters:
Name	Parameter	Data Type	Required
Valid	form	bool	No
StatusCode	form	int	No
Message	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.

POST /users/checkusername HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CheckUsernameRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</StoreId>
  <Username>String</Username>
</CheckUsernameRequest>

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

<CheckUsernameResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
  <Message>String</Message>
  <StatusCode>0</StatusCode>
  <Valid>false</Valid>
</CheckUsernameResponse>