ClubManager.Api

ViewBranchGetBranches

**Requires Authentication**
Required role:	API

The following routes are available for this service:
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

F# ViewBranchGetBranches DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ViewBranchGetBranches xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ViewBranchGetBranches>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfBranchGetBranchesInstancePEZRWkv_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
    <d2p1:BranchGetBranchesInstance>
      <d2p1:AccessControlTimeLimit>0</d2p1:AccessControlTimeLimit>
      <d2p1:AccountNumber>String</d2p1:AccountNumber>
      <d2p1:AllowNegativeBalance>false</d2p1:AllowNegativeBalance>
      <d2p1:AndroidAppLink>String</d2p1:AndroidAppLink>
      <d2p1:AppFeature>0</d2p1:AppFeature>
      <d2p1:AppOptions>String</d2p1:AppOptions>
      <d2p1:ApplicationType>0</d2p1:ApplicationType>
      <d2p1:AutoGenerateLicenses>false</d2p1:AutoGenerateLicenses>
      <d2p1:AutoShutoff>false</d2p1:AutoShutoff>
      <d2p1:BookingAccessTimeLimit>0</d2p1:BookingAccessTimeLimit>
      <d2p1:BookingMinuteIncrements>0</d2p1:BookingMinuteIncrements>
      <d2p1:BookingsPayLinkOnTrack>false</d2p1:BookingsPayLinkOnTrack>
      <d2p1:BranchType>0</d2p1:BranchType>
      <d2p1:CancelDate>0001-01-01T00:00:00</d2p1:CancelDate>
      <d2p1:CancelFurther>String</d2p1:CancelFurther>
      <d2p1:CancelReason>String</d2p1:CancelReason>
      <d2p1:Capacity>0</d2p1:Capacity>
      <d2p1:CompanyAddress>String</d2p1:CompanyAddress>
      <d2p1:CompanyDescription>String</d2p1:CompanyDescription>
      <d2p1:CompanyEmail>String</d2p1:CompanyEmail>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:CompanyOfficialName>String</d2p1:CompanyOfficialName>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:CreditCardFee>0</d2p1:CreditCardFee>
      <d2p1:Culture>String</d2p1:Culture>
      <d2p1:CurrencyCulture>String</d2p1:CurrencyCulture>
      <d2p1:DDPassword>String</d2p1:DDPassword>
      <d2p1:DDServiceUser>String</d2p1:DDServiceUser>
      <d2p1:DDUserName>String</d2p1:DDUserName>
      <d2p1:DeductSessionsOnBooking>false</d2p1:DeductSessionsOnBooking>
      <d2p1:DefaultCreditLimit>0</d2p1:DefaultCreditLimit>
      <d2p1:DfcClubNumber>String</d2p1:DfcClubNumber>
      <d2p1:DfcPassword>String</d2p1:DfcPassword>
      <d2p1:DfcUserName>String</d2p1:DfcUserName>
      <d2p1:DirectDebitFee>0</d2p1:DirectDebitFee>
      <d2p1:DirectDebitReference>String</d2p1:DirectDebitReference>
      <d2p1:Domain>String</d2p1:Domain>
      <d2p1:ExternalProviderWarning>String</d2p1:ExternalProviderWarning>
      <d2p1:Facebook>String</d2p1:Facebook>
      <d2p1:FastDDPlatinumRef>String</d2p1:FastDDPlatinumRef>
      <d2p1:FastDDReference>String</d2p1:FastDDReference>
      <d2p1:Feature>0</d2p1:Feature>
      <d2p1:FingerprintMatcherThreshold>0</d2p1:FingerprintMatcherThreshold>
      <d2p1:FingerprintThreshold>0</d2p1:FingerprintThreshold>
      <d2p1:FixPaymentSchedle>String</d2p1:FixPaymentSchedle>
      <d2p1:FixPayments>false</d2p1:FixPayments>
      <d2p1:FreeTextTitle>String</d2p1:FreeTextTitle>
      <d2p1:GiftAid>false</d2p1:GiftAid>
      <d2p1:GlobalBookingEndTime>PT0S</d2p1:GlobalBookingEndTime>
      <d2p1:GlobalBookingStartTime>PT0S</d2p1:GlobalBookingStartTime>
      <d2p1:InTrial>false</d2p1:InTrial>
      <d2p1:Instagram>String</d2p1:Instagram>
      <d2p1:LanguageId>0</d2p1:LanguageId>
      <d2p1:Logo>AA==</d2p1:Logo>
      <d2p1:LogoHash>String</d2p1:LogoHash>
      <d2p1:MCAClubNo>String</d2p1:MCAClubNo>
      <d2p1:MarketingComplianceManagedExternally>false</d2p1:MarketingComplianceManagedExternally>
      <d2p1:MemberLimit>0</d2p1:MemberLimit>
      <d2p1:Minimiser>0</d2p1:Minimiser>
      <d2p1:MinimumMemberAge>0</d2p1:MinimumMemberAge>
      <d2p1:MobileDomain>String</d2p1:MobileDomain>
      <d2p1:Modules>0</d2p1:Modules>
      <d2p1:MonthlySalesTarget>0</d2p1:MonthlySalesTarget>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:OnlineBookingAllowNonActives>false</d2p1:OnlineBookingAllowNonActives>
      <d2p1:OnlineBookingAllowWaitingList>false</d2p1:OnlineBookingAllowWaitingList>
      <d2p1:OnlineBookingCancellationLimit>0</d2p1:OnlineBookingCancellationLimit>
      <d2p1:OnlineBookingLimit>0</d2p1:OnlineBookingLimit>
      <d2p1:OnlineBookingTimetableLimit>0</d2p1:OnlineBookingTimetableLimit>
      <d2p1:OnlineMultiSiteEnabled>false</d2p1:OnlineMultiSiteEnabled>
      <d2p1:PaymentStartDate>0001-01-01T00:00:00</d2p1:PaymentStartDate>
      <d2p1:Prefix>String</d2p1:Prefix>
      <d2p1:PrimaryColors>String</d2p1:PrimaryColors>
      <d2p1:ProviderSaving>0</d2p1:ProviderSaving>
      <d2p1:PublicKey>00000000-0000-0000-0000-000000000000</d2p1:PublicKey>
      <d2p1:PublicMembershipTypes>0</d2p1:PublicMembershipTypes>
      <d2p1:ReportFormat>0</d2p1:ReportFormat>
      <d2p1:SMSPriceAdjustment>0</d2p1:SMSPriceAdjustment>
      <d2p1:SROAddress>String</d2p1:SROAddress>
      <d2p1:ScoreBranchId>0</d2p1:ScoreBranchId>
      <d2p1:SendMarketingInviteWhenMemberAdded>false</d2p1:SendMarketingInviteWhenMemberAdded>
      <d2p1:SendMarketingInviteWhenMemberJoinedOnline>false</d2p1:SendMarketingInviteWhenMemberJoinedOnline>
      <d2p1:SendSMSAppointmentRemindersDefault>false</d2p1:SendSMSAppointmentRemindersDefault>
      <d2p1:SendSMSBookingReminders>false</d2p1:SendSMSBookingReminders>
      <d2p1:Shopify>String</d2p1:Shopify>
      <d2p1:ShowGoCardlessAd>false</d2p1:ShowGoCardlessAd>
      <d2p1:ShowTrustedBranchBookings>false</d2p1:ShowTrustedBranchBookings>
      <d2p1:SignInScreenFeature>0</d2p1:SignInScreenFeature>
      <d2p1:SmsOriginator>String</d2p1:SmsOriginator>
      <d2p1:SortCode>String</d2p1:SortCode>
      <d2p1:Style>String</d2p1:Style>
      <d2p1:SwipeAction>0</d2p1:SwipeAction>
      <d2p1:Telephone>String</d2p1:Telephone>
      <d2p1:Terms>String</d2p1:Terms>
      <d2p1:TermsAndConditionsAcceptedDate>0001-01-01T00:00:00</d2p1:TermsAndConditionsAcceptedDate>
      <d2p1:TermsAndConditionsVersionDate>0001-01-01T00:00:00</d2p1:TermsAndConditionsVersionDate>
      <d2p1:TikTok>String</d2p1:TikTok>
      <d2p1:TimeZone>String</d2p1:TimeZone>
      <d2p1:Transferred>false</d2p1:Transferred>
      <d2p1:TrialEnd>0001-01-01T00:00:00</d2p1:TrialEnd>
      <d2p1:TrialStart>0001-01-01T00:00:00</d2p1:TrialStart>
      <d2p1:TrustedBranches>0</d2p1:TrustedBranches>
      <d2p1:TwilioNumber>String</d2p1:TwilioNumber>
      <d2p1:Twitter>String</d2p1:Twitter>
      <d2p1:UseCreditBalance>false</d2p1:UseCreditBalance>
      <d2p1:UseFreeText>false</d2p1:UseFreeText>
      <d2p1:UseMembershipTypes>false</d2p1:UseMembershipTypes>
      <d2p1:UsingPaymentMethods>0</d2p1:UsingPaymentMethods>
      <d2p1:VatRate>0</d2p1:VatRate>
      <d2p1:Website>String</d2p1:Website>
      <d2p1:YouTube>String</d2p1:YouTube>
      <d2p1:iOSAppLink>String</d2p1:iOSAppLink>
    </d2p1:BranchGetBranchesInstance>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfBranchGetBranchesInstancePEZRWkv_P>