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