| Required role: | API |
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
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: application/json
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-01T00:00:00.0000000","PublicKey":"00000000000000000000000000000000","TrialStart":"0001-01-01T00:00:00.0000000","TrialEnd":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000","TermsAndConditionsAcceptedDate":"0001-01-01T00:00:00.0000000","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"}}}