JSON API » cards » cards/statistics/get

Gets statistics for card groups and batches.

Input parameters

Requires authentication and the cards role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
batchIntegerID of card batch.NoAll batches in customer.
cardgroupIntegerID of card group.NoAll card groups in customer.
customerIntegerID of customer.NoCustomer of authentication user.

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
404The card group or batch does not exist, or you do not have permission to view it.

Data returned

Fields of card.

Example: With required parameters

https://www.015pbx.net/local/api/json/cards/statistics/get/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "batch":"123", "cardgroup":"456", ... }, { "batch":"234", "cardgroup":"567", ... } ] }

Change history