ClubManager.Api

ViewBranchGetBranches

**Requires Authentication**
Required role:	API

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

}

C# ViewBranchGetBranches DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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/jsv
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-01,
			PublicKey: 00000000000000000000000000000000,
			TrialStart: 0001-01-01,
			TrialEnd: 0001-01-01,
			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-01,
			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-01,
			TermsAndConditionsAcceptedDate: 0001-01-01,
			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
		}
	}
}