ClubManager.Api

<back to all web services

BranchService.GetBranchAppInfoRequest

The following routes are available for this service:
POST,GET/api/Branch/GetBranchAppInfo

// @Flags()
export enum AppFeature
{
    None = 0,
    JoinOnline = 1,
    TodaysClasses = 2,
    RegistrationForm = 4,
    ForthcomingBookings = 8,
    WeeklyTimetable = 16,
    SessionTimetable = 32,
    FacilityTimetable = 64,
    TasterSessions = 128,
    HowToFindUs = 256,
    AttendanceLeaderboard = 512,
    MemberMessages = 1024,
    AchievementGallery = 2048,
    FreeText = 4096,
    QRCode = 8192,
    ShareAndInviteAFriend = 16384,
    RenewalPrompt = 32768,
    CurrentCapacity = 65536,
    JoinFriend = 131072,
    MemberPoints = 262144,
    PromoMembership = 524288,
    Shop = 1048576,
    ShowFacebook = 2097152,
    ShowTwitter = 4194304,
    ShowInstagram = 8388608,
    ShowYouTube = 16777216,
    ShowTikTok = 33554432,
    ShowShopify = 67108864,
    AttendanceStreak = 134217728,
    BookingCategories = 268435456,
    ShowSessionsRemaining = 536870912,
}

export class BranchAppInfo
{
    public TitleText?: string;
    public AddText?: string;
    public RegisterText?: string;
    public JoinText?: string;
    public ARNiOS?: string;
    public ARNAndroid?: string;
    public AppIdentifier?: string;
    public AppBundleName?: string;
    public AppName?: string;
    public AppCenterAndroid?: string;
    public AppCenterIOS?: string;
    public BranchId?: number;
    public Name?: string;
    public BranchKey?: string;
    public Terms?: string;
    public CancelDate?: string;
    public AppFeature?: AppFeature;
    public CanBookOnline?: boolean;
    public PrimaryColor?: string;
    public SecondaryColor?: string;
    public BackgroundColor?: string;
    public HeaderTopColor?: string;
    public HeaderBottomColor?: string;
    public SideLeftColor?: string;
    public SideRightColor?: string;
    public SideFontColor?: string;
    public SideFontActiveColor?: string;
    public ExtWebBackgroundColor?: string;
    public ExtWebTextColor?: string;
    public ExtWebTintBackColor?: string;
    public ExtWebHighlightBackColor?: string;
    public ExtWebTabBackColor?: string;
    public HeadingColor?: string;

    public constructor(init?: Partial<BranchAppInfo>) { (Object as any).assign(this, init); }
}

TypeScript 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}