| GET | /club/guest-pass/types | Guest passes available at location. |
|---|
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
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}