ClubManager.Api

FindBranchStatistic

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/BranchStatistic

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 QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    @staticmethod
    def response_type(): return QueryResponse[T]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchStatisticInstance:
    active_red_alerts: Optional[int] = None
    active_green_alerts: Optional[int] = None
    active_sleepers: Optional[int] = None
    actives_attended_fifty: Optional[int] = None
    fourteen_dayers: Optional[int] = None
    attended_last7_dayers: Optional[int] = None
    active_missed_payments: Optional[int] = None
    contract_extenders: Optional[int] = None
    pre_pay_expiring: Optional[int] = None
    seven_day_started: Optional[int] = None


# @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="BranchStatistic")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FindBranchStatistic(QueryDb[BranchStatisticInstance]):
    pass


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
    offset: Optional[int] = None
    total: Optional[int] = None
    results: Optional[List[T]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python FindBranchStatistic 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.

POST /api/Query/BranchStatistic HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"ActiveRedAlerts":0,"ActiveGreenAlerts":0,"ActiveSleepers":0,"ActivesAttendedFifty":0,"FourteenDayers":0,"AttendedLast7Dayers":0,"ActiveMissedPayments":0,"ContractExtenders":0,"PrePayExpiring":0,"SevenDayStarted":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}