ClubManager.Api

<back to all web services

ViewBranchGetBranches

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/BranchGetBranches
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BranchGetBranchesInstance Parameters:
NameParameterData TypeRequiredDescription
BranchTypeformintNo
NameformstringNo
PrefixformstringNo
CompanyNameformstringNo
CompanyAddressformstringNo
CompanyOfficialNameformstringNo
DirectDebitReferenceformstringNo
FastDDReferenceformstringNo
FastDDPlatinumRefformstringNo
StyleformstringNo
PaymentStartDateformDateTime?No
PublicKeyformGuidNo
TrialStartformDateTime?No
TrialEndformDateTime?No
InTrialformboolNo
UseMembershipTypesformboolNo
DDUserNameformstringNo
DDPasswordformstringNo
DDServiceUserformstringNo
DfcUserNameformstringNo
DfcPasswordformstringNo
DfcClubNumberformstringNo
CompanyEmailformstringNo
SmsOriginatorformstringNo
LanguageIdformint?No
VatRateformdecimalNo
SwipeActionformintNo
ModulesformintNo
UseFreeTextformboolNo
FreeTextTitleformstringNo
TimeZoneformstringNo
UseCreditBalanceformboolNo
AllowNegativeBalanceformboolNo
DefaultCreditLimitformdecimalNo
ApplicationTypeformintNo
ExternalProviderWarningformstringNo
DomainformstringNo
MobileDomainformstringNo
OnlineBookingTimetableLimitformintNo
OnlineBookingCancellationLimitformintNo
FeatureformintNo
ShowGoCardlessAdformboolNo
ProviderSavingformdecimalNo
SROAddressformstringNo
TelephoneformstringNo
MCAClubNoformstringNo
Transferredformbool?No
OnlineBookingAllowNonActivesformboolNo
MemberLimitformintNo
SortCodeformstringNo
AccountNumberformstringNo
SendSMSAppointmentRemindersDefaultformboolNo
SendSMSBookingRemindersformboolNo
WebsiteformstringNo
GiftAidformboolNo
GlobalBookingStartTimeformTimeSpanNo
GlobalBookingEndTimeformTimeSpanNo
BookingMinuteIncrementsformintNo
CancelReasonformstringNo
CancelFurtherformstringNo
CancelDateformDateTime?No
TwilioNumberformstringNo
CreditCardFeeformdecimalNo
DirectDebitFeeformdecimalNo
CultureformstringNo
BookingsPayLinkOnTrackformboolNo
AccessControlTimeLimitformintNo
MinimiserformintNo
AutoGenerateLicensesformboolNo
TermsformstringNo
FingerprintThresholdformintNo
FingerprintMatcherThresholdformintNo
CurrencyCultureformstringNo
AutoShutoffformboolNo
PrimaryColorsformstringNo
Logoformbyte[]No
ReportFormatformintNo
CountryformstringNo
SMSPriceAdjustmentformdecimalNo
LogoHashformstringNo
FixPaymentsformboolNo
FixPaymentSchedleformstringNo
AppFeatureformintNo
AppOptionsformstringNo
CompanyDescriptionformstringNo
Capacityformint?No
SignInScreenFeatureformintNo
BookingAccessTimeLimitformintNo
DeductSessionsOnBookingformboolNo
MonthlySalesTargetformintNo
ShowTrustedBranchBookingsformboolNo
FacebookformstringNo
TwitterformstringNo
InstagramformstringNo
YouTubeformstringNo
TikTokformstringNo
ShopifyformstringNo
MinimumMemberAgeformintNo
UsingPaymentMethodsformint?No
TermsAndConditionsVersionDateformDateTime?No
TermsAndConditionsAcceptedDateformDateTime?No
SendMarketingInviteWhenMemberAddedformbool?No
SendMarketingInviteWhenMemberJoinedOnlineformbool?No
MarketingComplianceManagedExternallyformbool?No
OnlineBookingAllowWaitingListformbool?No
OnlineMultiSiteEnabledformboolNo
OnlineBookingLimitformint?No
PublicMembershipTypesformint?No
TrustedBranchesformint?No
ScoreBranchIdformintNo
iOSAppLinkformstringNo
AndroidAppLinkformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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