ClubReady Api

GetGuestPassesRequest

The following routes are available for this service:
GET	/club/guest-pass/get	Get a user's guest pass(es).

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


open class GetGuestPassesRequest : GetGuestPassRequestDto(), 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

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

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

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

open class GetGuestPassRequestDto : ApiDtoBase()
{
    var UserId:Int? = 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 GetGuestPassesResponse : GetGuestPassResponseDto()
{
    var Success:Boolean? = null
    var Message:String? = null
    var GuestPasses:ArrayList<GuestPassSimple> = ArrayList<GuestPassSimple>()
}

open class GetGuestPassResponseDto : ApiResponseBase()
{
    var GuestPasses:ArrayList<GuestPassSimple> = ArrayList<GuestPassSimple>()
}

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

open class GuestPassSimple
{
    var GuestPassId:Int? = null
    var GuestPassTypeId:Int? = null
    var StoreId:Int? = null
    var ActivatedOn:Date? = null
    var Expires:Date? = null
}

Kotlin GetGuestPassesRequest 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.

GET /club/guest-pass/get HTTP/1.1 
Host: clubready.com 
Accept: text/jsv

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

{
	Success: False,
	Message: String,
	GuestPasses: 
	[
		{
			GuestPassId: 0,
			GuestPassTypeId: 0,
			StoreId: 0,
			ActivatedOn: 0001-01-01,
			Expires: 0001-01-01
		}
	]
}