Required role: | API |
All Verbs | /api/Query/BranchStatistic |
---|
// @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 BranchStatisticInstance
{
public ActiveRedAlerts?: number;
public ActiveGreenAlerts?: number;
public ActiveSleepers?: number;
public ActivesAttendedFifty?: number;
public FourteenDayers?: number;
public AttendedLast7Dayers?: number;
public ActiveMissedPayments?: number;
public ContractExtenders?: number;
public PrePayExpiring?: number;
public SevenDayStarted?: number;
public constructor(init?: Partial<BranchStatisticInstance>) { (Object as any).assign(this, init); }
}
// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="BranchStatistic")
export class FindBranchStatistic extends QueryDb<BranchStatisticInstance>
{
public constructor(init?: Partial<FindBranchStatistic>) { 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 FindBranchStatistic 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/BranchStatistic 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":[{"ActiveRedAlerts":0,"ActiveGreenAlerts":0,"ActiveSleepers":0,"ActivesAttendedFifty":0,"FourteenDayers":0,"AttendedLast7Dayers":0,"ActiveMissedPayments":0,"ContractExtenders":0,"PrePayExpiring":0,"SevenDayStarted":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}