...
Parameter | Required | Type | Description | |||||
---|---|---|---|---|---|---|---|---|
${featureId} | Yes | integer | Specifies feature-specific parameters. | |||||
${returnType} | Yes | string | Specifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf. | |||||
sd | Yes | string | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2016-01-20. | |||||
ed | Yes | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2016-01-27. | |||||
granularity | Yes | integer | Specifies granularity of the returned data; Can be one of the following:
| |||||
rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or Excel. | |||||
filter | No | json/string | Applies filtering license usage data on all fields. To filter your data, use the following format:
| |||||
fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
where number "1" indicates that a specific field is visible. Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here. | |||||
limit | No | integer | Determines the maximum number of data records that can be returned. The value must be greater than zero. | |||||
offset | No | integer | Specifies the offset of the first row to return. | |||||
orderBy | No | string | Specifies the field by which you want to order your data records. The field name can be one of the following: lud, lumin, lua, lumax, lbmin, lbmax, ldtc, hu, ft. | |||||
orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
If your request is successful, you should see a response similar to the following:
Code Block | ||
---|---|---|
| ||
{
"success": ${success},
"msg": ${message},
"data": [
{
"fid": ${featureId},
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
}
],
"code": ${code},
"totalCount": ${count}
} |
where the response fields can be explained as follows:
Field | Type | Description |
---|---|---|
success | boolean | |
msg | string | |
fid | integer | |
lud | string | |
lumin | integer | |
lua | float | |
lumax | integer | |
lbmin | integer | |
lbmax | integer | |
ldtc | integer | |
hu | float | |
ft | integer | |
code | integer | |
totalCount | integer |