Add a vehicle type

The System Integrator (SI) needs to add a new vehicle type.

First step

As starting point, it is necessary to check which vehicle types are associated to the Flows instance

GET
https://api.dev.ptvgroup.tech/dataprovider/v1/sensors/detected-vehicle-type

Path parameter

No path parameters are needed.

Query parameters

No query parameters are needed.

Example of request

GET https://api.dev.ptvgroup.tech/dataprovider/v1/sensors/detected-vehicle-…

Host: api.ptvgroup.tech

Authorization: apiKey YOUR_API_KEY

Example of response

{
  "detectedVehicleTypes": [
    {
      "code": "CAR",
      "createdBy": "AS",
      "createdAt": "2026-02-15T13:43:49.005Z",
      "name": "Car",
      "description": "Motor vehicle designed for passenger transportation.",
      "equivalentFactor": 1.2,
      "configurations": {
        "additionalProp1": {}
      }
    }
  ]
}

Second step

Now it is necessary to add a new vehicle type.

POST
https://api.dev.ptvgroup.tech/dataprovider/v1/sensors/detected-vehicle-type

Path parameter

No path parameters are needed.

Query parameters

No query parameters are needed.

Example of request

POST https://api.dev.ptvgroup.tech/dataprovider/v1/sensors/detected-vehicle-…

Host: api.ptvgroup.tech

Authorization: apiKey YOUR_API_KEY

Body:

"detectedVehicleTypes": [
    {
      "name": "Truck",
      "description": "Motor vehicle designed to transport freight, carry specialized payloads, or perform other utilitarian work.",
      "equivalentFactor": 3,
      "configurations": {
        "additionalProp1": {}
      }
    }
  ]
}

Example of response

The response got by the combination of the first and second step:

{
 "detectedVehicleTypes": [
   {
     "equivalentFactor": 3,
     "code": "TRUCK",
     "createdBy": "AS",
     "createdAt": "2026-03-03T11:55:01.236456Z",
     "name": "Truck",
     "description": "Motor vehicle designed to transport freight, carry specialized payloads, or perform other utilitarian work."
   },
   {
     "equivalentFactor": 1,
     "code": "CAR",
     "createdBy": "AS",
     "createdAt": "2026-02-15T13:43:49.005Z",
     "name": "Car",
     "description": "Motor vehicle designed for passenger transportation.",
     "configurations": {
       "additionalProp1": {}
     }
   }
 ]
}

Another example of response

Another example of response containing other vehicle types, associated to a different instance:

{
 "detectedVehicleTypes": [
   {
     "equivalentFactor": 0.1,
     "code": "PEDESTRIAN",
     "createdBy": "system",
     "createdAt": "2026-02-10T11:55:01.236456Z",
     "name": "Pedestrian",
     "description": "Pedestrian"
   },
   {
     "equivalentFactor": 0.15,
     "code": "E_SCOOTER",
     "createdBy": "system",
     "createdAt": "2026-02-10T11:55:01.236456Z",
     "name": "E-Scooter",
     "description": "E-Scooter"
   },
   {
     "equivalentFactor": 1.2,
     "code": "VAN",
     "createdBy": "system",
     "createdAt": "2026-02-10T11:55:01.236456Z",
     "name": "Van",
     "description": "SUV - Light Goods"
   },
   {
     "equivalentFactor": 1.8,
     "code": "BUS",
     "createdBy": "system",
     "createdAt": "2026-02-10T11:55:01.236456Z",
     "name": "Bus/Coach",
     "description": "Bus - Coach"
   },
   {
     "equivalentFactor": 1,
     "code": "OTHER",
     "createdBy": "system",
     "createdAt": "2026-02-10T11:55:01.236456Z",
     "name": "Other",
     "description": "Other"
   },
   {
     "equivalentFactor": 1,
     "code": "NC",
     "createdBy": "system",
     "createdAt": "2026-02-10T11:55:01.236456Z",
     "name": "Not Classified",
     "description": "Not Classified"
   },
   {
     "equivalentFactor": 1,
     "code": "CAR",
     "createdBy": "AS",
     "createdAt": "2026-02-15T13:43:49.005Z",
     "name": "Car",
     "description": "Motor vehicle designed for passenger transportation.",
     "configurations": {
       "additionalProp1": {}
     }
   }
 ]
}
Best practices

Use Case