ClubReady Api

<back to all web services

GetCustomCategoriesUserRequest

The following routes are available for this service:
GET/users/custom-categoryList of a user's items for custom categories.
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 GetCustomCategoriesUserRequestDto(ApiDtoBase):
    user_id: int = 0
    custom_category_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 GetCustomCategoriesUserRequest(GetCustomCategoriesUserRequestDto, 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="ClubReady Club ID (StoreID internally)", Name="StoreId", ParameterType="query")
    store_id: Optional[int] = None
    """
    ClubReady Club ID (StoreID internally)
    """


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


    # @ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")
    user_id: int = 0
    """
    ClubReady User ID
    """


    # @ApiMember(DataType="integer", Description="Custom Category ID", Name="CustomCategoryId", ParameterType="query")
    custom_category_id: int = 0
    """
    Custom Category ID
    """


    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 CustomCategoryItemInfo:
    custom_category_id: int = 0
    custom_category_name: Optional[str] = None
    custom_category_item_id: int = 0
    custom_category_item_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomCategoriesUserResponseDto(ApiResponseBase):
    user_id: int = 0
    custom_categories: Optional[List[CustomCategoryItemInfo]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomCategoriesUserResponse(GetCustomCategoriesUserResponseDto):
    user_id: int = 0
    custom_categories: Optional[List[CustomCategoryItemInfo]] = None

Python GetCustomCategoriesUserRequest 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 /users/custom-category HTTP/1.1 
Host: clubready.com 
Accept: application/xml

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

<GetCustomCategoriesUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.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>
  <CustomCategories xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <CustomCategoryItemInfo>
      <CustomCategoryId>0</CustomCategoryId>
      <CustomCategoryItemId>0</CustomCategoryItemId>
      <CustomCategoryItemName>String</CustomCategoryItemName>
      <CustomCategoryName>String</CustomCategoryName>
    </CustomCategoryItemInfo>
  </CustomCategories>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</UserId>
</GetCustomCategoriesUserResponse>