List of Licenses
Version2.0
Since
Not tracked
Parameters
string$userEmail
Clients can get the list of licenses assigned to user (specified in <email>) using this API.
Request
| Method Type | URL | Authorization |
|---|---|---|
| GET | https://domain.tld/api/user/<email>/license | Service, User |
Querystrings
Please note that M is for Mandatory and O for Optional.
| Parameter | M/O | Description |
|---|---|---|
| pg | O | Page number if the results have more items than ipp |
| ipp | O | Maximum number of result items per page |
| Service | M | Service to which the user belongs. |
| Status | O | Filter the result of a specific status. Possible values are "active", "suspended" and "expired". Defaults to none. |
| Output | O | Choose amount of details to show for each program. Options are "minimal", "normal" and "full". Defaults to "normal" |
| pid | O | Filter licenses for a specific product, identified by its "id". Defaults to none |
| payment_method | O | Filter licenses for a specific payment mehtod. Possible values are , 'all', 'credit_card', 'wallet', 'voucher'. Defaults to all |
| supported_device | O | Filter licenses for a specific device. Possible values are , 'all', 'web', 'mobile', 'tablet', 'tv'. Defaults to all |
JSON Response
{
"license": {
"resultSet": {
"totalItems": 1,
"totalPages": 1,
"itemsPerPage": 1000,
"currentPage": 0,
"offset": 0
},
"licenseList": {
"description": "User licenses",
"licenses": [
{
"id": "1",
"status": "ACTIVE",
"startDate": "2013-01-11 16:22:13",
"stopDate": "2013-01-11 16:22:18",
"purchaseDate": "2013-01-11 16:22:22",
"currency": "EUR",
"paymentMethod": "credit_card",
"price": 1.0,
"productUrl": "https://boox.fi/api/user/waqqas.jabbar%40gmail.com/product/2?service=sevice1",
"recurring": false
}]
}
}
}
JSON Error Codes
| Error Code | Description |
|---|---|
| 307 | LICENSE_PARAM_INVALID_PG |
| 305 | LICENSE_PARAM_INVALID_OUTPUT |
| 300 | LICENSE_PARAM_INVALID_STATUS |
| 301 | LICENSE_PARAM_INVALID_PRODUCT_ID |
| 312 | LICENSE_PARAM_INVALID_TYPE |
| 334 | LICENSE_INVALID_PAYMENT_METHOD |