ClubManager.Api

<back to all web services

BranchService.GetBranchAppInfoRequest

The following routes are available for this service:
POST,GET/api/Branch/GetBranchAppInfo
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


# @Flags()
class AppFeature(IntEnum):
    NONE = 0
    JOIN_ONLINE = 1
    TODAYS_CLASSES = 2
    REGISTRATION_FORM = 4
    FORTHCOMING_BOOKINGS = 8
    WEEKLY_TIMETABLE = 16
    SESSION_TIMETABLE = 32
    FACILITY_TIMETABLE = 64
    TASTER_SESSIONS = 128
    HOW_TO_FIND_US = 256
    ATTENDANCE_LEADERBOARD = 512
    MEMBER_MESSAGES = 1024
    ACHIEVEMENT_GALLERY = 2048
    FREE_TEXT = 4096
    QR_CODE = 8192
    SHARE_AND_INVITE_A_FRIEND = 16384
    RENEWAL_PROMPT = 32768
    CURRENT_CAPACITY = 65536
    JOIN_FRIEND = 131072
    MEMBER_POINTS = 262144
    PROMO_MEMBERSHIP = 524288
    SHOP = 1048576
    SHOW_FACEBOOK = 2097152
    SHOW_TWITTER = 4194304
    SHOW_INSTAGRAM = 8388608
    SHOW_YOU_TUBE = 16777216
    SHOW_TIK_TOK = 33554432
    SHOW_SHOPIFY = 67108864
    ATTENDANCE_STREAK = 134217728
    BOOKING_CATEGORIES = 268435456
    SHOW_SESSIONS_REMAINING = 536870912


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchAppInfo:
    title_text: Optional[str] = None
    add_text: Optional[str] = None
    register_text: Optional[str] = None
    join_text: Optional[str] = None
    ar_ni_o_s: Optional[str] = None
    arn_android: Optional[str] = None
    app_identifier: Optional[str] = None
    app_bundle_name: Optional[str] = None
    app_name: Optional[str] = None
    app_center_android: Optional[str] = None
    app_center_i_o_s: Optional[str] = None
    branch_id: Optional[int] = None
    name: Optional[str] = None
    branch_key: Optional[str] = None
    terms: Optional[str] = None
    cancel_date: Optional[datetime.datetime] = None
    app_feature: Optional[AppFeature] = None
    can_book_online: Optional[bool] = None
    primary_color: Optional[str] = None
    secondary_color: Optional[str] = None
    background_color: Optional[str] = None
    header_top_color: Optional[str] = None
    header_bottom_color: Optional[str] = None
    side_left_color: Optional[str] = None
    side_right_color: Optional[str] = None
    side_font_color: Optional[str] = None
    side_font_active_color: Optional[str] = None
    ext_web_background_color: Optional[str] = None
    ext_web_text_color: Optional[str] = None
    ext_web_tint_back_color: Optional[str] = None
    ext_web_highlight_back_color: Optional[str] = None
    ext_web_tab_back_color: Optional[str] = None
    heading_color: Optional[str] = None

Python BranchService.GetBranchAppInfoRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /api/Branch/GetBranchAppInfo HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Id":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TitleText":"String","AddText":"String","RegisterText":"String","JoinText":"String","ARNiOS":"String","ARNAndroid":"String","AppIdentifier":"String","AppBundleName":"String","AppName":"String","AppCenterAndroid":"String","AppCenterIOS":"String","BranchId":0,"Name":"String","BranchKey":"00000000-0000-0000-0000-000000000000","Terms":null,"CancelDate":null,"AppFeature":0,"CanBookOnline":false,"PrimaryColor":null,"SecondaryColor":null,"BackgroundColor":null,"HeaderTopColor":null,"HeaderBottomColor":null,"SideLeftColor":null,"SideRightColor":null,"SideFontColor":null,"SideFontActiveColor":null,"ExtWebBackgroundColor":null,"ExtWebTextColor":null,"ExtWebTintBackColor":null,"ExtWebHighlightBackColor":null,"ExtWebTabBackColor":null,"HeadingColor":null}