POST | /users/checkusername | Check username availability |
---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApiKey | form | string | No | |
StoreId | form | int? | No | |
ChainId | form | int? | No |
Store | |
Chain | |
User | |
Undefined |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 .csv suffix or ?format=csv
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: clubready.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ApiKey":"String","StoreId":0,"ChainId":0,"Username":"String","RestrictedId":0,"RestrictedResourceType":"Chain"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Valid":false,"StatusCode":0,"Message":"String"}