Input & Output
Request
This example shows a calculation of a mobile telescopic crane for which all technical data are known and all data of activity.
POST /v1/emissions HTTP/1.1
Host: api-emissioninsight.com
EmissionInsight-Auth-Key: [yourAuthKey]
{
"calculationId": "e1b6f7af-9f40-4ae0-abb5-0f201fdb5eb3",
"unitId": "bb584f3f-5b07-44f6-923a-df8a52922779",
"type": "MobileTelescopicCrane",
"brand": "Demag",
"model": "AC 500-2",
"weight": 96,
"year": 2009,
"driveEngine": {
"standard": "Tier",
"class": "Tier 3",
"power": 448,
"powerUnit": "kW",
"drive": "Variable",
"fuel": "GTL",
"additionalFilter": false
},
"workEngine": {
"standard": "Euro",
"class": "Euro 2",
"power": 205,
"powerUnit": "kW",
"drive": "Variable",
"fuel": "GTL",
"additionalFilter": false
},
"activity": {
"drivingDistance": 100,
"timeOnLocation": 50,
"workingTimeOnLocation": 40,
"workload": "Normal"
}
}
Input explained per field
The table below provides explanations for each property of the overall request body.
| Property | Required | Type | Description | |
|---|---|---|---|---|
| calculationId | false | String | Enter your own calculation identifier here. | |
| unitId | false | String | Enter the unique identifier for the vehicle or machine. | |
| type | true | Enum (string) | Enter the type of vehicle here. See table Vehicle Types. | |
| brand | true | String | Enter the brand of the vehicle here. | |
| model | true | String | The specific model of the vehicle as specified by the manufacturer here. | |
| weight | false | Number | The maximum permissible driving weight of the vehicle in tons, or the basic weight. | |
| year | false | Number | Vehicle year of construction. | |
| driveEngine | true | Object | The engine used to drive. When a vehicle has more than one engine, it is usually the lower engine of a vehicle. | |
| driveEngine | standard | false | Enum (string) | Engine emission standard, see table Engine emission standards. |
| driveEngine | class | false | Enum (string) | Engine emission class, see table Engine emission classes. |
| driveEngine | power | true | Number | Power of the engine. |
| driveEngine | powerUnit | false | Enum (string) | See enums Engine power units. |
| driveEngine | drive | false | Enum (string) | The engine drive, this is constant or variable. See Engine drive types |
| driveEngine | fuel | false | Enum (string) | The type of fuel used for driving. See table Fueltype. |
| driveEngine | additionalFilter | false | Boolean | If the vehicle has an additional filter attached to the engine in addition to the built-in filter system, set this field to true. By default it is set to false. This field is optional. |
| workEngine | false | Object | The engine used for work. Usually this is the upper engine of a vehicle. This field is only required when an engine other than the driving engine is used for the work. if the work engine is not entered then the driving engine will also be used to calculate emissions from the work. If work engine is given, workEngine.power is required. |
|
| workEngine | standard | false | Enum (string) | Engine emission standard, see table Engine emission standards. |
| workEngine | class | false | Enum (string) | Engine emission class, see table Engine emission classes. |
| workEngine | power | true | Number | Power of the engine. |
| workEngine | powerUnit | false | Enum (string) | See table Engine power units. |
| workEngine | drive | false | Enum (string) | The engine drive, this is constant or variable. See Engine drive types |
| workEngine | fuel | false | Enum (string) | The type of fuel used for work. See table Fueltype. |
| workEngine | additionalFilter | false | Boolean | If the vehicle has an additional filter attached to the engine in addition to the built-in filter system, set this field to true. By default it is set to false. This field is optional. |
| activity | true | Object | The activity of the machine that needs to be calculated, this can either be driving or work or both. Either drivingDistance or timeOnLocation is required for a calculation. | |
| activity | drivingDistance | false | Number | The distance driven in km. If the machine/vehicle is fixed to one location (stationary / doesn’t drive). Then the default value will be set to zero. |
| activity | timeOnLocation | false | Number | The number of hours the vehicle is on location (either in planned hours or physically). If the vehicle doesn’t perform any activities (except driving). Then the default value will be set to zero. |
| activity | workingTimeOnLocation | false | Number | The amount in percentage of time on location that the vehicle is actually working. |
| activity | workload | false | Enum (string) | This field is optional. If the company has this data, it can be filled in according to one of the options from the Workload enum. If this field is left blank it is determined according to other input fields. If the company does not have this data it is strongly recommended to ignore this field. |
Response
Status Code: 200 OK
{
"calculationId": "e1b6f7af-9f40-4ae0-abb5-0f201fdb5eb3",
"calculationStatus": "Complete",
"unitId": "bb584f3f-5b07-44f6-923a-df8a52922779",
"emissions": {
"CO2": 417.9,
"NOx": 3.42,
"PM": 0.14
},
"accuracyScore": {
"CO2": 100,
"NOx": 100,
"PM": 100
},
"assumptions": [],
"apiVersion": "v0.1-alpha",
"eicmVersion": "4.2.2"
}
Output explained per field
The table below provides explanations for each property of the output body.
| Property | Type | Description | |
|---|---|---|---|
| calculationId | string | Your calculation identifier. | |
| calculationStatus | string | The status of the calculation, when all the data is specified to do a calculation, the calculation will be set to complete. When data is missing then this is a preliminary calculation. | |
| unitId | string | the unique identifier of the vehicle or machine. | |
| emissions | object | ||
| emissions | CO2 | number | Total CO2 emission in kg. |
| emissions | NOx | number | Total NOx emission in kg. |
| emissions | PM | number | Total PM emission in kg. |
| accuracyScore | object | The accuracy score is determined based on the given input. 100% means that the input was complete and that the emission insight computational model (eicm) was able to calculate as accurately as possible. A lower score means that the deviation may be larger. The lower the score, the higher the probability of deviation from actual emissions. Based on the score, decide whether to use the calculations or perhaps re-calculate at a later time. |
|
| accuracyScore | CO2 | number | Accuracy score for CO2 emission in percentages. |
| accuracyScore | NOx | number | Accuracy score for NOx emission in percentages. |
| accuracyScore | PM | number | Accuracy score for PM emission in percentages. |
| assumptions | array | A list of messages of all assumptions that have been made to get to a calculation. | |
| apiVersion | string | The version of the api while performing the calculations. | |
| eicmVersion | string | The version of the emission insight calculation model while performing the calculations. |
Enums
The tables below show the accepted input values that can be sent with the request.
type
The vehicle type (string)
"MobileTelescopicCrane"
"MobileTowerCrane"
"CrawlerCrane"
"TruckMountedCrane"
"BallastTruck"
"TelescopicHandler"
"Truck"
"CompanyCar"
"CompanyVan"
"SPMT"
"ExcavatorWheeled"
"ExcavatorCrawler"
Engine Standard types
(string)
Below are the allowed values for engine.standard
Engine class types
(string)
Below you can see the allowed values for engine.class, this depends on the engine.standard value.
"Euro"
"Euro 0"
"Euro 1"
"Euro 2"
"Euro 3"
"Euro 4"
"Euro 5"
"Euro 6"
"Unknown"
"Stage"
"Stage 1"
"Stage 2"
"Stage 3A"
"Stage 3B"
"Stage 4"
"Stage 5"
"Unknown"
"Tier"
"Tier 0"
"Tier 1"
"Tier 2"
"Tier 3"
"Tier 4i"
"Tier 4F"
"Unknown"
"Unknown"
"Unknown"
Engine power units
(string)
"kW"
"PK"
"HP"
"Unknown"
Engine drive types
(string)
"Variable"
"Constant"
"Unknown"
Fuel types
(string)
"Petrol"
"Diesel"
"TRAXX_DIESEL"
"HVO_100"
"HVO_20"
"GTL"
"BioDiesel"
"BioEthanol"
"LPG"
"Electric"
"Hydrogen"
"Unknown"
Workload
(string)
"Low"
"Normal"
"High"
"Unknown"