| POST,GET | /api/Branch/GetBranch |
|---|
namespace ClubManager.Interfaces.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type BranchType =
| DebitFinance = 0
| SmartDebit = 1
| Standard = 2
| Root = 3
| Reseller = 4
| Referrer = 5
[<Flags>]
type Module =
| Standard = 0
| Bookings = 1
type 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>]
type 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
[<AllowNullLiteral>]
type Iso3166Country() =
member val Name:String = null with get,set
member val TwoLetterCode:String = null with get,set
member val ThreeLetterCode:String = null with get,set
member val NumericCode:Int32 = new Int32() with get,set
member val PhonePrefix:String[] = [||] with get,set
type BranchMinimiser =
| None = 0
| CMGo = 1
| BasicPortal = 2
type ReportFormat =
| PDF = 1
| Word = 2
| Excel = 3
| PNG = 4
| XPS = 5
| CSV = 6
| Html5 = 7
[<Flags>]
type 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>]
type SignInScreenFeature =
| None = 0
| SignInNumPad = 1
[<AllowNullLiteral>]
type Branch() =
member val BranchId:Int32 = new Int32() with get,set
member val BranchType:BranchType = new BranchType() with get,set
member val Name:String = null with get,set
member val Prefix:String = null with get,set
member val CompanyName:String = null with get,set
member val CompanyAddress:String = null with get,set
member val CompanyOfficialName:String = null with get,set
member val DirectDebitReference:String = null with get,set
member val FastDDReference:String = null with get,set
member val FastDDPlatinumRef:String = null with get,set
member val Style:String = null with get,set
member val PublicKey:Guid = new Guid() with get,set
member val PrivateKey:Guid = new Guid() with get,set
member val TrialStart:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val TrialEnd:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val PaymentStartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val InTrial:Boolean = new Boolean() with get,set
member val UseFreeText:Boolean = new Boolean() with get,set
member val FreeTextTitle:String = null with get,set
member val UseMembershipTypes:Boolean = new Boolean() with get,set
member val DDUserName:String = null with get,set
member val DDPassword:String = null with get,set
member val DDServiceUser:String = null with get,set
member val DfcUserName:String = null with get,set
member val DfcPassword:String = null with get,set
member val DfcClubNumber:String = null with get,set
member val CompanyEmail:String = null with get,set
member val SmsOriginator:String = null with get,set
member val LanguageId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val VatRate:Decimal = new Decimal() with get,set
member val SwipeAction:Int32 = new Int32() with get,set
member val Modules:Module = new Module() with get,set
member val UseCreditBalance:Boolean = new Boolean() with get,set
member val AllowNegativeBalance:Boolean = new Boolean() with get,set
member val DefaultCreditLimit:Decimal = new Decimal() with get,set
member val ApplicationType:ApplicationType = new ApplicationType() with get,set
member val ExternalProviderWarning:String = null with get,set
member val Domain:String = null with get,set
member val MobileDomain:String = null with get,set
member val OnlineBookingTimetableLimit:Int32 = new Int32() with get,set
member val OnlineBookingCancellationLimit:Int32 = new Int32() with get,set
member val OnlineBookingLimit:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Feature:Feature = new Feature() with get,set
member val TimeZone:String = null with get,set
member val Culture:String = null with get,set
member val Country:String = null with get,set
member val Iso3166Country:Iso3166Country = null with get,set
member val CurrencyCulture:String = null with get,set
member val ShowGoCardlessAd:Boolean = new Boolean() with get,set
member val GoCardlessSaving:Decimal = new Decimal() with get,set
member val SROAddress:String = null with get,set
member val MCAClubNo:String = null with get,set
member val MCAClubRef:String = null with get,set
member val TwilioNumber:String = null with get,set
member val Telephone:String = null with get,set
member val Transferred:Boolean = new Boolean() with get,set
member val OnlineBookingAllowNonActives:Boolean = new Boolean() with get,set
member val MemberLimit:Int32 = new Int32() with get,set
member val SortCode:String = null with get,set
member val AccountNumber:String = null with get,set
member val Website:String = null with get,set
member val SendSMSAppointmentRemindersDefault:Boolean = new Boolean() with get,set
member val SendSMSBookingReminders:Boolean = new Boolean() with get,set
member val GiftAid:Boolean = new Boolean() with get,set
member val GlobalBookingStartTime:TimeSpan = new TimeSpan() with get,set
member val GlobalBookingEndTime:TimeSpan = new TimeSpan() with get,set
member val BookingMinuteIncrements:Int32 = new Int32() with get,set
member val CancelReason:String = null with get,set
member val CancelFurther:String = null with get,set
member val CancelDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DirectDebitFee:Decimal = new Decimal() with get,set
member val CreditCardFee:Decimal = new Decimal() with get,set
member val SMSPriceAdjustment:Decimal = new Decimal() with get,set
member val BookingsPayLinkOnTrack:Boolean = new Boolean() with get,set
member val AccessControlTimeLimit:Int32 = new Int32() with get,set
member val Minimiser:BranchMinimiser = new BranchMinimiser() with get,set
member val AutoGenerateLicenses:Boolean = new Boolean() with get,set
member val Terms:String = null with get,set
member val FingerprintThreshold:Int32 = new Int32() with get,set
member val FingerprintMatcherThreshold:Int32 = new Int32() with get,set
member val AutoShutoff:Boolean = new Boolean() with get,set
member val PrimaryColors:String = null with get,set
member val HasColors:Boolean = new Boolean() with get,set
member val PrimaryColor:String = null with get,set
member val SecondaryColor:String = null with get,set
member val BackgroundColor:String = null with get,set
member val HeaderTopColor:String = null with get,set
member val HeaderBottomColor:String = null with get,set
member val SideLeftColor:String = null with get,set
member val SideRightColor:String = null with get,set
member val SideFontColor:String = null with get,set
member val SideFontActiveColor:String = null with get,set
member val ExtWebBackgroundColor:String = null with get,set
member val ExtWebTextColor:String = null with get,set
member val ExtWebTintBackColor:String = null with get,set
member val ExtWebHighlightBackColor:String = null with get,set
member val ExtWebTabBackColor:String = null with get,set
member val HeadingColor:String = null with get,set
member val ReportFormat:ReportFormat = new ReportFormat() with get,set
member val FixPayments:Boolean = new Boolean() with get,set
member val FixPaymentSchedle:String = null with get,set
member val AppFeature:AppFeature = new AppFeature() with get,set
member val SignInScreenFeature:SignInScreenFeature = new SignInScreenFeature() with get,set
member val AppOptions:String = null with get,set
member val CompanyDescription:String = null with get,set
member val Capacity:Nullable<Int32> = new Nullable<Int32>() with get,set
member val MonthlySalesTarget:Nullable<Int32> = new Nullable<Int32>() with get,set
member val BookingAccessTimeLimit:Int32 = new Int32() with get,set
member val Facebook:String = null with get,set
member val Twitter:String = null with get,set
member val Instagram:String = null with get,set
member val YouTube:String = null with get,set
member val TikTok:String = null with get,set
member val Shopify:String = null with get,set
member val MinimumMemberAge:Int32 = new Int32() with get,set
member val TermsAndConditionsVersionDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val TermsAndConditionsAcceptedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val TermsAndConditionsAccepted:Boolean = new Boolean() with get,set
member val SiteUrl:String = null with get,set
member val IsUsingSmartDebit:Boolean = new Boolean() with get,set
member val IsUsingDfc:Boolean = new Boolean() with get,set
member val IsSouthAfrica:Boolean = new Boolean() with get,set
member val SmartDebitConfigured:Boolean = new Boolean() with get,set
member val DfcConfigured:Boolean = new Boolean() with get,set
member val UsingPaymentMethods:Boolean = new Boolean() with get,set
member val SmsPrefix:String = null with get,set
member val Logo:String = null with get,set
member val LogoThumbnail:String = null with get,set
member val LogoHash:String = null with get,set
member val SendMarketingInviteWhenMemberAdded:Boolean = new Boolean() with get,set
member val SendMarketingInviteWhenMemberJoinedOnline:Boolean = new Boolean() with get,set
member val MarketingComplianceManagedExternally:Boolean = new Boolean() with get,set
member val OnlineBookingAllowWaitingList:Boolean = new Boolean() with get,set
member val OnlineMultiSiteEnabled:Boolean = new Boolean() with get,set
member val CanBookOnline:Boolean = new Boolean() with get,set
member val PublicMembershipTypes:Int32 = new Int32() with get,set
member val TrustedBranches:Int32 = new Int32() with get,set
member val IsAddingProspects:Boolean = new Boolean() with get,set
member val IsSellingMemberships:Boolean = new Boolean() with get,set
member val IsCreatingTasks:Boolean = new Boolean() with get,set
member val IsCreatingAppointments:Boolean = new Boolean() with get,set
member val IsBookingClasses:Boolean = new Boolean() with get,set
member val IsRegisteringAttendance:Boolean = new Boolean() with get,set
member val IsSellingProducts:Boolean = new Boolean() with get,set
member val IsSendingEmails:Boolean = new Boolean() with get,set
member val IsSendingSMS:Boolean = new Boolean() with get,set
member val IsUsingAutomation:Boolean = new Boolean() with get,set
member val DeductSessionsOnBooking:Boolean = new Boolean() with get,set
member val ShowTrustedBranchBookings:Boolean = new Boolean() with get,set
member val Score:Int32 = new Int32() with get,set
member val ApplicationId:String = null with get,set
member val iOSAppLink:String = null with get,set
member val AndroidAppLink:String = null with get,set
F# BranchService.GetBranchRequest 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Branch/GetBranch HTTP/1.1
Host: api.clubmanagercentral.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{}
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"}