ClubReady Api

DoCheckInRequest

Check a user into a club

The following routes are available for this service:
POST	/users/checkin	Check User Into Club

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


/**
* Check a user into a club
*/
@Api(Description="Check a user into a club")
open class DoCheckInRequest : DoCheckInRequestDto(), IRestrictedApiRequest
{
    /**
    * 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

    /**
    * User barcode
    */
    @ApiMember(DataType="string", Description="User barcode", IsRequired=true, Name="Barcode", ParameterType="query")
    var Barcode:String? = null

    /**
    * ClubReady StoreId required
    */
    @ApiMember(DataType="integer", Description="ClubReady StoreId required", IsRequired=true, Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * UserId to check into club
    */
    @ApiMember(DataType="integer", Description="UserId to check into club", Name="UserId", ParameterType="query")
    var UserId:Int? = null

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

open class DoCheckInRequestDto : ApiDtoBase()
{
    var Barcode:String? = null
    var UserId:Int? = null
    var UtcTimeStamp:Date? = null
}

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

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

Kotlin DoCheckInRequest DTOs

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

{
	ApiKey: String,
	Barcode: String,
	StoreId: 0,
	UserId: 0,
	RestrictedId: 0,
	RestrictedResourceType: Store,
	UtcTimeStamp: 0001-01-01,
	ChainId: 0
}