| POST,GET | /api/Branch/GetBranchByKey |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 | |
| form | string | No | ||
| form | string | No | ||
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"BranchKey":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}