| POST,GET | /api/Branch/GetBranchByKey |
|---|
export enum BranchType
{
DebitFinance = 'DebitFinance',
SmartDebit = 'SmartDebit',
Standard = 'Standard',
Root = 'Root',
Reseller = 'Reseller',
Referrer = 'Referrer',
}
// @Flags()
export enum Module
{
Standard = 0,
Bookings = 1,
}
export enum ApplicationType
{
Gym = 1,
Golf = 2,
Dance = 3,
Soccer = 4,
Vanilla = 5,
Association = 6,
MartialArts = 7,
Gymnastics = 8,
Swimming = 9,
Nurseries = 10,
Racquet = 11,
SubscriptionBox = 12,
Clinic = 13,
Wellness = 14,
HealthAndBeauty = 15,
Climbing = 16,
AfterSchoolClub = 17,
PersonalTrainer = 18,
}
// @Flags()
export enum Feature
{
None = 0,
Standard = 1,
Bookings = 2,
Rota = 4,
GoCardless = 8,
HomeScreen = 16,
EPos = 32,
Attendance = 64,
Sales = 128,
PaymentCollections = 256,
MailChimp = 512,
MultiSite = 1024,
AccountingDashboard = 2048,
OtherDashboards = 4096,
Reports = 8192,
AdvancedAccounting = 16384,
MemberLicenseDates = 32768,
FaceRecognition = 65536,
MemberAccountCreation = 131072,
Automation = 262144,
FacebookMarketing = 524288,
Grades = 1048576,
ZoomIntegration = 2097152,
SalesTargetChart = 4194304,
CustomApp = 8388608,
CustomAttributesOnPortal = 16777216,
NoExport = 33554432,
EnterpriseClubPerformanceDashboards = 67108864,
}
export class Iso3166Country
{
public Name?: string;
public TwoLetterCode?: string;
public ThreeLetterCode?: string;
public NumericCode?: number;
public PhonePrefix?: string[];
public constructor(init?: Partial<Iso3166Country>) { (Object as any).assign(this, init); }
}
export enum BranchMinimiser
{
None = 'None',
CMGo = 'CMGo',
BasicPortal = 'BasicPortal',
}
export enum ReportFormat
{
PDF = 1,
Word = 2,
Excel = 3,
PNG = 4,
XPS = 5,
CSV = 6,
Html5 = 7,
}
// @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,
}
// @Flags()
export enum SignInScreenFeature
{
None = 0,
SignInNumPad = 1,
}
export class Branch
{
public BranchId?: number;
public BranchType?: BranchType;
public Name?: string;
public Prefix?: string;
public CompanyName?: string;
public CompanyAddress?: string;
public CompanyOfficialName?: string;
public DirectDebitReference?: string;
public FastDDReference?: string;
public FastDDPlatinumRef?: string;
public Style?: string;
public PublicKey?: string;
public PrivateKey?: string;
public TrialStart?: string;
public TrialEnd?: string;
public PaymentStartDate?: string;
public InTrial?: boolean;
public UseFreeText?: boolean;
public FreeTextTitle?: string;
public UseMembershipTypes?: boolean;
public DDUserName?: string;
public DDPassword?: string;
public DDServiceUser?: string;
public DfcUserName?: string;
public DfcPassword?: string;
public DfcClubNumber?: string;
public CompanyEmail?: string;
public SmsOriginator?: string;
public LanguageId?: number;
public VatRate?: number;
public SwipeAction?: number;
public Modules?: Module;
public UseCreditBalance?: boolean;
public AllowNegativeBalance?: boolean;
public DefaultCreditLimit?: number;
public ApplicationType?: ApplicationType;
public ExternalProviderWarning?: string;
public Domain?: string;
public MobileDomain?: string;
public OnlineBookingTimetableLimit?: number;
public OnlineBookingCancellationLimit?: number;
public OnlineBookingLimit?: number;
public Feature?: Feature;
public TimeZone?: string;
public Culture?: string;
public Country?: string;
public Iso3166Country?: Iso3166Country;
public CurrencyCulture?: string;
public ShowGoCardlessAd?: boolean;
public GoCardlessSaving?: number;
public SROAddress?: string;
public MCAClubNo?: string;
public MCAClubRef?: string;
public TwilioNumber?: string;
public Telephone?: string;
public Transferred?: boolean;
public OnlineBookingAllowNonActives?: boolean;
public MemberLimit?: number;
public SortCode?: string;
public AccountNumber?: string;
public Website?: string;
public SendSMSAppointmentRemindersDefault?: boolean;
public SendSMSBookingReminders?: boolean;
public GiftAid?: boolean;
public GlobalBookingStartTime?: string;
public GlobalBookingEndTime?: string;
public BookingMinuteIncrements?: number;
public CancelReason?: string;
public CancelFurther?: string;
public CancelDate?: string;
public DirectDebitFee?: number;
public CreditCardFee?: number;
public SMSPriceAdjustment?: number;
public BookingsPayLinkOnTrack?: boolean;
public AccessControlTimeLimit?: number;
public Minimiser?: BranchMinimiser;
public AutoGenerateLicenses?: boolean;
public Terms?: string;
public FingerprintThreshold?: number;
public FingerprintMatcherThreshold?: number;
public AutoShutoff?: boolean;
public PrimaryColors?: string;
public HasColors?: 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 ReportFormat?: ReportFormat;
public FixPayments?: boolean;
public FixPaymentSchedle?: string;
public AppFeature?: AppFeature;
public SignInScreenFeature?: SignInScreenFeature;
public AppOptions?: string;
public CompanyDescription?: string;
public Capacity?: number;
public MonthlySalesTarget?: number;
public BookingAccessTimeLimit?: number;
public Facebook?: string;
public Twitter?: string;
public Instagram?: string;
public YouTube?: string;
public TikTok?: string;
public Shopify?: string;
public MinimumMemberAge?: number;
public TermsAndConditionsVersionDate?: string;
public TermsAndConditionsAcceptedDate?: string;
public TermsAndConditionsAccepted?: boolean;
public SiteUrl?: string;
public IsUsingSmartDebit?: boolean;
public IsUsingDfc?: boolean;
public IsSouthAfrica?: boolean;
public SmartDebitConfigured?: boolean;
public DfcConfigured?: boolean;
public UsingPaymentMethods?: boolean;
public SmsPrefix?: string;
public Logo?: string;
public LogoThumbnail?: string;
public LogoHash?: string;
public SendMarketingInviteWhenMemberAdded?: boolean;
public SendMarketingInviteWhenMemberJoinedOnline?: boolean;
public MarketingComplianceManagedExternally?: boolean;
public OnlineBookingAllowWaitingList?: boolean;
public OnlineMultiSiteEnabled?: boolean;
public CanBookOnline?: boolean;
public PublicMembershipTypes?: number;
public TrustedBranches?: number;
public IsAddingProspects?: boolean;
public IsSellingMemberships?: boolean;
public IsCreatingTasks?: boolean;
public IsCreatingAppointments?: boolean;
public IsBookingClasses?: boolean;
public IsRegisteringAttendance?: boolean;
public IsSellingProducts?: boolean;
public IsSendingEmails?: boolean;
public IsSendingSMS?: boolean;
public IsUsingAutomation?: boolean;
public DeductSessionsOnBooking?: boolean;
public ShowTrustedBranchBookings?: boolean;
public Score?: number;
public ApplicationId?: string;
public iOSAppLink?: string;
public AndroidAppLink?: string;
public constructor(init?: Partial<Branch>) { (Object as any).assign(this, init); }
}
TypeScript BranchService.GetBranchByKeyRequest 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/Branch/GetBranchByKey HTTP/1.1
Host: api.clubmanagercentral.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
BranchKey: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
BranchId: 0,
BranchType: DebitFinance,
Name: String,
Prefix: String,
CompanyName: String,
CompanyAddress: String,
CompanyOfficialName: String,
DirectDebitReference: String,
FastDDReference: String,
FastDDPlatinumRef: String,
Style: String,
PublicKey: 00000000000000000000000000000000,
PrivateKey: 00000000000000000000000000000000,
TrialStart: 0001-01-01,
TrialEnd: 0001-01-01,
PaymentStartDate: 0001-01-01,
InTrial: False,
UseFreeText: False,
FreeTextTitle: String,
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,
UseCreditBalance: False,
AllowNegativeBalance: False,
DefaultCreditLimit: 0,
ApplicationType: Gym,
ExternalProviderWarning: String,
Domain: String,
MobileDomain: String,
OnlineBookingTimetableLimit: 0,
OnlineBookingCancellationLimit: 0,
OnlineBookingLimit: 0,
Feature: 0,
TimeZone: String,
Culture: String,
Country: String,
CurrencyCulture: String,
ShowGoCardlessAd: False,
GoCardlessSaving: 0,
SROAddress: String,
MCAClubNo: String,
MCAClubRef: String,
TwilioNumber: String,
Telephone: String,
Transferred: False,
OnlineBookingAllowNonActives: False,
MemberLimit: 0,
SortCode: String,
AccountNumber: String,
Website: String,
SendSMSAppointmentRemindersDefault: False,
SendSMSBookingReminders: False,
GiftAid: False,
GlobalBookingStartTime: PT0S,
GlobalBookingEndTime: PT0S,
BookingMinuteIncrements: 0,
CancelReason: String,
CancelFurther: String,
CancelDate: 0001-01-01,
DirectDebitFee: 0,
CreditCardFee: 0,
SMSPriceAdjustment: 0,
BookingsPayLinkOnTrack: False,
AccessControlTimeLimit: 0,
Minimiser: None,
AutoGenerateLicenses: False,
Terms: String,
FingerprintThreshold: 0,
FingerprintMatcherThreshold: 0,
AutoShutoff: False,
PrimaryColors: String,
HasColors: False,
PrimaryColor: String,
SecondaryColor: #FF0C67,
BackgroundColor: #ffffff,
HeaderTopColor: #d4fd04,
HeaderBottomColor: #d4fd04,
SideLeftColor: #F0F0F0,
SideRightColor: #F0F0F0,
SideFontColor: #555555,
SideFontActiveColor: #808080,
ExtWebBackgroundColor: #FFFFFF,
ExtWebTextColor: #404040,
ExtWebTintBackColor: #B9DE00,
ExtWebHighlightBackColor: #FF0C67,
ExtWebTabBackColor: #e8e8e8,
HeadingColor: #000000,
ReportFormat: PDF,
FixPayments: False,
FixPaymentSchedle: String,
AppFeature: 0,
SignInScreenFeature: 0,
AppOptions: String,
CompanyDescription: String,
Capacity: 0,
MonthlySalesTarget: 0,
BookingAccessTimeLimit: 0,
Facebook: String,
Twitter: String,
Instagram: String,
YouTube: String,
TikTok: String,
Shopify: String,
MinimumMemberAge: 0,
TermsAndConditionsVersionDate: 0001-01-01,
TermsAndConditionsAcceptedDate: 0001-01-01,
TermsAndConditionsAccepted: False,
SiteUrl: "https://string",
IsUsingSmartDebit: False,
IsUsingDfc: True,
IsSouthAfrica: False,
SmartDebitConfigured: True,
DfcConfigured: True,
UsingPaymentMethods: False,
SmsPrefix: String,
Logo: "https:///Template.mvc/GetImage?id=UgByAHUAeQBNAHMAZABmADQASQBMAFEAZwBIAGMAcgArADAAQgBoADEAQQA9AD0A",
LogoThumbnail: "https:///Template.mvc/GetThumbnail?id=UgByAHUAeQBNAHMAZABmADQASQBMAFEAZwBIAGMAcgArADAAQgBoADEAQQA9AD0A",
LogoHash: String,
SendMarketingInviteWhenMemberAdded: False,
SendMarketingInviteWhenMemberJoinedOnline: False,
MarketingComplianceManagedExternally: False,
OnlineBookingAllowWaitingList: False,
OnlineMultiSiteEnabled: False,
CanBookOnline: False,
PublicMembershipTypes: 0,
TrustedBranches: 0,
IsAddingProspects: False,
IsSellingMemberships: False,
IsCreatingTasks: False,
IsCreatingAppointments: False,
IsBookingClasses: False,
IsRegisteringAttendance: False,
IsSellingProducts: False,
IsSendingEmails: False,
IsSendingSMS: False,
IsUsingAutomation: False,
DeductSessionsOnBooking: False,
ShowTrustedBranchBookings: False,
Score: 0,
ApplicationId: com.clubmanagercentral.clublink,
iOSAppLink: String,
AndroidAppLink: String
}