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

GET /club/guest-pass/types HTTP/1.1 
Host: clubready.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetGuestPassTypesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.ClubAccess.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <GuestPassTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubReady.Core.ClubAccess.GuestPasses.Dtos" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <d2p1:GuestPassTypeDto>
      <d2p1:ActiveCount>0</d2p1:ActiveCount>
      <d2p1:AutoActivateWhenIssued>false</d2p1:AutoActivateWhenIssued>
      <d2p1:ChainId>0</d2p1:ChainId>
      <d2p1:DurationDays>0</d2p1:DurationDays>
      <d2p1:ExpirationEditable>false</d2p1:ExpirationEditable>
      <d2p1:ExpiredCount>0</d2p1:ExpiredCount>
      <d2p1:GuestPassTypeId>0</d2p1:GuestPassTypeId>
      <d2p1:InactiveCount>0</d2p1:InactiveCount>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:IssueBarcodeWhenActivated>false</d2p1:IssueBarcodeWhenActivated>
      <d2p1:MaxDurationDays>0</d2p1:MaxDurationDays>
      <d2p1:MaxIssuedCount>0</d2p1:MaxIssuedCount>
      <d2p1:PassName>String</d2p1:PassName>
      <d2p1:StoreId>0</d2p1:StoreId>
      <d2p1:TagWhenActivated>String</d2p1:TagWhenActivated>
      <d2p1:TotalCount>0</d2p1:TotalCount>
    </d2p1:GuestPassTypeDto>
  </GuestPassTypes>
</GetGuestPassTypesResponse>