> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctechnology.io/llms.txt > Use this file to discover all available pages before exploring further. # Vehicle > Receive messages that describe a vehicle's profile and that are usually sent when something in the vehicle profile changes (e.g., a user updates the profile or there was an automatic reconfiguration triggered by another event). ## AsyncAPI ````yaml asyncapi-reference/asyncapi.yml vehicle id: vehicle title: Vehicle description: > Receive messages that describe a vehicle's profile and that are usually sent when something in the vehicle profile changes (e.g., a user updates the profile or there was an automatic reconfiguration triggered by another event). servers: - id: production-ws protocol: wss host: api.ctechnology.io bindings: [] variables: [] - id: playground-ws protocol: wss host: api.playground.ctechnology.io bindings: [] variables: [] address: vehicle parameters: [] bindings: [] operations: - &ref_4 id: receiveVehicleProfile title: Receive vehicle profile description: Receive vehicle profile updates type: receive messages: - &ref_5 id: VehicleProfile contentType: application/json payload: - name: VehicleProfile type: object properties: - name: header type: object title: Application Header description: > Headers sent with all messages. They contain meta information about the data being sent. required: false properties: - name: type type: string description: > The type of message being sent, currently only coming from the API. enumValues: - API required: false - name: api_version type: string description: | The API version this message corresponds to. required: false - name: channel type: string description: > The channel for which this data is being sent. Usually of the form `group/object`. required: false - name: uri type: string description: > An URI that identifies the data being sent. Usually, this is an URL that corresponds to a REST endpoint, where exactly the same data can be retrieved. required: false - name: data type: object title: Vehicle Profile description: > A vehicle's profile, containing all settings, installed sensors, vehicle information, etc. required: false properties: - name: id type: string description: A unique identifier for this vehicle. required: true - name: vehicle_type type: string title: Vehicle Type description: > The vehicle types currently supported by the c.technology cloud platform. `BOAT` describes nautical vehicles, `MCYCLE` motorcycles, and `CLASSCAR` classic cars. `MOTOR` is a bit a special case, but is used to describe (electric) motors that act as the primarily important part of a vehicle. More vehicle types will be supported in the future. enumValues: - BOAT - MCYCLE - CLASSCAR - MOTOR required: true - name: drivetrain_type type: string description: The drivetrain of this vehicle. enumValues: - GASOLINE - DIESEL - ELECTRIC required: true - name: hardware_type type: string description: The IoT hardware that is available in this device. required: false - name: protocol_type type: string description: >- The primary communication protocol used to communicate with the IoT hardware. required: false - name: bluetooth type: boolean description: If this device supports Bluetooth connections. required: false - name: bluetooth_address type: string description: > The Bluetooth address of this device. This can (usually) only be set once, after which it is read-only. required: false - name: development_vehicle type: boolean description: > If this vehicle is a development vehicle. Development vehicles may offer additional options during usage. required: false - name: sim_type type: string description: The SIM card type that is available for this device. required: false - name: processing_pipeline type: string description: >- The processing pipeline used for processing this vehicle's data. required: false - name: description type: string description: > Individual module overrides. **Note**: This is only for OEMs with special processing requirements. required: false - name: readOnly type: boolean required: false - name: device_id type: string description: > The short ID that is given to the vehicle owner to connect his / her vehicle to his / her user account. required: true - name: name type: string description: The owner-given name of this vehicle. required: true - name: brand type: string description: The brand of this vehicle. required: false - name: type type: string description: A type description of this vehicle. required: true - name: desc type: string description: >- The owner-given description of his / her vehicle. -> Deprecated as of v2.1 in favor of `description`. required: true - name: description type: string description: The owner-given description of his / her vehicle. required: false - name: image_id type: string description: >- The ID of the "vehicle profile" image. You can retrieve a new image identifier by POSTing a new image to `/image/`. Please refer to the respective section of this documentation. required: false - name: image_url type: string description: >- A prepared URL that describes how to access the "vehicle profile image". required: true - name: group_id type: string description: The ID of the group this vehicle belongs to. required: false - name: delivery_date type: string description: >- Date when the IoT device was sent to the customer / vehicle manufacturer. required: true - name: primary_organization_id type: string description: > The ID of the primary organization, if any. The primary organization is responsible for the subscriptions and payments of the vehicle. required: false - name: manufacturing_organization_id type: string description: | The ID of the manufacturing organization, if any. required: false - name: professional_vehicle_id type: string description: | An ID given by a professional organization, if any. required: false - name: professional_vehicle_name type: string description: > An vehicle name given by a professional organization, if any. required: false - name: professional_location_main_lon type: number description: > The location (longitude) of the vehicle, as specified by the professional organization. required: false - name: professional_location_main_lat type: number description: > The location (latitude) of the vehicle, as specified by the professional organization. required: false - name: professional_location_main_desc type: string description: | A description of the vehicle's location. required: false - name: oem_vehicle_id type: string description: > An ID given by an OEM. -> Deprecated as of API v2.1 in favor of `vehicle_identification_number` and `organization_vehicles.organization_vehicle_id`. required: false - name: oem_vehicle_type_id type: string description: > The vehicle type as specified by an OEM. -> Deprecated as of API v2.1 in favor of `organization_vehicles.organization_vehicle_type_id`. required: false - name: vehicle_registration_id type: string description: > The vehicle's official registration ID. This is usually the license plate number. required: false - name: vehicle_identification_number type: string description: > The vehicle's official identification number, abbreviated as VIN. required: false - name: ain_1_type type: string enumValues: - NONE - FUEL - BATTERY - BATTERY_2 - BATTERY_3 - BATTERY_4 - 220VLAND - 220VLINV - WATER - WATERINV required: true - name: ain_2_type type: string enumValues: - NONE - FUEL - BATTERY - BATTERY_2 - BATTERY_3 - BATTERY_4 - 220VLAND - 220VLINV - WATER - WATERINV required: true - name: ain_3_type type: string enumValues: - NONE - FUEL - BATTERY - BATTERY_2 - BATTERY_3 - BATTERY_4 - 220VLAND - 220VLINV - WATER - WATERINV required: true - name: ain_4_type type: string enumValues: - NONE - FUEL - BATTERY - BATTERY_2 - BATTERY_3 - BATTERY_4 - 220VLAND - 220VLINV - WATER - WATERINV required: true - name: ain_1_desc type: string description: Description of what is plugged into analog input 1. required: false - name: ain_2_desc type: string description: Description of what is plugged into analog input 2. required: false - name: ain_3_desc type: string description: Description of what is plugged into analog input 3. required: false - name: ain_4_desc type: string description: Description of what is plugged into analog input 4. required: false - name: din_1_type type: string enumValues: - NONE - 220VLAND - 220VLINV - WATER - WATERINV - ARBTR - ARBTRINV required: true - name: din_2_type type: string enumValues: - NONE - 220VLAND - 220VLINV - WATER - WATERINV - ARBTR - ARBTRINV required: true - name: din_3_type type: string enumValues: - NONE - 220VLAND - 220VLINV - WATER - WATERINV - ARBTR - ARBTRINV required: true - name: din_4_type type: string enumValues: - NONE - 220VLAND - 220VLINV - WATER - WATERINV - ARBTR - ARBTRINV required: true - name: din_5_type type: string enumValues: - NONE - 220VLAND - 220VLINV - WATER - WATERINV - ARBTR - ARBTRINV required: true - name: din_1_desc type: string description: Description of what is plugged into digital input 1. required: false - name: din_2_desc type: string description: Description of what is plugged into digital input 2. required: false - name: din_3_desc type: string description: Description of what is plugged into digital input 3. required: false - name: din_4_desc type: string description: Description of what is plugged into digital input 4. required: false - name: din_5_desc type: string description: Description of what is plugged into digital input 5. required: false - name: dout_1_type type: string enumValues: - NONE - LOCK - NO_REFL - IN_OSZ - IN_ISZ - OSPD_SZ - IN_FRBZ - FUEL_CRT - ARBTR required: true - name: dout_2_type type: string enumValues: - NONE - LOCK - NO_REFL - IN_OSZ - IN_ISZ - OSPD_SZ - IN_FRBZ - FUEL_CRT - ARBTR required: true - name: dout_3_type type: string enumValues: - NONE - LOCK - NO_REFL - IN_OSZ - IN_ISZ - OSPD_SZ - IN_FRBZ - FUEL_CRT - ARBTR required: true - name: dout_4_type type: string enumValues: - NONE - LOCK - NO_REFL - IN_OSZ - IN_ISZ - OSPD_SZ - IN_FRBZ - FUEL_CRT - ARBTR required: true - name: dout_1_desc type: string description: Description of what is plugged into digital output 1. required: false - name: dout_2_desc type: string description: Description of what is plugged into digital output 2. required: false - name: dout_3_desc type: string description: Description of what is plugged into digital output 3. required: false - name: dout_4_desc type: string description: Description of what is plugged into digital output 4. required: false - name: ble_temp_type type: string description: > Describes the number of Bluetooth temperature sensors connected. This can either be `NONE` or a string-encoded bit mask of the form `XXXX` (e.g., `1000` when the first BLE temperature sensor is connected). required: true - name: temp_1_desc type: string description: Descriptive text of Bluetooth temperature sensor 1. required: true - name: temp_2_desc type: string description: Descriptive text of Bluetooth temperature sensor 2. required: true - name: temp_3_desc type: string description: Descriptive text of Bluetooth temperature sensor 3. required: true - name: temp_4_desc type: string description: Descriptive text of Bluetooth temperature sensor 4. required: true - name: battery_main_model type: string enumValues: - 12V-DEF - 24V-DEF - 24V-2x12 - 24V-SLB required: true - name: battery_main_desc type: string description: Description of main battery. required: true - name: battery_ext_1_model type: string enumValues: - 12V-DEF - 24V-DEF - 24V-2x12 - 24V-SLB required: true - name: battery_ext_1_desc type: string description: Description of first external battery. required: true - name: battery_ext_2_model type: string enumValues: - 12V-DEF - 24V-DEF - 24V-2x12 - 24V-SLB required: false - name: battery_ext_2_desc type: string description: Description of second external battery. required: false - name: battery_ext_3_model type: string enumValues: - 12V-DEF - 24V-DEF - 24V-2x12 - 24V-SLB required: false - name: battery_ext_3_desc type: string description: Description of third external battery. required: false - name: battery_ext_4_model type: string enumValues: - 12V-DEF - 24V-DEF - 24V-2x12 - 24V-SLB required: false - name: battery_ext_4_desc type: string description: Description of fourth external battery. required: false - name: device_angle_offset type: number description: >- An offset in degrees that describes the positioning of the IoT device within the vehicle. required: true - name: tank_size type: number description: The size of the primary tank (in liters). required: true - name: tank_prefer_analog type: boolean description: >- If an analog tank reading should be preferred over a CAN bus reading (if available). required: false - name: can_readout type: boolean description: If the installed IoT device supports CAN bus readouts. required: true - name: obd2_readout type: boolean description: If the installed IoT device supports OBD2 bus readouts. required: true - name: n2k_readout type: boolean description: >- If the installed IoT device supports NMEA2000 bus readouts. required: true - name: hibernation_mode type: boolean description: > If the installed IoT device is in hibernation mode (where it sends less data and thus conserves energy). required: true - name: transport_mode type: boolean description: > If the installed IoT device is in transport mode (where trips are recorded, but not saved to the logbook). required: false - name: notrack_mode type: boolean description: > If the installed IoT device is in notrack mode (the sensor / location data is not processed). required: false - name: notrack_mode_deact_time type: string description: > If the notrack mode is activated, when it will deactivate again. required: false - name: function_control_mode_deact_time type: string description: > If the function control mode is activated, when it will deactivate again. required: false - name: subscription type: object title: Service Subscription description: > A subscription to a service within the c.technology cloud ecosystem. This could be for a single vehicle's functionality (most common use case), but also for an additional service such as the vehicle launch service. Note that you cannot directly create service subscriptions, but have to use another endpoint to do so (Stripe for recurring payments, buy and use a voucher for one-time activations, etc.). required: false properties: - name: id type: string description: A unique ID identifying this subscription. required: true - name: user_id type: string description: > The user for which this subscription is used (might be undefined). required: false - name: vehicle_id type: string description: > The vehicle for which this subscription is used (might be undefined). required: false - name: timestamp_start type: string description: | The timestamp when this subscription starts. required: true - name: timestamp_end type: string description: | The timestamp when this subscription ends. required: true - name: service_type type: string description: | The type of service this subscription is used for. enumValues: - BASE required: true - name: origin_type type: string description: > How this subscription originally came to be, i.e., who bought or created it. enumValues: - SUBSCR_STRIPE - SUBSCR_STRIPE_RE - VOUCHER - OEM - MANUAL - TRIAL required: true - name: stripe_subscription type: string description: > The corresponding Stripe subscription object, if it exists. required: false - name: voucher_id type: number description: | The corresponding voucher object, if it exists. required: false - name: organization_vehicles type: array description: > The organizations that are allowed to access this vehicle. The information passed along here might differ depending on your own organizational access. required: false properties: - name: id type: string description: >- A unique identifier for this Organization Vehicle object. required: true - name: organization_id type: string description: The organization ID. required: true - name: vehicle_id type: string description: The vehicle Type ID. required: true - name: vehicle_device_id type: string description: The device ID for the vehicle. required: false - name: role type: string description: >- The role of the organization in relation to the vehicle. enumValues: - VEHICLE_OWNER - VEHICLE_MAINTAINER - VEHICLE_MANUFACTURER required: false - name: primary_organization type: boolean description: >- Whether the organization is the primary organization for the vehicle. required: false - name: manufacturing_organization type: boolean description: >- Whether the organization is the manufacturing organization for the vehicle. required: false - name: vehicle_category_id type: string description: The assigned category id for the vehicle. required: false - name: vehicle_category_name type: string description: The assigned category name for the vehicle. required: false - name: vehicle_family_id type: string description: The assigned family id for the vehicle. required: false - name: vehicle_family_name type: string description: The assigned family name for the vehicle. required: false - name: vehicle_type_id type: string description: The assigned type id for the vehicle. required: false - name: vehicle_type_name type: string description: The assigned type name for the vehicle. required: false - name: vehicle_type_image_url type: string description: The image URL for the vehicle type. required: false - name: organization_vehicle_id type: string description: >- An arbitrary id that the organization has assigned to the vehicle. required: false - name: organization_vehicle_name type: string description: >- The name of the vehicle as it is known within the organization. required: false - name: organization_vehicle_desc type: string description: >- A description of the vehicle as it is known within the organization. required: false - name: vehicle_type_max_speed type: number description: >- The maximum speed of this type in km/h. This is used to adapt the frontends to the vehicle type. required: false - name: vehicle_type_battery_capacity_wh type: number description: >- Battery capacity in watt-hours (Wh) for electric vehicles. Used for range calculations and energy consumption analytics. required: false - name: vehicle_type_avg_consumption_wh_per_km type: number description: >- Average energy consumption in watt-hours per kilometer (Wh/km) for electric vehicles. This OEM-specified value is used as baseline for range calculations. required: false - name: vehicle_type_tank_capacity_l type: number description: >- Fuel tank capacity in liters for fuel-powered vehicles. Used for range calculations and fuel consumption analytics. required: false - name: vehicle_type_avg_consumption_l_per_100km type: number description: >- Average fuel consumption in liters per 100 kilometers (L/100km) for fuel-powered vehicles. This OEM-specified value is used as baseline for range calculations. required: false - name: drivetrain_type type: string description: > The drivetrain type of this vehicle type. ELECTRIC for electric vehicles, DIESEL for diesel engines, GASOLINE for gasoline engines. Used to determine appropriate consumption parameters and analytics. enumValues: - ELECTRIC - DIESEL - GASOLINE required: false - name: location_main_desc type: string description: >- The description of the main location (e.g., where it is parked) for the vehicle. required: false - name: initial_distance type: number description: >- The configured initial distance before the IoT device was installed. required: false - name: initial_operation_hours type: number description: >- The configured operation hours before the IoT device was installed. required: false - name: initial_date type: string description: The data when the IoT device was installed. required: false - name: maintenance_can_distance type: boolean description: Measured CAN distance before installation. required: true - name: initialization_complete type: boolean description: | If the initialization of this vehicle is complete. required: false - name: auto_discover_home type: boolean description: > If this vehicle automatically discovers new home locations. required: false - name: trips_end_at_home type: boolean description: > If trips of this vehicle should always stop when it approaches a home location. required: false - name: remove_trip_points_on_land type: boolean description: > If trip points on land should be removed during trip processing. required: false - name: boat_type type: string description: The type of boat, if applicable. enumValues: - MOTORBOAT - SAILBOAT required: false - name: vehicle_length_m type: number description: The length of the vehicle in meters. required: false - name: vehicle_depth_m type: number description: The depth of the vehicle in meters. required: false - name: vehicle_height_m type: number description: The height of the vehicle in meters. required: false - name: vehicle_weight_kg type: number description: The weight of the vehicle in kilograms. required: false - name: main_battery_property_pct type: string description: >- The vehicle status field that is considered the main battery property. required: false - name: main_fuel_property_pct type: string description: >- The vehicle status field that is considered the main fuel property. required: false - name: display_settings type: object title: Vehicle Display Settings description: > Various settings related to how a vehicle is displayed in the native or web app. Currently, this is not editable, but only available as part of a vehicle GET response. required: false properties: - name: webapp_sidebar_slot_1 type: string description: > The vehicle status property to display in the first slot of the vehicle sidebar in the web app. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". required: false - name: webapp_sidebar_slot_2 type: string description: > The vehicle status property to display in the second slot of the vehicle sidebar in the web app. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". required: false - name: nativeapp_dashboard_main type: string description: > What to show on the dashboard in the native app. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". required: false - name: nativeapp_four_most_important_1 type: string description: > What to show as the most important additional property. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". required: false - name: nativeapp_four_most_important_2 type: string description: > What to show as the second most important additional property. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". required: false - name: nativeapp_four_most_important_3 type: string description: > What to show as the third most important additional property. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". required: false - name: nativeapp_four_most_important_4 type: string description: > What to show as the fourth most important additional property. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". required: false headers: [] jsonPayloadSchema: type: object properties: header: type: object title: Application Header description: > Headers sent with all messages. They contain meta information about the data being sent. properties: type: type: string description: > The type of message being sent, currently only coming from the API. enum: - API x-parser-schema-id: api_version: type: string description: | The API version this message corresponds to. x-parser-schema-id: channel: type: string description: > The channel for which this data is being sent. Usually of the form `group/object`. x-parser-schema-id: uri: type: string format: uri description: > An URI that identifies the data being sent. Usually, this is an URL that corresponds to a REST endpoint, where exactly the same data can be retrieved. x-parser-schema-id: x-parser-schema-id: ApplicationHeader data: type: object title: Vehicle Profile description: > A vehicle's profile, containing all settings, installed sensors, vehicle information, etc. required: - id - vehicle_type - drivetrain_type - device_id - name - type - desc - image_url - ain_1_type - ain_2_type - ain_3_type - ain_4_type - din_1_type - din_2_type - din_3_type - din_4_type - din_5_type - dout_1_type - dout_2_type - dout_3_type - dout_4_type - ble_temp_type - temp_1_desc - temp_2_desc - temp_3_desc - temp_4_desc - battery_main_model - battery_main_desc - battery_ext_1_model - battery_ext_1_desc - device_angle_offset - tank_size - can_readout - obd2_readout - n2k_readout - hibernation_mode - maintenance_can_distance - delivery_date properties: id: type: string description: A unique identifier for this vehicle. readOnly: true x-parser-schema-id: vehicle_type: type: string title: Vehicle Type description: > The vehicle types currently supported by the c.technology cloud platform. `BOAT` describes nautical vehicles, `MCYCLE` motorcycles, and `CLASSCAR` classic cars. `MOTOR` is a bit a special case, but is used to describe (electric) motors that act as the primarily important part of a vehicle. More vehicle types will be supported in the future. enum: - BOAT - MCYCLE - CLASSCAR - MOTOR x-parser-schema-id: VehicleType drivetrain_type: type: string description: The drivetrain of this vehicle. enum: - GASOLINE - DIESEL - ELECTRIC x-parser-schema-id: hardware_type: type: string description: The IoT hardware that is available in this device. readOnly: true x-parser-schema-id: protocol_type: type: string description: >- The primary communication protocol used to communicate with the IoT hardware. readOnly: true x-parser-schema-id: bluetooth: type: boolean description: If this device supports Bluetooth connections. readOnly: true x-parser-schema-id: bluetooth_address: type: string description: > The Bluetooth address of this device. This can (usually) only be set once, after which it is read-only. x-parser-schema-id: development_vehicle: type: boolean description: > If this vehicle is a development vehicle. Development vehicles may offer additional options during usage. readOnly: true x-parser-schema-id: sim_type: type: string description: The SIM card type that is available for this device. readOnly: true x-parser-schema-id: processing_pipeline: type: string description: >- The processing pipeline used for processing this vehicle's data. readOnly: true x-parser-schema-id: processing_pipeline_module_options_overrides: description: > Individual module overrides. **Note**: This is only for OEMs with special processing requirements. readOnly: true x-parser-schema-id: device_id: type: string description: > The short ID that is given to the vehicle owner to connect his / her vehicle to his / her user account. readOnly: true x-parser-schema-id: name: type: string description: The owner-given name of this vehicle. x-parser-schema-id: brand: type: string description: The brand of this vehicle. x-parser-schema-id: type: type: string description: A type description of this vehicle. x-parser-schema-id: desc: type: string description: >- The owner-given description of his / her vehicle. -> Deprecated as of v2.1 in favor of `description`. x-parser-schema-id: description: type: string description: The owner-given description of his / her vehicle. x-parser-schema-id: image_id: type: string description: >- The ID of the "vehicle profile" image. You can retrieve a new image identifier by POSTing a new image to `/image/`. Please refer to the respective section of this documentation. x-parser-schema-id: image_url: type: string description: >- A prepared URL that describes how to access the "vehicle profile image". readOnly: true x-parser-schema-id: group_id: type: string description: The ID of the group this vehicle belongs to. readOnly: true x-parser-schema-id: delivery_date: type: string format: date-time description: >- Date when the IoT device was sent to the customer / vehicle manufacturer. readOnly: true x-parser-schema-id: primary_organization_id: type: string description: > The ID of the primary organization, if any. The primary organization is responsible for the subscriptions and payments of the vehicle. x-parser-schema-id: manufacturing_organization_id: type: string description: | The ID of the manufacturing organization, if any. x-parser-schema-id: professional_vehicle_id: type: string x-internal: true description: | An ID given by a professional organization, if any. x-parser-schema-id: professional_vehicle_name: type: string x-internal: true description: > An vehicle name given by a professional organization, if any. x-parser-schema-id: professional_location_main_lon: type: number x-internal: true description: > The location (longitude) of the vehicle, as specified by the professional organization. x-parser-schema-id: professional_location_main_lat: type: number x-internal: true description: > The location (latitude) of the vehicle, as specified by the professional organization. x-parser-schema-id: professional_location_main_desc: type: string x-internal: true description: | A description of the vehicle's location. x-parser-schema-id: oem_vehicle_id: type: string description: > An ID given by an OEM. -> Deprecated as of API v2.1 in favor of `vehicle_identification_number` and `organization_vehicles.organization_vehicle_id`. x-parser-schema-id: oem_vehicle_type_id: type: string description: > The vehicle type as specified by an OEM. -> Deprecated as of API v2.1 in favor of `organization_vehicles.organization_vehicle_type_id`. x-parser-schema-id: vehicle_registration_id: type: string description: > The vehicle's official registration ID. This is usually the license plate number. x-parser-schema-id: vehicle_identification_number: type: string description: > The vehicle's official identification number, abbreviated as VIN. x-parser-schema-id: ain_1_type: &ref_0 enum: - NONE - FUEL - BATTERY - BATTERY_2 - BATTERY_3 - BATTERY_4 - 220VLAND - 220VLINV - WATER - WATERINV x-parser-schema-id: AINType ain_2_type: *ref_0 ain_3_type: *ref_0 ain_4_type: *ref_0 ain_1_desc: type: string description: Description of what is plugged into analog input 1. x-parser-schema-id: ain_2_desc: type: string description: Description of what is plugged into analog input 2. x-parser-schema-id: ain_3_desc: type: string description: Description of what is plugged into analog input 3. x-parser-schema-id: ain_4_desc: type: string description: Description of what is plugged into analog input 4. x-parser-schema-id: din_1_type: &ref_1 enum: - NONE - 220VLAND - 220VLINV - WATER - WATERINV - ARBTR - ARBTRINV x-parser-schema-id: DINType din_2_type: *ref_1 din_3_type: *ref_1 din_4_type: *ref_1 din_5_type: *ref_1 din_1_desc: type: string description: Description of what is plugged into digital input 1. x-parser-schema-id: din_2_desc: type: string description: Description of what is plugged into digital input 2. x-parser-schema-id: din_3_desc: type: string description: Description of what is plugged into digital input 3. x-parser-schema-id: din_4_desc: type: string description: Description of what is plugged into digital input 4. x-parser-schema-id: din_5_desc: type: string description: Description of what is plugged into digital input 5. x-parser-schema-id: dout_1_type: &ref_2 enum: - NONE - LOCK - NO_REFL - IN_OSZ - IN_ISZ - OSPD_SZ - IN_FRBZ - FUEL_CRT - ARBTR x-parser-schema-id: DOUTType dout_2_type: *ref_2 dout_3_type: *ref_2 dout_4_type: *ref_2 dout_1_desc: type: string description: Description of what is plugged into digital output 1. x-parser-schema-id: dout_2_desc: type: string description: Description of what is plugged into digital output 2. x-parser-schema-id: dout_3_desc: type: string description: Description of what is plugged into digital output 3. x-parser-schema-id: dout_4_desc: type: string description: Description of what is plugged into digital output 4. x-parser-schema-id: ble_temp_type: type: string description: > Describes the number of Bluetooth temperature sensors connected. This can either be `NONE` or a string-encoded bit mask of the form `XXXX` (e.g., `1000` when the first BLE temperature sensor is connected). x-parser-schema-id: temp_1_desc: type: string description: Descriptive text of Bluetooth temperature sensor 1. x-parser-schema-id: temp_2_desc: type: string description: Descriptive text of Bluetooth temperature sensor 2. x-parser-schema-id: temp_3_desc: type: string description: Descriptive text of Bluetooth temperature sensor 3. x-parser-schema-id: temp_4_desc: type: string description: Descriptive text of Bluetooth temperature sensor 4. x-parser-schema-id: battery_main_model: &ref_3 enum: - 12V-DEF - 24V-DEF - 24V-2x12 - 24V-SLB x-parser-schema-id: BatteryModelType battery_main_desc: type: string description: Description of main battery. x-parser-schema-id: battery_ext_1_model: *ref_3 battery_ext_1_desc: type: string description: Description of first external battery. x-parser-schema-id: battery_ext_2_model: *ref_3 battery_ext_2_desc: type: string description: Description of second external battery. x-parser-schema-id: battery_ext_3_model: *ref_3 battery_ext_3_desc: type: string description: Description of third external battery. x-parser-schema-id: battery_ext_4_model: *ref_3 battery_ext_4_desc: type: string description: Description of fourth external battery. x-parser-schema-id: device_angle_offset: type: number description: >- An offset in degrees that describes the positioning of the IoT device within the vehicle. readOnly: true x-parser-schema-id: tank_size: type: number description: The size of the primary tank (in liters). x-parser-schema-id: tank_prefer_analog: type: boolean description: >- If an analog tank reading should be preferred over a CAN bus reading (if available). x-parser-schema-id: can_readout: type: boolean description: If the installed IoT device supports CAN bus readouts. readOnly: true x-parser-schema-id: obd2_readout: type: boolean description: If the installed IoT device supports OBD2 bus readouts. readOnly: true x-parser-schema-id: n2k_readout: type: boolean description: If the installed IoT device supports NMEA2000 bus readouts. readOnly: true x-parser-schema-id: hibernation_mode: type: boolean description: > If the installed IoT device is in hibernation mode (where it sends less data and thus conserves energy). x-parser-schema-id: transport_mode: type: boolean description: > If the installed IoT device is in transport mode (where trips are recorded, but not saved to the logbook). x-parser-schema-id: notrack_mode: type: boolean description: > If the installed IoT device is in notrack mode (the sensor / location data is not processed). x-parser-schema-id: notrack_mode_deact_time: type: string format: date-time description: > If the notrack mode is activated, when it will deactivate again. readOnly: true x-parser-schema-id: function_control_mode_deact_time: type: string format: date-time description: > If the function control mode is activated, when it will deactivate again. readOnly: true x-parser-schema-id: subscription: type: object title: Service Subscription description: > A subscription to a service within the c.technology cloud ecosystem. This could be for a single vehicle's functionality (most common use case), but also for an additional service such as the vehicle launch service. Note that you cannot directly create service subscriptions, but have to use another endpoint to do so (Stripe for recurring payments, buy and use a voucher for one-time activations, etc.). required: - id - timestamp_start - timestamp_end - service_type - origin_type properties: id: type: string description: A unique ID identifying this subscription. readOnly: true x-parser-schema-id: user_id: type: string description: > The user for which this subscription is used (might be undefined). readOnly: true x-parser-schema-id: vehicle_id: type: string description: > The vehicle for which this subscription is used (might be undefined). readOnly: true x-parser-schema-id: timestamp_start: type: string format: date-time description: | The timestamp when this subscription starts. readOnly: true x-parser-schema-id: timestamp_end: type: string format: date-time description: | The timestamp when this subscription ends. readOnly: true x-parser-schema-id: service_type: type: string description: | The type of service this subscription is used for. enum: - BASE readOnly: true x-parser-schema-id: origin_type: type: string description: > How this subscription originally came to be, i.e., who bought or created it. enum: - SUBSCR_STRIPE - SUBSCR_STRIPE_RE - VOUCHER - OEM - MANUAL - TRIAL readOnly: true x-parser-schema-id: stripe_subscription: type: string description: > The corresponding Stripe subscription object, if it exists. readOnly: true x-parser-schema-id: voucher_id: type: number description: | The corresponding voucher object, if it exists. readOnly: true x-parser-schema-id: x-parser-schema-id: ServiceSubscription organization_vehicles: x-internal: true type: array description: > The organizations that are allowed to access this vehicle. The information passed along here might differ depending on your own organizational access. items: type: object title: Organization Vehicle x-internal: true description: | The relationship between an organization and a vehicle. required: - id - organization_id - vehicle_id properties: id: type: string description: >- A unique identifier for this Organization Vehicle object. readOnly: true x-parser-schema-id: organization_id: type: string description: The organization ID. x-parser-schema-id: vehicle_id: type: string description: The vehicle Type ID. x-parser-schema-id: vehicle_device_id: type: string description: The device ID for the vehicle. x-parser-schema-id: role: type: string enum: - VEHICLE_OWNER - VEHICLE_MAINTAINER - VEHICLE_MANUFACTURER description: >- The role of the organization in relation to the vehicle. x-parser-schema-id: primary_organization: type: boolean description: >- Whether the organization is the primary organization for the vehicle. x-parser-schema-id: manufacturing_organization: type: boolean description: >- Whether the organization is the manufacturing organization for the vehicle. x-parser-schema-id: vehicle_category_id: type: string description: The assigned category id for the vehicle. x-parser-schema-id: vehicle_category_name: type: string description: The assigned category name for the vehicle. x-parser-schema-id: vehicle_family_id: type: string description: The assigned family id for the vehicle. x-parser-schema-id: vehicle_family_name: type: string description: The assigned family name for the vehicle. x-parser-schema-id: vehicle_type_id: type: string description: The assigned type id for the vehicle. x-parser-schema-id: vehicle_type_name: type: string description: The assigned type name for the vehicle. x-parser-schema-id: vehicle_type_image_url: type: string description: The image URL for the vehicle type. x-parser-schema-id: organization_vehicle_id: type: string description: >- An arbitrary id that the organization has assigned to the vehicle. x-parser-schema-id: organization_vehicle_name: type: string description: >- The name of the vehicle as it is known within the organization. x-parser-schema-id: organization_vehicle_desc: type: string description: >- A description of the vehicle as it is known within the organization. x-parser-schema-id: vehicle_type_max_speed: type: number format: float description: >- The maximum speed of this type in km/h. This is used to adapt the frontends to the vehicle type. x-parser-schema-id: vehicle_type_battery_capacity_wh: type: number format: float description: >- Battery capacity in watt-hours (Wh) for electric vehicles. Used for range calculations and energy consumption analytics. x-parser-schema-id: vehicle_type_avg_consumption_wh_per_km: type: number format: float description: >- Average energy consumption in watt-hours per kilometer (Wh/km) for electric vehicles. This OEM-specified value is used as baseline for range calculations. x-parser-schema-id: vehicle_type_tank_capacity_l: type: number format: float description: >- Fuel tank capacity in liters for fuel-powered vehicles. Used for range calculations and fuel consumption analytics. x-parser-schema-id: vehicle_type_avg_consumption_l_per_100km: type: number format: float description: >- Average fuel consumption in liters per 100 kilometers (L/100km) for fuel-powered vehicles. This OEM-specified value is used as baseline for range calculations. x-parser-schema-id: drivetrain_type: type: string enum: - ELECTRIC - DIESEL - GASOLINE nullable: true description: > The drivetrain type of this vehicle type. ELECTRIC for electric vehicles, DIESEL for diesel engines, GASOLINE for gasoline engines. Used to determine appropriate consumption parameters and analytics. x-parser-schema-id: location_main_desc: type: string description: >- The description of the main location (e.g., where it is parked) for the vehicle. x-parser-schema-id: x-parser-schema-id: OrganizationVehicle x-parser-schema-id: initial_distance: type: number description: >- The configured initial distance before the IoT device was installed. x-parser-schema-id: initial_operation_hours: type: number description: >- The configured operation hours before the IoT device was installed. x-parser-schema-id: initial_date: type: string format: date description: The data when the IoT device was installed. x-parser-schema-id: maintenance_can_distance: type: boolean description: Measured CAN distance before installation. readOnly: true x-parser-schema-id: initialization_complete: type: boolean description: | If the initialization of this vehicle is complete. x-parser-schema-id: auto_discover_home: type: boolean description: | If this vehicle automatically discovers new home locations. x-parser-schema-id: trips_end_at_home: type: boolean description: > If trips of this vehicle should always stop when it approaches a home location. x-parser-schema-id: remove_trip_points_on_land: type: boolean description: > If trip points on land should be removed during trip processing. x-parser-schema-id: boat_type: type: string description: The type of boat, if applicable. enum: - MOTORBOAT - SAILBOAT x-parser-schema-id: vehicle_length_m: type: number description: The length of the vehicle in meters. x-parser-schema-id: vehicle_depth_m: type: number description: The depth of the vehicle in meters. x-parser-schema-id: vehicle_height_m: type: number description: The height of the vehicle in meters. x-parser-schema-id: vehicle_weight_kg: type: number description: The weight of the vehicle in kilograms. x-parser-schema-id: main_battery_property_pct: type: string description: >- The vehicle status field that is considered the main battery property. x-parser-schema-id: main_fuel_property_pct: type: string description: >- The vehicle status field that is considered the main fuel property. x-parser-schema-id: display_settings: type: object title: Vehicle Display Settings description: > Various settings related to how a vehicle is displayed in the native or web app. Currently, this is not editable, but only available as part of a vehicle GET response. properties: webapp_sidebar_slot_1: type: string description: > The vehicle status property to display in the first slot of the vehicle sidebar in the web app. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". x-parser-schema-id: webapp_sidebar_slot_2: type: string description: > The vehicle status property to display in the second slot of the vehicle sidebar in the web app. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". x-parser-schema-id: nativeapp_dashboard_main: type: string description: > What to show on the dashboard in the native app. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". x-parser-schema-id: nativeapp_four_most_important_1: type: string description: > What to show as the most important additional property. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". x-parser-schema-id: nativeapp_four_most_important_2: type: string description: > What to show as the second most important additional property. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". x-parser-schema-id: nativeapp_four_most_important_3: type: string description: > What to show as the third most important additional property. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". x-parser-schema-id: nativeapp_four_most_important_4: type: string description: > What to show as the fourth most important additional property. Is given in vehicle status accessor form, e.g., "fuel_level_pct" or nested as "vehicle_status_can.battery_main_pct". x-parser-schema-id: x-parser-schema-id: VehicleDisplaySettings x-parser-schema-id: VehicleProfile x-parser-schema-id: title: Vehicle profile example: No examples found bindings: [] extensions: - id: x-parser-unique-object-id value: VehicleProfile - id: x-parser-message-name value: VehicleProfile bindings: [] extensions: - id: x-parser-unique-object-id value: vehicle sendOperations: - *ref_4 receiveOperations: [] sendMessages: - *ref_5 receiveMessages: [] extensions: - id: x-parser-unique-object-id value: vehicle securitySchemes: [] ````