ClubReady Api

<back to all web services

GetGuestPassTypesRequest

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiDtoBase:
    api_key: Optional[str] = None
    store_id: Optional[int] = None
    chain_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetGuestPassTypesRequestDto(ApiDtoBase):
    pass


class RestrictedResourceType(str, Enum):
    STORE = 'Store'
    CHAIN = 'Chain'
    USER = 'User'
    UNDEFINED = 'Undefined'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetGuestPassTypesRequest(GetGuestPassTypesRequestDto, IRestrictedApiRequest):
    # @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    api_key: Optional[str] = None
    """
    Api Key - grants access to resources
    """


    # @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")
    store_id: Optional[int] = None
    """
    Either StoreId or ChainId is required
    """


    # @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")
    chain_id: Optional[int] = None
    """
    Either StoreId or ChainId is required
    """


    restricted_id: Optional[int] = None
    restricted_resource_type: Optional[RestrictedResourceType] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiResponseBase:
    success: bool = False
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GuestPassTypeDto:
    guest_pass_type_id: int = 0
    chain_id: Optional[int] = None
    store_id: Optional[int] = None
    pass_name: Optional[str] = None
    duration_days: int = 0
    expiration_editable: bool = False
    max_duration_days: int = 0
    auto_activate_when_issued: bool = False
    issue_barcode_when_activated: bool = False
    tag_when_activated: Optional[str] = None
    max_issued_count: int = 0
    is_deleted: bool = False
    inactive_count: int = 0
    active_count: int = 0
    expired_count: int = 0
    total_count: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetGuestPassTypesResponseDto(ApiResponseBase):
    guest_pass_types: Optional[List[GuestPassTypeDto]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetGuestPassTypesResponse(GetGuestPassTypesResponseDto):
    guest_pass_types: Optional[List[GuestPassTypeDto]] = None

Python GetGuestPassTypesRequest DTOs

GET /club/guest-pass/types HTTP/1.1 
Host: 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
}