ClubManager.Api

ViewBranchGetBranches

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/BranchGetBranches


// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

    // @DataMember(Order=2)
    public Take?: number;

    // @DataMember(Order=3)
    public OrderBy?: string;

    // @DataMember(Order=4)
    public OrderByDesc?: string;

    // @DataMember(Order=5)
    public Include?: string;

    // @DataMember(Order=6)
    public Fields?: string;

    // @DataMember(Order=7)
    public Meta?: { [index: string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<T> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}

export class BranchGetBranchesInstance
{
    public BranchType?: number;
    public Name?: string;
    public Prefix?: string;
    public CompanyName?: string;
    public CompanyAddress?: string;
    public CompanyOfficialName?: string;
    public DirectDebitReference?: string;
    public FastDDReference?: string;
    public FastDDPlatinumRef?: string;
    public Style?: string;
    public PaymentStartDate?: string;
    public PublicKey?: string;
    public TrialStart?: string;
    public TrialEnd?: string;
    public InTrial?: boolean;
    public UseMembershipTypes?: boolean;
    public DDUserName?: string;
    public DDPassword?: string;
    public DDServiceUser?: string;
    public DfcUserName?: string;
    public DfcPassword?: string;
    public DfcClubNumber?: string;
    public CompanyEmail?: string;
    public SmsOriginator?: string;
    public LanguageId?: number;
    public VatRate?: number;
    public SwipeAction?: number;
    public Modules?: number;
    public UseFreeText?: boolean;
    public FreeTextTitle?: string;
    public TimeZone?: string;
    public UseCreditBalance?: boolean;
    public AllowNegativeBalance?: boolean;
    public DefaultCreditLimit?: number;
    public ApplicationType?: number;
    public ExternalProviderWarning?: string;
    public Domain?: string;
    public MobileDomain?: string;
    public OnlineBookingTimetableLimit?: number;
    public OnlineBookingCancellationLimit?: number;
    public Feature?: number;
    public ShowGoCardlessAd?: boolean;
    public ProviderSaving?: number;
    public SROAddress?: string;
    public Telephone?: string;
    public MCAClubNo?: string;
    public Transferred?: boolean;
    public OnlineBookingAllowNonActives?: boolean;
    public MemberLimit?: number;
    public SortCode?: string;
    public AccountNumber?: string;
    public SendSMSAppointmentRemindersDefault?: boolean;
    public SendSMSBookingReminders?: boolean;
    public Website?: string;
    public GiftAid?: boolean;
    public GlobalBookingStartTime?: string;
    public GlobalBookingEndTime?: string;
    public BookingMinuteIncrements?: number;
    public CancelReason?: string;
    public CancelFurther?: string;
    public CancelDate?: string;
    public TwilioNumber?: string;
    public CreditCardFee?: number;
    public DirectDebitFee?: number;
    public Culture?: string;
    public BookingsPayLinkOnTrack?: boolean;
    public AccessControlTimeLimit?: number;
    public Minimiser?: number;
    public AutoGenerateLicenses?: boolean;
    public Terms?: string;
    public FingerprintThreshold?: number;
    public FingerprintMatcherThreshold?: number;
    public CurrencyCulture?: string;
    public AutoShutoff?: boolean;
    public PrimaryColors?: string;
    public Logo?: string;
    public ReportFormat?: number;
    public Country?: string;
    public SMSPriceAdjustment?: number;
    public LogoHash?: string;
    public FixPayments?: boolean;
    public FixPaymentSchedle?: string;
    public AppFeature?: number;
    public AppOptions?: string;
    public CompanyDescription?: string;
    public Capacity?: number;
    public SignInScreenFeature?: number;
    public BookingAccessTimeLimit?: number;
    public DeductSessionsOnBooking?: boolean;
    public MonthlySalesTarget?: number;
    public ShowTrustedBranchBookings?: boolean;
    public Facebook?: string;
    public Twitter?: string;
    public Instagram?: string;
    public YouTube?: string;
    public TikTok?: string;
    public Shopify?: string;
    public MinimumMemberAge?: number;
    public UsingPaymentMethods?: number;
    public TermsAndConditionsVersionDate?: string;
    public TermsAndConditionsAcceptedDate?: string;
    public SendMarketingInviteWhenMemberAdded?: boolean;
    public SendMarketingInviteWhenMemberJoinedOnline?: boolean;
    public MarketingComplianceManagedExternally?: boolean;
    public OnlineBookingAllowWaitingList?: boolean;
    public OnlineMultiSiteEnabled?: boolean;
    public OnlineBookingLimit?: number;
    public PublicMembershipTypes?: number;
    public TrustedBranches?: number;
    public ScoreBranchId?: number;
    public iOSAppLink?: string;
    public AndroidAppLink?: string;

    public constructor(init?: Partial<BranchGetBranchesInstance>) { (Object as any).assign(this, init); }
}

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="BranchGetBranches")
export class ViewBranchGetBranches extends QueryDb<BranchGetBranchesInstance>
{

    public constructor(init?: Partial<ViewBranchGetBranches>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset?: number;

    // @DataMember(Order=2)
    public Total?: number;

    // @DataMember(Order=3)
    public Results?: T[];

    // @DataMember(Order=4)
    public Meta?: { [index: string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus?: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript 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>