Web API Releases

[1.4.0] - 2026-01-20

Added

• Added operations for managing installer companies:
  • GET /installers Lists available installers in the system. 
  • POST /installers Creates an installer
  • GET /installers/{installerId} Fetches a specific installer
  • GET /installers/free-email-providers Returns a list of free email providers registered by the system. The list can be used to determine if the system allows creating an installer company using the submitted email domain.
• Added operations for managing users:
  • GET /installers/{installerId}/users List users in a company
  • POST /installers/{installerId}/users Creates a users in the specified installer company
• Added operations for managing installer´s access to fleets:
  • GET /installers/access Lists all access rules
  • GET /installers/{installerId}/access/fleets/{fleetId} Fetches a specific access rule
  • PUT /installers/{installerId}/access/fleets/{fleetId} Grants an installer access to a fleet
  • DELETE /installers/{installerId}/access/fleets/{fleetId} Revokes an installer´s access to a fleet
• Added operations related to provisioning:
  • GET /installers/provisioning-mode Queries the provisioning mode supported for the specified email domain. The provisioning mode can be either automated or assisted.
    • In automated provisioning, the installer is provisioned in real time.
    • In assisted provisioning, manual intervention is required, which introduces a delay.
  • GET /installers/provisioning-requests Lists submitted provisioning requests to be processed
  • POST /installers/provisioning-requests Creates a provisioning request which includes creating a company, a user administrator and granting the installer company access to a fleet resource

[1.3.2] - 2024-04-02

Fixed

• Fixed HTTP 400 responses to be described as content application/problem+json (instead of application/json). Impacts all endpoints.

[1.3.1] - 2024-03-26

Changed

• Changed OpenAPI document from version 3.0.0 to 3.1.0.
• Changed the successful response from "OK" to OK for these operations:
  • POST /fleets/{fleetId}/vehicles
  • PUT /fleets/{fleetId}/vehicles/{vehicleId}
  • DELETE /fleets/{fleetId}/vehicles/{vehicleId}

[1.3.0] - 2024-02-27

Added

• Added POST /fleets to enable TSPs to create new fleets.

---

[1.2.1] - 2023-10-20

Changed

Changes to POST /fleets/{fleetId}/vehicles

• Restricted allowed payload size to 1 MB of data (approx. 4500 vehicles). If the payload limit is exceeded, the client will receive an HTTP 413 "Request Entity Too Large"
• Attribute VIN in a vehicle model is now flagged as required, must be 17 characters, and only letters and alphanumeric characters are allowed.
• Attribute vehicleName in a vehicle model requires a minimum of 4 characters and a maximum of 32 characters.

Changes to POST /sensors/{hardwareAddress}/measurements

• Added data validation controls to the measurement attribute to ensure the hardware address and temperatures are set to something different than zeros.
• Attribute mileage-full and mileage-partial is not allowed to have negative numbers
• Attribute 'latitude' is restricted to +-90, and 'longitude' to +-180

[1.2.0] - 2023-02-16

Added

• Added a new endpoint GET /fleets. Returns a list of all valid configured fleets.

Fixed

• General overview of API error responses impacting all endpoints
  • Mainly consistency check and removal of details in HTTP standard response title field.
  • Changed the error for having an invalid token to 401 instead of 403.
• Sensor configuration changedAt field format consistent with the open API specification format. The data was handled in two
  different backend fields now changed to use the same field.
• No changedAt field returned for sensor decommissioning events.
• Update database definition so that each fleet's combination fleetId and vehicleId are unique within a fleet, impacting all fleets in the vehicle store.

[1.1.4] - 2023-02-16

Changed

• Updated the token expiration timeout parameter in the Gravitee Access Management console for each TSP or TraX-related application.

[1.1.3] - 2022-12-02

• Described the expected successful (HTTP 200) responses for POST /fleets/{fleetId}/vehicles and PUT+DELETE /fleets/{fleetId}/vehicles/{vehicleId}

[1.1.2] - 2022-11-28

Added

• Added required flag to several attributes that always should be present

[1.1.1] - 2022-11-09

Added

• Added Oauth token endpoint for production

[1.1.0] - 2022-11-09

Added

• Added new operation GET /fleetsto enable TSPs to determine which fleets are configured in the TraX vehicle store

[1.0.0] - 2022-10-18

Changed

• Bumped version to match production release

Added

• Sensor configuration changed events now contain all the information required for a TSP to commission or decommission a sensor.

  
  // Example of new attributes in "Sensor configuration changed events"
  "sensorCommissioningStatus": "Commissioned",
  "sensorHardwareAddress": "00:0a:95:9d:68:16",
  "sensorFirmwareVersion": "bss08d",
  "sensorAxlePosition": 1,
  "sensorWheelSide": "left",
  

[0.20.2] - 2022-09-05

Removed

• The operation POST /fleets/{fleetId}/vehicles/{vehicleId} is listed in the API but is not in use. For creating one or many vehicles, clients can use this operation instead POST /fleets/{fleetId}/vehicles

[0.20.1] - 2022-08-30

Changed

• Clarified rules for recreating sensor measurements in POST /sensors/{hardwareAddress}/measurements

[0.20.0] - 2022-08-18

Added

• Added operation to list content in vehicle store based on fleet-ID GET /fleets/{fleetId}/vehicles

[0.19.0] - 2022-05-24

Changed

• Clarified how the estimatednumber of sensors are calculated in operation GET /fleets/{fleetId}/vehicles/{vehicleId}/sensor-configurations

[0.18.0] - 2022-04-04

Added

• Added possibility to set thestate for vehicles in the TraX vehicle store. Available states: available and suspended. If the state attribute is omitted, it defaults to available. Impacted operations:
  • POST /fleets/{fleetId}/vehicles/request/{requestId}
  • PUT /fleets/{fleetId}/vehicles/{vehicleId}
  • POST /fleets/{fleetId}/vehicles
• Note, to remove a vehicle, use DELETE /fleets/{fleetId}/vehicles/{vehicleId}
• Added operation to create a vehicle in the TraX vehicle store POST /fleets/{fleetId}/vehicles/{vehicleId}

Changed

• Vehicle attributes brand and modelchanged to required.

[0.17.0] - 2022-03-09

Changed

• Corrected letter casing in the GET /fleets/{fleetId}/vehicles/{vehicleId}/sensor-configurations response

[0.16.0] - 2022-02-26

Changed

• GET /fleets/{fleetId}/vehicles/{vehicleId}/sensor-configurations now contains expected and actual commissioned sensors. There's also changes to the sensor configuration part of the response message.

[0.15.0] - 2022-02-26

Changed

• Enabled TSPs to determine if all wheel-ends at the vehicle have a sensor commissioned. The return message for GET /fleets/{fleetId}/vehicles/{vehicleId}/sensor-configurations now include all axles at a vehicle. An axle contains a left- and right wheel, each wheel can have a TraX sensor commissioned. If no sensor configuration exists at a wheel-end, a sensor has not yet been commissioned.

[0.14.0] - 2021-10-27

Changed

• In /fleets/{fleetId}/vehicles/{vehicleId}changed POST to PUT to better align to HTTP standard.
• Added trailing "s" to /fleets/{fleetId}/vehicles/{vehicleId}/sensor-configurations
• Corrected schema constraint related to required fields for mileage attributes in /sensors/{hardwareAddress}/measurements

[0.13.0] - 2021-04-08

Changed

• The need to use Basic authentication and pass Client ID and Client secret (instead of the previous API key)
• Refresh tokens will not be used.
• A new tokenURL for retrieving access token.

[0.12.0] - 2021-04-08

Changed

• Major redesign of API structure, except for uploading sensor measurements