ClubReady Api

<back to all web services

PackageEligibilityRequest

The following routes are available for this service:
GET/sales/members/{MemberId}/package-eligibilityFind out is a user is eligible to purchase a certain package.
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 PackageEligibilityRequestDto(ApiDtoBase):
    package_id: int = 0
    member_id: int = 0


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PackageEligibilityRequest(PackageEligibilityRequestDto, 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="Store ID # member belongs to", IsRequired=true, Name="StoreId", ParameterType="query")
    store_id: Optional[int] = None
    """
    Store ID # member belongs to
    """


    # @ApiMember(DataType="integer", Description="ID of the member to lookup", IsRequired=true, Name="MemberId", ParameterType="path")
    member_id: int = 0
    """
    ID of the member to lookup
    """


    # @ApiMember(DataType="integer", Description="ID of the package to check", IsRequired=true, Name="PackageId", ParameterType="query")
    package_id: int = 0
    """
    ID of the package to check
    """


    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 PackageEligibilityItem:
    name: Optional[str] = None
    value: Optional[str] = None
    is_eligible: bool = False
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PackageEligibility:
    is_eligible: bool = False
    eligibility: Optional[List[PackageEligibilityItem]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PackageEligibilityResponseDto(ApiResponseBase):
    eligibility_info: Optional[PackageEligibility] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PackageEligibilityResponse(PackageEligibilityResponseDto):
    eligibility_info: Optional[PackageEligibility] = None

Python PackageEligibilityRequest 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 /sales/members/{MemberId}/package-eligibility HTTP/1.1 
Host: clubready.com 
Accept: application/xml

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

<PackageEligibilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Sales.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>
  <EligibilityInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubReady.Core.Sales.Models" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <d2p1:Eligibility>
      <d2p1:PackageEligibilityItem>
        <d2p1:IsEligible>false</d2p1:IsEligible>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Value>String</d2p1:Value>
      </d2p1:PackageEligibilityItem>
    </d2p1:Eligibility>
    <d2p1:IsEligible>false</d2p1:IsEligible>
  </EligibilityInfo>
</PackageEligibilityResponse>