| Required role: | API |
| All Verbs | /api/Query/BranchGetBranches |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@AutoQueryViewer(Description="", IconUrl="octicon:database", Title="BranchGetBranches")
open class ViewBranchGetBranches : QueryDb<BranchGetBranchesInstance>()
{
}
open class QueryDb<T> : QueryBase()
{
}
@DataContract
open class QueryBase
{
@DataMember(Order=1)
var Skip:Int? = null
@DataMember(Order=2)
var Take:Int? = null
@DataMember(Order=3)
var OrderBy:String? = null
@DataMember(Order=4)
var OrderByDesc:String? = null
@DataMember(Order=5)
var Include:String? = null
@DataMember(Order=6)
var Fields:String? = null
@DataMember(Order=7)
var Meta:HashMap<String,String> = HashMap<String,String>()
}
open class BranchGetBranchesInstance
{
var BranchType:Int? = null
var Name:String? = null
var Prefix:String? = null
var CompanyName:String? = null
var CompanyAddress:String? = null
var CompanyOfficialName:String? = null
var DirectDebitReference:String? = null
var FastDDReference:String? = null
var FastDDPlatinumRef:String? = null
var Style:String? = null
var PaymentStartDate:Date? = null
var PublicKey:UUID? = null
var TrialStart:Date? = null
var TrialEnd:Date? = null
var InTrial:Boolean? = null
var UseMembershipTypes:Boolean? = null
var DDUserName:String? = null
var DDPassword:String? = null
var DDServiceUser:String? = null
var DfcUserName:String? = null
var DfcPassword:String? = null
var DfcClubNumber:String? = null
var CompanyEmail:String? = null
var SmsOriginator:String? = null
var LanguageId:Int? = null
var VatRate:BigDecimal? = null
var SwipeAction:Int? = null
var Modules:Int? = null
var UseFreeText:Boolean? = null
var FreeTextTitle:String? = null
var TimeZone:String? = null
var UseCreditBalance:Boolean? = null
var AllowNegativeBalance:Boolean? = null
var DefaultCreditLimit:BigDecimal? = null
var ApplicationType:Int? = null
var ExternalProviderWarning:String? = null
var Domain:String? = null
var MobileDomain:String? = null
var OnlineBookingTimetableLimit:Int? = null
var OnlineBookingCancellationLimit:Int? = null
var Feature:Int? = null
var ShowGoCardlessAd:Boolean? = null
var ProviderSaving:BigDecimal? = null
var SROAddress:String? = null
var Telephone:String? = null
var MCAClubNo:String? = null
var Transferred:Boolean? = null
var OnlineBookingAllowNonActives:Boolean? = null
var MemberLimit:Int? = null
var SortCode:String? = null
var AccountNumber:String? = null
var SendSMSAppointmentRemindersDefault:Boolean? = null
var SendSMSBookingReminders:Boolean? = null
var Website:String? = null
var GiftAid:Boolean? = null
var GlobalBookingStartTime:TimeSpan? = null
var GlobalBookingEndTime:TimeSpan? = null
var BookingMinuteIncrements:Int? = null
var CancelReason:String? = null
var CancelFurther:String? = null
var CancelDate:Date? = null
var TwilioNumber:String? = null
var CreditCardFee:BigDecimal? = null
var DirectDebitFee:BigDecimal? = null
var Culture:String? = null
var BookingsPayLinkOnTrack:Boolean? = null
var AccessControlTimeLimit:Int? = null
var Minimiser:Int? = null
var AutoGenerateLicenses:Boolean? = null
var Terms:String? = null
var FingerprintThreshold:Int? = null
var FingerprintMatcherThreshold:Int? = null
var CurrencyCulture:String? = null
var AutoShutoff:Boolean? = null
var PrimaryColors:String? = null
var Logo:ByteArray? = null
var ReportFormat:Int? = null
var Country:String? = null
var SMSPriceAdjustment:BigDecimal? = null
var LogoHash:String? = null
var FixPayments:Boolean? = null
var FixPaymentSchedle:String? = null
var AppFeature:Int? = null
var AppOptions:String? = null
var CompanyDescription:String? = null
var Capacity:Int? = null
var SignInScreenFeature:Int? = null
var BookingAccessTimeLimit:Int? = null
var DeductSessionsOnBooking:Boolean? = null
var MonthlySalesTarget:Int? = null
var ShowTrustedBranchBookings:Boolean? = null
var Facebook:String? = null
var Twitter:String? = null
var Instagram:String? = null
var YouTube:String? = null
var TikTok:String? = null
var Shopify:String? = null
var MinimumMemberAge:Int? = null
var UsingPaymentMethods:Int? = null
var TermsAndConditionsVersionDate:Date? = null
var TermsAndConditionsAcceptedDate:Date? = null
var SendMarketingInviteWhenMemberAdded:Boolean? = null
var SendMarketingInviteWhenMemberJoinedOnline:Boolean? = null
var MarketingComplianceManagedExternally:Boolean? = null
var OnlineBookingAllowWaitingList:Boolean? = null
var OnlineMultiSiteEnabled:Boolean? = null
var OnlineBookingLimit:Int? = null
var PublicMembershipTypes:Int? = null
var TrustedBranches:Int? = null
var ScoreBranchId:Int? = null
var iOSAppLink:String? = null
var AndroidAppLink:String? = null
}
@DataContract
open class QueryResponse<T>
{
@DataMember(Order=1)
var Offset:Int? = null
@DataMember(Order=2)
var Total:Int? = null
@DataMember(Order=3)
var Results:ArrayList<T> = ArrayList<T>()
@DataMember(Order=4)
var Meta:HashMap<String,String> = HashMap<String,String>()
@DataMember(Order=5)
var ResponseStatus:ResponseStatus? = null
}
Kotlin ViewBranchGetBranches DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
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/csv
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"}}}