| Required role: | API |
| All Verbs | /api/Query/BranchGetBranches |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubManager.Api.Services.Query;
namespace ClubManager.Api.Services.Query
{
public partial class BranchGetBranchesInstance
{
public BranchGetBranchesInstance()
{
Logo = new byte[]{};
}
public virtual int BranchType { get; set; }
public virtual string Name { get; set; }
public virtual string Prefix { get; set; }
public virtual string CompanyName { get; set; }
public virtual string CompanyAddress { get; set; }
public virtual string CompanyOfficialName { get; set; }
public virtual string DirectDebitReference { get; set; }
public virtual string FastDDReference { get; set; }
public virtual string FastDDPlatinumRef { get; set; }
public virtual string Style { get; set; }
public virtual DateTime? PaymentStartDate { get; set; }
public virtual Guid PublicKey { get; set; }
public virtual DateTime? TrialStart { get; set; }
public virtual DateTime? TrialEnd { get; set; }
public virtual bool InTrial { get; set; }
public virtual bool UseMembershipTypes { get; set; }
public virtual string DDUserName { get; set; }
public virtual string DDPassword { get; set; }
public virtual string DDServiceUser { get; set; }
public virtual string DfcUserName { get; set; }
public virtual string DfcPassword { get; set; }
public virtual string DfcClubNumber { get; set; }
public virtual string CompanyEmail { get; set; }
public virtual string SmsOriginator { get; set; }
public virtual int? LanguageId { get; set; }
public virtual decimal VatRate { get; set; }
public virtual int SwipeAction { get; set; }
public virtual int Modules { get; set; }
public virtual bool UseFreeText { get; set; }
public virtual string FreeTextTitle { get; set; }
public virtual string TimeZone { get; set; }
public virtual bool UseCreditBalance { get; set; }
public virtual bool AllowNegativeBalance { get; set; }
public virtual decimal DefaultCreditLimit { get; set; }
public virtual int ApplicationType { get; set; }
public virtual string ExternalProviderWarning { get; set; }
public virtual string Domain { get; set; }
public virtual string MobileDomain { get; set; }
public virtual int OnlineBookingTimetableLimit { get; set; }
public virtual int OnlineBookingCancellationLimit { get; set; }
public virtual int Feature { get; set; }
public virtual bool ShowGoCardlessAd { get; set; }
public virtual decimal ProviderSaving { get; set; }
public virtual string SROAddress { get; set; }
public virtual string Telephone { get; set; }
public virtual string MCAClubNo { get; set; }
public virtual bool? Transferred { get; set; }
public virtual bool OnlineBookingAllowNonActives { get; set; }
public virtual int MemberLimit { get; set; }
public virtual string SortCode { get; set; }
public virtual string AccountNumber { get; set; }
public virtual bool SendSMSAppointmentRemindersDefault { get; set; }
public virtual bool SendSMSBookingReminders { get; set; }
public virtual string Website { get; set; }
public virtual bool GiftAid { get; set; }
public virtual TimeSpan GlobalBookingStartTime { get; set; }
public virtual TimeSpan GlobalBookingEndTime { get; set; }
public virtual int BookingMinuteIncrements { get; set; }
public virtual string CancelReason { get; set; }
public virtual string CancelFurther { get; set; }
public virtual DateTime? CancelDate { get; set; }
public virtual string TwilioNumber { get; set; }
public virtual decimal CreditCardFee { get; set; }
public virtual decimal DirectDebitFee { get; set; }
public virtual string Culture { get; set; }
public virtual bool BookingsPayLinkOnTrack { get; set; }
public virtual int AccessControlTimeLimit { get; set; }
public virtual int Minimiser { get; set; }
public virtual bool AutoGenerateLicenses { get; set; }
public virtual string Terms { get; set; }
public virtual int FingerprintThreshold { get; set; }
public virtual int FingerprintMatcherThreshold { get; set; }
public virtual string CurrencyCulture { get; set; }
public virtual bool AutoShutoff { get; set; }
public virtual string PrimaryColors { get; set; }
public virtual byte[] Logo { get; set; }
public virtual int ReportFormat { get; set; }
public virtual string Country { get; set; }
public virtual decimal SMSPriceAdjustment { get; set; }
public virtual string LogoHash { get; set; }
public virtual bool FixPayments { get; set; }
public virtual string FixPaymentSchedle { get; set; }
public virtual int AppFeature { get; set; }
public virtual string AppOptions { get; set; }
public virtual string CompanyDescription { get; set; }
public virtual int? Capacity { get; set; }
public virtual int SignInScreenFeature { get; set; }
public virtual int BookingAccessTimeLimit { get; set; }
public virtual bool DeductSessionsOnBooking { get; set; }
public virtual int MonthlySalesTarget { get; set; }
public virtual bool ShowTrustedBranchBookings { get; set; }
public virtual string Facebook { get; set; }
public virtual string Twitter { get; set; }
public virtual string Instagram { get; set; }
public virtual string YouTube { get; set; }
public virtual string TikTok { get; set; }
public virtual string Shopify { get; set; }
public virtual int MinimumMemberAge { get; set; }
public virtual int? UsingPaymentMethods { get; set; }
public virtual DateTime? TermsAndConditionsVersionDate { get; set; }
public virtual DateTime? TermsAndConditionsAcceptedDate { get; set; }
public virtual bool? SendMarketingInviteWhenMemberAdded { get; set; }
public virtual bool? SendMarketingInviteWhenMemberJoinedOnline { get; set; }
public virtual bool? MarketingComplianceManagedExternally { get; set; }
public virtual bool? OnlineBookingAllowWaitingList { get; set; }
public virtual bool OnlineMultiSiteEnabled { get; set; }
public virtual int? OnlineBookingLimit { get; set; }
public virtual int? PublicMembershipTypes { get; set; }
public virtual int? TrustedBranches { get; set; }
public virtual int ScoreBranchId { get; set; }
public virtual string iOSAppLink { get; set; }
public virtual string AndroidAppLink { get; set; }
}
[AutoQueryViewer(Description="", IconUrl="octicon:database", Title="BranchGetBranches")]
public partial class ViewBranchGetBranches
: QueryDb<BranchGetBranchesInstance>
{
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
public QueryBase()
{
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int? Skip { get; set; }
[DataMember(Order=2)]
public virtual int? Take { get; set; }
[DataMember(Order=3)]
public virtual string OrderBy { get; set; }
[DataMember(Order=4)]
public virtual string OrderByDesc { get; set; }
[DataMember(Order=5)]
public virtual string Include { get; set; }
[DataMember(Order=6)]
public virtual string Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string> Meta { get; set; }
}
public partial class QueryDb<T>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<T>
{
public QueryResponse()
{
Results = new List<T>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<T> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>