ClubReady Api

<back to all web services

CheckUsernameRequest

The following routes are available for this service:
POST/users/checkusernameCheck username availability
CheckUsernameRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerNoStoreId OR ChainId is required
ChainIdqueryintegerNoStoreId OR ChainId is required
UsernamequerystringYesUsername should be between 4 and 255 characters long
RestrictedIdbodyint?No
RestrictedResourceTypebodyRestrictedResourceTypeNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
CheckUsernameResponse Parameters:
NameParameterData TypeRequiredDescription
ValidformboolNo
StatusCodeformintNo
MessageformstringNo

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 /users/checkusername HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: String,
	StoreId: 0,
	ChainId: 0,
	Username: String,
	RestrictedId: 0,
	RestrictedResourceType: Chain
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Valid: False,
	StatusCode: 0,
	Message: String
}