ClubManager.Api

ViewBranchGetBranches

**Requires Authentication**
Required role:	API

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

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 BranchGetBranchesInstance:
    branch_type: Optional[int] = None
    name: Optional[str] = None
    prefix: Optional[str] = None
    company_name: Optional[str] = None
    company_address: Optional[str] = None
    company_official_name: Optional[str] = None
    direct_debit_reference: Optional[str] = None
    fast_d_d_reference: Optional[str] = None
    fast_d_d_platinum_ref: Optional[str] = None
    style: Optional[str] = None
    payment_start_date: Optional[datetime.datetime] = None
    public_key: Optional[str] = None
    trial_start: Optional[datetime.datetime] = None
    trial_end: Optional[datetime.datetime] = None
    in_trial: Optional[bool] = None
    use_membership_types: Optional[bool] = None
    dd_user_name: Optional[str] = None
    dd_password: Optional[str] = None
    dd_service_user: Optional[str] = None
    dfc_user_name: Optional[str] = None
    dfc_password: Optional[str] = None
    dfc_club_number: Optional[str] = None
    company_email: Optional[str] = None
    sms_originator: Optional[str] = None
    language_id: Optional[int] = None
    vat_rate: Optional[Decimal] = None
    swipe_action: Optional[int] = None
    modules: Optional[int] = None
    use_free_text: Optional[bool] = None
    free_text_title: Optional[str] = None
    time_zone: Optional[str] = None
    use_credit_balance: Optional[bool] = None
    allow_negative_balance: Optional[bool] = None
    default_credit_limit: Optional[Decimal] = None
    application_type: Optional[int] = None
    external_provider_warning: Optional[str] = None
    domain: Optional[str] = None
    mobile_domain: Optional[str] = None
    online_booking_timetable_limit: Optional[int] = None
    online_booking_cancellation_limit: Optional[int] = None
    feature: Optional[int] = None
    show_go_cardless_ad: Optional[bool] = None
    provider_saving: Optional[Decimal] = None
    sro_address: Optional[str] = None
    telephone: Optional[str] = None
    mca_club_no: Optional[str] = None
    transferred: Optional[bool] = None
    online_booking_allow_non_actives: Optional[bool] = None
    member_limit: Optional[int] = None
    sort_code: Optional[str] = None
    account_number: Optional[str] = None
    send_s_m_s_appointment_reminders_default: Optional[bool] = None
    send_s_m_s_booking_reminders: Optional[bool] = None
    website: Optional[str] = None
    gift_aid: Optional[bool] = None
    global_booking_start_time: Optional[datetime.timedelta] = None
    global_booking_end_time: Optional[datetime.timedelta] = None
    booking_minute_increments: Optional[int] = None
    cancel_reason: Optional[str] = None
    cancel_further: Optional[str] = None
    cancel_date: Optional[datetime.datetime] = None
    twilio_number: Optional[str] = None
    credit_card_fee: Optional[Decimal] = None
    direct_debit_fee: Optional[Decimal] = None
    culture: Optional[str] = None
    bookings_pay_link_on_track: Optional[bool] = None
    access_control_time_limit: Optional[int] = None
    minimiser: Optional[int] = None
    auto_generate_licenses: Optional[bool] = None
    terms: Optional[str] = None
    fingerprint_threshold: Optional[int] = None
    fingerprint_matcher_threshold: Optional[int] = None
    currency_culture: Optional[str] = None
    auto_shutoff: Optional[bool] = None
    primary_colors: Optional[str] = None
    logo: Optional[bytes] = None
    report_format: Optional[int] = None
    country: Optional[str] = None
    sms_price_adjustment: Optional[Decimal] = None
    logo_hash: Optional[str] = None
    fix_payments: Optional[bool] = None
    fix_payment_schedle: Optional[str] = None
    app_feature: Optional[int] = None
    app_options: Optional[str] = None
    company_description: Optional[str] = None
    capacity: Optional[int] = None
    sign_in_screen_feature: Optional[int] = None
    booking_access_time_limit: Optional[int] = None
    deduct_sessions_on_booking: Optional[bool] = None
    monthly_sales_target: Optional[int] = None
    show_trusted_branch_bookings: Optional[bool] = None
    facebook: Optional[str] = None
    twitter: Optional[str] = None
    instagram: Optional[str] = None
    you_tube: Optional[str] = None
    tik_tok: Optional[str] = None
    shopify: Optional[str] = None
    minimum_member_age: Optional[int] = None
    using_payment_methods: Optional[int] = None
    terms_and_conditions_version_date: Optional[datetime.datetime] = None
    terms_and_conditions_accepted_date: Optional[datetime.datetime] = None
    send_marketing_invite_when_member_added: Optional[bool] = None
    send_marketing_invite_when_member_joined_online: Optional[bool] = None
    marketing_compliance_managed_externally: Optional[bool] = None
    online_booking_allow_waiting_list: Optional[bool] = None
    online_multi_site_enabled: Optional[bool] = None
    online_booking_limit: Optional[int] = None
    public_membership_types: Optional[int] = None
    trusted_branches: Optional[int] = None
    score_branch_id: Optional[int] = None
    i_o_s_app_link: Optional[str] = None
    android_app_link: Optional[str] = None


# @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="BranchGetBranches")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ViewBranchGetBranches(QueryDb[BranchGetBranchesInstance]):
    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 ViewBranchGetBranches 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.

POST /api/Query/BranchGetBranches HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ViewBranchGetBranches xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ViewBranchGetBranches>

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

<QueryResponseOfBranchGetBranchesInstancePEZRWkv_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
    <d2p1:BranchGetBranchesInstance>
      <d2p1:AccessControlTimeLimit>0</d2p1:AccessControlTimeLimit>
      <d2p1:AccountNumber>String</d2p1:AccountNumber>
      <d2p1:AllowNegativeBalance>false</d2p1:AllowNegativeBalance>
      <d2p1:AndroidAppLink>String</d2p1:AndroidAppLink>
      <d2p1:AppFeature>0</d2p1:AppFeature>
      <d2p1:AppOptions>String</d2p1:AppOptions>
      <d2p1:ApplicationType>0</d2p1:ApplicationType>
      <d2p1:AutoGenerateLicenses>false</d2p1:AutoGenerateLicenses>
      <d2p1:AutoShutoff>false</d2p1:AutoShutoff>
      <d2p1:BookingAccessTimeLimit>0</d2p1:BookingAccessTimeLimit>
      <d2p1:BookingMinuteIncrements>0</d2p1:BookingMinuteIncrements>
      <d2p1:BookingsPayLinkOnTrack>false</d2p1:BookingsPayLinkOnTrack>
      <d2p1:BranchType>0</d2p1:BranchType>
      <d2p1:CancelDate>0001-01-01T00:00:00</d2p1:CancelDate>
      <d2p1:CancelFurther>String</d2p1:CancelFurther>
      <d2p1:CancelReason>String</d2p1:CancelReason>
      <d2p1:Capacity>0</d2p1:Capacity>
      <d2p1:CompanyAddress>String</d2p1:CompanyAddress>
      <d2p1:CompanyDescription>String</d2p1:CompanyDescription>
      <d2p1:CompanyEmail>String</d2p1:CompanyEmail>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:CompanyOfficialName>String</d2p1:CompanyOfficialName>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:CreditCardFee>0</d2p1:CreditCardFee>
      <d2p1:Culture>String</d2p1:Culture>
      <d2p1:CurrencyCulture>String</d2p1:CurrencyCulture>
      <d2p1:DDPassword>String</d2p1:DDPassword>
      <d2p1:DDServiceUser>String</d2p1:DDServiceUser>
      <d2p1:DDUserName>String</d2p1:DDUserName>
      <d2p1:DeductSessionsOnBooking>false</d2p1:DeductSessionsOnBooking>
      <d2p1:DefaultCreditLimit>0</d2p1:DefaultCreditLimit>
      <d2p1:DfcClubNumber>String</d2p1:DfcClubNumber>
      <d2p1:DfcPassword>String</d2p1:DfcPassword>
      <d2p1:DfcUserName>String</d2p1:DfcUserName>
      <d2p1:DirectDebitFee>0</d2p1:DirectDebitFee>
      <d2p1:DirectDebitReference>String</d2p1:DirectDebitReference>
      <d2p1:Domain>String</d2p1:Domain>
      <d2p1:ExternalProviderWarning>String</d2p1:ExternalProviderWarning>
      <d2p1:Facebook>String</d2p1:Facebook>
      <d2p1:FastDDPlatinumRef>String</d2p1:FastDDPlatinumRef>
      <d2p1:FastDDReference>String</d2p1:FastDDReference>
      <d2p1:Feature>0</d2p1:Feature>
      <d2p1:FingerprintMatcherThreshold>0</d2p1:FingerprintMatcherThreshold>
      <d2p1:FingerprintThreshold>0</d2p1:FingerprintThreshold>
      <d2p1:FixPaymentSchedle>String</d2p1:FixPaymentSchedle>
      <d2p1:FixPayments>false</d2p1:FixPayments>
      <d2p1:FreeTextTitle>String</d2p1:FreeTextTitle>
      <d2p1:GiftAid>false</d2p1:GiftAid>
      <d2p1:GlobalBookingEndTime>PT0S</d2p1:GlobalBookingEndTime>
      <d2p1:GlobalBookingStartTime>PT0S</d2p1:GlobalBookingStartTime>
      <d2p1:InTrial>false</d2p1:InTrial>
      <d2p1:Instagram>String</d2p1:Instagram>
      <d2p1:LanguageId>0</d2p1:LanguageId>
      <d2p1:Logo>AA==</d2p1:Logo>
      <d2p1:LogoHash>String</d2p1:LogoHash>
      <d2p1:MCAClubNo>String</d2p1:MCAClubNo>
      <d2p1:MarketingComplianceManagedExternally>false</d2p1:MarketingComplianceManagedExternally>
      <d2p1:MemberLimit>0</d2p1:MemberLimit>
      <d2p1:Minimiser>0</d2p1:Minimiser>
      <d2p1:MinimumMemberAge>0</d2p1:MinimumMemberAge>
      <d2p1:MobileDomain>String</d2p1:MobileDomain>
      <d2p1:Modules>0</d2p1:Modules>
      <d2p1:MonthlySalesTarget>0</d2p1:MonthlySalesTarget>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:OnlineBookingAllowNonActives>false</d2p1:OnlineBookingAllowNonActives>
      <d2p1:OnlineBookingAllowWaitingList>false</d2p1:OnlineBookingAllowWaitingList>
      <d2p1:OnlineBookingCancellationLimit>0</d2p1:OnlineBookingCancellationLimit>
      <d2p1:OnlineBookingLimit>0</d2p1:OnlineBookingLimit>
      <d2p1:OnlineBookingTimetableLimit>0</d2p1:OnlineBookingTimetableLimit>
      <d2p1:OnlineMultiSiteEnabled>false</d2p1:OnlineMultiSiteEnabled>
      <d2p1:PaymentStartDate>0001-01-01T00:00:00</d2p1:PaymentStartDate>
      <d2p1:Prefix>String</d2p1:Prefix>
      <d2p1:PrimaryColors>String</d2p1:PrimaryColors>
      <d2p1:ProviderSaving>0</d2p1:ProviderSaving>
      <d2p1:PublicKey>00000000-0000-0000-0000-000000000000</d2p1:PublicKey>
      <d2p1:PublicMembershipTypes>0</d2p1:PublicMembershipTypes>
      <d2p1:ReportFormat>0</d2p1:ReportFormat>
      <d2p1:SMSPriceAdjustment>0</d2p1:SMSPriceAdjustment>
      <d2p1:SROAddress>String</d2p1:SROAddress>
      <d2p1:ScoreBranchId>0</d2p1:ScoreBranchId>
      <d2p1:SendMarketingInviteWhenMemberAdded>false</d2p1:SendMarketingInviteWhenMemberAdded>
      <d2p1:SendMarketingInviteWhenMemberJoinedOnline>false</d2p1:SendMarketingInviteWhenMemberJoinedOnline>
      <d2p1:SendSMSAppointmentRemindersDefault>false</d2p1:SendSMSAppointmentRemindersDefault>
      <d2p1:SendSMSBookingReminders>false</d2p1:SendSMSBookingReminders>
      <d2p1:Shopify>String</d2p1:Shopify>
      <d2p1:ShowGoCardlessAd>false</d2p1:ShowGoCardlessAd>
      <d2p1:ShowTrustedBranchBookings>false</d2p1:ShowTrustedBranchBookings>
      <d2p1:SignInScreenFeature>0</d2p1:SignInScreenFeature>
      <d2p1:SmsOriginator>String</d2p1:SmsOriginator>
      <d2p1:SortCode>String</d2p1:SortCode>
      <d2p1:Style>String</d2p1:Style>
      <d2p1:SwipeAction>0</d2p1:SwipeAction>
      <d2p1:Telephone>String</d2p1:Telephone>
      <d2p1:Terms>String</d2p1:Terms>
      <d2p1:TermsAndConditionsAcceptedDate>0001-01-01T00:00:00</d2p1:TermsAndConditionsAcceptedDate>
      <d2p1:TermsAndConditionsVersionDate>0001-01-01T00:00:00</d2p1:TermsAndConditionsVersionDate>
      <d2p1:TikTok>String</d2p1:TikTok>
      <d2p1:TimeZone>String</d2p1:TimeZone>
      <d2p1:Transferred>false</d2p1:Transferred>
      <d2p1:TrialEnd>0001-01-01T00:00:00</d2p1:TrialEnd>
      <d2p1:TrialStart>0001-01-01T00:00:00</d2p1:TrialStart>
      <d2p1:TrustedBranches>0</d2p1:TrustedBranches>
      <d2p1:TwilioNumber>String</d2p1:TwilioNumber>
      <d2p1:Twitter>String</d2p1:Twitter>
      <d2p1:UseCreditBalance>false</d2p1:UseCreditBalance>
      <d2p1:UseFreeText>false</d2p1:UseFreeText>
      <d2p1:UseMembershipTypes>false</d2p1:UseMembershipTypes>
      <d2p1:UsingPaymentMethods>0</d2p1:UsingPaymentMethods>
      <d2p1:VatRate>0</d2p1:VatRate>
      <d2p1:Website>String</d2p1:Website>
      <d2p1:YouTube>String</d2p1:YouTube>
      <d2p1:iOSAppLink>String</d2p1:iOSAppLink>
    </d2p1:BranchGetBranchesInstance>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfBranchGetBranchesInstancePEZRWkv_P>