ClubManager.Api

BranchService.GetBranchByKeyRequest

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

**Branch** Parameters:
Name	Parameter	Data Type	Required
BranchId	form	int	No
BranchType	form	BranchType	No
Name	form	string	No
Prefix	form	string	No
CompanyName	form	string	No
CompanyAddress	form	string	No
CompanyOfficialName	form	string	No
DirectDebitReference	form	string	No
FastDDReference	form	string	No
FastDDPlatinumRef	form	string	No
Style	form	string	No
PublicKey	form	Guid	No
PrivateKey	form	Guid	No
TrialStart	form	DateTime?	No
TrialEnd	form	DateTime?	No
PaymentStartDate	form	DateTime?	No
InTrial	form	bool	No
UseFreeText	form	bool	No
FreeTextTitle	form	string	No
UseMembershipTypes	form	bool	No
DDUserName	form	string	No
DDPassword	form	string	No
DDServiceUser	form	string	No
DfcUserName	form	string	No
DfcPassword	form	string	No
DfcClubNumber	form	string	No
CompanyEmail	form	string	No
SmsOriginator	form	string	No
LanguageId	form	int?	No
VatRate	form	decimal	No
SwipeAction	form	int	No
Modules	form	Module	No
UseCreditBalance	form	bool	No
AllowNegativeBalance	form	bool	No
DefaultCreditLimit	form	decimal	No
ApplicationType	form	ApplicationType	No
ExternalProviderWarning	form	string	No
Domain	form	string	No
MobileDomain	form	string	No
OnlineBookingTimetableLimit	form	int	No
OnlineBookingCancellationLimit	form	int	No
OnlineBookingLimit	form	int?	No
Feature	form	Feature	No
TimeZone	form	string	No
Culture	form	string	No
Country	form	string	No
Iso3166Country	form	Iso3166Country	No
CurrencyCulture	form	string	No
ShowGoCardlessAd	form	bool	No
GoCardlessSaving	form	decimal	No
SROAddress	form	string	No
MCAClubNo	form	string	No
MCAClubRef	form	string	No
TwilioNumber	form	string	No
Telephone	form	string	No
Transferred	form	bool	No
OnlineBookingAllowNonActives	form	bool	No
MemberLimit	form	int	No
SortCode	form	string	No
AccountNumber	form	string	No
Website	form	string	No
SendSMSAppointmentRemindersDefault	form	bool	No
SendSMSBookingReminders	form	bool	No
GiftAid	form	bool	No
GlobalBookingStartTime	form	TimeSpan	No
GlobalBookingEndTime	form	TimeSpan	No
BookingMinuteIncrements	form	int	No
CancelReason	form	string	No
CancelFurther	form	string	No
CancelDate	form	DateTime?	No
DirectDebitFee	form	decimal	No
CreditCardFee	form	decimal	No
SMSPriceAdjustment	form	decimal	No
BookingsPayLinkOnTrack	form	bool	No
AccessControlTimeLimit	form	int	No
Minimiser	form	BranchMinimiser	No
AutoGenerateLicenses	form	bool	No
Terms	form	string	No
FingerprintThreshold	form	int	No
FingerprintMatcherThreshold	form	int	No
AutoShutoff	form	bool	No
PrimaryColors	form	string	No
HasColors	form	bool	No
PrimaryColor	form	string	No
SecondaryColor	form	string	No
BackgroundColor	form	string	No
HeaderTopColor	form	string	No
HeaderBottomColor	form	string	No
SideLeftColor	form	string	No
SideRightColor	form	string	No
SideFontColor	form	string	No
SideFontActiveColor	form	string	No
ExtWebBackgroundColor	form	string	No
ExtWebTextColor	form	string	No
ExtWebTintBackColor	form	string	No
ExtWebHighlightBackColor	form	string	No
ExtWebTabBackColor	form	string	No
HeadingColor	form	string	No
ReportFormat	form	ReportFormat	No
FixPayments	form	bool	No
FixPaymentSchedle	form	string	No
AppFeature	form	AppFeature	No
SignInScreenFeature	form	SignInScreenFeature	No
AppOptions	form	string	No
CompanyDescription	form	string	No
Capacity	form	int?	No
MonthlySalesTarget	form	int?	No
BookingAccessTimeLimit	form	int	No
Facebook	form	string	No
Twitter	form	string	No
Instagram	form	string	No
YouTube	form	string	No
TikTok	form	string	No
Shopify	form	string	No
MinimumMemberAge	form	int	No
TermsAndConditionsVersionDate	form	DateTime?	No
TermsAndConditionsAcceptedDate	form	DateTime?	No
TermsAndConditionsAccepted	form	bool	No
SiteUrl	form	string	No
IsUsingSmartDebit	form	bool	No
IsUsingDfc	form	bool	No
IsSouthAfrica	form	bool	No
SmartDebitConfigured	form	bool	No
DfcConfigured	form	bool	No
UsingPaymentMethods	form	bool	No
SmsPrefix	form	string	No
Logo	form	string	No
LogoThumbnail	form	string	No
LogoHash	form	string	No
SendMarketingInviteWhenMemberAdded	form	bool	No
SendMarketingInviteWhenMemberJoinedOnline	form	bool	No
MarketingComplianceManagedExternally	form	bool	No
OnlineBookingAllowWaitingList	form	bool	No
OnlineMultiSiteEnabled	form	bool	No
CanBookOnline	form	bool	No
PublicMembershipTypes	form	int	No
TrustedBranches	form	int	No
IsAddingProspects	form	bool	No
IsSellingMemberships	form	bool	No
IsCreatingTasks	form	bool	No
IsCreatingAppointments	form	bool	No
IsBookingClasses	form	bool	No
IsRegisteringAttendance	form	bool	No
IsSellingProducts	form	bool	No
IsSendingEmails	form	bool	No
IsSendingSMS	form	bool	No
IsUsingAutomation	form	bool	No
DeductSessionsOnBooking	form	bool	No
ShowTrustedBranchBookings	form	bool	No
Score	form	int	No
ApplicationId	form	string	No
iOSAppLink	form	string	No
AndroidAppLink	form	string	No

**Iso3166Country** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
TwoLetterCode	form	string	No
ThreeLetterCode	form	string	No
NumericCode	form	int	No
PhonePrefix	form	string[]	No

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<BranchService.GetBranchByKeyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services">
  <BranchKey>00000000-0000-0000-0000-000000000000</BranchKey>
</BranchService.GetBranchByKeyRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Branch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Interfaces.Models.Branch">
  <_x003C_AccessControlTimeLimit_x003E_k__BackingField>0</_x003C_AccessControlTimeLimit_x003E_k__BackingField>
  <_x003C_AccountNumber_x003E_k__BackingField>String</_x003C_AccountNumber_x003E_k__BackingField>
  <_x003C_AllowNegativeBalance_x003E_k__BackingField>false</_x003C_AllowNegativeBalance_x003E_k__BackingField>
  <_x003C_AndroidAppLink_x003E_k__BackingField>String</_x003C_AndroidAppLink_x003E_k__BackingField>
  <_x003C_AppFeature_x003E_k__BackingField>None</_x003C_AppFeature_x003E_k__BackingField>
  <_x003C_AppOptions_x003E_k__BackingField>String</_x003C_AppOptions_x003E_k__BackingField>
  <_x003C_ApplicationType_x003E_k__BackingField>Gym</_x003C_ApplicationType_x003E_k__BackingField>
  <_x003C_AutoGenerateLicenses_x003E_k__BackingField>false</_x003C_AutoGenerateLicenses_x003E_k__BackingField>
  <_x003C_AutoShutoff_x003E_k__BackingField>false</_x003C_AutoShutoff_x003E_k__BackingField>
  <_x003C_BookingAccessTimeLimit_x003E_k__BackingField>0</_x003C_BookingAccessTimeLimit_x003E_k__BackingField>
  <_x003C_BookingMinuteIncrements_x003E_k__BackingField>0</_x003C_BookingMinuteIncrements_x003E_k__BackingField>
  <_x003C_BookingsPayLinkOnTrack_x003E_k__BackingField>false</_x003C_BookingsPayLinkOnTrack_x003E_k__BackingField>
  <_x003C_BranchId_x003E_k__BackingField>0</_x003C_BranchId_x003E_k__BackingField>
  <_x003C_BranchType_x003E_k__BackingField>DebitFinance</_x003C_BranchType_x003E_k__BackingField>
  <_x003C_CancelDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_CancelDate_x003E_k__BackingField>
  <_x003C_CancelFurther_x003E_k__BackingField>String</_x003C_CancelFurther_x003E_k__BackingField>
  <_x003C_CancelReason_x003E_k__BackingField>String</_x003C_CancelReason_x003E_k__BackingField>
  <_x003C_Capacity_x003E_k__BackingField>0</_x003C_Capacity_x003E_k__BackingField>
  <_x003C_CompanyAddress_x003E_k__BackingField>String</_x003C_CompanyAddress_x003E_k__BackingField>
  <_x003C_CompanyDescription_x003E_k__BackingField>String</_x003C_CompanyDescription_x003E_k__BackingField>
  <_x003C_CompanyEmail_x003E_k__BackingField>String</_x003C_CompanyEmail_x003E_k__BackingField>
  <_x003C_CompanyName_x003E_k__BackingField>String</_x003C_CompanyName_x003E_k__BackingField>
  <_x003C_CompanyOfficialName_x003E_k__BackingField>String</_x003C_CompanyOfficialName_x003E_k__BackingField>
  <_x003C_Country_x003E_k__BackingField>String</_x003C_Country_x003E_k__BackingField>
  <_x003C_CreditCardFee_x003E_k__BackingField>0</_x003C_CreditCardFee_x003E_k__BackingField>
  <_x003C_Culture_x003E_k__BackingField>String</_x003C_Culture_x003E_k__BackingField>
  <_x003C_CurrencyCulture_x003E_k__BackingField>String</_x003C_CurrencyCulture_x003E_k__BackingField>
  <_x003C_DDPassword_x003E_k__BackingField>String</_x003C_DDPassword_x003E_k__BackingField>
  <_x003C_DDServiceUser_x003E_k__BackingField>String</_x003C_DDServiceUser_x003E_k__BackingField>
  <_x003C_DDUserName_x003E_k__BackingField>String</_x003C_DDUserName_x003E_k__BackingField>
  <_x003C_DeductSessionsOnBooking_x003E_k__BackingField>false</_x003C_DeductSessionsOnBooking_x003E_k__BackingField>
  <_x003C_DefaultCreditLimit_x003E_k__BackingField>0</_x003C_DefaultCreditLimit_x003E_k__BackingField>
  <_x003C_DfcClubNumber_x003E_k__BackingField>String</_x003C_DfcClubNumber_x003E_k__BackingField>
  <_x003C_DfcPassword_x003E_k__BackingField>String</_x003C_DfcPassword_x003E_k__BackingField>
  <_x003C_DfcUserName_x003E_k__BackingField>String</_x003C_DfcUserName_x003E_k__BackingField>
  <_x003C_DirectDebitFee_x003E_k__BackingField>0</_x003C_DirectDebitFee_x003E_k__BackingField>
  <_x003C_DirectDebitReference_x003E_k__BackingField>String</_x003C_DirectDebitReference_x003E_k__BackingField>
  <_x003C_Domain_x003E_k__BackingField>String</_x003C_Domain_x003E_k__BackingField>
  <_x003C_ExternalProviderWarning_x003E_k__BackingField>String</_x003C_ExternalProviderWarning_x003E_k__BackingField>
  <_x003C_Facebook_x003E_k__BackingField>String</_x003C_Facebook_x003E_k__BackingField>
  <_x003C_FastDDPlatinumRef_x003E_k__BackingField>String</_x003C_FastDDPlatinumRef_x003E_k__BackingField>
  <_x003C_FastDDReference_x003E_k__BackingField>String</_x003C_FastDDReference_x003E_k__BackingField>
  <_x003C_Feature_x003E_k__BackingField>None</_x003C_Feature_x003E_k__BackingField>
  <_x003C_FingerprintMatcherThreshold_x003E_k__BackingField>0</_x003C_FingerprintMatcherThreshold_x003E_k__BackingField>
  <_x003C_FingerprintThreshold_x003E_k__BackingField>0</_x003C_FingerprintThreshold_x003E_k__BackingField>
  <_x003C_FixPaymentSchedle_x003E_k__BackingField>String</_x003C_FixPaymentSchedle_x003E_k__BackingField>
  <_x003C_FixPayments_x003E_k__BackingField>false</_x003C_FixPayments_x003E_k__BackingField>
  <_x003C_FreeTextTitle_x003E_k__BackingField>String</_x003C_FreeTextTitle_x003E_k__BackingField>
  <_x003C_GiftAid_x003E_k__BackingField>false</_x003C_GiftAid_x003E_k__BackingField>
  <_x003C_GlobalBookingEndTime_x003E_k__BackingField>PT0S</_x003C_GlobalBookingEndTime_x003E_k__BackingField>
  <_x003C_GlobalBookingStartTime_x003E_k__BackingField>PT0S</_x003C_GlobalBookingStartTime_x003E_k__BackingField>
  <_x003C_GoCardlessSaving_x003E_k__BackingField>0</_x003C_GoCardlessSaving_x003E_k__BackingField>
  <_x003C_InTrial_x003E_k__BackingField>false</_x003C_InTrial_x003E_k__BackingField>
  <_x003C_Instagram_x003E_k__BackingField>String</_x003C_Instagram_x003E_k__BackingField>
  <_x003C_IsAddingProspects_x003E_k__BackingField>false</_x003C_IsAddingProspects_x003E_k__BackingField>
  <_x003C_IsBookingClasses_x003E_k__BackingField>false</_x003C_IsBookingClasses_x003E_k__BackingField>
  <_x003C_IsCreatingAppointments_x003E_k__BackingField>false</_x003C_IsCreatingAppointments_x003E_k__BackingField>
  <_x003C_IsCreatingTasks_x003E_k__BackingField>false</_x003C_IsCreatingTasks_x003E_k__BackingField>
  <_x003C_IsRegisteringAttendance_x003E_k__BackingField>false</_x003C_IsRegisteringAttendance_x003E_k__BackingField>
  <_x003C_IsSellingMemberships_x003E_k__BackingField>false</_x003C_IsSellingMemberships_x003E_k__BackingField>
  <_x003C_IsSellingProducts_x003E_k__BackingField>false</_x003C_IsSellingProducts_x003E_k__BackingField>
  <_x003C_IsSendingEmails_x003E_k__BackingField>false</_x003C_IsSendingEmails_x003E_k__BackingField>
  <_x003C_IsSendingSMS_x003E_k__BackingField>false</_x003C_IsSendingSMS_x003E_k__BackingField>
  <_x003C_IsUsingAutomation_x003E_k__BackingField>false</_x003C_IsUsingAutomation_x003E_k__BackingField>
  <_x003C_LanguageId_x003E_k__BackingField>0</_x003C_LanguageId_x003E_k__BackingField>
  <_x003C_LogoHash_x003E_k__BackingField>String</_x003C_LogoHash_x003E_k__BackingField>
  <_x003C_MCAClubNo_x003E_k__BackingField>String</_x003C_MCAClubNo_x003E_k__BackingField>
  <_x003C_MCAClubRef_x003E_k__BackingField>String</_x003C_MCAClubRef_x003E_k__BackingField>
  <_x003C_MarketingComplianceManagedExternally_x003E_k__BackingField>false</_x003C_MarketingComplianceManagedExternally_x003E_k__BackingField>
  <_x003C_MemberLimit_x003E_k__BackingField>0</_x003C_MemberLimit_x003E_k__BackingField>
  <_x003C_Minimiser_x003E_k__BackingField>None</_x003C_Minimiser_x003E_k__BackingField>
  <_x003C_MinimumMemberAge_x003E_k__BackingField>0</_x003C_MinimumMemberAge_x003E_k__BackingField>
  <_x003C_MobileDomain_x003E_k__BackingField>String</_x003C_MobileDomain_x003E_k__BackingField>
  <_x003C_Modules_x003E_k__BackingField>Standard</_x003C_Modules_x003E_k__BackingField>
  <_x003C_MonthlySalesTarget_x003E_k__BackingField>0</_x003C_MonthlySalesTarget_x003E_k__BackingField>
  <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
  <_x003C_OnlineBookingAllowNonActives_x003E_k__BackingField>false</_x003C_OnlineBookingAllowNonActives_x003E_k__BackingField>
  <_x003C_OnlineBookingAllowWaitingList_x003E_k__BackingField>false</_x003C_OnlineBookingAllowWaitingList_x003E_k__BackingField>
  <_x003C_OnlineBookingCancellationLimit_x003E_k__BackingField>0</_x003C_OnlineBookingCancellationLimit_x003E_k__BackingField>
  <_x003C_OnlineBookingLimit_x003E_k__BackingField>0</_x003C_OnlineBookingLimit_x003E_k__BackingField>
  <_x003C_OnlineBookingTimetableLimit_x003E_k__BackingField>0</_x003C_OnlineBookingTimetableLimit_x003E_k__BackingField>
  <_x003C_OnlineMultiSiteEnabled_x003E_k__BackingField>false</_x003C_OnlineMultiSiteEnabled_x003E_k__BackingField>
  <_x003C_PaymentStartDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_PaymentStartDate_x003E_k__BackingField>
  <_x003C_Prefix_x003E_k__BackingField>String</_x003C_Prefix_x003E_k__BackingField>
  <_x003C_PrimaryColors_x003E_k__BackingField>String</_x003C_PrimaryColors_x003E_k__BackingField>
  <_x003C_PrivateKey_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_PrivateKey_x003E_k__BackingField>
  <_x003C_PublicKey_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_PublicKey_x003E_k__BackingField>
  <_x003C_PublicMembershipTypes_x003E_k__BackingField>0</_x003C_PublicMembershipTypes_x003E_k__BackingField>
  <_x003C_ReportFormat_x003E_k__BackingField>PDF</_x003C_ReportFormat_x003E_k__BackingField>
  <_x003C_SMSPriceAdjustment_x003E_k__BackingField>0</_x003C_SMSPriceAdjustment_x003E_k__BackingField>
  <_x003C_SROAddress_x003E_k__BackingField>String</_x003C_SROAddress_x003E_k__BackingField>
  <_x003C_Score_x003E_k__BackingField>0</_x003C_Score_x003E_k__BackingField>
  <_x003C_SendMarketingInviteWhenMemberAdded_x003E_k__BackingField>false</_x003C_SendMarketingInviteWhenMemberAdded_x003E_k__BackingField>
  <_x003C_SendMarketingInviteWhenMemberJoinedOnline_x003E_k__BackingField>false</_x003C_SendMarketingInviteWhenMemberJoinedOnline_x003E_k__BackingField>
  <_x003C_SendSMSAppointmentRemindersDefault_x003E_k__BackingField>false</_x003C_SendSMSAppointmentRemindersDefault_x003E_k__BackingField>
  <_x003C_SendSMSBookingReminders_x003E_k__BackingField>false</_x003C_SendSMSBookingReminders_x003E_k__BackingField>
  <_x003C_Shopify_x003E_k__BackingField>String</_x003C_Shopify_x003E_k__BackingField>
  <_x003C_ShowGoCardlessAd_x003E_k__BackingField>false</_x003C_ShowGoCardlessAd_x003E_k__BackingField>
  <_x003C_ShowTrustedBranchBookings_x003E_k__BackingField>false</_x003C_ShowTrustedBranchBookings_x003E_k__BackingField>
  <_x003C_SignInScreenFeature_x003E_k__BackingField>None</_x003C_SignInScreenFeature_x003E_k__BackingField>
  <_x003C_SmsOriginator_x003E_k__BackingField>String</_x003C_SmsOriginator_x003E_k__BackingField>
  <_x003C_SortCode_x003E_k__BackingField>String</_x003C_SortCode_x003E_k__BackingField>
  <_x003C_Style_x003E_k__BackingField>String</_x003C_Style_x003E_k__BackingField>
  <_x003C_SwipeAction_x003E_k__BackingField>0</_x003C_SwipeAction_x003E_k__BackingField>
  <_x003C_Telephone_x003E_k__BackingField>String</_x003C_Telephone_x003E_k__BackingField>
  <_x003C_TermsAndConditionsAcceptedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_TermsAndConditionsAcceptedDate_x003E_k__BackingField>
  <_x003C_TermsAndConditionsVersionDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_TermsAndConditionsVersionDate_x003E_k__BackingField>
  <_x003C_Terms_x003E_k__BackingField>String</_x003C_Terms_x003E_k__BackingField>
  <_x003C_TikTok_x003E_k__BackingField>String</_x003C_TikTok_x003E_k__BackingField>
  <_x003C_TimeZone_x003E_k__BackingField>String</_x003C_TimeZone_x003E_k__BackingField>
  <_x003C_Transferred_x003E_k__BackingField>false</_x003C_Transferred_x003E_k__BackingField>
  <_x003C_TrialEnd_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_TrialEnd_x003E_k__BackingField>
  <_x003C_TrialStart_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_TrialStart_x003E_k__BackingField>
  <_x003C_TrustedBranches_x003E_k__BackingField>0</_x003C_TrustedBranches_x003E_k__BackingField>
  <_x003C_TwilioNumber_x003E_k__BackingField>String</_x003C_TwilioNumber_x003E_k__BackingField>
  <_x003C_Twitter_x003E_k__BackingField>String</_x003C_Twitter_x003E_k__BackingField>
  <_x003C_UseCreditBalance_x003E_k__BackingField>false</_x003C_UseCreditBalance_x003E_k__BackingField>
  <_x003C_UseFreeText_x003E_k__BackingField>false</_x003C_UseFreeText_x003E_k__BackingField>
  <_x003C_UseMembershipTypes_x003E_k__BackingField>false</_x003C_UseMembershipTypes_x003E_k__BackingField>
  <_x003C_UsingPaymentMethods_x003E_k__BackingField>false</_x003C_UsingPaymentMethods_x003E_k__BackingField>
  <_x003C_VatRate_x003E_k__BackingField>0</_x003C_VatRate_x003E_k__BackingField>
  <_x003C_Website_x003E_k__BackingField>String</_x003C_Website_x003E_k__BackingField>
  <_x003C_YouTube_x003E_k__BackingField>String</_x003C_YouTube_x003E_k__BackingField>
  <_x003C_iOSAppLink_x003E_k__BackingField>String</_x003C_iOSAppLink_x003E_k__BackingField>
</Branch>