| Required role: | API |
| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
BranchType: 0,
Name: String,
Prefix: String,
CompanyName: String,
CompanyAddress: String,
CompanyOfficialName: String,
DirectDebitReference: String,
FastDDReference: String,
FastDDPlatinumRef: String,
Style: String,
PaymentStartDate: 0001-01-01,
PublicKey: 00000000000000000000000000000000,
TrialStart: 0001-01-01,
TrialEnd: 0001-01-01,
InTrial: False,
UseMembershipTypes: False,
DDUserName: String,
DDPassword: String,
DDServiceUser: String,
DfcUserName: String,
DfcPassword: String,
DfcClubNumber: String,
CompanyEmail: String,
SmsOriginator: String,
LanguageId: 0,
VatRate: 0,
SwipeAction: 0,
Modules: 0,
UseFreeText: False,
FreeTextTitle: String,
TimeZone: String,
UseCreditBalance: False,
AllowNegativeBalance: False,
DefaultCreditLimit: 0,
ApplicationType: 0,
ExternalProviderWarning: String,
Domain: String,
MobileDomain: String,
OnlineBookingTimetableLimit: 0,
OnlineBookingCancellationLimit: 0,
Feature: 0,
ShowGoCardlessAd: False,
ProviderSaving: 0,
SROAddress: String,
Telephone: String,
MCAClubNo: String,
Transferred: False,
OnlineBookingAllowNonActives: False,
MemberLimit: 0,
SortCode: String,
AccountNumber: String,
SendSMSAppointmentRemindersDefault: False,
SendSMSBookingReminders: False,
Website: String,
GiftAid: False,
GlobalBookingStartTime: PT0S,
GlobalBookingEndTime: PT0S,
BookingMinuteIncrements: 0,
CancelReason: String,
CancelFurther: String,
CancelDate: 0001-01-01,
TwilioNumber: String,
CreditCardFee: 0,
DirectDebitFee: 0,
Culture: String,
BookingsPayLinkOnTrack: False,
AccessControlTimeLimit: 0,
Minimiser: 0,
AutoGenerateLicenses: False,
Terms: String,
FingerprintThreshold: 0,
FingerprintMatcherThreshold: 0,
CurrencyCulture: String,
AutoShutoff: False,
PrimaryColors: String,
Logo: AA==,
ReportFormat: 0,
Country: String,
SMSPriceAdjustment: 0,
LogoHash: String,
FixPayments: False,
FixPaymentSchedle: String,
AppFeature: 0,
AppOptions: String,
CompanyDescription: String,
Capacity: 0,
SignInScreenFeature: 0,
BookingAccessTimeLimit: 0,
DeductSessionsOnBooking: False,
MonthlySalesTarget: 0,
ShowTrustedBranchBookings: False,
Facebook: String,
Twitter: String,
Instagram: String,
YouTube: String,
TikTok: String,
Shopify: String,
MinimumMemberAge: 0,
UsingPaymentMethods: 0,
TermsAndConditionsVersionDate: 0001-01-01,
TermsAndConditionsAcceptedDate: 0001-01-01,
SendMarketingInviteWhenMemberAdded: False,
SendMarketingInviteWhenMemberJoinedOnline: False,
MarketingComplianceManagedExternally: False,
OnlineBookingAllowWaitingList: False,
OnlineMultiSiteEnabled: False,
OnlineBookingLimit: 0,
PublicMembershipTypes: 0,
TrustedBranches: 0,
ScoreBranchId: 0,
iOSAppLink: String,
AndroidAppLink: String
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}