| Required role: | API |
| All Verbs | /api/Query/BranchStatistic |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ActiveRedAlerts | form | int | No | |
| ActiveGreenAlerts | form | int | No | |
| ActiveSleepers | form | int | No | |
| ActivesAttendedFifty | form | int | No | |
| FourteenDayers | form | int | No | |
| AttendedLast7Dayers | form | int | No | |
| ActiveMissedPayments | form | int | No | |
| ContractExtenders | form | int | No | |
| PrePayExpiring | form | int | No | |
| SevenDayStarted | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .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/BranchStatistic 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":[{"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"}}}