ClientPersistenceResponse
Response for /v2/clients/registration. It provides a generated device ID and the certificates needed to connect the ETX Message Exchange.
ClientPersistenceResponse
Response for /v2/clients/registration. It provides a generated device ID and the certificates needed to connect the ETX Message Exchange.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
DeviceID | string (uuid) | No | The generated ID (UUID v4) for the device. It can be used as: - the MQTT Client ID when connecting to the Message Exchange system - a parameter when asking for the connection endpoint - a parameter when finishing the device registration - a parameter when unregistering the device |
Certificate | object | No | Structure for the credentials required to connect to the ETX MQTT Message Exchange. |
ClientType | string (one of: Vehicle, VulnerableRoadUser, TrafficLightController, InfrastructureSensor, OnboardSensor, Software) | No | The type of the client that is to be registered. This is one of the major traffic participant groups considered in V2X communication. The system uses this value to define which topics the client will be able to publish and subscribe to. Values: - Vehicle - Vehicle with an enclosure around the passengers. (Subtypes: Motorcycle, PassengerCar, Truck, Bus, EmergencyVehicle, SchoolBus, MaintenanceVehicle) - VulnerableRoadUser - Traffic participants without a protecting enclosure. (Subtypes: Bicycle, Pedestrian, Scooter) - TrafficLightController - A Traffic light controller system. (Subtypes: NA) - InfrastructureSensor - Sensors that are deployed in the infrastructure. (Subtypes: RoadSideUnit, Camera, Lidar, Radar, InductiveLoop, MagneticSensor) - OnboardSensor - Sensors that are onboard on a vehicle(Subtypes: Camera, Lidar, Radar) - Software - A software system or application. (Subtypes: Platform, Application, NA) |
ClientSubtype | string (one of: PassengerCar, Truck, Bus, EmergencyVehicle, SchoolBus, MaintenanceVehicle, Pedestrian, Bicycle, Scooter, Motorcycle, RoadSideUnit, Camera, Lidar, Radar, InductiveLoop, MagneticSensor, Platform, Application, NA) | No | The subtype or subgroup of the client type. This further specifies the client type. For example it will specify if the client is a passenger car or a truck. See the ClientType description for the supported Subtypes for each client type. |
VendorID | string | No | The ID the vendor wants its devices to be registered under. E.g. Verizon, GM, Ford, etc. |