| Required role: | API |
| All Verbs | /api/Query/BranchGetBranches |
|---|
namespace ClubManager.Api.Services.Query
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type BranchGetBranchesInstance() =
member val BranchType:Int32 = new Int32() 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 PaymentStartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val PublicKey: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 InTrial:Boolean = new Boolean() 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:Int32 = new Int32() with get,set
member val UseFreeText:Boolean = new Boolean() with get,set
member val FreeTextTitle:String = null with get,set
member val TimeZone:String = null 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:Int32 = new Int32() 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 Feature:Int32 = new Int32() with get,set
member val ShowGoCardlessAd:Boolean = new Boolean() with get,set
member val ProviderSaving:Decimal = new Decimal() with get,set
member val SROAddress:String = null with get,set
member val Telephone:String = null with get,set
member val MCAClubNo:String = null with get,set
member val Transferred:Nullable<Boolean> = new Nullable<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 SendSMSAppointmentRemindersDefault:Boolean = new Boolean() with get,set
member val SendSMSBookingReminders:Boolean = new Boolean() with get,set
member val Website:String = null 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 TwilioNumber:String = null with get,set
member val CreditCardFee:Decimal = new Decimal() with get,set
member val DirectDebitFee:Decimal = new Decimal() with get,set
member val Culture:String = null with get,set
member val BookingsPayLinkOnTrack:Boolean = new Boolean() with get,set
member val AccessControlTimeLimit:Int32 = new Int32() with get,set
member val Minimiser:Int32 = new Int32() 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 CurrencyCulture:String = null with get,set
member val AutoShutoff:Boolean = new Boolean() with get,set
member val PrimaryColors:String = null with get,set
member val Logo:Byte[] = [||] with get,set
member val ReportFormat:Int32 = new Int32() with get,set
member val Country:String = null with get,set
member val SMSPriceAdjustment:Decimal = new Decimal() with get,set
member val LogoHash:String = null with get,set
member val FixPayments:Boolean = new Boolean() with get,set
member val FixPaymentSchedle:String = null with get,set
member val AppFeature:Int32 = new Int32() 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 SignInScreenFeature:Int32 = new Int32() with get,set
member val BookingAccessTimeLimit:Int32 = new Int32() with get,set
member val DeductSessionsOnBooking:Boolean = new Boolean() with get,set
member val MonthlySalesTarget:Int32 = new Int32() with get,set
member val ShowTrustedBranchBookings:Boolean = new Boolean() 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 UsingPaymentMethods:Nullable<Int32> = new Nullable<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 SendMarketingInviteWhenMemberAdded:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val SendMarketingInviteWhenMemberJoinedOnline:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val MarketingComplianceManagedExternally:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val OnlineBookingAllowWaitingList:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val OnlineMultiSiteEnabled:Boolean = new Boolean() with get,set
member val OnlineBookingLimit:Nullable<Int32> = new Nullable<Int32>() with get,set
member val PublicMembershipTypes:Nullable<Int32> = new Nullable<Int32>() with get,set
member val TrustedBranches:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ScoreBranchId:Int32 = new Int32() with get,set
member val iOSAppLink:String = null with get,set
member val AndroidAppLink:String = null with get,set
[<AutoQueryViewer(Description="", IconUrl="octicon:database", Title="BranchGetBranches")>]
[<AllowNullLiteral>]
type ViewBranchGetBranches() =
inherit QueryDb<BranchGetBranchesInstance>()
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
[<DataMember(Order=1)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=2)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=3)>]
member val OrderBy:String = null with get,set
[<DataMember(Order=4)>]
member val OrderByDesc:String = null with get,set
[<DataMember(Order=5)>]
member val Include:String = null with get,set
[<DataMember(Order=6)>]
member val Fields:String = null with get,set
[<DataMember(Order=7)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type QueryDb<'T>() =
inherit QueryBase()
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<'T>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<'T> = new ResizeArray<'T>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
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"}}}