POST | /users/checkusername | Check username availability |
---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class CheckUsernameRequest extends ApiDtoBase implements IRestrictedApiRequest
{
/**
* Api Key - grants access to resources
*/
@ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
public String ApiKey = null;
/**
* StoreId OR ChainId is required
*/
@ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="StoreId", ParameterType="query")
public Integer StoreId = null;
/**
* StoreId OR ChainId is required
*/
@ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
public Integer ChainId = null;
/**
* Username should be between 4 and 255 characters long
*/
@ApiMember(DataType="string", Description="Username should be between 4 and 255 characters long", IsRequired=true, Name="Username", ParameterType="query")
public String Username = null;
public Integer RestrictedId = null;
public RestrictedResourceType RestrictedResourceType = null;
public String getApiKey() { return ApiKey; }
public CheckUsernameRequest setApiKey(String value) { this.ApiKey = value; return this; }
public Integer getStoreId() { return StoreId; }
public CheckUsernameRequest setStoreId(Integer value) { this.StoreId = value; return this; }
public Integer getChainId() { return ChainId; }
public CheckUsernameRequest setChainId(Integer value) { this.ChainId = value; return this; }
public String getUsername() { return Username; }
public CheckUsernameRequest setUsername(String value) { this.Username = value; return this; }
public Integer getRestrictedId() { return RestrictedId; }
public CheckUsernameRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
public CheckUsernameRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
}
public static class ApiDtoBase
{
public String ApiKey = null;
public Integer StoreId = null;
public Integer ChainId = null;
public String getApiKey() { return ApiKey; }
public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
public Integer getStoreId() { return StoreId; }
public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
public Integer getChainId() { return ChainId; }
public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
}
public static enum RestrictedResourceType
{
Store,
Chain,
User,
Undefined;
}
public static class CheckUsernameResponse implements IApiResponse
{
public Boolean Valid = null;
public Integer StatusCode = null;
public String Message = null;
public Boolean isValid() { return Valid; }
public CheckUsernameResponse setValid(Boolean value) { this.Valid = value; return this; }
public Integer getStatusCode() { return StatusCode; }
public CheckUsernameResponse setStatusCode(Integer value) { this.StatusCode = value; return this; }
public String getMessage() { return Message; }
public CheckUsernameResponse setMessage(String value) { this.Message = value; return this; }
}
}
Java CheckUsernameRequest DTOs
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"}