JSON API » cards » cards/statistics/get
Gets statistics for card groups and batches.
Input parameters
Requires authentication and the cards role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
batch | Integer | ID of card batch. | No | All batches in customer. |
cardgroup | Integer | ID of card group. | No | All card groups in customer. |
customer | Integer | ID of customer. | No | Customer of authentication user. |
Responses
Code | Description |
---|---|
200 | Success. |
400 | Invalid customer specified. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The 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
http://enswitch.example.com/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
Version | Changes |
---|---|
3.13 | Function added. |