ClubReady Api

CreateGuestPassRequest

The following routes are available for this service:
POST	/club/guest-pass/create	Create a guest pass for a user.

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


open class CreateGuestPassRequest : CreateGuestPassRequestDto(), 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 ID
    */
    @ApiMember(DataType="string", Description="User ID", IsRequired=true, Name="UserId", ParameterType="query")
    var UserId:Int? = null

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

    /**
    * Guest pass type to create.
    */
    @ApiMember(DataType="integer", Description="Guest pass type to create.", IsRequired=true, Name="GuestPassTypeId", ParameterType="query")
    var GuestPassTypeId:Int? = null

    /**
    * Activate this Guest Pass immediately? (True or False)
    */
    @ApiMember(DataType="bool", Description="Activate this Guest Pass immediately? (True or False)", IsRequired=true, Name="Activated", ParameterType="query")
    var Activated:Boolean? = null

    /**
    * When will this pass expire? (leave blank for never)
    */
    @ApiMember(DataType="datetime", Description="When will this pass expire? (leave blank for never)", Name="Expires", ParameterType="query")
    var Expires:Date? = null

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

open class CreateGuestPassRequestDto : ApiDtoBase()
{
    var UserId:Int? = null
    var GuestPassTypeId:Int? = null
    var Activated:Boolean? = null
    var Expires:Date? = null
}

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

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

open class CreateGuestPassResponse : CreateGuestPassResponseDto()
{
    var Success:Boolean? = null
    var GuestPassId:Int? = null
    var Message:String? = null
}

open class CreateGuestPassResponseDto : ApiResponseBase()
{
    var GuestPassId:Int? = null
}

open class ApiResponseBase
{
    var Success:Boolean? = null
    var Message:String? = null
}

Kotlin CreateGuestPassRequest 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 /club/guest-pass/create HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: String,
	UserId: 0,
	StoreId: 0,
	GuestPassTypeId: 0,
	Activated: False,
	Expires: 0001-01-01,
	RestrictedId: 0,
	RestrictedResourceType: Store,
	ChainId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	GuestPassId: 0,
	Message: String
}