ClubManager.Api

ViewBranchGetBranches

**Requires Authentication**
Required role:	API

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

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

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

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

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