ClubManager.Api

<back to all web services

BranchService.GetBranchByKeyRequest

The following routes are available for this service:
POST,GET/api/Branch/GetBranchByKey
Branch Parameters:
NameParameterData TypeRequiredDescription
BranchIdformintNo
BranchTypeformBranchTypeNo
NameformstringNo
PrefixformstringNo
CompanyNameformstringNo
CompanyAddressformstringNo
CompanyOfficialNameformstringNo
DirectDebitReferenceformstringNo
FastDDReferenceformstringNo
FastDDPlatinumRefformstringNo
StyleformstringNo
PublicKeyformGuidNo
PrivateKeyformGuidNo
TrialStartformDateTime?No
TrialEndformDateTime?No
PaymentStartDateformDateTime?No
InTrialformboolNo
UseFreeTextformboolNo
FreeTextTitleformstringNo
UseMembershipTypesformboolNo
DDUserNameformstringNo
DDPasswordformstringNo
DDServiceUserformstringNo
DfcUserNameformstringNo
DfcPasswordformstringNo
DfcClubNumberformstringNo
CompanyEmailformstringNo
SmsOriginatorformstringNo
LanguageIdformint?No
VatRateformdecimalNo
SwipeActionformintNo
ModulesformModuleNo
UseCreditBalanceformboolNo
AllowNegativeBalanceformboolNo
DefaultCreditLimitformdecimalNo
ApplicationTypeformApplicationTypeNo
ExternalProviderWarningformstringNo
DomainformstringNo
MobileDomainformstringNo
OnlineBookingTimetableLimitformintNo
OnlineBookingCancellationLimitformintNo
OnlineBookingLimitformint?No
FeatureformFeatureNo
TimeZoneformstringNo
CultureformstringNo
CountryformstringNo
Iso3166CountryformIso3166CountryNo
CurrencyCultureformstringNo
ShowGoCardlessAdformboolNo
GoCardlessSavingformdecimalNo
SROAddressformstringNo
MCAClubNoformstringNo
MCAClubRefformstringNo
TwilioNumberformstringNo
TelephoneformstringNo
TransferredformboolNo
OnlineBookingAllowNonActivesformboolNo
MemberLimitformintNo
SortCodeformstringNo
AccountNumberformstringNo
WebsiteformstringNo
SendSMSAppointmentRemindersDefaultformboolNo
SendSMSBookingRemindersformboolNo
GiftAidformboolNo
GlobalBookingStartTimeformTimeSpanNo
GlobalBookingEndTimeformTimeSpanNo
BookingMinuteIncrementsformintNo
CancelReasonformstringNo
CancelFurtherformstringNo
CancelDateformDateTime?No
DirectDebitFeeformdecimalNo
CreditCardFeeformdecimalNo
SMSPriceAdjustmentformdecimalNo
BookingsPayLinkOnTrackformboolNo
AccessControlTimeLimitformintNo
MinimiserformBranchMinimiserNo
AutoGenerateLicensesformboolNo
TermsformstringNo
FingerprintThresholdformintNo
FingerprintMatcherThresholdformintNo
AutoShutoffformboolNo
PrimaryColorsformstringNo
HasColorsformboolNo
PrimaryColorformstringNo
SecondaryColorformstringNo
BackgroundColorformstringNo
HeaderTopColorformstringNo
HeaderBottomColorformstringNo
SideLeftColorformstringNo
SideRightColorformstringNo
SideFontColorformstringNo
SideFontActiveColorformstringNo
ExtWebBackgroundColorformstringNo
ExtWebTextColorformstringNo
ExtWebTintBackColorformstringNo
ExtWebHighlightBackColorformstringNo
ExtWebTabBackColorformstringNo
HeadingColorformstringNo
ReportFormatformReportFormatNo
FixPaymentsformboolNo
FixPaymentSchedleformstringNo
AppFeatureformAppFeatureNo
SignInScreenFeatureformSignInScreenFeatureNo
AppOptionsformstringNo
CompanyDescriptionformstringNo
Capacityformint?No
MonthlySalesTargetformint?No
BookingAccessTimeLimitformintNo
FacebookformstringNo
TwitterformstringNo
InstagramformstringNo
YouTubeformstringNo
TikTokformstringNo
ShopifyformstringNo
MinimumMemberAgeformintNo
TermsAndConditionsVersionDateformDateTime?No
TermsAndConditionsAcceptedDateformDateTime?No
TermsAndConditionsAcceptedformboolNo
SiteUrlformstringNo
IsUsingSmartDebitformboolNo
IsUsingDfcformboolNo
IsSouthAfricaformboolNo
SmartDebitConfiguredformboolNo
DfcConfiguredformboolNo
UsingPaymentMethodsformboolNo
SmsPrefixformstringNo
LogoformstringNo
LogoThumbnailformstringNo
LogoHashformstringNo
SendMarketingInviteWhenMemberAddedformboolNo
SendMarketingInviteWhenMemberJoinedOnlineformboolNo
MarketingComplianceManagedExternallyformboolNo
OnlineBookingAllowWaitingListformboolNo
OnlineMultiSiteEnabledformboolNo
CanBookOnlineformboolNo
PublicMembershipTypesformintNo
TrustedBranchesformintNo
IsAddingProspectsformboolNo
IsSellingMembershipsformboolNo
IsCreatingTasksformboolNo
IsCreatingAppointmentsformboolNo
IsBookingClassesformboolNo
IsRegisteringAttendanceformboolNo
IsSellingProductsformboolNo
IsSendingEmailsformboolNo
IsSendingSMSformboolNo
IsUsingAutomationformboolNo
DeductSessionsOnBookingformboolNo
ShowTrustedBranchBookingsformboolNo
ScoreformintNo
ApplicationIdformstringNo
iOSAppLinkformstringNo
AndroidAppLinkformstringNo
BranchType Enum:
DebitFinance
SmartDebit
Standard
Root
Reseller
Referrer
Module Enum:
NameValue
Standard0
Bookings1
ApplicationType Enum:
NameValue
Gym1
Golf2
Dance3
Soccer4
Vanilla5
Association6
MartialArts7
Gymnastics8
Swimming9
Nurseries10
Racquet11
SubscriptionBox12
Clinic13
Wellness14
HealthAndBeauty15
Climbing16
AfterSchoolClub17
PersonalTrainer18
Feature Enum:
NameValue
None0
Standard1
Bookings2
Rota4
GoCardless8
HomeScreen16
EPos32
Attendance64
Sales128
PaymentCollections256
MailChimp512
MultiSite1024
AccountingDashboard2048
OtherDashboards4096
Reports8192
AdvancedAccounting16384
MemberLicenseDates32768
FaceRecognition65536
MemberAccountCreation131072
Automation262144
FacebookMarketing524288
Grades1048576
ZoomIntegration2097152
SalesTargetChart4194304
CustomApp8388608
CustomAttributesOnPortal16777216
NoExport33554432
EnterpriseClubPerformanceDashboards67108864
NoBasketForBookings134217728
Iso3166Country Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
TwoLetterCodeformstringNo
ThreeLetterCodeformstringNo
NumericCodeformintNo
PhonePrefixformstring[]No
BranchMinimiser Enum:
None
CMGo
BasicPortal
ReportFormat Enum:
NameValue
PDF1
Word2
Excel3
PNG4
XPS5
CSV6
Html57
AppFeature Enum:
NameValue
None0
JoinOnline1
TodaysClasses2
RegistrationForm4
ForthcomingBookings8
WeeklyTimetable16
SessionTimetable32
FacilityTimetable64
TasterSessions128
HowToFindUs256
AttendanceLeaderboard512
MemberMessages1024
AchievementGallery2048
FreeText4096
QRCode8192
ShareAndInviteAFriend16384
RenewalPrompt32768
CurrentCapacity65536
JoinFriend131072
MemberPoints262144
PromoMembership524288
Shop1048576
ShowFacebook2097152
ShowTwitter4194304
ShowInstagram8388608
ShowYouTube16777216
ShowTikTok33554432
ShowShopify67108864
AttendanceStreak134217728
BookingCategories268435456
ShowSessionsRemaining536870912
PromptToCollectDebt1073741824
SignInScreenFeature Enum:
NameValue
None0
SignInNumPad1

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"BranchKey":"00000000000000000000000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","TrialEnd":"0001-01-01T00:00:00.0000000","PaymentStartDate":"0001-01-01T00:00:00.0000000","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","Iso3166Country":null,"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-01T00:00:00.0000000","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-01T00:00:00.0000000","TermsAndConditionsAcceptedDate":"0001-01-01T00:00:00.0000000","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"}