| Required role: | API |
| All Verbs | /api/Query/BranchGetBranches |
|---|
import Foundation
import ServiceStack
// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="BranchGetBranches")
public class ViewBranchGetBranches : QueryDb<BranchGetBranchesInstance>
{
required public init(){ super.init() }
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
}
}
public class BranchGetBranchesInstance : Codable
{
public var branchType:Int?
public var name:String?
public var `prefix`:String?
public var companyName:String?
public var companyAddress:String?
public var companyOfficialName:String?
public var directDebitReference:String?
public var fastDDReference:String?
public var fastDDPlatinumRef:String?
public var style:String?
public var paymentStartDate:Date?
public var publicKey:String?
public var trialStart:Date?
public var trialEnd:Date?
public var inTrial:Bool?
public var useMembershipTypes:Bool?
public var ddUserName:String?
public var ddPassword:String?
public var ddServiceUser:String?
public var dfcUserName:String?
public var dfcPassword:String?
public var dfcClubNumber:String?
public var companyEmail:String?
public var smsOriginator:String?
public var languageId:Int?
public var vatRate:Double?
public var swipeAction:Int?
public var modules:Int?
public var useFreeText:Bool?
public var freeTextTitle:String?
public var timeZone:String?
public var useCreditBalance:Bool?
public var allowNegativeBalance:Bool?
public var defaultCreditLimit:Double?
public var applicationType:Int?
public var externalProviderWarning:String?
public var domain:String?
public var mobileDomain:String?
public var onlineBookingTimetableLimit:Int?
public var onlineBookingCancellationLimit:Int?
public var feature:Int?
public var showGoCardlessAd:Bool?
public var providerSaving:Double?
public var sroAddress:String?
public var telephone:String?
public var mcaClubNo:String?
public var transferred:Bool?
public var onlineBookingAllowNonActives:Bool?
public var memberLimit:Int?
public var sortCode:String?
public var accountNumber:String?
public var sendSMSAppointmentRemindersDefault:Bool?
public var sendSMSBookingReminders:Bool?
public var website:String?
public var giftAid:Bool?
@TimeSpan public var globalBookingStartTime:TimeInterval?
@TimeSpan public var globalBookingEndTime:TimeInterval?
public var bookingMinuteIncrements:Int?
public var cancelReason:String?
public var cancelFurther:String?
public var cancelDate:Date?
public var twilioNumber:String?
public var creditCardFee:Double?
public var directDebitFee:Double?
public var culture:String?
public var bookingsPayLinkOnTrack:Bool?
public var accessControlTimeLimit:Int?
public var minimiser:Int?
public var autoGenerateLicenses:Bool?
public var terms:String?
public var fingerprintThreshold:Int?
public var fingerprintMatcherThreshold:Int?
public var currencyCulture:String?
public var autoShutoff:Bool?
public var primaryColors:String?
public var logo:[UInt8] = []
public var reportFormat:Int?
public var country:String?
public var smsPriceAdjustment:Double?
public var logoHash:String?
public var fixPayments:Bool?
public var fixPaymentSchedle:String?
public var appFeature:Int?
public var appOptions:String?
public var companyDescription:String?
public var capacity:Int?
public var signInScreenFeature:Int?
public var bookingAccessTimeLimit:Int?
public var deductSessionsOnBooking:Bool?
public var monthlySalesTarget:Int?
public var showTrustedBranchBookings:Bool?
public var facebook:String?
public var twitter:String?
public var instagram:String?
public var youTube:String?
public var tikTok:String?
public var shopify:String?
public var minimumMemberAge:Int?
public var usingPaymentMethods:Int?
public var termsAndConditionsVersionDate:Date?
public var termsAndConditionsAcceptedDate:Date?
public var sendMarketingInviteWhenMemberAdded:Bool?
public var sendMarketingInviteWhenMemberJoinedOnline:Bool?
public var marketingComplianceManagedExternally:Bool?
public var onlineBookingAllowWaitingList:Bool?
public var onlineMultiSiteEnabled:Bool?
public var onlineBookingLimit:Int?
public var publicMembershipTypes:Int?
public var trustedBranches:Int?
public var scoreBranchId:Int?
public var iOSAppLink:String?
public var androidAppLink:String?
required public init(){}
}
Swift ViewBranchGetBranches DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Query/BranchGetBranches HTTP/1.1
Host: api.clubmanagercentral.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"BranchType":0,"Name":"String","Prefix":"String","CompanyName":"String","CompanyAddress":"String","CompanyOfficialName":"String","DirectDebitReference":"String","FastDDReference":"String","FastDDPlatinumRef":"String","Style":"String","PaymentStartDate":"0001-01-01T00:00:00.0000000","PublicKey":"00000000000000000000000000000000","TrialStart":"0001-01-01T00:00:00.0000000","TrialEnd":"0001-01-01T00:00:00.0000000","InTrial":false,"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,"UseFreeText":false,"FreeTextTitle":"String","TimeZone":"String","UseCreditBalance":false,"AllowNegativeBalance":false,"DefaultCreditLimit":0,"ApplicationType":0,"ExternalProviderWarning":"String","Domain":"String","MobileDomain":"String","OnlineBookingTimetableLimit":0,"OnlineBookingCancellationLimit":0,"Feature":0,"ShowGoCardlessAd":false,"ProviderSaving":0,"SROAddress":"String","Telephone":"String","MCAClubNo":"String","Transferred":false,"OnlineBookingAllowNonActives":false,"MemberLimit":0,"SortCode":"String","AccountNumber":"String","SendSMSAppointmentRemindersDefault":false,"SendSMSBookingReminders":false,"Website":"String","GiftAid":false,"GlobalBookingStartTime":"PT0S","GlobalBookingEndTime":"PT0S","BookingMinuteIncrements":0,"CancelReason":"String","CancelFurther":"String","CancelDate":"0001-01-01T00:00:00.0000000","TwilioNumber":"String","CreditCardFee":0,"DirectDebitFee":0,"Culture":"String","BookingsPayLinkOnTrack":false,"AccessControlTimeLimit":0,"Minimiser":0,"AutoGenerateLicenses":false,"Terms":"String","FingerprintThreshold":0,"FingerprintMatcherThreshold":0,"CurrencyCulture":"String","AutoShutoff":false,"PrimaryColors":"String","Logo":"AA==","ReportFormat":0,"Country":"String","SMSPriceAdjustment":0,"LogoHash":"String","FixPayments":false,"FixPaymentSchedle":"String","AppFeature":0,"AppOptions":"String","CompanyDescription":"String","Capacity":0,"SignInScreenFeature":0,"BookingAccessTimeLimit":0,"DeductSessionsOnBooking":false,"MonthlySalesTarget":0,"ShowTrustedBranchBookings":false,"Facebook":"String","Twitter":"String","Instagram":"String","YouTube":"String","TikTok":"String","Shopify":"String","MinimumMemberAge":0,"UsingPaymentMethods":0,"TermsAndConditionsVersionDate":"0001-01-01T00:00:00.0000000","TermsAndConditionsAcceptedDate":"0001-01-01T00:00:00.0000000","SendMarketingInviteWhenMemberAdded":false,"SendMarketingInviteWhenMemberJoinedOnline":false,"MarketingComplianceManagedExternally":false,"OnlineBookingAllowWaitingList":false,"OnlineMultiSiteEnabled":false,"OnlineBookingLimit":0,"PublicMembershipTypes":0,"TrustedBranches":0,"ScoreBranchId":0,"iOSAppLink":"String","AndroidAppLink":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}