get_report_settings
To obtain the parameters used in reports, use the unit/get_report_settings method.
svc=unit/get_report_settings¶ms={
"itemId": <long>
}
Parameters
The request must contain the itemId parameter, specifying the unit ID.
Response
If the request is completed successfully, the response contains the parameters used in reports.
{
"speedLimit": <uint>, /* Speed limit, km/h */
"maxMessagesInterval": <uint>, /* Maximum interval between messages, seconds */
"dailyEngineHoursRate": <uint>, /* Daily rate of engine hours, seconds */
"urbanMaxSpeed": <uint>, /* Urban speed limit, km/h */
"mileageCoefficient": <double>, /* Mileage coefficient */
"fuelRateCoefficient": <double>, /* Fuel rate coefficient */
"maxDistanceBetweenCoordinates": <uint>, /* Maximum distance between coordinates in two successive messages, km (returned only if set) */
"maxMessagesSpeed": <uint>, /* Maximum speed, km/h (returned only if set) */
"speedingTolerance": <uint>, /* Allowed speeding, km/h (used if speedingMode = 1) */
"speedingMinDuration": <uint>, /* Minimum speeding time, seconds */
"speedingMode": <uint> /* Speeding detection mode: 0: use speedLimit, 1: use map data */
}
The maxDistanceBetweenCoordinates and maxMessagesSpeed parameters are returned only if they were set for the unit, for example, with the unit/update_report_settings method. If a parameter isn’t returned, the default value of 1000 is used.
If speedingMode = 0 and speedLimit = 0, the Speedings table is not generated.
If the request fails, an error code is returned:
| Error code | Description |
|---|---|
| 4 | Invalid input parameters. |
| 7 | The unit doesn’t exist, or the user doesn’t have the View detailed object properties access right to it. |