ClubReady Api

GetGuestPassTypesRequest

The following routes are available for this service:
GET	/club/guest-pass/types	Guest passes available at location.

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


open class GetGuestPassTypesRequest : GetGuestPassTypesRequestDto(), 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

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

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

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

open class GetGuestPassTypesRequestDto : ApiDtoBase()
{
}

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

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

open class GetGuestPassTypesResponse : GetGuestPassTypesResponseDto()
{
    var GuestPassTypes:ArrayList<GuestPassTypeDto> = ArrayList<GuestPassTypeDto>()
}

open class GetGuestPassTypesResponseDto : ApiResponseBase()
{
    var GuestPassTypes:ArrayList<GuestPassTypeDto> = ArrayList<GuestPassTypeDto>()
}

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

open class GuestPassTypeDto
{
    var GuestPassTypeId:Int? = null
    var ChainId:Int? = null
    var StoreId:Int? = null
    var PassName:String? = null
    var DurationDays:Int? = null
    var ExpirationEditable:Boolean? = null
    var MaxDurationDays:Int? = null
    var AutoActivateWhenIssued:Boolean? = null
    var IssueBarcodeWhenActivated:Boolean? = null
    var TagWhenActivated:String? = null
    var MaxIssuedCount:Int? = null
    var IsDeleted:Boolean? = null
    var InactiveCount:Int? = null
    var ActiveCount:Int? = null
    var ExpiredCount:Int? = null
    var TotalCount:Int? = null
}

Kotlin GetGuestPassTypesRequest 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/types HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv

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

{
	GuestPassTypes: 
	[
		{
			GuestPassTypeId: 0,
			ChainId: 0,
			StoreId: 0,
			PassName: String,
			DurationDays: 0,
			ExpirationEditable: False,
			MaxDurationDays: 0,
			AutoActivateWhenIssued: False,
			IssueBarcodeWhenActivated: False,
			TagWhenActivated: String,
			MaxIssuedCount: 0,
			IsDeleted: False,
			InactiveCount: 0,
			ActiveCount: 0,
			ExpiredCount: 0,
			TotalCount: 0
		}
	],
	Success: False,
	Message: String
}