ClubReady Api

<back to all web services

UserOnlineCancelRequest

The following routes are available for this service:
GET/users/{UserId}/online-cancelGet an online cancellation link for a user
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 UserOnlineCancelRequestDto(ApiDtoBase):
    user_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 UserOnlineCancelRequest(UserOnlineCancelRequestDto, 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="", IsRequired=true, Name="UserId", ParameterType="query")
    user_id: int = 0
    """
    
    """

    # @ApiMember(DataType="integer", Description="StoreId of the user's home club", IsRequired=true, Name="StoreId", ParameterType="query")
    store_id: Optional[int] = None
    """
    StoreId of the user's home club
    """


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

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

Python UserOnlineCancelRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /users/{UserId}/online-cancel HTTP/1.1 
Host: clubready.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'Uri' using the custom 'csv' filter}No parameterless constructor defined for this object.