ClubReady Api

CheckUsernameRequest

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class CheckUsernameRequest : ApiDtoBase(), IRestrictedApiRequest
{
    /**
    * IP address of the end user
    */
    @ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")
    var XForwardedFor:String? = null

    /**
    * Api Key - grants access to resources
    */
    @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    var ApiKey:String? = null

    /**
    * StoreId OR ChainId is required
    */
    @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * StoreId OR ChainId is required
    */
    @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
    var ChainId:Int? = 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")
    var Username:String? = null

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

open class ApiDtoBase : IApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

open class CheckUsernameResponse : IApiResponse
{
    var Valid:Boolean? = null
    var StatusCode:Int? = null
    var Message:String? = null
}

Kotlin CheckUsernameRequest DTOs

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: 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">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api">0</StoreId>
  <Username>String</Username>
  <XForwardedFor>String</XForwardedFor>
</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>