Munic GraphQL API
Exploring the API
- Learn about GraphQL itself.
- Use the web client for quick API experiments.
- Connect your app to this API endpoint
- Download the schema definition
Authentication
Most queries require an authenticated user.
See auth service to obain a token, and provide your auth token in the Authorization: Bearer <YOUR_JSON_WEB_TOKEN_HERE> http header.
Main objects
- Accounts represent your user and what it has access to.
- Devices are Munic devices (obd dongle...) plugged into a vehicle.
- Vehicles are cars, trucks, etc.
- Groups contain accounts, devices, vehicles, and other groups. They help organizing assets and permissions. They are the starting point for most searches.
Support
Queries
account
Description
Get account info
Response
Returns an Account
Arguments
| Name | Description |
|---|---|
id - ID
|
Account id. Defaults to logged-in user. Default = "me" |
Example
Query
query account($id: ID) {
account(id: $id) {
alert_preference {
...AlertPreferenceFragment
}
company_name
confirmed_at
country_code
created_at
descriptions {
...DescriptionPagedFragment
}
devices {
...DevicePagedFragment
}
distributors {
...OnboardingDistributorPagedFragment
}
driver_contacts {
...DriverPagedFragment
}
driver_profiles {
...DriverPagedFragment
}
drivers {
...DriverPagedFragment
}
email
full_name
groups {
...GroupPagedFragment
}
id
language
last_sign_in_at
organization_id
phone
roles {
...AccountRoleFragment
}
short_name
time_zone
updated_at
vehicles {
...VehiclePagedFragment
}
workshops {
...WorkshopPagedFragment
}
sso_user {
... on user {
...userFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{"id": "me"}
Response
{
"data": {
"account": {
"alert_preference": AlertPreference,
"company_name": "abc123",
"confirmed_at": "2007-12-03T10:15:30Z",
"country_code": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"distributors": OnboardingDistributorPaged,
"driver_contacts": DriverPaged,
"driver_profiles": DriverPaged,
"drivers": DriverPaged,
"email": "xyz789",
"full_name": "abc123",
"groups": GroupPaged,
"id": "4",
"language": Language,
"last_sign_in_at": "2007-12-03T10:15:30Z",
"organization_id": "4",
"phone": "abc123",
"roles": [AccountRole],
"short_name": "xyz789",
"time_zone": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"vehicles": VehiclePaged,
"workshops": WorkshopPaged,
"sso_user": user
}
}
}
accounts
Description
List accounts
Response
Returns an AccountPaged
Example
Query
query accounts(
$email: String,
$full_name: String,
$ids: [ID!],
$page_id: ID,
$page_size: Int,
$phone: String,
$short_name: String
) {
accounts(
email: $email,
full_name: $full_name,
ids: $ids,
page_id: $page_id,
page_size: $page_size,
phone: $phone,
short_name: $short_name
) {
count
list {
...AccountFragment
}
next
}
}
Variables
{
"email": "xyz789",
"full_name": "xyz789",
"ids": [4],
"page_id": 4,
"page_size": 123,
"phone": "abc123",
"short_name": "xyz789"
}
Response
{
"data": {
"accounts": {
"count": 987,
"list": [Account],
"next": 4
}
}
}
alert_feedbacks
Description
List alert feedbacks
Response
Returns a VehicleAlertFeedbackPaged
Arguments
| Name | Description |
|---|---|
alert_ids - [ID!]
|
Filter by alert ids |
language - LangArg
|
Filter by feedback language |
page_id - ID
|
Request page id (followup queries) |
page_size - Int
|
Results per page (initial query) |
status - VehicleAlertFeedbackStatusArg
|
Filter by feedback status |
Example
Query
query alert_feedbacks(
$alert_ids: [ID!],
$language: LangArg,
$page_id: ID,
$page_size: Int,
$status: VehicleAlertFeedbackStatusArg
) {
alert_feedbacks(
alert_ids: $alert_ids,
language: $language,
page_id: $page_id,
page_size: $page_size,
status: $status
) {
count
list {
...VehicleAlertFeedbackFragment
}
next
}
}
Variables
{
"alert_ids": ["4"],
"language": "EN",
"page_id": 4,
"page_size": 987,
"status": "CONFIRMED"
}
Response
{
"data": {
"alert_feedbacks": {
"count": 123,
"list": [VehicleAlertFeedback],
"next": "4"
}
}
}
alert_template
Description
Get template
Response
Returns an AlertTemplate
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query alert_template($id: ID!) {
alert_template(id: $id) {
id
attachments {
...AlertAttachmentPagedFragment
}
channel_name
content_type
created_at
default_context
definition
locked
name
updated_at
version
}
}
Variables
{"id": 4}
Response
{
"data": {
"alert_template": {
"id": "4",
"attachments": AlertAttachmentPaged,
"channel_name": "abc123",
"content_type": "HTML",
"created_at": "2007-12-03T10:15:30Z",
"default_context": Json,
"definition": "abc123",
"locked": false,
"name": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"version": "xyz789"
}
}
}
alert_templates
Description
List templates
Response
Returns an AlertTemplatePaged
Example
Query
query alert_templates(
$page_id: ID,
$page_size: Int
) {
alert_templates(
page_id: $page_id,
page_size: $page_size
) {
count
list {
...AlertTemplateFragment
}
next
}
}
Variables
{"page_id": 4, "page_size": 987}
Response
{
"data": {
"alert_templates": {
"count": 987,
"list": [AlertTemplate],
"next": "4"
}
}
}
alpr
Description
Recognize plate from image
Response
Returns an Alpr
Arguments
| Name | Description |
|---|---|
country - String!
|
vehicle country type string and required / value supports country code such as fr, it , al, ad , ao, ect .. |
region - String
|
vehicle region type string and optional / values are supported region Codes, they are made for United States of America plates: nc, ak, az, ct, ect …. Default = "NA" |
vehicle_picture - String!
|
vehicle picture type String and required / value in 64b and supports jpg,jpeg,png ... except GIF |
year - Int
|
vehicle manufacturing year type integer and optional / supported value are a valid year such as 1990,2001,2009 ... Default = 0 |
Example
Query
query alpr(
$country: String!,
$region: String,
$vehicle_picture: String!,
$year: Int
) {
alpr(
country: $country,
region: $region,
vehicle_picture: $vehicle_picture,
year: $year
) {
plate {
...PlateFragment
}
vehicle {
...VehicleInfoFragment
}
}
}
Variables
{
"country": "abc123",
"region": "NA",
"vehicle_picture": "xyz789",
"year": 0
}
Response
{
"data": {
"alpr": {
"plate": Plate,
"vehicle": VehicleInfo
}
}
}
am_group_user_roles
Description
Method:
GETBase URL:{env.ASSET_MANAGER_API}Path:/v1/groups/{args.group_id}/user_roles
[alpha] List Group User roles
Response
Returns a user_role_paginated
Example
Query
query am_group_user_roles(
$group_id: String!,
$page_number: Int,
$page_size: Int,
$fields_user_roles: String
) {
am_group_user_roles(
group_id: $group_id,
page_number: $page_number,
page_size: $page_size,
fields_user_roles: $fields_user_roles
) {
data {
...am_user_roleFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"group_id": "abc123",
"page_number": 123,
"page_size": 987,
"fields_user_roles": "abc123"
}
Response
{
"data": {
"am_group_user_roles": {
"data": [am_user_role],
"meta": meta
}
}
}
booking
Description
Get booking by ID
Example
Query
query booking($id: ID!) {
booking(id: $id) {
id
additional_information
booking_date
city
contact_method
country
plate_number
preferred_language
quotation_ids
status
user_email
user_name
user_phone_number
vehicle_make
vehicle_model
vehicle_year
vin
workshop {
...WorkshopFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"booking": {
"id": "4",
"additional_information": "xyz789",
"booking_date": "2007-12-03T10:15:30Z",
"city": "abc123",
"contact_method": "EMAIL",
"country": "xyz789",
"plate_number": "abc123",
"preferred_language": Language,
"quotation_ids": ["4"],
"status": "CONFIRMED",
"user_email": "abc123",
"user_name": "abc123",
"user_phone_number": "xyz789",
"vehicle_make": "xyz789",
"vehicle_model": "xyz789",
"vehicle_year": "abc123",
"vin": "xyz789",
"workshop": Workshop
}
}
}
bookings
Description
List Bookings
Response
Returns a BookingPaged
Example
Query
query bookings(
$page_id: ID,
$page_size: Int
) {
bookings(
page_id: $page_id,
page_size: $page_size
) {
count
list {
...BookingFragment
}
next
}
}
Variables
{"page_id": 4, "page_size": 987}
Response
{
"data": {
"bookings": {
"count": 123,
"list": [Booking],
"next": 4
}
}
}
cache
Description
Configure server-side query cache
Tweak this to bias toward performance or data freshness. The configuration is tied to your login token.
Response
Returns a CacheInfo
Arguments
| Name | Description |
|---|---|
extend_ttl - Boolean
|
Wether cache hits extend the time to live (default false) |
flush - Boolean
|
Remove all cache entries from the scope. Default = false |
save_settings - Boolean
|
Wether settings should be applied for the duration of the SSO login (default true). Default = true |
scope - CacheScope
|
Cache scope (default LOGIN) |
soft_flush - Boolean
|
Ignore old cache entries in the scope |
ttl - Int
|
Time to live of future entries (default 5 seconds) |
Example
Query
query cache(
$extend_ttl: Boolean,
$flush: Boolean,
$save_settings: Boolean,
$scope: CacheScope,
$soft_flush: Boolean,
$ttl: Int
) {
cache(
extend_ttl: $extend_ttl,
flush: $flush,
save_settings: $save_settings,
scope: $scope,
soft_flush: $soft_flush,
ttl: $ttl
) {
extend_ttl
scope
soft_flush
ttl
}
}
Variables
{
"extend_ttl": false,
"flush": false,
"save_settings": true,
"scope": "LOGIN",
"soft_flush": false,
"ttl": 987
}
Response
{
"data": {
"cache": {
"extend_ttl": false,
"scope": "LOGIN",
"soft_flush": "abc123",
"ttl": 123
}
}
}
campaign
Temporary internal API
Example
Query
query campaign($id: ID!) {
campaign(id: $id) {
id
configurations
created_at
devices_status {
...CampaignDeviceFragment
}
name
status
}
}
Variables
{"id": "4"}
Response
{
"data": {
"campaign": {
"id": 4,
"configurations": [4],
"created_at": "2007-12-03T10:15:30Z",
"devices_status": [CampaignDevice],
"name": "xyz789",
"status": "OTHER"
}
}
}
campaigns
Temporary internal API
Response
Returns a CampaignPaged
Example
Query
query campaigns(
$archived: Boolean,
$page_id: ID,
$page_size: Int
) {
campaigns(
archived: $archived,
page_id: $page_id,
page_size: $page_size
) {
count
list {
...CampaignFragment
}
next
}
}
Variables
{
"archived": false,
"page_id": "4",
"page_size": 987
}
Response
{
"data": {
"campaigns": {
"count": 987,
"list": [Campaign],
"next": 4
}
}
}
client_identifications
Description
List client identifications
Response
Returns a ClientIdentificationPaged
Example
Query
query client_identifications(
$client_reference: ID,
$code: String,
$default_account_id: ID,
$distributor_id: ID,
$label: String,
$page_id: ID,
$page_size: Int,
$revoked: Boolean,
$usable: Boolean
) {
client_identifications(
client_reference: $client_reference,
code: $code,
default_account_id: $default_account_id,
distributor_id: $distributor_id,
label: $label,
page_id: $page_id,
page_size: $page_size,
revoked: $revoked,
usable: $usable
) {
count
list {
...ClientIdentificationFragment
}
next
}
}
Variables
{
"client_reference": 4,
"code": "xyz789",
"default_account_id": "4",
"distributor_id": "4",
"label": "xyz789",
"page_id": 4,
"page_size": 123,
"revoked": false,
"usable": false
}
Response
{
"data": {
"client_identifications": {
"count": 123,
"list": [ClientIdentification],
"next": "4"
}
}
}
coverage_blacklists
Description
Parameter coverage info for a given type of vehicle
Response
Returns a CoverageBlacklistPaged
Example
Query
query coverage_blacklists(
$ids: [ID!],
$makes: [String!],
$models: [String!],
$page_id: ID,
$page_size: Int,
$years: [Int!]
) {
coverage_blacklists(
ids: $ids,
makes: $makes,
models: $models,
page_id: $page_id,
page_size: $page_size,
years: $years
) {
count
list {
...CoverageBlacklistFragment
}
next
}
}
Variables
{
"ids": [4],
"makes": ["abc123"],
"models": ["xyz789"],
"page_id": "4",
"page_size": 987,
"years": [123]
}
Response
{
"data": {
"coverage_blacklists": {
"count": 123,
"list": [CoverageBlacklist],
"next": "4"
}
}
}
coverage_makes
Response
Returns a CoverageMakePaged
Example
Query
query coverage_makes(
$name: String,
$page_id: ID,
$page_size: Int
) {
coverage_makes(
name: $name,
page_id: $page_id,
page_size: $page_size
) {
count
list {
...CoverageMakeFragment
}
next
}
}
Variables
{
"name": "xyz789",
"page_id": 4,
"page_size": 987
}
Response
{
"data": {
"coverage_makes": {
"count": 123,
"list": [CoverageMake],
"next": 4
}
}
}
coverage_models
Response
Returns a CoverageModelPaged
Example
Query
query coverage_models(
$makes: [String!],
$page_id: ID,
$page_size: Int
) {
coverage_models(
makes: $makes,
page_id: $page_id,
page_size: $page_size
) {
count
list {
...CoverageModelFragment
}
next
}
}
Variables
{
"makes": ["xyz789"],
"page_id": 4,
"page_size": 987
}
Response
{
"data": {
"coverage_models": {
"count": 987,
"list": [CoverageModel],
"next": 4
}
}
}
coverage_vehicles
Description
Parameter coverage info for a given type of vehicle
Response
Returns a CoverageVehiclePaged
Arguments
| Name | Description |
|---|---|
blacklisted - Boolean
|
Filter by blacklist status |
energy_types - [CoverageEnergyTypeArg!]
|
Filter by vehicle energy type |
ids - [ID!]
|
Filter by ids |
makes - [String!]
|
Filter by vehicle make |
models - [String!]
|
Filter by vehicle model |
page_id - ID
|
Request page id (followup queries) |
page_size - Int
|
Results per page (initial query) |
parameters - [String!]
|
Filter by covered parameters |
powertrain - CoveragePowertrainArg
|
Filter by powertrain |
regions - [CoverageRegionArg!]
|
Filter by world region |
vin - [String!]
|
Filter by VIN |
years - [Int!]
|
Filter by vehicle year |
Example
Query
query coverage_vehicles(
$blacklisted: Boolean,
$energy_types: [CoverageEnergyTypeArg!],
$ids: [ID!],
$makes: [String!],
$models: [String!],
$page_id: ID,
$page_size: Int,
$parameters: [String!],
$powertrain: CoveragePowertrainArg,
$regions: [CoverageRegionArg!],
$vin: [String!],
$years: [Int!]
) {
coverage_vehicles(
blacklisted: $blacklisted,
energy_types: $energy_types,
ids: $ids,
makes: $makes,
models: $models,
page_id: $page_id,
page_size: $page_size,
parameters: $parameters,
powertrain: $powertrain,
regions: $regions,
vin: $vin,
years: $years
) {
count
list {
...CoverageVehicleFragment
}
next
}
}
Variables
{
"blacklisted": false,
"energy_types": ["DIESEL"],
"ids": ["4"],
"makes": ["xyz789"],
"models": ["abc123"],
"page_id": "4",
"page_size": 123,
"parameters": ["abc123"],
"powertrain": "HEV",
"regions": ["EUROPE"],
"vin": ["xyz789"],
"years": [123]
}
Response
{
"data": {
"coverage_vehicles": {
"count": 123,
"list": [CoverageVehicle],
"next": "4"
}
}
}
dashcam_dashcam
Description
Method:
GETBase URL:{env.DASHCAM_API}Path:/v1/dashcams/{args.id}Show Dashcam
Response
Returns a dashcam_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query dashcam_dashcam($id: String!) {
dashcam_dashcam(id: $id) {
data {
...dashcamFragment
}
}
}
Variables
{"id": "abc123"}
Response
{"data": {"dashcam_dashcam": {"data": dashcam}}}
dashcam_dashcam_file
Description
Method:
GETBase URL:{env.DASHCAM_API}Path:/v1/dashcam_files/{args.id}Show Dashcam File
Response
Returns a dashcam_file_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query dashcam_dashcam_file($id: String!) {
dashcam_dashcam_file(id: $id) {
data {
...dashcam_fileFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{"data": {"dashcam_dashcam_file": {"data": dashcam_file}}}
dashcam_dashcam_files_dashcam
Description
Method:
GETBase URL:{env.DASHCAM_API}Path:/v1/dashcam_files/{args.id}/dashcamShow Dashcam
Response
Returns a dashcam_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query dashcam_dashcam_files_dashcam($id: String!) {
dashcam_dashcam_files_dashcam(id: $id) {
data {
...dashcamFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"dashcam_dashcam_files_dashcam": {"data": dashcam}
}
}
dashcam_dashcams_dashcam_files
Description
Method:
GETBase URL:{env.DASHCAM_API}Path:/v1/dashcams/{args.id}/dashcam_filesList Dashcam Files for Dashcam
Response
Returns a dashcam_file_paged
Arguments
| Name | Description |
|---|---|
id - String!
|
Dashcam id |
lens - dashcam_lens
|
|
storage_status - dashcam_file_storage_status
|
|
sort - queryInput_dashcams_dashcam_files_sort
|
|
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query dashcam_dashcams_dashcam_files(
$id: String!,
$lens: dashcam_lens,
$storage_status: dashcam_file_storage_status,
$sort: queryInput_dashcams_dashcam_files_sort,
$page_number: Int,
$page_size: Int
) {
dashcam_dashcams_dashcam_files(
id: $id,
lens: $lens,
storage_status: $storage_status,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...dashcam_fileFragment
}
meta {
...metaFragment
}
links
}
}
Variables
{
"id": "abc123",
"lens": "front",
"storage_status": "not_stored",
"sort": "id",
"page_number": 987,
"page_size": 987
}
Response
{
"data": {
"dashcam_dashcams_dashcam_files": {
"data": [dashcam_file],
"meta": meta,
"links": {}
}
}
}
dashcam_devices_dashcams
Description
Method:
GETBase URL:{env.DASHCAM_API}Path:/v1/devices/{args.device_id}/dashcamsShow Dashcam for Device
Response
Returns a dashcam_paged
Arguments
| Name | Description |
|---|---|
device_id - String!
|
Device id |
sort - queryInput_devices_dashcams_sort
|
|
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query dashcam_devices_dashcams(
$device_id: String!,
$sort: queryInput_devices_dashcams_sort,
$page_number: Int,
$page_size: Int
) {
dashcam_devices_dashcams(
device_id: $device_id,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...dashcamFragment
}
meta {
...metaFragment
}
links
}
}
Variables
{
"device_id": "abc123",
"sort": "id",
"page_number": 987,
"page_size": 123
}
Response
{
"data": {
"dashcam_devices_dashcams": {
"data": [dashcam],
"meta": meta,
"links": {}
}
}
}
dashcam_devices_video_segments
Description
Method:
GETBase URL:{env.DASHCAM_API}Path:/v1/devices/{args.device_id}/video_segmentsList Video Segments for Device
Response
Returns a video_segment_paged
Arguments
| Name | Description |
|---|---|
device_id - String!
|
Device id |
referenced_event_id - String
|
Filter by referenced_event_id |
referenced_event_kind - video_segment_referenced_event_kind
|
|
storage_status - video_segment_storage_status
|
|
name - String
|
Filter by name |
description - String
|
Filter by description |
start_time_before - String
|
Filter segments with start_time before the given date-time |
start_time_after - String
|
Filter segments with start_time after the given date-time |
end_time_before - String
|
Filter segments with end_time before the given date-time |
end_time_after - String
|
Filter segments with end_time after the given date-time |
sort - queryInput_devices_video_segments_sort
|
|
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query dashcam_devices_video_segments(
$device_id: String!,
$referenced_event_id: String,
$referenced_event_kind: video_segment_referenced_event_kind,
$storage_status: video_segment_storage_status,
$name: String,
$description: String,
$start_time_before: String,
$start_time_after: String,
$end_time_before: String,
$end_time_after: String,
$sort: queryInput_devices_video_segments_sort,
$page_number: Int,
$page_size: Int
) {
dashcam_devices_video_segments(
device_id: $device_id,
referenced_event_id: $referenced_event_id,
referenced_event_kind: $referenced_event_kind,
storage_status: $storage_status,
name: $name,
description: $description,
start_time_before: $start_time_before,
start_time_after: $start_time_after,
end_time_before: $end_time_before,
end_time_after: $end_time_after,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...video_segmentFragment
}
meta {
...metaFragment
}
links
}
}
Variables
{
"device_id": "abc123",
"referenced_event_id": "xyz789",
"referenced_event_kind": "Overspeed",
"storage_status": "pending",
"name": "xyz789",
"description": "xyz789",
"start_time_before": "xyz789",
"start_time_after": "abc123",
"end_time_before": "xyz789",
"end_time_after": "xyz789",
"sort": "id",
"page_number": 987,
"page_size": 123
}
Response
{
"data": {
"dashcam_devices_video_segments": {
"data": [video_segment],
"meta": meta,
"links": {}
}
}
}
dashcam_video_segment
Description
Method:
GETBase URL:{env.DASHCAM_API}Path:/v1/video_segments/{args.id}Show Video Segment
Response
Returns a video_segment_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query dashcam_video_segment($id: String!) {
dashcam_video_segment(id: $id) {
data {
...video_segmentFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"dashcam_video_segment": {"data": video_segment}
}
}
dashcam_video_segments_video_files
Description
Method:
GETBase URL:{env.DASHCAM_API}Path:/v1/video_segments/{args.id}/video_filesShow Video Segment Files
Response
Returns a dashcam_file_paged
Arguments
| Name | Description |
|---|---|
id - String!
|
|
lens - dashcam_lens
|
|
storage_status - dashcam_file_storage_status
|
|
debug - Boolean
|
|
sort - queryInput_video_segments_video_files_sort
|
|
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query dashcam_video_segments_video_files(
$id: String!,
$lens: dashcam_lens,
$storage_status: dashcam_file_storage_status,
$debug: Boolean,
$sort: queryInput_video_segments_video_files_sort,
$page_number: Int,
$page_size: Int
) {
dashcam_video_segments_video_files(
id: $id,
lens: $lens,
storage_status: $storage_status,
debug: $debug,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...dashcam_fileFragment
}
meta {
...metaFragment
}
links
}
}
Variables
{
"id": "xyz789",
"lens": "front",
"storage_status": "not_stored",
"debug": true,
"sort": "id",
"page_number": 123,
"page_size": 987
}
Response
{
"data": {
"dashcam_video_segments_video_files": {
"data": [dashcam_file],
"meta": meta,
"links": {}
}
}
}
data_fusion_vehicles_refills
Description
Method:
GETBase URL:{env.DATA_FUSION_API}Path:/v1/vehicles/{args.id}/refillsIndex Document Feature Refill
Response
Returns a vehicles_refills_response
Arguments
| Name | Description |
|---|---|
id - String!
|
Vehicle ID |
start_time - DateTime
|
Start Time |
end_time - DateTime
|
End Time |
page_number - Int
|
Page Number |
page_size - Int
|
Page Size |
sort - [queryInput_vehicles_refills_sort_items]
|
Sort results by fields (use "-" prefix for descending order) |
fields_refills - [queryInput_vehicles_refills_fields_LEFT_SQUARE_BRACE_refills_RIGHT_SQUARE_BRACE__items]
|
Fields to include in the response |
Example
Query
query data_fusion_vehicles_refills(
$id: String!,
$start_time: DateTime,
$end_time: DateTime,
$page_number: Int,
$page_size: Int,
$sort: [queryInput_vehicles_refills_sort_items],
$fields_refills: [queryInput_vehicles_refills_fields_LEFT_SQUARE_BRACE_refills_RIGHT_SQUARE_BRACE__items]
) {
data_fusion_vehicles_refills(
id: $id,
start_time: $start_time,
end_time: $end_time,
page_number: $page_number,
page_size: $page_size,
sort: $sort,
fields_refills: $fields_refills
) {
... on refill_paged {
...refill_pagedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "xyz789",
"start_time": "2007-12-03T10:15:30Z",
"end_time": "2007-12-03T10:15:30Z",
"page_number": 123,
"page_size": 123,
"sort": ["id"],
"fields_refills": ["product"]
}
Response
{"data": {"data_fusion_vehicles_refills": refill_paged}}
data_fusion_vehicles_summary
Description
Method:
GETBase URL:{env.DATA_FUSION_API}Path:/v1/vehicles/{args.id}/summaryShow Vehicle Summary
Response
Returns a vehicles_summary_response
Arguments
| Name | Description |
|---|---|
id - String!
|
Vehicle ID |
fields_vehicle_summaries - [queryInput_vehicles_summary_fields_LEFT_SQUARE_BRACE_vehicle_summaries_RIGHT_SQUARE_BRACE__items]
|
Fields to include in the response |
since - DateTime
|
minimum time in rfc3339 format |
until - DateTime
|
maximum time in rfc3339 format |
Example
Query
query data_fusion_vehicles_summary(
$id: String!,
$fields_vehicle_summaries: [queryInput_vehicles_summary_fields_LEFT_SQUARE_BRACE_vehicle_summaries_RIGHT_SQUARE_BRACE__items],
$since: DateTime,
$until: DateTime
) {
data_fusion_vehicles_summary(
id: $id,
fields_vehicle_summaries: $fields_vehicle_summaries,
since: $since,
until: $until
) {
... on vehicle_summary_show {
...vehicle_summary_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "xyz789",
"fields_vehicle_summaries": ["quantity"],
"since": "2007-12-03T10:15:30Z",
"until": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"data_fusion_vehicles_summary": vehicle_summary_show
}
}
decode_dtcs
Description
Get list of dtc codes description & related informations
Response
Returns [Dtc]
Arguments
| Name | Description |
|---|---|
codes - [String]!
|
List of DTC codes to be decoded |
language - Language
|
Decoded information display language |
make - String
|
Vehicle's make |
oem - Boolean
|
Should be set to True, if codes are known to be oem specific. |
protocol - DtcProtocol!
|
Protocol used for communicating with the vehicle |
region - DtcRegion!
|
Decoding region |
vin - String!
|
VIN of vehicle related to the codes |
Example
Query
query decode_dtcs(
$codes: [String]!,
$language: Language,
$make: String,
$oem: Boolean,
$protocol: DtcProtocol!,
$region: DtcRegion!,
$vin: String!
) {
decode_dtcs(
codes: $codes,
language: $language,
make: $make,
oem: $oem,
protocol: $protocol,
region: $region,
vin: $vin
) {
cause
classification
code
description
effect
id
information
mdi_dtc
protocol
recommendation
risk_availability
risk_damage
risk_emissions
risk_safety
subdescription
system_category
warning
warning_img
}
}
Variables
{
"codes": ["abc123"],
"language": Language,
"make": "xyz789",
"oem": false,
"protocol": "UNKNOWN",
"region": "EU",
"vin": "xyz789"
}
Response
{
"data": {
"decode_dtcs": [
{
"cause": "xyz789",
"classification": "xyz789",
"code": "abc123",
"description": "xyz789",
"effect": "xyz789",
"id": "4",
"information": "abc123",
"mdi_dtc": "xyz789",
"protocol": "abc123",
"recommendation": "abc123",
"risk_availability": "CRITICAL",
"risk_damage": "CRITICAL",
"risk_emissions": "CRITICAL",
"risk_safety": "CRITICAL",
"subdescription": "xyz789",
"system_category": "xyz789",
"warning": "xyz789",
"warning_img": "xyz789"
}
]
}
}
decode_plate
Description
Get list of vehicle descriptions by Plate & Country
Response
Returns [DecodeVinResult!]
Example
Query
query decode_plate(
$country: String!,
$plate: String!
) {
decode_plate(
country: $country,
plate: $plate
) {
acceleration
advanced_model
body_type
body_type_code
brakes_abs
brakes_front_type
brakes_rear_type
brakes_system
cargo_capacity
co_2_emission
co_emission
color
company_id
country
critair
curb_weight
day_of_first_circulation
day_of_sale
decoding_region
doors
drive_type
electric_vehicle_battery_capacity
electric_vehicle_battery_voltage
emission_standard
engine_aspiration
engine_bore
engine_code
engine_configuration
engine_cylinder_head_type
engine_cylinders
engine_displacement
engine_extra
engine_fiscal_power
engine_fuel_type
engine_fuel_type_secondary
engine_fuel_type_tertiary
engine_ignition_system
engine_manufacturer
engine_output_power
engine_output_power_ps
engine_rpm_idle_max
engine_rpm_idle_min
engine_rpm_max
engine_stroke
engine_valves
engine_version
engine_with_turbo
extra_info {
...VinExtraInfoFragment
}
front_overhang
front_track
fuel_efficiency_city
fuel_efficiency_combined
fuel_efficiency_highway
fuel_injection_control_type
fuel_injection_subtype
fuel_injection_system_design
fuel_injection_type
gearbox_speed
gearbox_type
gross_weight
hc_emission
hc_nox_emission
height
hip_room_front
hip_room_rear
id
k_type
kba
length
make
manufacturer
max_roof_load
max_tow_bar_download
max_trailer_load_b_license
max_trailer_load_braked_12
max_trailer_load_unbraked
model
model_code
model_version_code
month_of_first_circulation
month_of_sale
nox_emission
oil_temperature_emission
options {
...DescriptionOptionFragment
}
plate
price
rear_overhang
rear_track
seats
sli_battery_capacity
springs_front_type
springs_rear_type
steering_system
steering_type
tank_volume
top_speed
transmission_electronic_control
transmission_manufacturer_code
transmission_type
trunk_volume
url_vehicle_image
vehicle_type
verified
vin
wheel_base
wheels_dimension
width
year_of_first_circulation
year_of_sale
}
}
Variables
{
"country": "abc123",
"plate": "abc123"
}
Response
{
"data": {
"decode_plate": [
{
"acceleration": 987.65,
"advanced_model": "xyz789",
"body_type": "xyz789",
"body_type_code": "xyz789",
"brakes_abs": "abc123",
"brakes_front_type": "xyz789",
"brakes_rear_type": "xyz789",
"brakes_system": "abc123",
"cargo_capacity": 123,
"co_2_emission": 123,
"co_emission": 987.65,
"color": "abc123",
"company_id": "4",
"country": "abc123",
"critair": "abc123",
"curb_weight": 123,
"day_of_first_circulation": 123,
"day_of_sale": 123,
"decoding_region": "abc123",
"doors": 987,
"drive_type": "abc123",
"electric_vehicle_battery_capacity": 123.45,
"electric_vehicle_battery_voltage": 123.45,
"emission_standard": "abc123",
"engine_aspiration": "abc123",
"engine_bore": 987.65,
"engine_code": "xyz789",
"engine_configuration": "xyz789",
"engine_cylinder_head_type": "abc123",
"engine_cylinders": 987,
"engine_displacement": 987,
"engine_extra": "abc123",
"engine_fiscal_power": 987,
"engine_fuel_type": "ADBLUE",
"engine_fuel_type_secondary": "ADBLUE",
"engine_fuel_type_tertiary": "ADBLUE",
"engine_ignition_system": "abc123",
"engine_manufacturer": "xyz789",
"engine_output_power": 987,
"engine_output_power_ps": 123,
"engine_rpm_idle_max": 123,
"engine_rpm_idle_min": 987,
"engine_rpm_max": 987,
"engine_stroke": 123.45,
"engine_valves": 123,
"engine_version": "abc123",
"engine_with_turbo": false,
"extra_info": VinExtraInfo,
"front_overhang": 123,
"front_track": 123,
"fuel_efficiency_city": 987.65,
"fuel_efficiency_combined": 123.45,
"fuel_efficiency_highway": 987.65,
"fuel_injection_control_type": "abc123",
"fuel_injection_subtype": "abc123",
"fuel_injection_system_design": "abc123",
"fuel_injection_type": "xyz789",
"gearbox_speed": 987,
"gearbox_type": "abc123",
"gross_weight": 987,
"hc_emission": 123.45,
"hc_nox_emission": 987.65,
"height": 123,
"hip_room_front": 123,
"hip_room_rear": 987,
"id": 4,
"k_type": "xyz789",
"kba": 4,
"length": 987,
"make": "xyz789",
"manufacturer": "abc123",
"max_roof_load": 123,
"max_tow_bar_download": 123,
"max_trailer_load_b_license": 123,
"max_trailer_load_braked_12": 123,
"max_trailer_load_unbraked": 123,
"model": "xyz789",
"model_code": "abc123",
"model_version_code": "abc123",
"month_of_first_circulation": 987,
"month_of_sale": 987,
"nox_emission": 987.65,
"oil_temperature_emission": 987.65,
"options": [DescriptionOption],
"plate": "xyz789",
"price": 987,
"rear_overhang": 123,
"rear_track": 123,
"seats": 123,
"sli_battery_capacity": 123.45,
"springs_front_type": "xyz789",
"springs_rear_type": "xyz789",
"steering_system": "xyz789",
"steering_type": "abc123",
"tank_volume": 987,
"top_speed": 987,
"transmission_electronic_control": "abc123",
"transmission_manufacturer_code": "abc123",
"transmission_type": "xyz789",
"trunk_volume": 987,
"url_vehicle_image": "xyz789",
"vehicle_type": "abc123",
"verified": true,
"vin": "xyz789",
"wheel_base": 123,
"wheels_dimension": "xyz789",
"width": 987,
"year_of_first_circulation": 987,
"year_of_sale": 987
}
]
}
}
decode_vin
Description
Get list of vehicle descriptions by VIN and region (optional)
Response
Returns [DecodeVinResult!]
Arguments
| Name | Description |
|---|---|
device_id - ID
|
Device imei |
k_type - ID
|
k_type number (also known as techdoc number) |
kba - ID
|
Kraftfahrbundesamt (Germany and Austria) |
region - String
|
Decode region (africa, asia, europe, north america, south america, oceania) |
vin - String!
|
Vehicle Identification Number to decode |
Example
Query
query decode_vin(
$device_id: ID,
$k_type: ID,
$kba: ID,
$region: String,
$vin: String!
) {
decode_vin(
device_id: $device_id,
k_type: $k_type,
kba: $kba,
region: $region,
vin: $vin
) {
acceleration
advanced_model
body_type
body_type_code
brakes_abs
brakes_front_type
brakes_rear_type
brakes_system
cargo_capacity
co_2_emission
co_emission
color
company_id
country
critair
curb_weight
day_of_first_circulation
day_of_sale
decoding_region
doors
drive_type
electric_vehicle_battery_capacity
electric_vehicle_battery_voltage
emission_standard
engine_aspiration
engine_bore
engine_code
engine_configuration
engine_cylinder_head_type
engine_cylinders
engine_displacement
engine_extra
engine_fiscal_power
engine_fuel_type
engine_fuel_type_secondary
engine_fuel_type_tertiary
engine_ignition_system
engine_manufacturer
engine_output_power
engine_output_power_ps
engine_rpm_idle_max
engine_rpm_idle_min
engine_rpm_max
engine_stroke
engine_valves
engine_version
engine_with_turbo
extra_info {
...VinExtraInfoFragment
}
front_overhang
front_track
fuel_efficiency_city
fuel_efficiency_combined
fuel_efficiency_highway
fuel_injection_control_type
fuel_injection_subtype
fuel_injection_system_design
fuel_injection_type
gearbox_speed
gearbox_type
gross_weight
hc_emission
hc_nox_emission
height
hip_room_front
hip_room_rear
id
k_type
kba
length
make
manufacturer
max_roof_load
max_tow_bar_download
max_trailer_load_b_license
max_trailer_load_braked_12
max_trailer_load_unbraked
model
model_code
model_version_code
month_of_first_circulation
month_of_sale
nox_emission
oil_temperature_emission
options {
...DescriptionOptionFragment
}
plate
price
rear_overhang
rear_track
seats
sli_battery_capacity
springs_front_type
springs_rear_type
steering_system
steering_type
tank_volume
top_speed
transmission_electronic_control
transmission_manufacturer_code
transmission_type
trunk_volume
url_vehicle_image
vehicle_type
verified
vin
wheel_base
wheels_dimension
width
year_of_first_circulation
year_of_sale
}
}
Variables
{
"device_id": "4",
"k_type": 4,
"kba": "4",
"region": "abc123",
"vin": "xyz789"
}
Response
{
"data": {
"decode_vin": [
{
"acceleration": 123.45,
"advanced_model": "xyz789",
"body_type": "xyz789",
"body_type_code": "xyz789",
"brakes_abs": "xyz789",
"brakes_front_type": "abc123",
"brakes_rear_type": "xyz789",
"brakes_system": "xyz789",
"cargo_capacity": 123,
"co_2_emission": 987,
"co_emission": 987.65,
"color": "abc123",
"company_id": "4",
"country": "abc123",
"critair": "abc123",
"curb_weight": 987,
"day_of_first_circulation": 123,
"day_of_sale": 123,
"decoding_region": "abc123",
"doors": 123,
"drive_type": "xyz789",
"electric_vehicle_battery_capacity": 123.45,
"electric_vehicle_battery_voltage": 123.45,
"emission_standard": "xyz789",
"engine_aspiration": "xyz789",
"engine_bore": 987.65,
"engine_code": "xyz789",
"engine_configuration": "abc123",
"engine_cylinder_head_type": "xyz789",
"engine_cylinders": 987,
"engine_displacement": 987,
"engine_extra": "xyz789",
"engine_fiscal_power": 987,
"engine_fuel_type": "ADBLUE",
"engine_fuel_type_secondary": "ADBLUE",
"engine_fuel_type_tertiary": "ADBLUE",
"engine_ignition_system": "abc123",
"engine_manufacturer": "xyz789",
"engine_output_power": 987,
"engine_output_power_ps": 123,
"engine_rpm_idle_max": 987,
"engine_rpm_idle_min": 123,
"engine_rpm_max": 987,
"engine_stroke": 987.65,
"engine_valves": 123,
"engine_version": "abc123",
"engine_with_turbo": false,
"extra_info": VinExtraInfo,
"front_overhang": 987,
"front_track": 123,
"fuel_efficiency_city": 123.45,
"fuel_efficiency_combined": 987.65,
"fuel_efficiency_highway": 123.45,
"fuel_injection_control_type": "abc123",
"fuel_injection_subtype": "xyz789",
"fuel_injection_system_design": "abc123",
"fuel_injection_type": "abc123",
"gearbox_speed": 987,
"gearbox_type": "abc123",
"gross_weight": 987,
"hc_emission": 123.45,
"hc_nox_emission": 987.65,
"height": 987,
"hip_room_front": 987,
"hip_room_rear": 987,
"id": "4",
"k_type": "abc123",
"kba": 4,
"length": 987,
"make": "abc123",
"manufacturer": "xyz789",
"max_roof_load": 123,
"max_tow_bar_download": 987,
"max_trailer_load_b_license": 123,
"max_trailer_load_braked_12": 123,
"max_trailer_load_unbraked": 987,
"model": "xyz789",
"model_code": "xyz789",
"model_version_code": "abc123",
"month_of_first_circulation": 987,
"month_of_sale": 123,
"nox_emission": 123.45,
"oil_temperature_emission": 987.65,
"options": [DescriptionOption],
"plate": "xyz789",
"price": 987,
"rear_overhang": 987,
"rear_track": 987,
"seats": 987,
"sli_battery_capacity": 123.45,
"springs_front_type": "xyz789",
"springs_rear_type": "xyz789",
"steering_system": "abc123",
"steering_type": "abc123",
"tank_volume": 987,
"top_speed": 123,
"transmission_electronic_control": "abc123",
"transmission_manufacturer_code": "xyz789",
"transmission_type": "xyz789",
"trunk_volume": 987,
"url_vehicle_image": "xyz789",
"vehicle_type": "abc123",
"verified": true,
"vin": "abc123",
"wheel_base": 123,
"wheels_dimension": "xyz789",
"width": 987,
"year_of_first_circulation": 123,
"year_of_sale": 123
}
]
}
}
description
Response
Returns a Description
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
subject - DescriptionSubject!
|
Example
Query
query description(
$id: ID!,
$subject: DescriptionSubject!
) {
description(
id: $id,
subject: $subject
) {
created_at
id
label
source
updated_at
value
}
}
Variables
{
"id": "4",
"subject": DescriptionSubject
}
Response
{
"data": {
"description": {
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"label": "abc123",
"source": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"value": "xyz789"
}
}
}
device
Example
Query
query device($id: ID!) {
device(id: $id) {
id
active_account
aggregated_data {
...AggregatedDataFragment
}
alerts {
...VehicleAlertPagedFragment
}
alerts_state {
...VehicleAlertsStateFragment
}
battery_annotations {
...BatteryAnnotationPagedFragment
}
created_at
current_vehicle {
...VehicleFragment
}
device_type
fields {
...FieldPagedFragment
}
first_connection_at
groups {
...GroupPagedFragment
}
harshes {
...TripHarshPagedFragment
}
history {
...DeviceHistoryPagedFragment
}
last_activity_at
last_connection_at
last_connection_reason
last_disconnection_at
last_disconnection_reason
last_position {
...CoordinatesFragment
}
last_trip {
...TripFragment
}
log_fetches {
...LogfetchPagedFragment
}
onboarded
overspeeds {
...TripOverspeedPagedFragment
}
owner {
...AccountFragment
}
product {
...ProductFragment
}
profile_mode {
...ProfileDeviceModeFragment
}
profile_modes {
...ProfileDeviceModePagedFragment
}
profile_privacies {
...ProfilePrivacyPagedFragment
}
profile_privacy {
...ProfilePrivacyFragment
}
readings {
...ReadingPagedFragment
}
readings_anon {
...ReadingAnonPagedFragment
}
remote_diags {
...RemoteDiagPagedFragment
}
serial_number
status
trip_summary {
...TripSummaryFragment
}
trips {
...TripPagedFragment
}
updated_at
vehicle_sessions {
...DeviceVehicleSessionPagedFragment
}
vehicles {
...VehiclePagedFragment
}
dashcams {
...dashcam_pagedFragment
}
video_segments {
...video_segment_pagedFragment
}
geofences {
...geofence_paginatedFragment
}
cleaned_positions {
...map_matching_position_paginatedFragment
}
summary_from_journey {
...journey_summaryFragment
}
trip_journeys {
...journey_trip_paginatedFragment
}
trip_tag_schedules {
...trip_tag_schedule_paginatedFragment
}
journey_reports {
... on report_paginated {
...report_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_harshes {
...journey_trip_harsh_paginatedFragment
}
journey_overspeeds {
... on journey_trip_overspeed_paginated {
...journey_trip_overspeed_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_idlings {
... on journey_trip_idling_paginated {
...journey_trip_idling_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_config {
... on device_config_show_nullable {
...device_config_show_nullableFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"device": {
"id": "4",
"active_account": "abc123",
"aggregated_data": AggregatedData,
"alerts": VehicleAlertPaged,
"alerts_state": VehicleAlertsState,
"battery_annotations": BatteryAnnotationPaged,
"created_at": "2007-12-03T10:15:30Z",
"current_vehicle": Vehicle,
"device_type": "xyz789",
"fields": FieldPaged,
"first_connection_at": "2007-12-03T10:15:30Z",
"groups": GroupPaged,
"harshes": TripHarshPaged,
"history": DeviceHistoryPaged,
"last_activity_at": "2007-12-03T10:15:30Z",
"last_connection_at": "2007-12-03T10:15:30Z",
"last_connection_reason": "CLOSED_BY_SERVER",
"last_disconnection_at": "2007-12-03T10:15:30Z",
"last_disconnection_reason": "AUTH_FAILED_ACCOUNT",
"last_position": Coordinates,
"last_trip": Trip,
"log_fetches": LogfetchPaged,
"onboarded": true,
"overspeeds": TripOverspeedPaged,
"owner": Account,
"product": Product,
"profile_mode": ProfileDeviceMode,
"profile_modes": ProfileDeviceModePaged,
"profile_privacies": ProfilePrivacyPaged,
"profile_privacy": ProfilePrivacy,
"readings": ReadingPaged,
"readings_anon": ReadingAnonPaged,
"remote_diags": RemoteDiagPaged,
"serial_number": "xyz789",
"status": "CONNECTED",
"trip_summary": TripSummary,
"trips": TripPaged,
"updated_at": "2007-12-03T10:15:30Z",
"vehicle_sessions": DeviceVehicleSessionPaged,
"vehicles": VehiclePaged,
"dashcams": dashcam_paged,
"video_segments": video_segment_paged,
"geofences": geofence_paginated,
"cleaned_positions": map_matching_position_paginated,
"summary_from_journey": journey_summary,
"trip_journeys": journey_trip_paginated,
"trip_tag_schedules": trip_tag_schedule_paginated,
"journey_reports": report_paginated,
"journey_harshes": journey_trip_harsh_paginated,
"journey_overspeeds": journey_trip_overspeed_paginated,
"journey_idlings": journey_trip_idling_paginated,
"journey_config": device_config_show_nullable
}
}
}
devices
Response
Returns a DevicePaged
Arguments
| Name | Description |
|---|---|
device_types - [String]
|
|
has_bluetooth - Boolean
|
|
has_wifi - Boolean
|
|
ids - [ID]
|
|
onboarded - Boolean
|
|
page_id - ID
|
Request page id (followup queries) |
page_size - Int
|
Results per page (initial query) |
product_markets - [ProductMarket!]
|
|
product_names - [String!]
|
|
product_networks - [ProductNetwork!]
|
|
statuses - [DeviceStatus!]
|
Example
Query
query devices(
$device_types: [String],
$has_bluetooth: Boolean,
$has_wifi: Boolean,
$ids: [ID],
$onboarded: Boolean,
$page_id: ID,
$page_size: Int,
$product_markets: [ProductMarket!],
$product_names: [String!],
$product_networks: [ProductNetwork!],
$statuses: [DeviceStatus!]
) {
devices(
device_types: $device_types,
has_bluetooth: $has_bluetooth,
has_wifi: $has_wifi,
ids: $ids,
onboarded: $onboarded,
page_id: $page_id,
page_size: $page_size,
product_markets: $product_markets,
product_names: $product_names,
product_networks: $product_networks,
statuses: $statuses
) {
count
list {
...DeviceFragment
}
next
}
}
Variables
{
"device_types": ["abc123"],
"has_bluetooth": true,
"has_wifi": false,
"ids": ["4"],
"onboarded": false,
"page_id": 4,
"page_size": 987,
"product_markets": ["EU"],
"product_names": ["abc123"],
"product_networks": ["_2G"],
"statuses": ["CONNECTED"]
}
Response
{
"data": {
"devices": {"count": 987, "list": [Device], "next": 4}
}
}
distributor
Description
Get distributor
Response
Returns an OnboardingDistributor
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query distributor($id: ID!) {
distributor(id: $id) {
id
is_active
label
organization_id
provider {
...OnboardingProviderFragment
}
provider_workshop_id
requests {
...OnboardingRequestPagedFragment
}
staff {
...OnboardingStaffPagedFragment
}
workshop {
...WorkshopFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"distributor": {
"id": "4",
"is_active": false,
"label": "abc123",
"organization_id": 4,
"provider": OnboardingProvider,
"provider_workshop_id": 4,
"requests": OnboardingRequestPaged,
"staff": OnboardingStaffPaged,
"workshop": Workshop
}
}
}
distributors
Description
List distributors
Response
Returns an OnboardingDistributorPaged
Example
Query
query distributors(
$is_active: Boolean,
$page_id: ID,
$page_size: Int
) {
distributors(
is_active: $is_active,
page_id: $page_id,
page_size: $page_size
) {
count
list {
...OnboardingDistributorFragment
}
next
}
}
Variables
{"is_active": true, "page_id": 4, "page_size": 123}
Response
{
"data": {
"distributors": {
"count": 123,
"list": [OnboardingDistributor],
"next": 4
}
}
}
driver
Example
Query
query driver($id: ID) {
driver(id: $id) {
active
created_at
current_vehicle {
...VehicleFragment
}
current_vehicles {
...VehiclePagedFragment
}
default_vehicle {
...VehicleFragment
}
descriptions {
...DescriptionPagedFragment
}
groups {
...GroupPagedFragment
}
id
id_key
label
last_trip {
...TripFragment
}
trips {
...TripPagedFragment
}
updated_at
user_contact {
...AccountFragment
}
user_profile {
...AccountFragment
}
vehicle_sessions {
...DriverVehicleSessionPagedFragment
}
vehicles {
...VehiclePagedFragment
}
auxiliary_devices {
... on auxiliary_device_paginated {
...auxiliary_device_paginatedFragment
}
... on errors {
...errorsFragment
}
}
auxiliary_device {
... on auxiliary_device_show {
...auxiliary_device_showFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{"id": "me"}
Response
{
"data": {
"driver": {
"active": true,
"created_at": "2007-12-03T10:15:30Z",
"current_vehicle": Vehicle,
"current_vehicles": VehiclePaged,
"default_vehicle": Vehicle,
"descriptions": DescriptionPaged,
"groups": GroupPaged,
"id": 4,
"id_key": "abc123",
"label": "xyz789",
"last_trip": Trip,
"trips": TripPaged,
"updated_at": "2007-12-03T10:15:30Z",
"user_contact": Account,
"user_profile": Account,
"vehicle_sessions": DriverVehicleSessionPaged,
"vehicles": VehiclePaged,
"auxiliary_devices": auxiliary_device_paginated,
"auxiliary_device": auxiliary_device_show
}
}
}
driver_auxiliary_devices
Description
Method:
GETBase URL:{env.ASSET_MANAGER_API}Path:/v1/drivers/{args.driver_id}/auxiliary_devices
[beta] list driver's auxilary devices
Response
Returns a driver_auxiliary_devices_response
Arguments
| Name | Description |
|---|---|
driver_id - String!
|
Driver ID |
label - String
|
Driver label |
id_key - String
|
Custom identifier |
kind - auxiliary_device_kind
|
|
connection_type - auxiliary_device_connection_type
|
|
created_by_id - String
|
User uid |
serial_number - String
|
User uid |
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query driver_auxiliary_devices(
$driver_id: String!,
$label: String,
$id_key: String,
$kind: auxiliary_device_kind,
$connection_type: auxiliary_device_connection_type,
$created_by_id: String,
$serial_number: String,
$page_number: Int,
$page_size: Int
) {
driver_auxiliary_devices(
driver_id: $driver_id,
label: $label,
id_key: $id_key,
kind: $kind,
connection_type: $connection_type,
created_by_id: $created_by_id,
serial_number: $serial_number,
page_number: $page_number,
page_size: $page_size
) {
... on auxiliary_device_paginated {
...auxiliary_device_paginatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"driver_id": "abc123",
"label": "abc123",
"id_key": "abc123",
"kind": "phone",
"connection_type": "unknown",
"created_by_id": "abc123",
"serial_number": "xyz789",
"page_number": 123,
"page_size": 987
}
Response
{
"data": {
"driver_auxiliary_devices": auxiliary_device_paginated
}
}
driver_service
Description
Get Driver service by ID
Response
Returns a DriverService
Arguments
| Name | Description |
|---|---|
id - ID!
|
Driver service ID |
Example
Query
query driver_service($id: ID!) {
driver_service(id: $id) {
id
description
label
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"driver_service": {
"id": "4",
"description": "xyz789",
"label": "xyz789",
"workshops": WorkshopPaged
}
}
}
driver_services
Description
List Driver services
Response
Returns a DriverServicePaged
Example
Query
query driver_services(
$label: String,
$page_id: ID,
$page_size: Int
) {
driver_services(
label: $label,
page_id: $page_id,
page_size: $page_size
) {
count
list {
...DriverServiceFragment
}
next
}
}
Variables
{
"label": "abc123",
"page_id": 4,
"page_size": 123
}
Response
{
"data": {
"driver_services": {
"count": 987,
"list": [DriverService],
"next": "4"
}
}
}
drivers
Response
Returns a DriverPaged
Arguments
| Name | Description |
|---|---|
active - Boolean
|
|
auxiliary_device_id_keys - [String!]
|
Filter by driver auxiliary devices id_key |
auxiliary_device_mac_address_hashs - [String!]
|
Filter by driver auxiliary devices mac address hash |
auxiliary_device_serial_numbers - [String!]
|
Filter by driver auxiliary devices serial number |
has_vehicle - Boolean
|
|
id_keys - [ID!]
|
Filter by id_keys |
ids - [ID!]
|
Filter by ids |
labels - [String!]
|
Filter by labels |
page_id - ID
|
Request page id (followup queries) |
page_size - Int
|
Results per page (initial query) |
Example
Query
query drivers(
$active: Boolean,
$auxiliary_device_id_keys: [String!],
$auxiliary_device_mac_address_hashs: [String!],
$auxiliary_device_serial_numbers: [String!],
$has_vehicle: Boolean,
$id_keys: [ID!],
$ids: [ID!],
$labels: [String!],
$page_id: ID,
$page_size: Int
) {
drivers(
active: $active,
auxiliary_device_id_keys: $auxiliary_device_id_keys,
auxiliary_device_mac_address_hashs: $auxiliary_device_mac_address_hashs,
auxiliary_device_serial_numbers: $auxiliary_device_serial_numbers,
has_vehicle: $has_vehicle,
id_keys: $id_keys,
ids: $ids,
labels: $labels,
page_id: $page_id,
page_size: $page_size
) {
count
list {
...DriverFragment
}
next
}
}
Variables
{
"active": true,
"auxiliary_device_id_keys": ["xyz789"],
"auxiliary_device_mac_address_hashs": [
"xyz789"
],
"auxiliary_device_serial_numbers": [
"xyz789"
],
"has_vehicle": false,
"id_keys": ["4"],
"ids": [4],
"labels": ["abc123"],
"page_id": "4",
"page_size": 987
}
Response
{
"data": {
"drivers": {"count": 123, "list": [Driver], "next": 4}
}
}
geodecode
Description
Get the geodecoding of a coordinate
Response
Returns a Geodecode
Arguments
| Name | Description |
|---|---|
lang - String
|
Coordinate Language Define the language that will be used to perform the address lookup. Objects for which defined language code is not available, default language will be used. Values language Code - An US-ASCII string that defines an ISO 639-1 (2-letter) language code. The specials "IC" (no sensitive case) language code allows you to search for a country depending on its ISO-3166 Alpha-3 or Alpha-2 country code. default "en". Default = |
lat - Float
|
Coordinate latitude |
lng - Float
|
Coordinate longitude |
max_result - Int
|
Max Results, default 1. Default = 1 |
radius - Int
|
Search radius around lat/lon (meters), default 100. Default = 100 |
skip_empty_streetname - Boolean
|
Skip results with empty streetnames. Default = true |
Example
Query
query geodecode(
$lang: String,
$lat: Float,
$lng: Float,
$max_result: Int,
$radius: Int,
$skip_empty_streetname: Boolean
) {
geodecode(
lang: $lang,
lat: $lat,
lng: $lng,
max_result: $max_result,
radius: $radius,
skip_empty_streetname: $skip_empty_streetname
) {
elements {
...GeodecodeElementsFragment
}
extent {
...GeodecodeExtentFragment
}
}
}
Variables
{
"lang": "en",
"lat": 987.65,
"lng": 987.65,
"max_result": 1,
"radius": 100,
"skip_empty_streetname": true
}
Response
{
"data": {
"geodecode": {
"elements": GeodecodeElements,
"extent": GeodecodeExtent
}
}
}
geofence_alert
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/alerts/{args.id}
[alpha] Show Alert
Response
Returns an alert_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Alert id |
Example
Query
query geofence_alert($id: String!) {
geofence_alert(id: $id) {
data {
...geofence_alertFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{"data": {"geofence_alert": {"data": geofence_alert}}}
geofence_alerts
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/alerts
[alpha] Get Alerts
Response
Returns an alert_paginated
Example
Query
query geofence_alerts(
$state: String,
$event_type: String,
$group_id: String,
$sort: queryInput_alerts_sort,
$page_number: Int,
$page_size: Int
) {
geofence_alerts(
state: $state,
event_type: $event_type,
group_id: $group_id,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...geofence_alertFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"state": "abc123",
"event_type": "xyz789",
"group_id": "xyz789",
"sort": "id",
"page_number": 123,
"page_size": 987
}
Response
{
"data": {
"geofence_alerts": {
"data": [geofence_alert],
"meta": meta
}
}
}
geofence_device
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/devices/{args.id}
[alpha] Show Device
Response
Returns a device_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Device imei |
Example
Query
query geofence_device($id: String!) {
geofence_device(id: $id) {
data {
...geofence_deviceFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{"data": {"geofence_device": {"data": geofence_device}}}
geofence_devices
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/devices
[alpha] Get Device
Response
Returns a JSON
Example
Query
query geofence_devices {
geofence_devices
}
Response
{"data": {"geofence_devices": {}}}
geofence_devices_alerts
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/devices/{args.id}/alerts
[alpha] List device alerts
Response
Returns an alert_paginated
Example
Query
query geofence_devices_alerts(
$id: String!,
$state: String,
$event_type: String,
$group_id: String,
$sort: queryInput_devices_alerts_sort,
$page_number: Int,
$page_size: Int
) {
geofence_devices_alerts(
id: $id,
state: $state,
event_type: $event_type,
group_id: $group_id,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...geofence_alertFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"id": "xyz789",
"state": "xyz789",
"event_type": "xyz789",
"group_id": "xyz789",
"sort": "id",
"page_number": 123,
"page_size": 987
}
Response
{
"data": {
"geofence_devices_alerts": {
"data": [geofence_alert],
"meta": meta
}
}
}
geofence_devices_geofences
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/devices/{args.id}/geofences
[alpha] List device geofences
Response
Returns a geofence_paginated
Arguments
| Name | Description |
|---|---|
id - String!
|
Device id |
active - Boolean
|
active status |
label - String
|
label (accept partial match) |
imei - String
|
IMEI (accept partial match) |
shape_center - String
|
shape center coordinate in the format 'latitude,longitude,max_distance_in_meters' |
group_id - String
|
group_id |
sort - queryInput_devices_geofences_sort
|
|
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query geofence_devices_geofences(
$id: String!,
$active: Boolean,
$label: String,
$imei: String,
$shape_center: String,
$group_id: String,
$sort: queryInput_devices_geofences_sort,
$page_number: Int,
$page_size: Int
) {
geofence_devices_geofences(
id: $id,
active: $active,
label: $label,
imei: $imei,
shape_center: $shape_center,
group_id: $group_id,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...geofence_geofenceFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"id": "abc123",
"active": true,
"label": "xyz789",
"imei": "xyz789",
"shape_center": "abc123",
"group_id": "abc123",
"sort": "id",
"page_number": 987,
"page_size": 123
}
Response
{
"data": {
"geofence_devices_geofences": {
"data": [geofence_geofence],
"meta": meta
}
}
}
geofence_drop_data_requests
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/drop_data_requests
[alpha] List Drop Data Requests
Response
Returns a JSON
Example
Query
query geofence_drop_data_requests {
geofence_drop_data_requests
}
Response
{"data": {"geofence_drop_data_requests": {}}}
geofence_geofence
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.id}
[alpha] Show Geofence
Response
Returns a geofence_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Geofence id |
Example
Query
query geofence_geofence($id: String!) {
geofence_geofence(id: $id) {
data {
...geofence_geofenceFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"geofence_geofence": {"data": geofence_geofence}
}
}
geofence_geofences
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/geofences
[alpha] Get Geofence
Response
Returns a geofence_paginated
Arguments
| Name | Description |
|---|---|
active - Boolean
|
active status |
label - String
|
label (accept partial match) |
imei - String
|
IMEI (accept partial match) |
shape_center - String
|
shape center coordinate in the format 'latitude,longitude,max_distance_in_meters' |
group_id - String
|
group_id |
sort - queryInput_geofences_sort
|
|
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query geofence_geofences(
$active: Boolean,
$label: String,
$imei: String,
$shape_center: String,
$group_id: String,
$sort: queryInput_geofences_sort,
$page_number: Int,
$page_size: Int
) {
geofence_geofences(
active: $active,
label: $label,
imei: $imei,
shape_center: $shape_center,
group_id: $group_id,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...geofence_geofenceFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"active": false,
"label": "xyz789",
"imei": "xyz789",
"shape_center": "xyz789",
"group_id": "abc123",
"sort": "id",
"page_number": 123,
"page_size": 987
}
Response
{
"data": {
"geofence_geofences": {
"data": [geofence_geofence],
"meta": meta
}
}
}
geofence_geofences_alerts
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.geofence_id}/alerts
[alpha] Get Geofence Alerts
Response
Returns an alert_paginated
Example
Query
query geofence_geofences_alerts(
$geofence_id: String!,
$state: String,
$event_type: String,
$group_id: String,
$sort: queryInput_geofences_alerts_sort,
$page_number: Int,
$page_size: Int
) {
geofence_geofences_alerts(
geofence_id: $geofence_id,
state: $state,
event_type: $event_type,
group_id: $group_id,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...geofence_alertFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"geofence_id": "xyz789",
"state": "xyz789",
"event_type": "xyz789",
"group_id": "abc123",
"sort": "id",
"page_number": 987,
"page_size": 987
}
Response
{
"data": {
"geofence_geofences_alerts": {
"data": [geofence_alert],
"meta": meta
}
}
}
geofence_geofences_devices
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.geofence_id}/devices
[alpha] Get Geofence Devices
Response
Returns a geofence_device_paginated
Arguments
| Name | Description |
|---|---|
geofence_id - String!
|
Geofence id |
imei - String
|
IMEI (accept partial match) |
sort - queryInput_geofences_devices_sort
|
|
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query geofence_geofences_devices(
$geofence_id: String!,
$imei: String,
$sort: queryInput_geofences_devices_sort,
$page_number: Int,
$page_size: Int
) {
geofence_geofences_devices(
geofence_id: $geofence_id,
imei: $imei,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...geofence_deviceFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"geofence_id": "abc123",
"imei": "abc123",
"sort": "id",
"page_number": 123,
"page_size": 123
}
Response
{
"data": {
"geofence_geofences_devices": {
"data": [geofence_device],
"meta": meta
}
}
}
geofence_geofences_groups
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.geofence_id}/groups
[alpha] Get Geofence Groups
geofence_geofences_relationships_devices
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.id}/relationships/devices
[alpha] Show Devices
Response
Returns a JSON
Arguments
| Name | Description |
|---|---|
id - String!
|
Geofence id |
imei - String
|
IMEI (accept partial match) |
sort - queryInput_geofences_relationships_devices_sort
|
|
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query geofence_geofences_relationships_devices(
$id: String!,
$imei: String,
$sort: queryInput_geofences_relationships_devices_sort,
$page_number: Int,
$page_size: Int
) {
geofence_geofences_relationships_devices(
id: $id,
imei: $imei,
sort: $sort,
page_number: $page_number,
page_size: $page_size
)
}
Variables
{
"id": "xyz789",
"imei": "abc123",
"sort": "id",
"page_number": 987,
"page_size": 123
}
Response
{"data": {"geofence_geofences_relationships_devices": {}}}
geofence_geofences_schedules
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.id}/schedules
[alpha] Get Geofence Schedules
Response
Returns a schedule_paginated
Example
Query
query geofence_geofences_schedules(
$id: String!,
$time_zone: timezone,
$outside_of_slots: Boolean,
$group_id: String,
$sort: queryInput_geofences_schedules_sort,
$page_number: Int,
$page_size: Int
) {
geofence_geofences_schedules(
id: $id,
time_zone: $time_zone,
outside_of_slots: $outside_of_slots,
group_id: $group_id,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...geofence_scheduleFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"id": "xyz789",
"time_zone": "Africa_Abidjan",
"outside_of_slots": true,
"group_id": "xyz789",
"sort": "id",
"page_number": 987,
"page_size": 123
}
Response
{
"data": {
"geofence_geofences_schedules": {
"data": [geofence_schedule],
"meta": meta
}
}
}
geofence_geofences_shapes
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.id}/shapes
[alpha] Get Geofence Schedules
Response
Returns a shape_paginated
Arguments
| Name | Description |
|---|---|
id - String!
|
Geofence id |
geometry_type - String
|
Shape geometry type |
shape_center - String
|
Shape center coordinate in the format 'latitude,longitude,max_distance_in_meters' |
group_id - String
|
group_id |
sort - queryInput_geofences_shapes_sort
|
|
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query geofence_geofences_shapes(
$id: String!,
$geometry_type: String,
$shape_center: String,
$group_id: String,
$sort: queryInput_geofences_shapes_sort,
$page_number: Int,
$page_size: Int
) {
geofence_geofences_shapes(
id: $id,
geometry_type: $geometry_type,
shape_center: $shape_center,
group_id: $group_id,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...geofence_shapeFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"id": "xyz789",
"geometry_type": "xyz789",
"shape_center": "xyz789",
"group_id": "abc123",
"sort": "id",
"page_number": 123,
"page_size": 123
}
Response
{
"data": {
"geofence_geofences_shapes": {
"data": [geofence_shape],
"meta": meta
}
}
}
geofence_schedule
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/schedules/{args.id}
[alpha] Show Schedule
Response
Returns a schedule_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Schedule id |
Example
Query
query geofence_schedule($id: String!) {
geofence_schedule(id: $id) {
data {
...geofence_scheduleFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"geofence_schedule": {"data": geofence_schedule}
}
}
geofence_schedules
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/schedules
[alpha] Get Schedules
Response
Returns a schedule_paginated
Example
Query
query geofence_schedules(
$geofence_id: String,
$time_zone: timezone,
$outside_of_slots: Boolean,
$group_id: String,
$sort: queryInput_schedules_sort,
$page_number: Int,
$page_size: Int
) {
geofence_schedules(
geofence_id: $geofence_id,
time_zone: $time_zone,
outside_of_slots: $outside_of_slots,
group_id: $group_id,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...geofence_scheduleFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"geofence_id": "abc123",
"time_zone": "Africa_Abidjan",
"outside_of_slots": false,
"group_id": "xyz789",
"sort": "id",
"page_number": 123,
"page_size": 987
}
Response
{
"data": {
"geofence_schedules": {
"data": [geofence_schedule],
"meta": meta
}
}
}
geofence_shape
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/shapes/{args.id}
[alpha] Show Shape
Response
Returns a shape_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Geofence id |
Example
Query
query geofence_shape($id: String!) {
geofence_shape(id: $id) {
data {
...geofence_shapeFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{"data": {"geofence_shape": {"data": geofence_shape}}}
geofence_shapes
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/shapes
[alpha] Get Shape
Response
Returns a shape_paginated
Arguments
| Name | Description |
|---|---|
geofence_id - String
|
Geofence identifier |
geometry_type - String
|
Shape geometry type |
shape_center - String
|
Shape center coordinate in the format 'latitude,longitude,max_distance_in_meters' |
group_id - String
|
group_id |
sort - queryInput_shapes_sort
|
|
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query geofence_shapes(
$geofence_id: String,
$geometry_type: String,
$shape_center: String,
$group_id: String,
$sort: queryInput_shapes_sort,
$page_number: Int,
$page_size: Int
) {
geofence_shapes(
geofence_id: $geofence_id,
geometry_type: $geometry_type,
shape_center: $shape_center,
group_id: $group_id,
sort: $sort,
page_number: $page_number,
page_size: $page_size
) {
data {
...geofence_shapeFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"geofence_id": "xyz789",
"geometry_type": "abc123",
"shape_center": "abc123",
"group_id": "abc123",
"sort": "id",
"page_number": 123,
"page_size": 987
}
Response
{
"data": {
"geofence_shapes": {
"data": [geofence_shape],
"meta": meta
}
}
}
geofence_user
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/users/{args.id}
[alpha] Show User
Response
Returns a geofence_user
Arguments
| Name | Description |
|---|---|
id - String!
|
User id |
Example
Query
query geofence_user($id: String!) {
geofence_user(id: $id) {
data {
...geofence_query_user_dataFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"geofence_user": {"data": geofence_query_user_data}
}
}
geofence_users
Description
Method:
GETBase URL:{env.GEOFENCE_API}Path:/v1/users
[alpha] Get Users
Response
Returns a JSON
Example
Query
query geofence_users(
$uid: String,
$full_name: String,
$role: String,
$sort: queryInput_users_sort,
$page_number: Int,
$page_size: Int
) {
geofence_users(
uid: $uid,
full_name: $full_name,
role: $role,
sort: $sort,
page_number: $page_number,
page_size: $page_size
)
}
Variables
{
"uid": "xyz789",
"full_name": "xyz789",
"role": "abc123",
"sort": "id",
"page_number": 987,
"page_size": 123
}
Response
{"data": {"geofence_users": {}}}
get_driver_auxiliary_device
Description
Method:
GETBase URL:{env.ASSET_MANAGER_API}Path:/v1/drivers/{args.driver_id}/auxiliary_devices/{args.aux_id}
[beta] show auxiliary device info
Response
Returns a get_driver_auxiliary_device_response
Example
Query
query get_driver_auxiliary_device(
$driver_id: String!,
$aux_id: String!
) {
get_driver_auxiliary_device(
driver_id: $driver_id,
aux_id: $aux_id
) {
... on auxiliary_device_show {
...auxiliary_device_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"driver_id": "abc123",
"aux_id": "xyz789"
}
Response
{
"data": {
"get_driver_auxiliary_device": auxiliary_device_show
}
}
get_metadatum
Description
Get trip metdatum
Response
Returns a TripMetadatum
Arguments
| Name | Description |
|---|---|
id - ID!
|
Metadatum id |
Example
Query
query get_metadatum($id: ID!) {
get_metadatum(id: $id) {
created_at
id
key
trip_id
updated_at
value
}
}
Variables
{"id": 4}
Response
{
"data": {
"get_metadatum": {
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"key": "xyz789",
"trip_id": "4",
"updated_at": "2007-12-03T10:15:30Z",
"value": "xyz789"
}
}
}
get_vehicle_auxiliary_device
Description
Method:
GETBase URL:{env.ASSET_MANAGER_API}Path:/v1/vehicles/{args.vehicle_id}/auxiliary_devices/{args.aux_id}
[beta] show auxiliary device info
Response
Returns a get_vehicle_auxiliary_device_response
Example
Query
query get_vehicle_auxiliary_device(
$vehicle_id: String!,
$aux_id: String!
) {
get_vehicle_auxiliary_device(
vehicle_id: $vehicle_id,
aux_id: $aux_id
) {
... on auxiliary_device_show {
...auxiliary_device_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"vehicle_id": "abc123",
"aux_id": "abc123"
}
Response
{
"data": {
"get_vehicle_auxiliary_device": auxiliary_device_show
}
}
group
Example
Query
query group($id: ID!) {
group(id: $id) {
id
alerts {
...VehicleAlertPagedFragment
}
children {
...GroupPagedFragment
}
descriptions {
...DescriptionPagedFragment
}
devices {
...DevicePagedFragment
}
drivers {
...DriverPagedFragment
}
hierarchy_level
label
owner {
...AccountFragment
}
parents {
...GroupPagedFragment
}
tags
users {
...AccountPagedFragment
}
vehicles {
...VehiclePagedFragment
}
device_groups {
...device_group_paginatedFragment
}
user_roles {
...user_role_paginatedFragment
}
geofences {
...geofence_paginatedFragment
}
summary_from_journey {
...journey_summaryFragment
}
journey_reports {
... on report_paginated {
...report_paginatedFragment
}
... on errors {
...errorsFragment
}
}
summary_from_alerts {
... on fleet_summary {
...fleet_summaryFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"group": {
"id": 4,
"alerts": VehicleAlertPaged,
"children": GroupPaged,
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"drivers": DriverPaged,
"hierarchy_level": "CENTER",
"label": "xyz789",
"owner": Account,
"parents": GroupPaged,
"tags": ["abc123"],
"users": AccountPaged,
"vehicles": VehiclePaged,
"device_groups": device_group_paginated,
"user_roles": user_role_paginated,
"geofences": geofence_paginated,
"summary_from_journey": journey_summary,
"journey_reports": report_paginated,
"summary_from_alerts": fleet_summary
}
}
}
group_devices
Description
Method:
GETBase URL:{env.ASSET_MANAGER_API}Path:/v1/groups/{args.id}/device_groups
[alpha] List Group Devices
Response
Returns a device_group_paginated
Example
Query
query group_devices(
$id: String!,
$page_number: Int,
$page_size: Int,
$max_created_at: DateTime
) {
group_devices(
id: $id,
page_number: $page_number,
page_size: $page_size,
max_created_at: $max_created_at
) {
data {
...am_device_groupFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"id": "abc123",
"page_number": 123,
"page_size": 987,
"max_created_at": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"group_devices": {
"data": [am_device_group],
"meta": meta
}
}
}
groups
Response
Returns a GroupPaged
Arguments
| Name | Description |
|---|---|
hierarchy_levels - [GroupHierarchyLevel!]
|
|
ids - [ID!]
|
|
labels - [String!]
|
|
page_id - ID
|
Request page id (followup queries) |
page_size - Int
|
Results per page (initial query) |
Example
Query
query groups(
$hierarchy_levels: [GroupHierarchyLevel!],
$ids: [ID!],
$labels: [String!],
$page_id: ID,
$page_size: Int
) {
groups(
hierarchy_levels: $hierarchy_levels,
ids: $ids,
labels: $labels,
page_id: $page_id,
page_size: $page_size
) {
count
list {
...GroupFragment
}
next
}
}
Variables
{
"hierarchy_levels": ["CENTER"],
"ids": [4],
"labels": ["abc123"],
"page_id": 4,
"page_size": 987
}
Response
{
"data": {
"groups": {
"count": 123,
"list": [Group],
"next": "4"
}
}
}
journey_device_harshes
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/devices/{args.id}/harshes
[alpha] List Device Harshes
Response
Returns a device_harshes_response
Example
Query
query journey_device_harshes(
$id: String!,
$min_time: DateTime,
$max_time: DateTime,
$has_time: DateTime,
$fields_harshes: String,
$page_number: Int,
$page_size: Int
) {
journey_device_harshes(
id: $id,
min_time: $min_time,
max_time: $max_time,
has_time: $has_time,
fields_harshes: $fields_harshes,
page_number: $page_number,
page_size: $page_size
) {
... on journey_trip_harsh_paginated {
...journey_trip_harsh_paginatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "xyz789",
"min_time": "2007-12-03T10:15:30Z",
"max_time": "2007-12-03T10:15:30Z",
"has_time": "2007-12-03T10:15:30Z",
"fields_harshes": "xyz789",
"page_number": 123,
"page_size": 123
}
Response
{
"data": {
"journey_device_harshes": journey_trip_harsh_paginated
}
}
journey_device_idlings
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/devices/{args.id}/idlings
[alpha] List Device Idlings
Response
Returns a device_idlings_response
Example
Query
query journey_device_idlings(
$id: String!,
$min_time: DateTime,
$max_time: DateTime,
$has_time: DateTime,
$fields_idlings: String,
$page_number: Int,
$page_size: Int
) {
journey_device_idlings(
id: $id,
min_time: $min_time,
max_time: $max_time,
has_time: $has_time,
fields_idlings: $fields_idlings,
page_number: $page_number,
page_size: $page_size
) {
... on journey_trip_idling_paginated {
...journey_trip_idling_paginatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "abc123",
"min_time": "2007-12-03T10:15:30Z",
"max_time": "2007-12-03T10:15:30Z",
"has_time": "2007-12-03T10:15:30Z",
"fields_idlings": "abc123",
"page_number": 123,
"page_size": 987
}
Response
{
"data": {
"journey_device_idlings": journey_trip_idling_paginated
}
}
journey_device_overspeeds
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/devices/{args.id}/overspeeds
[alpha] List Device Overspeeds
Response
Returns a device_overspeeds_response
Example
Query
query journey_device_overspeeds(
$id: String!,
$min_time: DateTime,
$max_time: DateTime,
$has_time: DateTime,
$fields_overspeeds: String,
$page_number: Int,
$page_size: Int
) {
journey_device_overspeeds(
id: $id,
min_time: $min_time,
max_time: $max_time,
has_time: $has_time,
fields_overspeeds: $fields_overspeeds,
page_number: $page_number,
page_size: $page_size
) {
... on journey_trip_overspeed_paginated {
...journey_trip_overspeed_paginatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "xyz789",
"min_time": "2007-12-03T10:15:30Z",
"max_time": "2007-12-03T10:15:30Z",
"has_time": "2007-12-03T10:15:30Z",
"fields_overspeeds": "abc123",
"page_number": 987,
"page_size": 987
}
Response
{
"data": {
"journey_device_overspeeds": journey_trip_overspeed_paginated
}
}
journey_device_reports
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/devices/{args.id}/reports
[alpha] List group reports
Response
Returns a device_reports_response
Arguments
| Name | Description |
|---|---|
id - String!
|
device id |
page_number - Int
|
page number |
page_size - Int
|
page size |
time - DateTime
|
report having time |
kind - report_kind
|
|
status - report_status
|
|
sort - String
|
Example
Query
query journey_device_reports(
$id: String!,
$page_number: Int,
$page_size: Int,
$time: DateTime,
$kind: report_kind,
$status: report_status,
$sort: String
) {
journey_device_reports(
id: $id,
page_number: $page_number,
page_size: $page_size,
time: $time,
kind: $kind,
status: $status,
sort: $sort
) {
... on report_paginated {
...report_paginatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "abc123",
"page_number": 123,
"page_size": 123,
"time": "2007-12-03T10:15:30Z",
"kind": "trips",
"status": "pending",
"sort": "xyz789"
}
Response
{"data": {"journey_device_reports": report_paginated}}
journey_device_summary
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/devices/{args.id}/summary
[alpha] Show Device Summary
Response
Returns a journey_summary
Arguments
| Name | Description |
|---|---|
id - String!
|
Device id |
since - DateTime
|
since timestamp in RFC3339 |
until - DateTime
|
until timestamp in RFC3339 |
computed_statistics - String
|
computed_statistics |
metadata_key - String
|
include only trips having the given metadata_key |
not_metadata_key - String
|
include only trips not having the given metadata_key |
Example
Query
query journey_device_summary(
$id: String!,
$since: DateTime,
$until: DateTime,
$computed_statistics: String,
$metadata_key: String,
$not_metadata_key: String
) {
journey_device_summary(
id: $id,
since: $since,
until: $until,
computed_statistics: $computed_statistics,
metadata_key: $metadata_key,
not_metadata_key: $not_metadata_key
) {
data {
...query_device_summary_dataFragment
}
}
}
Variables
{
"id": "xyz789",
"since": "2007-12-03T10:15:30Z",
"until": "2007-12-03T10:15:30Z",
"computed_statistics": "xyz789",
"metadata_key": "xyz789",
"not_metadata_key": "xyz789"
}
Response
{
"data": {
"journey_device_summary": {
"data": query_device_summary_data
}
}
}
journey_device_trip_tag_schedules
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/devices/{args.id}/trip_tag_schedules
[alpha] List trip tag schedules
Response
Returns a trip_tag_schedule_paginated
Example
Query
query journey_device_trip_tag_schedules(
$id: String!,
$page_number: Int,
$page_size: Int,
$active: Boolean
) {
journey_device_trip_tag_schedules(
id: $id,
page_number: $page_number,
page_size: $page_size,
active: $active
) {
data {
...journey_trip_tag_scheduleFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"id": "abc123",
"page_number": 987,
"page_size": 987,
"active": true
}
Response
{
"data": {
"journey_device_trip_tag_schedules": {
"data": [journey_trip_tag_schedule],
"meta": meta
}
}
}
journey_device_trips
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/devices/{args.id}/trips
[alpha] List Device Trips
Response
Returns a journey_trip_paginated
Arguments
| Name | Description |
|---|---|
id - String!
|
Device id |
min_time - DateTime
|
min time |
max_time - DateTime
|
max time |
has_time - DateTime
|
has time |
min_idling_proportion - Float
|
min idling proporition |
max_idling_proportion - Float
|
max idling proporition |
fields_trips - String
|
fields to query |
computed_statistics - String
|
statistics to compute |
with_postal_addresses - Boolean
|
|
fields_metadata - String
|
fields to query |
page_number - Int
|
page number |
page_size - Int
|
page size |
include - String
|
additional relationship to query |
metadata_key - String
|
include only trips having the given metadata_key |
not_metadata_key - String
|
include only trips not having the given metadata_key |
Example
Query
query journey_device_trips(
$id: String!,
$min_time: DateTime,
$max_time: DateTime,
$has_time: DateTime,
$min_idling_proportion: Float,
$max_idling_proportion: Float,
$fields_trips: String,
$computed_statistics: String,
$with_postal_addresses: Boolean,
$fields_metadata: String,
$page_number: Int,
$page_size: Int,
$include: String,
$metadata_key: String,
$not_metadata_key: String
) {
journey_device_trips(
id: $id,
min_time: $min_time,
max_time: $max_time,
has_time: $has_time,
min_idling_proportion: $min_idling_proportion,
max_idling_proportion: $max_idling_proportion,
fields_trips: $fields_trips,
computed_statistics: $computed_statistics,
with_postal_addresses: $with_postal_addresses,
fields_metadata: $fields_metadata,
page_number: $page_number,
page_size: $page_size,
include: $include,
metadata_key: $metadata_key,
not_metadata_key: $not_metadata_key
) {
data {
...journey_tripFragment
}
meta {
...metaFragment
}
included {
...journey_query_device_trips_included_itemsFragment
}
}
}
Variables
{
"id": "abc123",
"min_time": "2007-12-03T10:15:30Z",
"max_time": "2007-12-03T10:15:30Z",
"has_time": "2007-12-03T10:15:30Z",
"min_idling_proportion": 123.45,
"max_idling_proportion": 987.65,
"fields_trips": "abc123",
"computed_statistics": "xyz789",
"with_postal_addresses": false,
"fields_metadata": "abc123",
"page_number": 987,
"page_size": 987,
"include": "abc123",
"metadata_key": "abc123",
"not_metadata_key": "xyz789"
}
Response
{
"data": {
"journey_device_trips": {
"data": [journey_trip],
"meta": meta,
"included": [
journey_query_device_trips_included_items
]
}
}
}
journey_devices_device_config
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/devices/{args.id}/device_configShow Device Config
Response
Returns a devices_device_config_response
Arguments
| Name | Description |
|---|---|
id - String!
|
device ID |
fields_device_configs - [queryInput_devices_device_config_fields_LEFT_SQUARE_BRACE_device_configs_RIGHT_SQUARE_BRACE__items]
|
Fields to include in the response |
Example
Query
query journey_devices_device_config(
$id: String!,
$fields_device_configs: [queryInput_devices_device_config_fields_LEFT_SQUARE_BRACE_device_configs_RIGHT_SQUARE_BRACE__items]
) {
journey_devices_device_config(
id: $id,
fields_device_configs: $fields_device_configs
) {
... on device_config_show_nullable {
...device_config_show_nullableFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "abc123",
"fields_device_configs": ["imei"]
}
Response
{
"data": {
"journey_devices_device_config": device_config_show_nullable
}
}
journey_get_trip
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/trips/{args.id}
[alpha] Get one trip
Response
Returns a get_trip_response
Example
Query
query journey_get_trip(
$id: String!,
$fields_trips: String,
$computed_statistics: String,
$with_postal_addresses: Boolean,
$fields_metadata: String,
$include: String
) {
journey_get_trip(
id: $id,
fields_trips: $fields_trips,
computed_statistics: $computed_statistics,
with_postal_addresses: $with_postal_addresses,
fields_metadata: $fields_metadata,
include: $include
) {
... on journey_trip_encapsulated {
...journey_trip_encapsulatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "xyz789",
"fields_trips": "xyz789",
"computed_statistics": "xyz789",
"with_postal_addresses": false,
"fields_metadata": "xyz789",
"include": "abc123"
}
Response
{"data": {"journey_get_trip": journey_trip_encapsulated}}
journey_group_reports
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/groups/{args.id}/reports
[alpha] List group reports
Response
Returns a group_reports_response
Arguments
| Name | Description |
|---|---|
id - String!
|
group id |
page_number - Int
|
page number |
page_size - Int
|
page size |
time - DateTime
|
report having time |
kind - report_kind
|
|
status - report_status
|
|
sort - String
|
Example
Query
query journey_group_reports(
$id: String!,
$page_number: Int,
$page_size: Int,
$time: DateTime,
$kind: report_kind,
$status: report_status,
$sort: String
) {
journey_group_reports(
id: $id,
page_number: $page_number,
page_size: $page_size,
time: $time,
kind: $kind,
status: $status,
sort: $sort
) {
... on report_paginated {
...report_paginatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "abc123",
"page_number": 123,
"page_size": 123,
"time": "2007-12-03T10:15:30Z",
"kind": "trips",
"status": "pending",
"sort": "xyz789"
}
Response
{"data": {"journey_group_reports": report_paginated}}
journey_group_summary
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/groups/{args.id}/summary
[alpha] Show Group Summary
Response
Returns a journey_summary
Arguments
| Name | Description |
|---|---|
id - String!
|
Group id |
since - DateTime
|
since timestamp in RFC3339 |
until - DateTime
|
until timestamp in RFC3339 |
computed_statistics - String
|
computed_statistics |
metadata_key - String
|
include only trips having the given metadata_key |
not_metadata_key - String
|
include only trips not having the given metadata_key |
Example
Query
query journey_group_summary(
$id: String!,
$since: DateTime,
$until: DateTime,
$computed_statistics: String,
$metadata_key: String,
$not_metadata_key: String
) {
journey_group_summary(
id: $id,
since: $since,
until: $until,
computed_statistics: $computed_statistics,
metadata_key: $metadata_key,
not_metadata_key: $not_metadata_key
) {
data {
...query_device_summary_dataFragment
}
}
}
Variables
{
"id": "xyz789",
"since": "2007-12-03T10:15:30Z",
"until": "2007-12-03T10:15:30Z",
"computed_statistics": "xyz789",
"metadata_key": "xyz789",
"not_metadata_key": "xyz789"
}
Response
{
"data": {
"journey_group_summary": {
"data": query_device_summary_data
}
}
}
journey_harsh
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/harshes/{args.id}
[alpha] Get one harsh behavior event
Response
Returns a harsh_response
Example
Query
query journey_harsh(
$id: String!,
$fields_harshes: String
) {
journey_harsh(
id: $id,
fields_harshes: $fields_harshes
) {
... on trip_harsh_encapsulated {
...trip_harsh_encapsulatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "xyz789",
"fields_harshes": "xyz789"
}
Response
{"data": {"journey_harsh": trip_harsh_encapsulated}}
journey_idling
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/idlings/{args.id}
[alpha] Get one idling
Response
Returns an idling_response
Example
Query
query journey_idling(
$id: String!,
$fields_idlings: String
) {
journey_idling(
id: $id,
fields_idlings: $fields_idlings
) {
... on trip_idling_encapsulated {
...trip_idling_encapsulatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "abc123",
"fields_idlings": "xyz789"
}
Response
{"data": {"journey_idling": trip_idling_encapsulated}}
journey_overspeed
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/overspeeds/{args.id}
[alpha] Get one overspeed
Response
Returns an overspeed_response
Example
Query
query journey_overspeed(
$id: String!,
$fields_overspeeds: String
) {
journey_overspeed(
id: $id,
fields_overspeeds: $fields_overspeeds
) {
... on trip_overspeed_encapsulated {
...trip_overspeed_encapsulatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "abc123",
"fields_overspeeds": "xyz789"
}
Response
{
"data": {
"journey_overspeed": trip_overspeed_encapsulated
}
}
journey_report
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/reports/{args.id}
[alpha] Use show report
Response
Returns a report_response
Arguments
| Name | Description |
|---|---|
id - String!
|
report id |
Example
Query
query journey_report($id: String!) {
journey_report(id: $id) {
... on report_encapsulated {
...report_encapsulatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{"data": {"journey_report": report_encapsulated}}
journey_reports
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/reports
[alpha] List reports
Response
Returns a reports_response
Arguments
| Name | Description |
|---|---|
page_number - Int
|
page number |
page_size - Int
|
page size |
time - DateTime
|
report having time |
kind - report_kind
|
|
imei - String
|
imei |
group_id - String
|
group_id |
status - report_status
|
|
sort - String
|
Example
Query
query journey_reports(
$page_number: Int,
$page_size: Int,
$time: DateTime,
$kind: report_kind,
$imei: String,
$group_id: String,
$status: report_status,
$sort: String
) {
journey_reports(
page_number: $page_number,
page_size: $page_size,
time: $time,
kind: $kind,
imei: $imei,
group_id: $group_id,
status: $status,
sort: $sort
) {
... on report_paginated {
...report_paginatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"page_number": 987,
"page_size": 123,
"time": "2007-12-03T10:15:30Z",
"kind": "trips",
"imei": "xyz789",
"group_id": "abc123",
"status": "pending",
"sort": "xyz789"
}
Response
{"data": {"journey_reports": report_paginated}}
journey_trip
Description
[alpha]
Response
Returns a get_trip_response
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query journey_trip($id: String!) {
journey_trip(id: $id) {
... on journey_trip_encapsulated {
...journey_trip_encapsulatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{"data": {"journey_trip": journey_trip_encapsulated}}
journey_trip_harshes
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/trips/{args.id}/harshes
[alpha] get journey trip harshes
Response
Returns a journey_trip_harsh_paginated
Example
Query
query journey_trip_harshes(
$id: String!,
$min_time: DateTime,
$max_time: DateTime,
$has_time: DateTime,
$fields_harshes: String,
$page_number: Int,
$page_size: Int
) {
journey_trip_harshes(
id: $id,
min_time: $min_time,
max_time: $max_time,
has_time: $has_time,
fields_harshes: $fields_harshes,
page_number: $page_number,
page_size: $page_size
) {
data {
...journey_trip_harshFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"id": "abc123",
"min_time": "2007-12-03T10:15:30Z",
"max_time": "2007-12-03T10:15:30Z",
"has_time": "2007-12-03T10:15:30Z",
"fields_harshes": "abc123",
"page_number": 123,
"page_size": 123
}
Response
{
"data": {
"journey_trip_harshes": {
"data": [journey_trip_harsh],
"meta": meta
}
}
}
journey_trip_idlings
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/trips/{args.id}/idlings
[alpha] get journey trip idlings
Response
Returns a trip_idlings_response
Example
Query
query journey_trip_idlings(
$id: String!,
$min_time: DateTime,
$max_time: DateTime,
$has_time: DateTime,
$fields_idlings: String,
$page_number: Int,
$page_size: Int
) {
journey_trip_idlings(
id: $id,
min_time: $min_time,
max_time: $max_time,
has_time: $has_time,
fields_idlings: $fields_idlings,
page_number: $page_number,
page_size: $page_size
) {
... on journey_trip_idling_paginated {
...journey_trip_idling_paginatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "xyz789",
"min_time": "2007-12-03T10:15:30Z",
"max_time": "2007-12-03T10:15:30Z",
"has_time": "2007-12-03T10:15:30Z",
"fields_idlings": "abc123",
"page_number": 987,
"page_size": 123
}
Response
{
"data": {
"journey_trip_idlings": journey_trip_idling_paginated
}
}
journey_trip_overspeeds
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/trips/{args.id}/overspeeds
[alpha] get journey trip overspeeds
Response
Returns a trip_overspeeds_response
Example
Query
query journey_trip_overspeeds(
$id: String!,
$min_time: DateTime,
$max_time: DateTime,
$has_time: DateTime,
$fields_overspeeds: String,
$page_number: Int,
$page_size: Int
) {
journey_trip_overspeeds(
id: $id,
min_time: $min_time,
max_time: $max_time,
has_time: $has_time,
fields_overspeeds: $fields_overspeeds,
page_number: $page_number,
page_size: $page_size
) {
... on journey_trip_overspeed_paginated {
...journey_trip_overspeed_paginatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "xyz789",
"min_time": "2007-12-03T10:15:30Z",
"max_time": "2007-12-03T10:15:30Z",
"has_time": "2007-12-03T10:15:30Z",
"fields_overspeeds": "abc123",
"page_number": 123,
"page_size": 987
}
Response
{
"data": {
"journey_trip_overspeeds": journey_trip_overspeed_paginated
}
}
journey_trip_tag_schedule
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/trip_tag_schedules/{args.id}
[alpha] Show Trip Tag Schedule
Response
Returns a trip_tag_schedule_encapsulated
Arguments
| Name | Description |
|---|---|
id - String!
|
Device id |
Example
Query
query journey_trip_tag_schedule($id: String!) {
journey_trip_tag_schedule(id: $id) {
data {
...journey_trip_tag_scheduleFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"journey_trip_tag_schedule": {
"data": journey_trip_tag_schedule
}
}
}
journey_trip_tag_schedule_devices
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/trip_tag_schedules/{args.id}/devices
[alpha] List trip tag schedule devices
Response
Returns a journey_device_paginated
Example
Query
query journey_trip_tag_schedule_devices(
$id: String!,
$fields_devices: String,
$page_number: Int,
$page_size: Int
) {
journey_trip_tag_schedule_devices(
id: $id,
fields_devices: $fields_devices,
page_number: $page_number,
page_size: $page_size
) {
data {
...journey_associated_deviceFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"id": "abc123",
"fields_devices": "abc123",
"page_number": 123,
"page_size": 987
}
Response
{
"data": {
"journey_trip_tag_schedule_devices": {
"data": [journey_associated_device],
"meta": meta
}
}
}
journey_trip_tag_schedules
Description
Method:
GETBase URL:{env.JOURNEY_API}Path:/v1/trip_tag_schedules
[alpha] List trip tag schedules
Response
Returns a trip_tag_schedule_paginated
Example
Query
query journey_trip_tag_schedules(
$page_number: Int,
$page_size: Int,
$active: Boolean
) {
journey_trip_tag_schedules(
page_number: $page_number,
page_size: $page_size,
active: $active
) {
data {
...journey_trip_tag_scheduleFragment
}
meta {
...metaFragment
}
}
}
Variables
{"page_number": 123, "page_size": 987, "active": true}
Response
{
"data": {
"journey_trip_tag_schedules": {
"data": [journey_trip_tag_schedule],
"meta": meta
}
}
}
logfetch_actions
Description
List standard log fetch actions
Response
Returns a LogfetchActionPaged
Example
Query
query logfetch_actions(
$page_id: ID,
$page_size: Int
) {
logfetch_actions(
page_id: $page_id,
page_size: $page_size
) {
count
list {
...LogfetchActionFragment
}
next
}
}
Variables
{"page_id": "4", "page_size": 123}
Response
{
"data": {
"logfetch_actions": {
"count": 987,
"list": [LogfetchAction],
"next": 4
}
}
}
lpa
Description
Local profile assistance
Response
Returns a Lpa
Arguments
| Name | Description |
|---|---|
function_name - FunctionNameType!
|
The name of the function to call |
imei - ID!
|
IMEI of the dongle |
parameters - ParametersType!
|
Parameters needed for the called function |
Example
Query
query lpa(
$function_name: FunctionNameType!,
$imei: ID!,
$parameters: ParametersType!
) {
lpa(
function_name: $function_name,
imei: $imei,
parameters: $parameters
) {
function_name
id
imei
parameters {
...ParametersFragment
}
status
}
}
Variables
{
"function_name": "DELETE_PROFILE",
"imei": "4",
"parameters": ParametersType
}
Response
{
"data": {
"lpa": {
"function_name": "xyz789",
"id": 4,
"imei": "4",
"parameters": Parameters,
"status": "abc123"
}
}
}
maintenance_criticality_threshold
Response
Returns a MaintenanceCriticalityThreshold
Example
Query
query maintenance_criticality_threshold {
maintenance_criticality_threshold {
criticality
description
id
remaining_distance
remaining_duration
}
}
Response
{
"data": {
"maintenance_criticality_threshold": {
"criticality": 987,
"description": "abc123",
"id": 4,
"remaining_distance": 123,
"remaining_duration": 123
}
}
}
maintenance_criticality_thresholds
Description
Maintenance criticality ID
Response
Returns a MaintenanceCriticalityThresholdPaged
Example
Query
query maintenance_criticality_thresholds(
$page_id: ID,
$page_size: Int
) {
maintenance_criticality_thresholds(
page_id: $page_id,
page_size: $page_size
) {
count
list {
...MaintenanceCriticalityThresholdFragment
}
next
}
}
Variables
{"page_id": "4", "page_size": 987}
Response
{
"data": {
"maintenance_criticality_thresholds": {
"count": 987,
"list": [MaintenanceCriticalityThreshold],
"next": "4"
}
}
}
maintenance_historical
Response
Returns a MaintenanceHistorical
Arguments
| Name | Description |
|---|---|
id - ID!
|
Historical maintenance ID |
Example
Query
query maintenance_historical($id: ID!) {
maintenance_historical(id: $id) {
id
date
mileage
template {
...MaintenanceTemplateFragment
}
vehicle {
...VehicleFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"maintenance_historical": {
"id": 4,
"date": "2007-12-03T10:15:30Z",
"mileage": 987,
"template": MaintenanceTemplate,
"vehicle": Vehicle
}
}
}
maintenance_template
Response
Returns a MaintenanceTemplate
Arguments
| Name | Description |
|---|---|
id - ID!
|
Maintenance template ID |
Example
Query
query maintenance_template($id: ID!) {
maintenance_template(id: $id) {
id
description
from_external_service
system {
...MaintenanceSystemFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"maintenance_template": {
"id": "4",
"description": "xyz789",
"from_external_service": false,
"system": MaintenanceSystem
}
}
}
maintenance_upcoming
Description
Maintenance Planner : Get upcoming maintenance details by maitenance id
Response
Returns a MaintenanceUpcoming
Arguments
| Name | Description |
|---|---|
id - ID!
|
Upcoming maintenance ID |
Example
Query
query maintenance_upcoming($id: ID!) {
maintenance_upcoming(id: $id) {
id
criticality {
...MaintenanceCriticalityThresholdFragment
}
date_deadline
mileage_deadline
remaining_days_to_drive
remaining_distance_to_drive
template {
...MaintenanceTemplateFragment
}
vehicle {
...VehicleFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"maintenance_upcoming": {
"id": "4",
"criticality": MaintenanceCriticalityThreshold,
"date_deadline": "2007-12-03T10:15:30Z",
"mileage_deadline": 123,
"remaining_days_to_drive": 123,
"remaining_distance_to_drive": 987,
"template": MaintenanceTemplate,
"vehicle": Vehicle
}
}
}
map_matching_v2_api_autocompletes
Description
Method:
POSTBase URL:{env.MAP_MATCHING_API_V2}Path:/v1/autocompletes[alpha] Fetch addresses from a given plain text place.
Response
Returns an autocompletes_response
Arguments
| Name | Description |
|---|---|
input - autocomplete_create_Input
|
Example
Query
query map_matching_v2_api_autocompletes($input: autocomplete_create_Input) {
map_matching_v2_api_autocompletes(input: $input) {
... on autocomplete_show {
...autocomplete_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"input": autocomplete_create_Input}
Response
{
"data": {
"map_matching_v2_api_autocompletes": autocomplete_show
}
}
map_matching_v2_api_geocodes
Description
Method:
POSTBase URL:{env.MAP_MATCHING_API_V2}Path:/v1/geocodes
[alpha] Fetch addresses from prositions.
Response
Returns a geocodes_response
Arguments
| Name | Description |
|---|---|
input - geocode_create_Input
|
Example
Query
query map_matching_v2_api_geocodes($input: geocode_create_Input) {
map_matching_v2_api_geocodes(input: $input) {
... on geocode_show {
...geocode_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"input": geocode_create_Input}
Response
{"data": {"map_matching_v2_api_geocodes": geocode_show}}
map_matching_v2_api_matched_positions
Description
Method:
GETBase URL:{env.MAP_MATCHING_API_V2}Path:/v1/devices/{args.id}/positions
[alpha] List all the positions attach to the device.
Response
Returns a map_matching_position_paginated
Example
Query
query map_matching_v2_api_matched_positions(
$id: String!,
$page_number: Int,
$fields_positions: String,
$page_size: Int,
$start_time: DateTime!,
$end_time: DateTime!
) {
map_matching_v2_api_matched_positions(
id: $id,
page_number: $page_number,
fields_positions: $fields_positions,
page_size: $page_size,
start_time: $start_time,
end_time: $end_time
) {
data {
...map_matching_positionFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"id": "xyz789",
"page_number": 123,
"fields_positions": "abc123",
"page_size": 987,
"start_time": "2007-12-03T10:15:30Z",
"end_time": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"map_matching_v2_api_matched_positions": {
"data": [map_matching_position],
"meta": meta
}
}
}
map_matching_v2_api_revcodes
Description
Method:
POSTBase URL:{env.MAP_MATCHING_API_V2}Path:/v1/revcodes
[alpha] Fetch addresses from positions.
Response
Returns a revcodes_response
Arguments
| Name | Description |
|---|---|
input - revcode_create_Input
|
Example
Query
query map_matching_v2_api_revcodes($input: revcode_create_Input) {
map_matching_v2_api_revcodes(input: $input) {
... on revcode_show {
...revcode_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"input": revcode_create_Input}
Response
{"data": {"map_matching_v2_api_revcodes": revcode_show}}
metrics
Response
Returns a MetricPaged
Example
Query
query metrics(
$ids: [ID!],
$name_contains: String,
$names: [String!],
$page_id: ID,
$page_size: Int,
$raw_unit: Boolean
) {
metrics(
ids: $ids,
name_contains: $name_contains,
names: $names,
page_id: $page_id,
page_size: $page_size,
raw_unit: $raw_unit
) {
count
list {
...MetricFragment
}
next
}
}
Variables
{
"ids": [4],
"name_contains": "abc123",
"names": ["xyz789"],
"page_id": 4,
"page_size": 987,
"raw_unit": true
}
Response
{
"data": {
"metrics": {
"count": 987,
"list": [Metric],
"next": "4"
}
}
}
munic_remote_diagnostic_interactive_Interactive_GetResponses
Response
Arguments
| Name | Description |
|---|---|
input - munic__remote_diagnostic__interactive__Action_Input
|
Example
Query
query munic_remote_diagnostic_interactive_Interactive_GetResponses($input: munic__remote_diagnostic__interactive__Action_Input) {
munic_remote_diagnostic_interactive_Interactive_GetResponses(input: $input) {
j2534_msgs {
...j2534__J2534MsgFragment
}
}
}
Variables
{
"input": munic__remote_diagnostic__interactive__Action_Input
}
Response
{
"data": {
"munic_remote_diagnostic_interactive_Interactive_GetResponses": {
"j2534_msgs": [j2534__J2534Msg]
}
}
}
munic_remote_diagnostic_interactive_Interactive_GetTasks
Response
Arguments
| Name | Description |
|---|---|
input - munic__remote_diagnostic__interactive__Action_Input
|
Example
Query
query munic_remote_diagnostic_interactive_Interactive_GetTasks($input: munic__remote_diagnostic__interactive__Action_Input) {
munic_remote_diagnostic_interactive_Interactive_GetTasks(input: $input) {
action_id
tasks {
...meta_j2534__TaskFragment
}
}
}
Variables
{
"input": munic__remote_diagnostic__interactive__Action_Input
}
Response
{
"data": {
"munic_remote_diagnostic_interactive_Interactive_GetTasks": {
"action_id": "xyz789",
"tasks": [meta_j2534__Task]
}
}
}
munic_remote_diagnostic_interactive_Interactive_connectivityState
Response
Returns a ConnectivityState
Arguments
| Name | Description |
|---|---|
tryToConnect - Boolean
|
Example
Query
query munic_remote_diagnostic_interactive_Interactive_connectivityState($tryToConnect: Boolean) {
munic_remote_diagnostic_interactive_Interactive_connectivityState(tryToConnect: $tryToConnect)
}
Variables
{"tryToConnect": false}
Response
{
"data": {
"munic_remote_diagnostic_interactive_Interactive_connectivityState": "IDLE"
}
}
munic_remote_diagnostic_main_TypeExposition_connectivityState
Response
Returns a ConnectivityState
Arguments
| Name | Description |
|---|---|
tryToConnect - Boolean
|
Example
Query
query munic_remote_diagnostic_main_TypeExposition_connectivityState($tryToConnect: Boolean) {
munic_remote_diagnostic_main_TypeExposition_connectivityState(tryToConnect: $tryToConnect)
}
Variables
{"tryToConnect": true}
Response
{
"data": {
"munic_remote_diagnostic_main_TypeExposition_connectivityState": "IDLE"
}
}
onboarding_client_identification
Description
Method:
GETBase URL:{env.ONBOARDING_API}Path:/v2/client_identifications/{args.id}
[alpha] Show Client Identification
Response
Returns a client_identification_v2_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query onboarding_client_identification($id: String!) {
onboarding_client_identification(id: $id) {
data {
...client_identification_v2Fragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"onboarding_client_identification": {
"data": client_identification_v2
}
}
}
onboarding_client_identifications
Description
Method:
GETBase URL:{env.ONBOARDING_API}Path:/v2/client_identificationsOB List Ticket
Response
Returns a client_identification_v2_paginated
Example
Query
query onboarding_client_identifications(
$distributor_id: String,
$code: String,
$label: String,
$client_reference_type: String,
$default_user: String,
$client_reference: String,
$usable: Boolean,
$page_number: Int,
$page_size: Int
) {
onboarding_client_identifications(
distributor_id: $distributor_id,
code: $code,
label: $label,
client_reference_type: $client_reference_type,
default_user: $default_user,
client_reference: $client_reference,
usable: $usable,
page_number: $page_number,
page_size: $page_size
) {
data {
...client_identification_v2Fragment
}
meta {
...metaFragment
}
}
}
Variables
{
"distributor_id": "xyz789",
"code": "xyz789",
"label": "xyz789",
"client_reference_type": "abc123",
"default_user": "abc123",
"client_reference": "xyz789",
"usable": true,
"page_number": 123,
"page_size": 987
}
Response
{
"data": {
"onboarding_client_identifications": {
"data": [client_identification_v2],
"meta": meta
}
}
}
onboarding_request_setup_status
Description
Method:
GETBase URL:{env.ONBOARDING_API}Path:/v2/requests/{args.request_id}/setup_status
[alpha] Show onboarding request setup status
Response
Returns a request_setup_status_show
Arguments
| Name | Description |
|---|---|
request_id - String!
|
Example
Query
query onboarding_request_setup_status($request_id: String!) {
onboarding_request_setup_status(request_id: $request_id) {
data {
...request_setup_statusFragment
}
}
}
Variables
{"request_id": "abc123"}
Response
{
"data": {
"onboarding_request_setup_status": {
"data": request_setup_status
}
}
}
onboardings
Description
List onboarding requests
Response
Returns an OnboardingRequestPaged
Arguments
| Name | Description |
|---|---|
client_identification_ids - [ID!]
|
Filter by client identification ids |
client_references - [ID!]
|
Filter by client identification reference |
device_ids - [ID!]
|
Filter by linked device id |
distributor_ids - [ID!]
|
Filter by distributor ids |
ids - [ID!]
|
Filter by request id |
modes - [OnboardingMode!]
|
Filter by onboarding mode |
multi - [String]
|
Filter by Vehicle plate, vin, by Driver uid, by Device imei, serial_number or by Client Identification code, default_user and client_reference. |
page_id - ID
|
Request page id (followup queries) |
page_size - Int
|
Results per page (initial query) |
plates - [String!]
|
Filter by linked vehicle plate |
sort - [OnboardingRequestSort!]
|
Sort criteria |
status - [OnboardingStatus!]
|
Filter by request status |
vehicle_enrichments - [String!]
|
Filter by any vehicle enrichment values |
vehicle_types - [VehicleTypeName!]
|
Filter by vehicle type |
vins - [String!]
|
Filter by linked vehicle VIN |
Example
Query
query onboardings(
$client_identification_ids: [ID!],
$client_references: [ID!],
$device_ids: [ID!],
$distributor_ids: [ID!],
$ids: [ID!],
$modes: [OnboardingMode!],
$multi: [String],
$page_id: ID,
$page_size: Int,
$plates: [String!],
$sort: [OnboardingRequestSort!],
$status: [OnboardingStatus!],
$vehicle_enrichments: [String!],
$vehicle_types: [VehicleTypeName!],
$vins: [String!]
) {
onboardings(
client_identification_ids: $client_identification_ids,
client_references: $client_references,
device_ids: $device_ids,
distributor_ids: $distributor_ids,
ids: $ids,
modes: $modes,
multi: $multi,
page_id: $page_id,
page_size: $page_size,
plates: $plates,
sort: $sort,
status: $status,
vehicle_enrichments: $vehicle_enrichments,
vehicle_types: $vehicle_types,
vins: $vins
) {
count
list {
...OnboardingRequestFragment
}
next
}
}
Variables
{
"client_identification_ids": ["4"],
"client_references": [4],
"device_ids": [4],
"distributor_ids": [4],
"ids": [4],
"modes": ["OTHER"],
"multi": ["xyz789"],
"page_id": 4,
"page_size": 123,
"plates": ["xyz789"],
"sort": [OnboardingRequestSort],
"status": ["OTHER"],
"vehicle_enrichments": ["abc123"],
"vehicle_types": ["CAR"],
"vins": ["xyz789"]
}
Response
{
"data": {
"onboardings": {
"count": 987,
"list": [OnboardingRequest],
"next": 4
}
}
}
organization
Description
Method:
GETBase URL:{env.MUNIC_CONNECT_API}Path:/api/v2/organizations/{args.id}
[alpha] Show Organization
Response
Returns an organization_response
Arguments
| Name | Description |
|---|---|
id - String!
|
Organization id |
Example
Query
query organization($id: String!) {
organization(id: $id) {
... on organization_encapsulated {
...organization_encapsulatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"id": "abc123"}
Response
{"data": {"organization": organization_encapsulated}}
organizations
Description
Method:
GETBase URL:{env.MUNIC_CONNECT_API}Path:/api/v2/organizations
[alpha] List Organizations
Response
Returns an organization_paginated
Example
Query
query organizations(
$page_number: Int,
$page_size: Int
) {
organizations(
page_number: $page_number,
page_size: $page_size
) {
data {
...sso_organizationFragment
}
meta {
...metaFragment
}
}
}
Variables
{"page_number": 123, "page_size": 987}
Response
{
"data": {
"organizations": {
"data": [sso_organization],
"meta": meta
}
}
}
parkings
Description
Get parkings for vehicles
Response
Returns a ParkingPaged
Example
Query
query parkings(
$latitude: Float!,
$longitude: Float!,
$page_id: ID,
$page_size: Int,
$radius: Int!
) {
parkings(
latitude: $latitude,
longitude: $longitude,
page_id: $page_id,
page_size: $page_size,
radius: $radius
) {
count
list {
...ParkingFragment
}
next
}
}
Variables
{
"latitude": 123.45,
"longitude": 987.65,
"page_id": "4",
"page_size": 123,
"radius": 987
}
Response
{
"data": {
"parkings": {
"count": 987,
"list": [Parking],
"next": 4
}
}
}
partners
Description
List partners
Response
Returns an OnboardingPartnerPaged
Example
Query
query partners(
$ids: [ID!],
$page_id: ID,
$page_size: Int
) {
partners(
ids: $ids,
page_id: $page_id,
page_size: $page_size
) {
count
list {
...OnboardingPartnerFragment
}
next
}
}
Variables
{"ids": [4], "page_id": 4, "page_size": 123}
Response
{
"data": {
"partners": {
"count": 987,
"list": [OnboardingPartner],
"next": "4"
}
}
}
password_check_token
Description
Check if a password reset token is valid
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
channel - PasswordResetChannel!
|
Side channel type |
id - ID!
|
Side channel id |
token - String!
|
Reset token (see passwordResetToken()) |
Example
Query
query password_check_token(
$channel: PasswordResetChannel!,
$id: ID!,
$token: String!
) {
password_check_token(
channel: $channel,
id: $id,
token: $token
)
}
Variables
{
"channel": "EMAIL",
"id": 4,
"token": "xyz789"
}
Response
{"data": {"password_check_token": false}}
perf
Experimental/unstable API
Description
Get performance info
post_v1_fleet_summaries
Description
Method:
POSTBase URL:{env.VEHICLE_ALERTS_API}Path:/v1/fleet_summaries
[alpha] Create fleet summaries
Response
Returns a post_v1_fleet_summaries_response
Arguments
| Name | Description |
|---|---|
input - fleet_summary_Input
|
Example
Query
query post_v1_fleet_summaries($input: fleet_summary_Input) {
post_v1_fleet_summaries(input: $input) {
... on fleet_summary {
...fleet_summaryFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"input": fleet_summary_Input}
Response
{"data": {"post_v1_fleet_summaries": fleet_summary}}
project
Example
Query
query project($id: ID!) {
project(id: $id) {
id
devices {
...DevicePagedFragment
}
drivers {
...DriverPagedFragment
}
groups {
...GroupPagedFragment
}
label
owner {
...AccountFragment
}
users {
...AccountPagedFragment
}
vehicles {
...VehiclePagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"project": {
"id": 4,
"devices": DevicePaged,
"drivers": DriverPaged,
"groups": GroupPaged,
"label": "xyz789",
"owner": Account,
"users": AccountPaged,
"vehicles": VehiclePaged
}
}
}
projects
Description
Get the logged-in user project list
Response
Returns a ProjectPaged
Example
Query
query projects(
$page_id: ID,
$page_size: Int
) {
projects(
page_id: $page_id,
page_size: $page_size
) {
count
list {
...ProjectFragment
}
next
}
}
Variables
{"page_id": 4, "page_size": 123}
Response
{
"data": {
"projects": {
"count": 987,
"list": [Project],
"next": "4"
}
}
}
providers
Description
List providers
Response
Returns an OnboardingProviderPaged
Example
Query
query providers(
$ids: [ID!],
$page_id: ID,
$page_size: Int
) {
providers(
ids: $ids,
page_id: $page_id,
page_size: $page_size
) {
count
list {
...OnboardingProviderFragment
}
next
}
}
Variables
{
"ids": ["4"],
"page_id": "4",
"page_size": 987
}
Response
{
"data": {
"providers": {
"count": 123,
"list": [OnboardingProvider],
"next": "4"
}
}
}
quotation
Description
Get Quotation by ID
Example
Query
query quotation($id: ID!) {
quotation(id: $id) {
id
booking_id
currency
maintenance_code
plate_number
price
provider_quotation_id
taxes
taxes_price
workshop {
...WorkshopFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"quotation": {
"id": 4,
"booking_id": 4,
"currency": "abc123",
"maintenance_code": "xyz789",
"plate_number": "abc123",
"price": 123,
"provider_quotation_id": "4",
"taxes": 987,
"taxes_price": 123,
"workshop": Workshop
}
}
}
quotations
Description
List Quotations
Response
Returns a QuotationPaged
Example
Query
query quotations(
$page_id: ID,
$page_size: Int
) {
quotations(
page_id: $page_id,
page_size: $page_size
) {
count
list {
...QuotationFragment
}
next
}
}
Variables
{"page_id": "4", "page_size": 987}
Response
{
"data": {
"quotations": {
"count": 123,
"list": [Quotation],
"next": "4"
}
}
}
rating
Description
Get Rating by ID
Example
Query
query rating($id: ID!) {
rating(id: $id) {
id
booking {
...BookingFragment
}
created_at
message
response
response_date
stars
status
workshop {
...WorkshopFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"rating": {
"id": 4,
"booking": Booking,
"created_at": "2007-12-03T10:15:30Z",
"message": "abc123",
"response": "abc123",
"response_date": "2007-12-03T10:15:30Z",
"stars": 987,
"status": "NOT_VERIFIED",
"workshop": Workshop
}
}
}
rdc_doors_toggle_requests
Description
Method:
GETBase URL:{env.REMOTE_DEVICE_COMMAND_API}Path:/v1/public/doors/requests/togglesList all doors toggle requests
Response
Returns a doors_toggle_request_paginated
Arguments
| Name | Description |
|---|---|
account - String
|
Account name |
imei - String
|
Device IMEI |
request_custom_id - String
|
Custom ID provided at creation |
status - process_status
|
|
origin - request_origin
|
Example
Query
query rdc_doors_toggle_requests(
$account: String,
$imei: String,
$request_custom_id: String,
$status: process_status,
$origin: request_origin
) {
rdc_doors_toggle_requests(
account: $account,
imei: $imei,
request_custom_id: $request_custom_id,
status: $status,
origin: $origin
) {
data {
...doors_toggle_requestFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"account": "abc123",
"imei": "xyz789",
"request_custom_id": "abc123",
"status": "unknown",
"origin": "api"
}
Response
{
"data": {
"rdc_doors_toggle_requests": {
"data": [doors_toggle_request],
"meta": meta
}
}
}
rdc_engine_immobilizer_requests
Description
Method:
GETBase URL:{env.REMOTE_DEVICE_COMMAND_API}Path:/v1/public/engine/requests/immobilizersList all engine immobilizers requests
Response
Returns an engine_immobilizer_request_paginated
Arguments
| Name | Description |
|---|---|
account - String
|
Account name |
imei - String
|
Device IMEI |
request_custom_id - String
|
Custom ID provided at creation |
status - process_status
|
|
origin - request_origin
|
Example
Query
query rdc_engine_immobilizer_requests(
$account: String,
$imei: String,
$request_custom_id: String,
$status: process_status,
$origin: request_origin
) {
rdc_engine_immobilizer_requests(
account: $account,
imei: $imei,
request_custom_id: $request_custom_id,
status: $status,
origin: $origin
) {
data {
...engine_immobilizer_requestFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"account": "xyz789",
"imei": "abc123",
"request_custom_id": "abc123",
"status": "unknown",
"origin": "api"
}
Response
{
"data": {
"rdc_engine_immobilizer_requests": {
"data": [engine_immobilizer_request],
"meta": meta
}
}
}
rdc_get_doors_toggle_request
Description
Method:
GETBase URL:{env.REMOTE_DEVICE_COMMAND_API}Path:/v1/public/doors/requests/toggles/{args.id}Show request details
Response
Returns a doors_toggle_request_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Request ID |
Example
Query
query rdc_get_doors_toggle_request($id: String!) {
rdc_get_doors_toggle_request(id: $id) {
data {
...doors_toggle_requestFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"rdc_get_doors_toggle_request": {
"data": doors_toggle_request
}
}
}
rdc_get_engine_immobilizer_request
Description
Method:
GETBase URL:{env.REMOTE_DEVICE_COMMAND_API}Path:/v1/public/engine/requests/immobilizers/{args.id}Show request details
Response
Returns an engine_immobilizer_request_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Request ID |
Example
Query
query rdc_get_engine_immobilizer_request($id: String!) {
rdc_get_engine_immobilizer_request(id: $id) {
data {
...engine_immobilizer_requestFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"rdc_get_engine_immobilizer_request": {
"data": engine_immobilizer_request
}
}
}
rdc_log
Description
Get log of sent RemoteDeviceCommands
Response
Returns [RdcAsyncAck]
Arguments
| Name | Description |
|---|---|
endpoint - RdcEndpoint!
|
Type of logs |
Example
Query
query rdc_log($endpoint: RdcEndpoint!) {
rdc_log(endpoint: $endpoint) {
attributes
id
type
}
}
Variables
{"endpoint": "DISPLACEMENT_SET"}
Response
{
"data": {
"rdc_log": [
{
"attributes": Json,
"id": "4",
"type": "xyz789"
}
]
}
}
remote_diag
Description
Get a remote diagnostic session
Response
Returns a RemoteDiag
Arguments
| Name | Description |
|---|---|
id - ID!
|
Remote diagnostic session id |
Example
Query
query remote_diag($id: ID!) {
remote_diag(id: $id) {
id
actions {
...RemoteDiagActionPagedFragment
}
created_at
current_step
language
provider_name
result {
...RemoteDiagResultFragment
}
status
steps {
...RemoteDiagStepPagedFragment
}
updated_at
vci {
...RemoteDiagEndpointFragment
}
vud {
...RemoteDiagEndpointFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"remote_diag": {
"id": 4,
"actions": RemoteDiagActionPaged,
"created_at": "2007-12-03T10:15:30Z",
"current_step": "OTHER",
"language": Language,
"provider_name": "abc123",
"result": RemoteDiagResult,
"status": "xyz789",
"steps": RemoteDiagStepPaged,
"updated_at": "2007-12-03T10:15:30Z",
"vci": RemoteDiagEndpoint,
"vud": RemoteDiagEndpoint
}
}
}
remote_diagnostic_dummy
Response
Returns a String
Example
Query
query remote_diagnostic_dummy {
remote_diagnostic_dummy
}
Response
{
"data": {
"remote_diagnostic_dummy": "xyz789"
}
}
sso_user
Description
Method:
GETBase URL:{env.MUNIC_CONNECT_API}Path:/api/v2/users/{args.id}
[alpha] Show User
Response
Returns a sso_user_response
Arguments
| Name | Description |
|---|---|
id - String!
|
User id |
Example
Query
query sso_user($id: String!) {
sso_user(id: $id) {
... on user {
...userFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"id": "abc123"}
Response
{"data": {"sso_user": user}}
stations
Description
Get stations for vehicles
Response
Returns a StationPaged
Arguments
| Name | Description |
|---|---|
connector_types - [ConnectorType]
|
Electric connector type filter |
energy_types - [EnergyType]
|
Energy type filter |
latitude - Float!
|
Latitude |
longitude - Float!
|
Longitude |
page_id - ID
|
Request page id (followup queries) |
page_size - Int
|
Results per page (initial query) |
radius - Int!
|
Search radius (meters) |
Example
Query
query stations(
$connector_types: [ConnectorType],
$energy_types: [EnergyType],
$latitude: Float!,
$longitude: Float!,
$page_id: ID,
$page_size: Int,
$radius: Int!
) {
stations(
connector_types: $connector_types,
energy_types: $energy_types,
latitude: $latitude,
longitude: $longitude,
page_id: $page_id,
page_size: $page_size,
radius: $radius
) {
count
list {
...StationFragment
}
next
}
}
Variables
{
"connector_types": ["AVCON_CONNECTOR"],
"energy_types": ["ADBLUE"],
"latitude": 987.65,
"longitude": 123.45,
"page_id": 4,
"page_size": 987,
"radius": 987
}
Response
{
"data": {
"stations": {
"count": 123,
"list": [Station],
"next": 4
}
}
}
system_info
Description
Get system information
Response
Returns a SystemInfo
Example
Query
query system_info(
$extra: [String!],
$service: String
) {
system_info(
extra: $extra,
service: $service
) {
extra
hash
schema
services {
...SystemServiceFragment
}
software
}
}
Variables
{"extra": [""], "service": "abc123"}
Response
{
"data": {
"system_info": {
"extra": Json,
"hash": "abc123",
"schema": "xyz789",
"services": [SystemService],
"software": "abc123"
}
}
}
tickets
Description
List support tickets
Response
Returns a TicketPaged
Example
Query
query tickets(
$page_id: ID,
$page_size: Int
) {
tickets(
page_id: $page_id,
page_size: $page_size
) {
count
list {
...TicketFragment
}
next
}
}
Variables
{"page_id": "4", "page_size": 123}
Response
{
"data": {
"tickets": {"count": 987, "list": [Ticket], "next": 4}
}
}
trip
Description
Get trip
Example
Query
query trip($id: ID!) {
trip(id: $id) {
id
activities {
...TripActivityPagedFragment
}
average_speed
co_2_estimation
distance
distance_in_day
driving_duration
driving_percentage
duration
eco_driving_score
end_event {
...IdcoordinatesFragment
}
end_postal_address {
...AddressAttributesFragment
}
end_weather {
...WeatherFragment
}
fuel_efficiency
fuel_estimation
harshes {
...TripHarshPagedFragment
}
idling_duration
idling_percentage
locations {
...IdcoordinatesPagedFragment
}
max_idling_duration
max_speed
metadata {
...TripMetadatumPagedFragment
}
movements {
...TripMovementPagedFragment
}
nb_harsh_acceleration
nb_harsh_braking
nb_harsh_cornering
nb_overspeed
nb_postprocessed_overspeed
overconsumption_gap
overemission_gap
overspeed_distance
overspeed_duration
overspeed_score
overspeeds {
...TripOverspeedPagedFragment
}
safety_score
start_event {
...IdcoordinatesFragment
}
start_postal_address {
...AddressAttributesFragment
}
start_weather {
...WeatherFragment
}
status
stops {
...TripStopPagedFragment
}
tow_away
journey_harshes {
...journey_trip_harsh_paginatedFragment
}
journey_overspeeds {
... on journey_trip_overspeed_paginated {
...journey_trip_overspeed_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_idlings {
... on journey_trip_idling_paginated {
...journey_trip_idling_paginatedFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"trip": {
"id": 4,
"activities": TripActivityPaged,
"average_speed": 987.65,
"co_2_estimation": 123,
"distance": 987,
"distance_in_day": Percent,
"driving_duration": 123,
"driving_percentage": Percent,
"duration": 987,
"eco_driving_score": Percent,
"end_event": Idcoordinates,
"end_postal_address": AddressAttributes,
"end_weather": Weather,
"fuel_efficiency": 987.65,
"fuel_estimation": 123,
"harshes": TripHarshPaged,
"idling_duration": 123,
"idling_percentage": Percent,
"locations": IdcoordinatesPaged,
"max_idling_duration": 987,
"max_speed": 123.45,
"metadata": TripMetadatumPaged,
"movements": TripMovementPaged,
"nb_harsh_acceleration": 987,
"nb_harsh_braking": 987,
"nb_harsh_cornering": 123,
"nb_overspeed": 123,
"nb_postprocessed_overspeed": 987,
"overconsumption_gap": AnyPercent,
"overemission_gap": AnyPercent,
"overspeed_distance": 123,
"overspeed_duration": 123,
"overspeed_score": Percent,
"overspeeds": TripOverspeedPaged,
"safety_score": Percent,
"start_event": Idcoordinates,
"start_postal_address": AddressAttributes,
"start_weather": Weather,
"status": "CLOSED",
"stops": TripStopPaged,
"tow_away": false,
"journey_harshes": journey_trip_harsh_paginated,
"journey_overspeeds": journey_trip_overspeed_paginated,
"journey_idlings": journey_trip_idling_paginated
}
}
}
v1_user_alert_notifications
Description
Method:
GETBase URL:{env.VEHICLE_ALERTS_API}Path:/v1/user_alert_notifications
[alpha] List user_alerts_notifications
Response
Returns a fetch_user_alert_notification_paginated
Arguments
| Name | Description |
|---|---|
geofence_id - [String]
|
List of geofence IDs |
event_type - geofence_event_type
|
|
uid - String
|
UID |
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query v1_user_alert_notifications(
$geofence_id: [String],
$event_type: geofence_event_type,
$uid: String,
$page_number: Int,
$page_size: Int
) {
v1_user_alert_notifications(
geofence_id: $geofence_id,
event_type: $event_type,
uid: $uid,
page_number: $page_number,
page_size: $page_size
) {
data {
...va_fetch_user_alert_notificationFragment
}
meta {
...metaFragment
}
}
}
Variables
{
"geofence_id": ["abc123"],
"event_type": "ENTRY",
"uid": "xyz789",
"page_number": 987,
"page_size": 987
}
Response
{
"data": {
"v1_user_alert_notifications": {
"data": [va_fetch_user_alert_notification],
"meta": meta
}
}
}
vehicle
Example
Query
query vehicle($id: ID!) {
vehicle(id: $id) {
id
alerts {
...VehicleAlertPagedFragment
}
alerts_state {
...VehicleAlertsStateFragment
}
archived
can_be_towed
can_tow
current_device {
...DeviceFragment
}
current_devices {
...DevicePagedFragment
}
current_driver {
...DriverFragment
}
current_towing_session_as_towing_vehicle {
...TowingSessionFragment
}
current_towing_session_as_trailer_vehicle {
...TowingSessionFragment
}
current_towing_vehicle {
...VehicleFragment
}
current_trailer_vehicle {
...VehicleFragment
}
descriptions {
...DescriptionPagedFragment
}
doors_lock_status
doors_lock_status_updated_at
driver_sessions {
...DriverVehicleSessionPagedFragment
}
fuel_type
fuel_type_secondary
garage_mode_status
garage_mode_status_updated_at
groups {
...GroupPagedFragment
}
has_driver
hybrid
immobilizer_status
immobilizer_status_updated_at
kba
ktype
label
last_trip {
...TripFragment
}
maintenance_schedules {
...MaintenanceSchedulePagedFragment
}
maintenance_templates {
...MaintenanceTemplatePagedFragment
}
maintenances_historical {
...MaintenanceHistoricalPagedFragment
}
maintenances_upcoming {
...MaintenanceUpcomingPagedFragment
}
make
model
model_id
onboarded
owner {
...AccountFragment
}
plate
tags
towing_sessions_as_towing_vehicle {
...TowingSessionPagedFragment
}
towing_sessions_as_trailer_vehicle {
...TowingSessionPagedFragment
}
trips {
...TripPagedFragment
}
vehicle_type
vin
vin_descriptions {
...DecodeVinResultFragment
}
year
authorized_drivers {
... on vehicle_driver_paginated {
...vehicle_driver_paginatedFragment
}
... on errors {
...errorsFragment
}
}
auxiliary_devices {
... on auxiliary_device_paginated {
...auxiliary_device_paginatedFragment
}
... on errors {
...errorsFragment
}
}
auxiliary_device {
... on auxiliary_device_show {
...auxiliary_device_showFragment
}
... on errors {
...errorsFragment
}
}
refills {
... on refill_paged {
...refill_pagedFragment
}
... on errors {
...errorsFragment
}
}
refills_summary {
... on vehicle_summary_show {
...vehicle_summary_showFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"vehicle": {
"id": "4",
"alerts": VehicleAlertPaged,
"alerts_state": VehicleAlertsState,
"archived": false,
"can_be_towed": false,
"can_tow": true,
"current_device": Device,
"current_devices": DevicePaged,
"current_driver": Driver,
"current_towing_session_as_towing_vehicle": TowingSession,
"current_towing_session_as_trailer_vehicle": TowingSession,
"current_towing_vehicle": Vehicle,
"current_trailer_vehicle": Vehicle,
"descriptions": DescriptionPaged,
"doors_lock_status": "LOCKED",
"doors_lock_status_updated_at": "2007-12-03T10:15:30Z",
"driver_sessions": DriverVehicleSessionPaged,
"fuel_type": "abc123",
"fuel_type_secondary": "xyz789",
"garage_mode_status": "DISABLED",
"garage_mode_status_updated_at": "2007-12-03T10:15:30Z",
"groups": GroupPaged,
"has_driver": false,
"hybrid": true,
"immobilizer_status": "DISABLED",
"immobilizer_status_updated_at": "2007-12-03T10:15:30Z",
"kba": "xyz789",
"ktype": "abc123",
"label": "abc123",
"last_trip": Trip,
"maintenance_schedules": MaintenanceSchedulePaged,
"maintenance_templates": MaintenanceTemplatePaged,
"maintenances_historical": MaintenanceHistoricalPaged,
"maintenances_upcoming": MaintenanceUpcomingPaged,
"make": "xyz789",
"model": "abc123",
"model_id": "4",
"onboarded": false,
"owner": Account,
"plate": "abc123",
"tags": ["xyz789"],
"towing_sessions_as_towing_vehicle": TowingSessionPaged,
"towing_sessions_as_trailer_vehicle": TowingSessionPaged,
"trips": TripPaged,
"vehicle_type": "CAR",
"vin": "abc123",
"vin_descriptions": DecodeVinResult,
"year": "xyz789",
"authorized_drivers": vehicle_driver_paginated,
"auxiliary_devices": auxiliary_device_paginated,
"auxiliary_device": auxiliary_device_show,
"refills": refill_paged,
"refills_summary": vehicle_summary_show
}
}
}
vehicle_alert
Description
Get vehicle alert
Response
Returns a VehicleAlert
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query vehicle_alert($id: ID!) {
vehicle_alert(id: $id) {
aggregated_data {
...AggregatedDataFragment
}
created_at
device {
...DeviceFragment
}
feedback_status
feedbacks {
...VehicleAlertFeedbackPagedFragment
}
icon
id
language
last_received
last_reported
source
status
type
updated_at
vehicle {
...VehicleFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"vehicle_alert": {
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"icon": "xyz789",
"id": "4",
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"source": "OTHER",
"status": "CLOSED",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
}
}
vehicle_alerts
Description
List vehicle alerts
Response
Returns a VehicleAlertPaged
Arguments
| Name | Description |
|---|---|
battery_types - [VehicleAlertBatteryType!]
|
Filter battery alerts by type |
dtc_classification - DtcClassification
|
Filter DTC alerts by classification |
dtc_code - String
|
Filter DTC alerts by code |
dtc_mode - DtcMode
|
Filter DTC alerts by mode |
groups - [ID!]
|
Filter by groups |
ids - [ID!]
|
Filter by ids |
is_active - Boolean
|
Filter by activity |
language - LangArg
|
Filter by language |
maintenance_criticalities - [MaintenanceCriticalityArg!]
|
Filter maintenance alerts by criticality |
maintenance_from_vehicle - Boolean
|
Filter maintenance alerts by source |
page_id - ID
|
Request page id (followup queries) |
page_size - Int
|
Results per page (initial query) |
sort - [VehicleAlertSort!]
|
Sort criteria |
source - VehicleAlertSourceArg
|
Filter by source |
status - VehicleAlertStatusArg
|
Filter by status |
types - [VehicleAlertTypeArg!]
|
Filter by alert types |
warning_light_code - String
|
Filter by warning lignt code |
warning_light_level - AlertWarningLightLevelArg
|
Filter by warning light level |
Example
Query
query vehicle_alerts(
$battery_types: [VehicleAlertBatteryType!],
$dtc_classification: DtcClassification,
$dtc_code: String,
$dtc_mode: DtcMode,
$groups: [ID!],
$ids: [ID!],
$is_active: Boolean,
$language: LangArg,
$maintenance_criticalities: [MaintenanceCriticalityArg!],
$maintenance_from_vehicle: Boolean,
$page_id: ID,
$page_size: Int,
$sort: [VehicleAlertSort!],
$source: VehicleAlertSourceArg,
$status: VehicleAlertStatusArg,
$types: [VehicleAlertTypeArg!],
$warning_light_code: String,
$warning_light_level: AlertWarningLightLevelArg
) {
vehicle_alerts(
battery_types: $battery_types,
dtc_classification: $dtc_classification,
dtc_code: $dtc_code,
dtc_mode: $dtc_mode,
groups: $groups,
ids: $ids,
is_active: $is_active,
language: $language,
maintenance_criticalities: $maintenance_criticalities,
maintenance_from_vehicle: $maintenance_from_vehicle,
page_id: $page_id,
page_size: $page_size,
sort: $sort,
source: $source,
status: $status,
types: $types,
warning_light_code: $warning_light_code,
warning_light_level: $warning_light_level
) {
count
list {
...VehicleAlertFragment
}
next
}
}
Variables
{
"battery_types": ["DISCHARGE"],
"dtc_classification": "ADVISORY",
"dtc_code": "xyz789",
"dtc_mode": "ABSENT",
"groups": [4],
"ids": [4],
"is_active": false,
"language": "EN",
"maintenance_criticalities": ["HIGH"],
"maintenance_from_vehicle": true,
"page_id": 4,
"page_size": 987,
"sort": [VehicleAlertSort],
"source": "DEVICE",
"status": "CLOSED",
"types": ["BAD_INSTALLATION"],
"warning_light_code": "xyz789",
"warning_light_level": "ADVISORY"
}
Response
{
"data": {
"vehicle_alerts": {
"count": 123,
"list": [VehicleAlert],
"next": "4"
}
}
}
vehicle_auxiliary_devices
Description
Method:
GETBase URL:{env.ASSET_MANAGER_API}Path:/v1/vehicles/{args.vehicle_id}/auxiliary_devices
[beta] list driver's auxilary devices
Response
Returns a vehicle_auxiliary_devices_response
Arguments
| Name | Description |
|---|---|
vehicle_id - String!
|
Vehicle ID |
label - String
|
Driver label |
id_key - String
|
Custom identifier |
kind - auxiliary_device_kind
|
|
connection_type - auxiliary_device_connection_type
|
|
created_by_id - String
|
User uid |
serial_number - String
|
User uid |
page_number - Int
|
page number |
page_size - Int
|
page size |
Example
Query
query vehicle_auxiliary_devices(
$vehicle_id: String!,
$label: String,
$id_key: String,
$kind: auxiliary_device_kind,
$connection_type: auxiliary_device_connection_type,
$created_by_id: String,
$serial_number: String,
$page_number: Int,
$page_size: Int
) {
vehicle_auxiliary_devices(
vehicle_id: $vehicle_id,
label: $label,
id_key: $id_key,
kind: $kind,
connection_type: $connection_type,
created_by_id: $created_by_id,
serial_number: $serial_number,
page_number: $page_number,
page_size: $page_size
) {
... on auxiliary_device_paginated {
...auxiliary_device_paginatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"vehicle_id": "abc123",
"label": "xyz789",
"id_key": "abc123",
"kind": "phone",
"connection_type": "unknown",
"created_by_id": "abc123",
"serial_number": "abc123",
"page_number": 987,
"page_size": 987
}
Response
{
"data": {
"vehicle_auxiliary_devices": auxiliary_device_paginated
}
}
vehicle_desc
Description
Get vehicle description by id
Response
Returns a DecodeVinResult
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query vehicle_desc($id: ID!) {
vehicle_desc(id: $id) {
acceleration
advanced_model
body_type
body_type_code
brakes_abs
brakes_front_type
brakes_rear_type
brakes_system
cargo_capacity
co_2_emission
co_emission
color
company_id
country
critair
curb_weight
day_of_first_circulation
day_of_sale
decoding_region
doors
drive_type
electric_vehicle_battery_capacity
electric_vehicle_battery_voltage
emission_standard
engine_aspiration
engine_bore
engine_code
engine_configuration
engine_cylinder_head_type
engine_cylinders
engine_displacement
engine_extra
engine_fiscal_power
engine_fuel_type
engine_fuel_type_secondary
engine_fuel_type_tertiary
engine_ignition_system
engine_manufacturer
engine_output_power
engine_output_power_ps
engine_rpm_idle_max
engine_rpm_idle_min
engine_rpm_max
engine_stroke
engine_valves
engine_version
engine_with_turbo
extra_info {
...VinExtraInfoFragment
}
front_overhang
front_track
fuel_efficiency_city
fuel_efficiency_combined
fuel_efficiency_highway
fuel_injection_control_type
fuel_injection_subtype
fuel_injection_system_design
fuel_injection_type
gearbox_speed
gearbox_type
gross_weight
hc_emission
hc_nox_emission
height
hip_room_front
hip_room_rear
id
k_type
kba
length
make
manufacturer
max_roof_load
max_tow_bar_download
max_trailer_load_b_license
max_trailer_load_braked_12
max_trailer_load_unbraked
model
model_code
model_version_code
month_of_first_circulation
month_of_sale
nox_emission
oil_temperature_emission
options {
...DescriptionOptionFragment
}
plate
price
rear_overhang
rear_track
seats
sli_battery_capacity
springs_front_type
springs_rear_type
steering_system
steering_type
tank_volume
top_speed
transmission_electronic_control
transmission_manufacturer_code
transmission_type
trunk_volume
url_vehicle_image
vehicle_type
verified
vin
wheel_base
wheels_dimension
width
year_of_first_circulation
year_of_sale
}
}
Variables
{"id": 4}
Response
{
"data": {
"vehicle_desc": {
"acceleration": 123.45,
"advanced_model": "abc123",
"body_type": "abc123",
"body_type_code": "xyz789",
"brakes_abs": "xyz789",
"brakes_front_type": "xyz789",
"brakes_rear_type": "abc123",
"brakes_system": "abc123",
"cargo_capacity": 123,
"co_2_emission": 123,
"co_emission": 987.65,
"color": "xyz789",
"company_id": "4",
"country": "abc123",
"critair": "abc123",
"curb_weight": 123,
"day_of_first_circulation": 123,
"day_of_sale": 123,
"decoding_region": "abc123",
"doors": 987,
"drive_type": "abc123",
"electric_vehicle_battery_capacity": 123.45,
"electric_vehicle_battery_voltage": 987.65,
"emission_standard": "abc123",
"engine_aspiration": "xyz789",
"engine_bore": 987.65,
"engine_code": "abc123",
"engine_configuration": "xyz789",
"engine_cylinder_head_type": "xyz789",
"engine_cylinders": 987,
"engine_displacement": 123,
"engine_extra": "xyz789",
"engine_fiscal_power": 123,
"engine_fuel_type": "ADBLUE",
"engine_fuel_type_secondary": "ADBLUE",
"engine_fuel_type_tertiary": "ADBLUE",
"engine_ignition_system": "xyz789",
"engine_manufacturer": "abc123",
"engine_output_power": 987,
"engine_output_power_ps": 987,
"engine_rpm_idle_max": 987,
"engine_rpm_idle_min": 987,
"engine_rpm_max": 123,
"engine_stroke": 123.45,
"engine_valves": 123,
"engine_version": "xyz789",
"engine_with_turbo": true,
"extra_info": VinExtraInfo,
"front_overhang": 123,
"front_track": 987,
"fuel_efficiency_city": 123.45,
"fuel_efficiency_combined": 987.65,
"fuel_efficiency_highway": 123.45,
"fuel_injection_control_type": "xyz789",
"fuel_injection_subtype": "xyz789",
"fuel_injection_system_design": "xyz789",
"fuel_injection_type": "xyz789",
"gearbox_speed": 987,
"gearbox_type": "xyz789",
"gross_weight": 123,
"hc_emission": 987.65,
"hc_nox_emission": 987.65,
"height": 123,
"hip_room_front": 987,
"hip_room_rear": 123,
"id": 4,
"k_type": "abc123",
"kba": "4",
"length": 987,
"make": "abc123",
"manufacturer": "abc123",
"max_roof_load": 987,
"max_tow_bar_download": 123,
"max_trailer_load_b_license": 987,
"max_trailer_load_braked_12": 123,
"max_trailer_load_unbraked": 123,
"model": "xyz789",
"model_code": "abc123",
"model_version_code": "xyz789",
"month_of_first_circulation": 987,
"month_of_sale": 987,
"nox_emission": 987.65,
"oil_temperature_emission": 987.65,
"options": [DescriptionOption],
"plate": "abc123",
"price": 123,
"rear_overhang": 123,
"rear_track": 123,
"seats": 123,
"sli_battery_capacity": 123.45,
"springs_front_type": "abc123",
"springs_rear_type": "xyz789",
"steering_system": "xyz789",
"steering_type": "abc123",
"tank_volume": 987,
"top_speed": 123,
"transmission_electronic_control": "xyz789",
"transmission_manufacturer_code": "xyz789",
"transmission_type": "xyz789",
"trunk_volume": 987,
"url_vehicle_image": "abc123",
"vehicle_type": "xyz789",
"verified": false,
"vin": "abc123",
"wheel_base": 123,
"wheels_dimension": "xyz789",
"width": 123,
"year_of_first_circulation": 123,
"year_of_sale": 123
}
}
}
vehicle_service
Description
Get Vehicle service by ID
Response
Returns a VehicleService
Arguments
| Name | Description |
|---|---|
id - ID!
|
Vehicle service ID |
Example
Query
query vehicle_service($id: ID!) {
vehicle_service(id: $id) {
id
description
label
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"vehicle_service": {
"id": "4",
"description": "abc123",
"label": "xyz789",
"workshops": WorkshopPaged
}
}
}
vehicle_services
Description
List Vehicle services
Response
Returns a VehicleServicePaged
Example
Query
query vehicle_services(
$label: String,
$page_id: ID,
$page_size: Int
) {
vehicle_services(
label: $label,
page_id: $page_id,
page_size: $page_size
) {
count
list {
...VehicleServiceFragment
}
next
}
}
Variables
{
"label": "xyz789",
"page_id": 4,
"page_size": 123
}
Response
{
"data": {
"vehicle_services": {
"count": 987,
"list": [VehicleService],
"next": "4"
}
}
}
vehicle_type
Description
Get Vehicle type by ID
Response
Returns a VehicleType
Arguments
| Name | Description |
|---|---|
id - ID!
|
Vehicle type ID |
Example
Query
query vehicle_type($id: ID!) {
vehicle_type(id: $id) {
id
description
label
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"vehicle_type": {
"id": 4,
"description": "abc123",
"label": "xyz789",
"workshops": WorkshopPaged
}
}
}
vehicle_types
Description
List Vehicle types
Response
Returns a VehicleTypePaged
Example
Query
query vehicle_types(
$label: String,
$page_id: ID,
$page_size: Int
) {
vehicle_types(
label: $label,
page_id: $page_id,
page_size: $page_size
) {
count
list {
...VehicleTypeFragment
}
next
}
}
Variables
{
"label": "abc123",
"page_id": 4,
"page_size": 123
}
Response
{
"data": {
"vehicle_types": {
"count": 987,
"list": [VehicleType],
"next": "4"
}
}
}
vehicles
Description
Get the logged-in user vehicle list
Response
Returns a VehiclePaged
Arguments
| Name | Description |
|---|---|
any_fuel_types - [String]
|
Primary or secondary fuel type |
archived - Boolean
|
Filter by archived |
can_be_towed - Boolean
|
can be used as trailer vehicle |
can_tow - Boolean
|
can be used as towing vehicle |
doors_lock_statuses - [DoorsLockStatus]
|
Filter by doors lock status. |
fuel_type_secondaries - [String]
|
Secondary fuel type |
fuel_types - [String]
|
Primary fuel type |
garage_mode_statuses - [GarageModeStatus]
|
Filter by garage mode status. |
has_driver - Boolean
|
has_driver |
hybrid - Boolean
|
hybrid |
ids - [ID]
|
Filter by ids |
immobilizer_statuses - [ImmobilizerStatus]
|
Filter by immobilizer status. |
kba - [String]
|
KBA |
ktypes - [String]
|
KType |
labels - [String]
|
Filter by labels |
makes - [String]
|
Model make |
model_ids - [ID]
|
Model ID |
models - [String]
|
Model |
multi - [String]
|
Filter by Vehicle plate, vin, make and model, by Driver label and by Device imei. |
onboarded - Boolean
|
onboarded |
page_id - ID
|
Request page id (followup queries) |
page_size - Int
|
Results per page (initial query) |
plates - [String]
|
Filter by plates |
vehicle_types - [VehicleTypeName]
|
Vehicle type |
vins - [String]
|
Filter by VINs |
years - [String]
|
Model Year |
Example
Query
query vehicles(
$any_fuel_types: [String],
$archived: Boolean,
$can_be_towed: Boolean,
$can_tow: Boolean,
$doors_lock_statuses: [DoorsLockStatus],
$fuel_type_secondaries: [String],
$fuel_types: [String],
$garage_mode_statuses: [GarageModeStatus],
$has_driver: Boolean,
$hybrid: Boolean,
$ids: [ID],
$immobilizer_statuses: [ImmobilizerStatus],
$kba: [String],
$ktypes: [String],
$labels: [String],
$makes: [String],
$model_ids: [ID],
$models: [String],
$multi: [String],
$onboarded: Boolean,
$page_id: ID,
$page_size: Int,
$plates: [String],
$vehicle_types: [VehicleTypeName],
$vins: [String],
$years: [String]
) {
vehicles(
any_fuel_types: $any_fuel_types,
archived: $archived,
can_be_towed: $can_be_towed,
can_tow: $can_tow,
doors_lock_statuses: $doors_lock_statuses,
fuel_type_secondaries: $fuel_type_secondaries,
fuel_types: $fuel_types,
garage_mode_statuses: $garage_mode_statuses,
has_driver: $has_driver,
hybrid: $hybrid,
ids: $ids,
immobilizer_statuses: $immobilizer_statuses,
kba: $kba,
ktypes: $ktypes,
labels: $labels,
makes: $makes,
model_ids: $model_ids,
models: $models,
multi: $multi,
onboarded: $onboarded,
page_id: $page_id,
page_size: $page_size,
plates: $plates,
vehicle_types: $vehicle_types,
vins: $vins,
years: $years
) {
count
list {
...VehicleFragment
}
next
}
}
Variables
{
"any_fuel_types": ["xyz789"],
"archived": false,
"can_be_towed": false,
"can_tow": true,
"doors_lock_statuses": ["LOCKED"],
"fuel_type_secondaries": ["xyz789"],
"fuel_types": ["xyz789"],
"garage_mode_statuses": ["DISABLED"],
"has_driver": false,
"hybrid": true,
"ids": [4],
"immobilizer_statuses": ["DISABLED"],
"kba": ["xyz789"],
"ktypes": ["xyz789"],
"labels": ["xyz789"],
"makes": ["abc123"],
"model_ids": [4],
"models": ["xyz789"],
"multi": ["abc123"],
"onboarded": false,
"page_id": "4",
"page_size": 123,
"plates": ["xyz789"],
"vehicle_types": ["CAR"],
"vins": ["abc123"],
"years": ["abc123"]
}
Response
{
"data": {
"vehicles": {
"count": 123,
"list": [Vehicle],
"next": "4"
}
}
}
warning_icons
Description
List warning icons
Response
Returns a WarningIconPaged
Example
Query
query warning_icons(
$codes: [String!],
$names: [String!],
$page_id: ID,
$page_size: Int
) {
warning_icons(
codes: $codes,
names: $names,
page_id: $page_id,
page_size: $page_size
) {
count
list {
...WarningIconFragment
}
next
}
}
Variables
{
"codes": ["xyz789"],
"names": ["xyz789"],
"page_id": "4",
"page_size": 123
}
Response
{
"data": {
"warning_icons": {
"count": 123,
"list": [WarningIcon],
"next": "4"
}
}
}
weather
Description
Get Weather using coordinates
Response
Returns a WeatherCoordinates
Example
Query
query weather(
$latitude: Float!,
$longitude: Float!,
$time: DateTime
) {
weather(
latitude: $latitude,
longitude: $longitude,
time: $time
) {
latitude
longitude
temperature
time
weather
weather_id
}
}
Variables
{
"latitude": 987.65,
"longitude": 123.45,
"time": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"weather": {
"latitude": 123.45,
"longitude": 987.65,
"temperature": 987.65,
"time": "2007-12-03T10:15:30Z",
"weather": "abc123",
"weather_id": 123
}
}
}
wifi_status
Description
Get wifi status
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
device_id - ID!
|
Device id |
Example
Query
query wifi_status($device_id: ID!) {
wifi_status(device_id: $device_id) {
attributes
id
type
}
}
Variables
{"device_id": 4}
Response
{
"data": {
"wifi_status": {
"attributes": Json,
"id": 4,
"type": "xyz789"
}
}
}
workday
Description
Get Workday by ID
Example
Query
query workday($id: ID!) {
workday(id: $id) {
id
closing_hour_1
closing_hour_2
day
opening_hour_1
opening_hour_2
workshop {
...WorkshopFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"workday": {
"id": 4,
"closing_hour_1": "abc123",
"closing_hour_2": "abc123",
"day": "FRIDAY",
"opening_hour_1": "abc123",
"opening_hour_2": "abc123",
"workshop": Workshop
}
}
}
workshop
Description
Get Workshop by ID
Example
Query
query workshop($id: ID!) {
workshop(id: $id) {
id
address
average_stars
bookings {
...BookingPagedFragment
}
brand
city
code
country
driver_services {
...DriverServicePagedFragment
}
email
fax
icon
international_phone
language
lat
lon
managers {
...WorkshopManagerPagedFragment
}
name
phone
postal_code
provider
provider_workshop_id
province
quotations {
...QuotationPagedFragment
}
ratings {
...RatingPagedFragment
}
time_zone
vehicle_services {
...VehicleServicePagedFragment
}
vehicle_types {
...VehicleTypePagedFragment
}
web
workdays {
...WorkdayPagedFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"workshop": {
"id": "4",
"address": "xyz789",
"average_stars": 987.65,
"bookings": BookingPaged,
"brand": "xyz789",
"city": "abc123",
"code": "xyz789",
"country": "xyz789",
"driver_services": DriverServicePaged,
"email": "abc123",
"fax": "xyz789",
"icon": "xyz789",
"international_phone": "xyz789",
"language": Language,
"lat": 123.45,
"lon": 987.65,
"managers": WorkshopManagerPaged,
"name": "abc123",
"phone": "xyz789",
"postal_code": "abc123",
"provider": "abc123",
"provider_workshop_id": 4,
"province": "abc123",
"quotations": QuotationPaged,
"ratings": RatingPaged,
"time_zone": "xyz789",
"vehicle_services": VehicleServicePaged,
"vehicle_types": VehicleTypePaged,
"web": "abc123",
"workdays": WorkdayPaged
}
}
}
workshops
Description
List Workshops
Response
Returns a WorkshopPaged
Arguments
| Name | Description |
|---|---|
address - String
|
Workshop address |
available - String
|
Workshop open on the specified DAY,HH:MM or DAY |
average_stars - Float
|
Workshop with average rating stars above value |
brand - String
|
Workshop brand |
city - String
|
Workshop city |
code - String
|
Workshop code |
country - String
|
Workshop country |
distance - Int
|
Max distance (km) from lat/lon |
international_phone - String
|
Workshop international phone |
language - Language
|
Workshop language |
lat - Float
|
Workshop latitude |
lon - Float
|
Workshop longitude |
name - String
|
Workshop name |
page_id - ID
|
Request page id (followup queries) |
page_size - Int
|
Results per page (initial query) |
phone - String
|
Workshop phone |
postal_code - String
|
Workshop postal code |
provider - String
|
Workshop provider |
province - String
|
Workshop province |
time_zone - String
|
Workshop time_zone |
Example
Query
query workshops(
$address: String,
$available: String,
$average_stars: Float,
$brand: String,
$city: String,
$code: String,
$country: String,
$distance: Int,
$international_phone: String,
$language: Language,
$lat: Float,
$lon: Float,
$name: String,
$page_id: ID,
$page_size: Int,
$phone: String,
$postal_code: String,
$provider: String,
$province: String,
$time_zone: String
) {
workshops(
address: $address,
available: $available,
average_stars: $average_stars,
brand: $brand,
city: $city,
code: $code,
country: $country,
distance: $distance,
international_phone: $international_phone,
language: $language,
lat: $lat,
lon: $lon,
name: $name,
page_id: $page_id,
page_size: $page_size,
phone: $phone,
postal_code: $postal_code,
provider: $provider,
province: $province,
time_zone: $time_zone
) {
count
list {
...WorkshopFragment
}
next
}
}
Variables
{
"address": "abc123",
"available": "abc123",
"average_stars": 987.65,
"brand": "abc123",
"city": "abc123",
"code": "abc123",
"country": "xyz789",
"distance": 987,
"international_phone": "xyz789",
"language": Language,
"lat": 123.45,
"lon": 987.65,
"name": "xyz789",
"page_id": "4",
"page_size": 987,
"phone": "abc123",
"postal_code": "abc123",
"provider": "xyz789",
"province": "xyz789",
"time_zone": "abc123"
}
Response
{
"data": {
"workshops": {
"count": 987,
"list": [Workshop],
"next": 4
}
}
}
Mutations
account_confirm
Description
Confirm account using side-channel code
Response
Returns an AccountConfirmation
Arguments
| Name | Description |
|---|---|
code - String!
|
Confirmation code |
Example
Query
mutation account_confirm($code: String!) {
account_confirm(code: $code) {
force_reset_at_confirmation
force_reset_password
id
updated_at
}
}
Variables
{"code": "xyz789"}
Response
{
"data": {
"account_confirm": {
"force_reset_at_confirmation": false,
"force_reset_password": true,
"id": "4",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
account_create
Description
Create a new user account
Response
Returns an Account
Arguments
| Name | Description |
|---|---|
country_code - String
|
Country code (ISO 639) |
email - String
|
|
full_name - String
|
Full name |
group_id - ID
|
Group id |
language - Language
|
Language |
organization_id - ID
|
Organization id |
password - String
|
Account password (see also passwordResetToken) |
phone - String
|
Phone number (including international code) |
short_name - String
|
Short name |
time_zone - String
|
Time zone |
Example
Query
mutation account_create(
$country_code: String,
$email: String,
$full_name: String,
$group_id: ID,
$language: Language,
$organization_id: ID,
$password: String,
$phone: String,
$short_name: String,
$time_zone: String
) {
account_create(
country_code: $country_code,
email: $email,
full_name: $full_name,
group_id: $group_id,
language: $language,
organization_id: $organization_id,
password: $password,
phone: $phone,
short_name: $short_name,
time_zone: $time_zone
) {
alert_preference {
...AlertPreferenceFragment
}
company_name
confirmed_at
country_code
created_at
descriptions {
...DescriptionPagedFragment
}
devices {
...DevicePagedFragment
}
distributors {
...OnboardingDistributorPagedFragment
}
driver_contacts {
...DriverPagedFragment
}
driver_profiles {
...DriverPagedFragment
}
drivers {
...DriverPagedFragment
}
email
full_name
groups {
...GroupPagedFragment
}
id
language
last_sign_in_at
organization_id
phone
roles {
...AccountRoleFragment
}
short_name
time_zone
updated_at
vehicles {
...VehiclePagedFragment
}
workshops {
...WorkshopPagedFragment
}
sso_user {
... on user {
...userFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{
"country_code": "xyz789",
"email": "xyz789",
"full_name": "xyz789",
"group_id": 4,
"language": Language,
"organization_id": "4",
"password": "abc123",
"phone": "abc123",
"short_name": "xyz789",
"time_zone": "xyz789"
}
Response
{
"data": {
"account_create": {
"alert_preference": AlertPreference,
"company_name": "xyz789",
"confirmed_at": "2007-12-03T10:15:30Z",
"country_code": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"distributors": OnboardingDistributorPaged,
"driver_contacts": DriverPaged,
"driver_profiles": DriverPaged,
"drivers": DriverPaged,
"email": "abc123",
"full_name": "abc123",
"groups": GroupPaged,
"id": "4",
"language": Language,
"last_sign_in_at": "2007-12-03T10:15:30Z",
"organization_id": 4,
"phone": "abc123",
"roles": [AccountRole],
"short_name": "xyz789",
"time_zone": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"vehicles": VehiclePaged,
"workshops": WorkshopPaged,
"sso_user": user
}
}
}
account_delete
Currently not supported, contact customer support for account deletion
account_update
Description
Update Logged in user account
Response
Returns an Account
Arguments
| Name | Description |
|---|---|
country_code - String
|
Country code (ISO 639) |
email - String
|
|
full_name - String
|
Full name |
id - ID
|
Account to update. Default = "me" |
language - Language
|
Language |
password - String
|
Account password (see also passwordResetToken) |
phone - String
|
Phone number (including international code) |
roles - [RoleInput]
|
Role- and target-based permissions |
short_name - String
|
Short name |
time_zone - String
|
Time zone |
Example
Query
mutation account_update(
$country_code: String,
$email: String,
$full_name: String,
$id: ID,
$language: Language,
$password: String,
$phone: String,
$roles: [RoleInput],
$short_name: String,
$time_zone: String
) {
account_update(
country_code: $country_code,
email: $email,
full_name: $full_name,
id: $id,
language: $language,
password: $password,
phone: $phone,
roles: $roles,
short_name: $short_name,
time_zone: $time_zone
) {
alert_preference {
...AlertPreferenceFragment
}
company_name
confirmed_at
country_code
created_at
descriptions {
...DescriptionPagedFragment
}
devices {
...DevicePagedFragment
}
distributors {
...OnboardingDistributorPagedFragment
}
driver_contacts {
...DriverPagedFragment
}
driver_profiles {
...DriverPagedFragment
}
drivers {
...DriverPagedFragment
}
email
full_name
groups {
...GroupPagedFragment
}
id
language
last_sign_in_at
organization_id
phone
roles {
...AccountRoleFragment
}
short_name
time_zone
updated_at
vehicles {
...VehiclePagedFragment
}
workshops {
...WorkshopPagedFragment
}
sso_user {
... on user {
...userFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{
"country_code": "xyz789",
"email": "xyz789",
"full_name": "abc123",
"id": "me",
"language": Language,
"password": "abc123",
"phone": "abc123",
"roles": [RoleInput],
"short_name": "xyz789",
"time_zone": "xyz789"
}
Response
{
"data": {
"account_update": {
"alert_preference": AlertPreference,
"company_name": "xyz789",
"confirmed_at": "2007-12-03T10:15:30Z",
"country_code": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"distributors": OnboardingDistributorPaged,
"driver_contacts": DriverPaged,
"driver_profiles": DriverPaged,
"drivers": DriverPaged,
"email": "xyz789",
"full_name": "abc123",
"groups": GroupPaged,
"id": 4,
"language": Language,
"last_sign_in_at": "2007-12-03T10:15:30Z",
"organization_id": 4,
"phone": "xyz789",
"roles": [AccountRole],
"short_name": "abc123",
"time_zone": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"vehicles": VehiclePaged,
"workshops": WorkshopPaged,
"sso_user": user
}
}
}
alert_notification_create
Description
Create notification
Response
Returns an AlertNotification
Example
Query
mutation alert_notification_create(
$context: Json,
$queue_name: String,
$queue_version: String,
$receiver: ID
) {
alert_notification_create(
context: $context,
queue_name: $queue_name,
queue_version: $queue_version,
receiver: $receiver
) {
created_at
failed_at
force_channel
id
jobs {
...AlertJobPagedFragment
}
queue {
...AlertQueueFragment
}
receiver {
...AccountFragment
}
sender {
...AccountFragment
}
sent_at
status
template {
...AlertTemplateFragment
}
template_context
updated_at
}
}
Variables
{
"context": Json,
"queue_name": "xyz789",
"queue_version": "abc123",
"receiver": "4"
}
Response
{
"data": {
"alert_notification_create": {
"created_at": "2007-12-03T10:15:30Z",
"failed_at": "2007-12-03T10:15:30Z",
"force_channel": true,
"id": 4,
"jobs": AlertJobPaged,
"queue": AlertQueue,
"receiver": Account,
"sender": Account,
"sent_at": "2007-12-03T10:15:30Z",
"status": "SUCEEDED",
"template": AlertTemplate,
"template_context": Json,
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
alert_notification_update
Description
Update notification
Response
Returns an AlertNotification
Example
Query
mutation alert_notification_update(
$context: Json,
$id: ID!,
$queue_name: String,
$queue_version: String,
$receiver: ID,
$status: AlertNotificationStatus
) {
alert_notification_update(
context: $context,
id: $id,
queue_name: $queue_name,
queue_version: $queue_version,
receiver: $receiver,
status: $status
) {
created_at
failed_at
force_channel
id
jobs {
...AlertJobPagedFragment
}
queue {
...AlertQueueFragment
}
receiver {
...AccountFragment
}
sender {
...AccountFragment
}
sent_at
status
template {
...AlertTemplateFragment
}
template_context
updated_at
}
}
Variables
{
"context": Json,
"id": 4,
"queue_name": "abc123",
"queue_version": "abc123",
"receiver": "4",
"status": "SUCEEDED"
}
Response
{
"data": {
"alert_notification_update": {
"created_at": "2007-12-03T10:15:30Z",
"failed_at": "2007-12-03T10:15:30Z",
"force_channel": false,
"id": "4",
"jobs": AlertJobPaged,
"queue": AlertQueue,
"receiver": Account,
"sender": Account,
"sent_at": "2007-12-03T10:15:30Z",
"status": "SUCEEDED",
"template": AlertTemplate,
"template_context": Json,
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
alert_preference_update
Response
Returns an AlertPreference
Arguments
| Name | Description |
|---|---|
firebase_messaging_token - String
|
|
id - ID
|
Account id. Default = "me" |
preferred_channels - [AlertPreferredChannel]
|
|
stop_notifications - Boolean
|
Example
Query
mutation alert_preference_update(
$firebase_messaging_token: String,
$id: ID,
$preferred_channels: [AlertPreferredChannel],
$stop_notifications: Boolean
) {
alert_preference_update(
firebase_messaging_token: $firebase_messaging_token,
id: $id,
preferred_channels: $preferred_channels,
stop_notifications: $stop_notifications
) {
firebase_messaging_token
id
preferred_channels
stop_notifications
}
}
Variables
{
"firebase_messaging_token": "xyz789",
"id": "me",
"preferred_channels": ["EMAIL"],
"stop_notifications": true
}
Response
{
"data": {
"alert_preference_update": {
"firebase_messaging_token": "abc123",
"id": "4",
"preferred_channels": ["EMAIL"],
"stop_notifications": true
}
}
}
booking_create
Description
Create booking
Response
Returns a Booking
Arguments
| Name | Description |
|---|---|
additional_information - String
|
|
booking_date - DateTime
|
|
city - String
|
|
contact_method - WorkshopContactMethod!
|
|
country - String
|
|
plate_number - String!
|
Vehichle plate number |
preferred_language - Language
|
|
quotation_ids - [ID]
|
|
uid - ID
|
|
user_email - String!
|
|
user_name - String!
|
|
user_phone_number - String!
|
|
vehicle_make - String
|
|
vehicle_model - String
|
|
vehicle_year - String
|
|
vin - String
|
|
workshop_id - ID!
|
Workshop ID |
Example
Query
mutation booking_create(
$additional_information: String,
$booking_date: DateTime,
$city: String,
$contact_method: WorkshopContactMethod!,
$country: String,
$plate_number: String!,
$preferred_language: Language,
$quotation_ids: [ID],
$uid: ID,
$user_email: String!,
$user_name: String!,
$user_phone_number: String!,
$vehicle_make: String,
$vehicle_model: String,
$vehicle_year: String,
$vin: String,
$workshop_id: ID!
) {
booking_create(
additional_information: $additional_information,
booking_date: $booking_date,
city: $city,
contact_method: $contact_method,
country: $country,
plate_number: $plate_number,
preferred_language: $preferred_language,
quotation_ids: $quotation_ids,
uid: $uid,
user_email: $user_email,
user_name: $user_name,
user_phone_number: $user_phone_number,
vehicle_make: $vehicle_make,
vehicle_model: $vehicle_model,
vehicle_year: $vehicle_year,
vin: $vin,
workshop_id: $workshop_id
) {
id
additional_information
booking_date
city
contact_method
country
plate_number
preferred_language
quotation_ids
status
user_email
user_name
user_phone_number
vehicle_make
vehicle_model
vehicle_year
vin
workshop {
...WorkshopFragment
}
}
}
Variables
{
"additional_information": "xyz789",
"booking_date": "2007-12-03T10:15:30Z",
"city": "abc123",
"contact_method": "EMAIL",
"country": "xyz789",
"plate_number": "xyz789",
"preferred_language": Language,
"quotation_ids": [4],
"uid": "4",
"user_email": "xyz789",
"user_name": "abc123",
"user_phone_number": "xyz789",
"vehicle_make": "abc123",
"vehicle_model": "xyz789",
"vehicle_year": "abc123",
"vin": "abc123",
"workshop_id": "4"
}
Response
{
"data": {
"booking_create": {
"id": "4",
"additional_information": "abc123",
"booking_date": "2007-12-03T10:15:30Z",
"city": "abc123",
"contact_method": "EMAIL",
"country": "xyz789",
"plate_number": "xyz789",
"preferred_language": Language,
"quotation_ids": [4],
"status": "CONFIRMED",
"user_email": "xyz789",
"user_name": "abc123",
"user_phone_number": "abc123",
"vehicle_make": "abc123",
"vehicle_model": "xyz789",
"vehicle_year": "abc123",
"vin": "abc123",
"workshop": Workshop
}
}
}
booking_delete
Description
Cancel booking
booking_update
Description
Update booking
Response
Returns a Booking
Arguments
| Name | Description |
|---|---|
additional_information - String
|
|
booking_date - DateTime
|
|
city - String
|
|
contact_method - WorkshopContactMethod
|
|
country - String
|
|
id - ID!
|
|
plate_number - String
|
Vehichle plate number |
preferred_language - Language
|
|
quotation_ids - [ID]
|
|
uid - ID
|
|
user_email - String
|
|
user_name - String
|
|
user_phone_number - String
|
|
vehicle_make - String
|
|
vehicle_model - String
|
|
vehicle_year - String
|
|
vin - String
|
|
workshop_id - ID
|
Workshop ID |
Example
Query
mutation booking_update(
$additional_information: String,
$booking_date: DateTime,
$city: String,
$contact_method: WorkshopContactMethod,
$country: String,
$id: ID!,
$plate_number: String,
$preferred_language: Language,
$quotation_ids: [ID],
$uid: ID,
$user_email: String,
$user_name: String,
$user_phone_number: String,
$vehicle_make: String,
$vehicle_model: String,
$vehicle_year: String,
$vin: String,
$workshop_id: ID
) {
booking_update(
additional_information: $additional_information,
booking_date: $booking_date,
city: $city,
contact_method: $contact_method,
country: $country,
id: $id,
plate_number: $plate_number,
preferred_language: $preferred_language,
quotation_ids: $quotation_ids,
uid: $uid,
user_email: $user_email,
user_name: $user_name,
user_phone_number: $user_phone_number,
vehicle_make: $vehicle_make,
vehicle_model: $vehicle_model,
vehicle_year: $vehicle_year,
vin: $vin,
workshop_id: $workshop_id
) {
id
additional_information
booking_date
city
contact_method
country
plate_number
preferred_language
quotation_ids
status
user_email
user_name
user_phone_number
vehicle_make
vehicle_model
vehicle_year
vin
workshop {
...WorkshopFragment
}
}
}
Variables
{
"additional_information": "abc123",
"booking_date": "2007-12-03T10:15:30Z",
"city": "xyz789",
"contact_method": "EMAIL",
"country": "abc123",
"id": "4",
"plate_number": "abc123",
"preferred_language": Language,
"quotation_ids": ["4"],
"uid": "4",
"user_email": "abc123",
"user_name": "xyz789",
"user_phone_number": "abc123",
"vehicle_make": "xyz789",
"vehicle_model": "abc123",
"vehicle_year": "xyz789",
"vin": "abc123",
"workshop_id": "4"
}
Response
{
"data": {
"booking_update": {
"id": 4,
"additional_information": "abc123",
"booking_date": "2007-12-03T10:15:30Z",
"city": "abc123",
"contact_method": "EMAIL",
"country": "abc123",
"plate_number": "xyz789",
"preferred_language": Language,
"quotation_ids": ["4"],
"status": "CONFIRMED",
"user_email": "abc123",
"user_name": "xyz789",
"user_phone_number": "xyz789",
"vehicle_make": "abc123",
"vehicle_model": "abc123",
"vehicle_year": "xyz789",
"vin": "xyz789",
"workshop": Workshop
}
}
}
client_identification_create
Response
Returns a ClientIdentification
Arguments
| Name | Description |
|---|---|
client_reference - ID
|
|
client_reference_type - ClientReferenceType
|
|
default_account_id - ID
|
Default account to use with these onboardings |
default_whitelisted_data - [OnboardingWhitelistedDataArg!]
|
|
distributor_id - ID
|
Distributor id (if user has access to more than one) |
label - String
|
|
number_of_onboardings - Int
|
Example
Query
mutation client_identification_create(
$client_reference: ID,
$client_reference_type: ClientReferenceType,
$default_account_id: ID,
$default_whitelisted_data: [OnboardingWhitelistedDataArg!],
$distributor_id: ID,
$label: String,
$number_of_onboardings: Int
) {
client_identification_create(
client_reference: $client_reference,
client_reference_type: $client_reference_type,
default_account_id: $default_account_id,
default_whitelisted_data: $default_whitelisted_data,
distributor_id: $distributor_id,
label: $label,
number_of_onboardings: $number_of_onboardings
) {
client_reference
client_reference_type
code
created_by {
...AccountFragment
}
default_account {
...AccountFragment
}
default_whitelisted_data
distributor {
...OnboardingDistributorFragment
}
id
label
number_of_onboardings
number_of_started_onboardings
revoked
}
}
Variables
{
"client_reference": 4,
"client_reference_type": "GROUP",
"default_account_id": "4",
"default_whitelisted_data": ["POSITION"],
"distributor_id": 4,
"label": "xyz789",
"number_of_onboardings": 123
}
Response
{
"data": {
"client_identification_create": {
"client_reference": "4",
"client_reference_type": "GROUP",
"code": "xyz789",
"created_by": Account,
"default_account": Account,
"default_whitelisted_data": ["OTHER"],
"distributor": OnboardingDistributor,
"id": "4",
"label": "abc123",
"number_of_onboardings": 987,
"number_of_started_onboardings": 987,
"revoked": true
}
}
}
client_identification_revoke
cloud_events_create
Description
Notify events from the cloud to the subscribed clients
Response
Returns a CloudEventStatus
Arguments
| Name | Description |
|---|---|
pokes - [EventPokeArg!]
|
List of pokes to notify. Default = [] |
positions - [EventPositionArg!]
|
Default = [] |
presences - [EventPresenceArg!]
|
Default = [] |
remotediags - [EventRemotediagArg!]
|
Default = [] |
tracks - [EventTrackArg!]
|
List of tracks to notify. Default = [] |
Example
Query
mutation cloud_events_create(
$pokes: [EventPokeArg!],
$positions: [EventPositionArg!],
$presences: [EventPresenceArg!],
$remotediags: [EventRemotediagArg!],
$tracks: [EventTrackArg!]
) {
cloud_events_create(
pokes: $pokes,
positions: $positions,
presences: $presences,
remotediags: $remotediags,
tracks: $tracks
) {
node
peers
}
}
Variables
{
"pokes": [""],
"positions": [""],
"presences": [""],
"remotediags": [""],
"tracks": [""]
}
Response
{
"data": {
"cloud_events_create": {
"node": "xyz789",
"peers": ["abc123"]
}
}
}
create_device_token
Description
Method:
POSTBase URL:{env.ASSET_MANAGER_API}Path:/v1/device_tokens
[beta] generate device token
Response
Returns a create_device_token_response
Arguments
| Name | Description |
|---|---|
input - device_token_create_Input
|
Example
Query
mutation create_device_token($input: device_token_create_Input) {
create_device_token(input: $input) {
... on device_token_show {
...device_token_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"input": device_token_create_Input}
Response
{"data": {"create_device_token": device_token_show}}
create_metadatum
Description
Create metadatum
Response
Returns a TripMetadatum
Example
Query
mutation create_metadatum(
$key: String!,
$trip_id: ID!,
$value: String!
) {
create_metadatum(
key: $key,
trip_id: $trip_id,
value: $value
) {
created_at
id
key
trip_id
updated_at
value
}
}
Variables
{
"key": "abc123",
"trip_id": "4",
"value": "xyz789"
}
Response
{
"data": {
"create_metadatum": {
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"key": "abc123",
"trip_id": 4,
"updated_at": "2007-12-03T10:15:30Z",
"value": "xyz789"
}
}
}
dashcam_delete_video_segment
Description
Method:
DELETEBase URL:{env.DASHCAM_API}Path:/v1/video_segments/{args.id}Delete Video Segment
dashcam_post_video_segments
Description
Method:
POSTBase URL:{env.DASHCAM_API}Path:/v1/video_segmentsCreate Video Segment for Device
Response
Returns a video_segment_show
Arguments
| Name | Description |
|---|---|
input - video_segment_create_Input
|
Example
Query
mutation dashcam_post_video_segments($input: video_segment_create_Input) {
dashcam_post_video_segments(input: $input) {
data {
...video_segmentFragment
}
}
}
Variables
{"input": video_segment_create_Input}
Response
{
"data": {
"dashcam_post_video_segments": {"data": video_segment}
}
}
dashcam_put_dashcam
Description
Method:
PUTBase URL:{env.DASHCAM_API}Path:/v1/dashcams/{args.id}Update Dashcam
Response
Returns a dashcam_show
Arguments
| Name | Description |
|---|---|
id - String!
|
|
input - dashcam_update_Input
|
Example
Query
mutation dashcam_put_dashcam(
$id: String!,
$input: dashcam_update_Input
) {
dashcam_put_dashcam(
id: $id,
input: $input
) {
data {
...dashcamFragment
}
}
}
Variables
{
"id": "xyz789",
"input": dashcam_update_Input
}
Response
{"data": {"dashcam_put_dashcam": {"data": dashcam}}}
dashcam_put_dashcam_file
Description
Method:
PUTBase URL:{env.DASHCAM_API}Path:/v1/dashcam_files/{args.id}Update Dashcam File
Response
Returns a dashcam_file_show
Arguments
| Name | Description |
|---|---|
id - String!
|
|
input - dashcam_file_update_Input
|
Example
Query
mutation dashcam_put_dashcam_file(
$id: String!,
$input: dashcam_file_update_Input
) {
dashcam_put_dashcam_file(
id: $id,
input: $input
) {
data {
...dashcam_fileFragment
}
}
}
Variables
{
"id": "xyz789",
"input": dashcam_file_update_Input
}
Response
{
"data": {
"dashcam_put_dashcam_file": {"data": dashcam_file}
}
}
dashcam_put_video_segment
Description
Method:
PUTBase URL:{env.DASHCAM_API}Path:/v1/video_segments/{args.id}Update Video Segment
Response
Returns a video_segment_show
Arguments
| Name | Description |
|---|---|
id - String!
|
|
input - video_segment_update_Input
|
Example
Query
mutation dashcam_put_video_segment(
$id: String!,
$input: video_segment_update_Input
) {
dashcam_put_video_segment(
id: $id,
input: $input
) {
data {
...video_segmentFragment
}
}
}
Variables
{
"id": "xyz789",
"input": video_segment_update_Input
}
Response
{
"data": {
"dashcam_put_video_segment": {"data": video_segment}
}
}
delete_driver_auxiliary_device
Description
Method:
DELETEBase URL:{env.ASSET_MANAGER_API}Path:/v1/drivers/{args.driver_id}/auxiliary_devices/{args.aux_id}
[beta] Delete auxiliary device info
Response
Returns a delete_driver_auxiliary_device_response
Example
Query
mutation delete_driver_auxiliary_device(
$driver_id: String!,
$aux_id: String!
) {
delete_driver_auxiliary_device(
driver_id: $driver_id,
aux_id: $aux_id
) {
... on Void_container {
...Void_containerFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"driver_id": "abc123",
"aux_id": "xyz789"
}
Response
{
"data": {
"delete_driver_auxiliary_device": Void_container
}
}
delete_metadatum
Description
Delete metdatum
delete_v1_user_alert_notifications_by_id
Description
Method:
DELETEBase URL:{env.VEHICLE_ALERTS_API}Path:/v1/user_alert_notifications/{args.id}
[alpha] Delete user_alert_notification
Example
Query
mutation delete_v1_user_alert_notifications_by_id($id: String!) {
delete_v1_user_alert_notifications_by_id(id: $id)
}
Variables
{"id": "xyz789"}
Response
{"data": {"delete_v1_user_alert_notifications_by_id": null}}
delete_vehicle_auxiliary_device
Description
Method:
DELETEBase URL:{env.ASSET_MANAGER_API}Path:/v1/vehicles/{args.vehicle_id}/auxiliary_devices/{args.aux_id}
[beta] Delete auxiliary device info
Response
Returns a delete_vehicle_auxiliary_device_response
Example
Query
mutation delete_vehicle_auxiliary_device(
$vehicle_id: String!,
$aux_id: String!
) {
delete_vehicle_auxiliary_device(
vehicle_id: $vehicle_id,
aux_id: $aux_id
) {
... on Void_container {
...Void_containerFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"vehicle_id": "abc123",
"aux_id": "abc123"
}
Response
{
"data": {
"delete_vehicle_auxiliary_device": Void_container
}
}
description_create
Response
Returns a Description
Arguments
| Name | Description |
|---|---|
description - DescriptionCreate!
|
|
subject - DescriptionSubject!
|
Example
Query
mutation description_create(
$description: DescriptionCreate!,
$subject: DescriptionSubject!
) {
description_create(
description: $description,
subject: $subject
) {
created_at
id
label
source
updated_at
value
}
}
Variables
{
"description": DescriptionCreate,
"subject": DescriptionSubject
}
Response
{
"data": {
"description_create": {
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"label": "xyz789",
"source": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"value": "abc123"
}
}
}
description_delete
Response
Returns an ID
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
subject - DescriptionSubject!
|
Example
Query
mutation description_delete(
$id: ID!,
$subject: DescriptionSubject!
) {
description_delete(
id: $id,
subject: $subject
)
}
Variables
{
"id": "4",
"subject": DescriptionSubject
}
Response
{"data": {"description_delete": "4"}}
description_set
Response
Returns a Description
Arguments
| Name | Description |
|---|---|
description - DescriptionUpdate!
|
|
subject - DescriptionSubject!
|
Example
Query
mutation description_set(
$description: DescriptionUpdate!,
$subject: DescriptionSubject!
) {
description_set(
description: $description,
subject: $subject
) {
created_at
id
label
source
updated_at
value
}
}
Variables
{
"description": DescriptionUpdate,
"subject": DescriptionSubject
}
Response
{
"data": {
"description_set": {
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"label": "xyz789",
"source": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"value": "abc123"
}
}
}
device_create
Description
Create a new device
Response
Returns a Device
Arguments
| Name | Description |
|---|---|
input - DeviceInput!
|
Device Input |
Example
Query
mutation device_create($input: DeviceInput!) {
device_create(input: $input) {
id
active_account
aggregated_data {
...AggregatedDataFragment
}
alerts {
...VehicleAlertPagedFragment
}
alerts_state {
...VehicleAlertsStateFragment
}
battery_annotations {
...BatteryAnnotationPagedFragment
}
created_at
current_vehicle {
...VehicleFragment
}
device_type
fields {
...FieldPagedFragment
}
first_connection_at
groups {
...GroupPagedFragment
}
harshes {
...TripHarshPagedFragment
}
history {
...DeviceHistoryPagedFragment
}
last_activity_at
last_connection_at
last_connection_reason
last_disconnection_at
last_disconnection_reason
last_position {
...CoordinatesFragment
}
last_trip {
...TripFragment
}
log_fetches {
...LogfetchPagedFragment
}
onboarded
overspeeds {
...TripOverspeedPagedFragment
}
owner {
...AccountFragment
}
product {
...ProductFragment
}
profile_mode {
...ProfileDeviceModeFragment
}
profile_modes {
...ProfileDeviceModePagedFragment
}
profile_privacies {
...ProfilePrivacyPagedFragment
}
profile_privacy {
...ProfilePrivacyFragment
}
readings {
...ReadingPagedFragment
}
readings_anon {
...ReadingAnonPagedFragment
}
remote_diags {
...RemoteDiagPagedFragment
}
serial_number
status
trip_summary {
...TripSummaryFragment
}
trips {
...TripPagedFragment
}
updated_at
vehicle_sessions {
...DeviceVehicleSessionPagedFragment
}
vehicles {
...VehiclePagedFragment
}
dashcams {
...dashcam_pagedFragment
}
video_segments {
...video_segment_pagedFragment
}
geofences {
...geofence_paginatedFragment
}
cleaned_positions {
...map_matching_position_paginatedFragment
}
summary_from_journey {
...journey_summaryFragment
}
trip_journeys {
...journey_trip_paginatedFragment
}
trip_tag_schedules {
...trip_tag_schedule_paginatedFragment
}
journey_reports {
... on report_paginated {
...report_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_harshes {
...journey_trip_harsh_paginatedFragment
}
journey_overspeeds {
... on journey_trip_overspeed_paginated {
...journey_trip_overspeed_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_idlings {
... on journey_trip_idling_paginated {
...journey_trip_idling_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_config {
... on device_config_show_nullable {
...device_config_show_nullableFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{"input": DeviceInput}
Response
{
"data": {
"device_create": {
"id": 4,
"active_account": "abc123",
"aggregated_data": AggregatedData,
"alerts": VehicleAlertPaged,
"alerts_state": VehicleAlertsState,
"battery_annotations": BatteryAnnotationPaged,
"created_at": "2007-12-03T10:15:30Z",
"current_vehicle": Vehicle,
"device_type": "abc123",
"fields": FieldPaged,
"first_connection_at": "2007-12-03T10:15:30Z",
"groups": GroupPaged,
"harshes": TripHarshPaged,
"history": DeviceHistoryPaged,
"last_activity_at": "2007-12-03T10:15:30Z",
"last_connection_at": "2007-12-03T10:15:30Z",
"last_connection_reason": "CLOSED_BY_SERVER",
"last_disconnection_at": "2007-12-03T10:15:30Z",
"last_disconnection_reason": "AUTH_FAILED_ACCOUNT",
"last_position": Coordinates,
"last_trip": Trip,
"log_fetches": LogfetchPaged,
"onboarded": false,
"overspeeds": TripOverspeedPaged,
"owner": Account,
"product": Product,
"profile_mode": ProfileDeviceMode,
"profile_modes": ProfileDeviceModePaged,
"profile_privacies": ProfilePrivacyPaged,
"profile_privacy": ProfilePrivacy,
"readings": ReadingPaged,
"readings_anon": ReadingAnonPaged,
"remote_diags": RemoteDiagPaged,
"serial_number": "xyz789",
"status": "CONNECTED",
"trip_summary": TripSummary,
"trips": TripPaged,
"updated_at": "2007-12-03T10:15:30Z",
"vehicle_sessions": DeviceVehicleSessionPaged,
"vehicles": VehiclePaged,
"dashcams": dashcam_paged,
"video_segments": video_segment_paged,
"geofences": geofence_paginated,
"cleaned_positions": map_matching_position_paginated,
"summary_from_journey": journey_summary,
"trip_journeys": journey_trip_paginated,
"trip_tag_schedules": trip_tag_schedule_paginated,
"journey_reports": report_paginated,
"journey_harshes": journey_trip_harsh_paginated,
"journey_overspeeds": journey_trip_overspeed_paginated,
"journey_idlings": journey_trip_idling_paginated,
"journey_config": device_config_show_nullable
}
}
}
device_delete
Description
Delete a user device
Example
Query
mutation device_delete($id: ID!) {
device_delete(id: $id) {
id
active_account
aggregated_data {
...AggregatedDataFragment
}
alerts {
...VehicleAlertPagedFragment
}
alerts_state {
...VehicleAlertsStateFragment
}
battery_annotations {
...BatteryAnnotationPagedFragment
}
created_at
current_vehicle {
...VehicleFragment
}
device_type
fields {
...FieldPagedFragment
}
first_connection_at
groups {
...GroupPagedFragment
}
harshes {
...TripHarshPagedFragment
}
history {
...DeviceHistoryPagedFragment
}
last_activity_at
last_connection_at
last_connection_reason
last_disconnection_at
last_disconnection_reason
last_position {
...CoordinatesFragment
}
last_trip {
...TripFragment
}
log_fetches {
...LogfetchPagedFragment
}
onboarded
overspeeds {
...TripOverspeedPagedFragment
}
owner {
...AccountFragment
}
product {
...ProductFragment
}
profile_mode {
...ProfileDeviceModeFragment
}
profile_modes {
...ProfileDeviceModePagedFragment
}
profile_privacies {
...ProfilePrivacyPagedFragment
}
profile_privacy {
...ProfilePrivacyFragment
}
readings {
...ReadingPagedFragment
}
readings_anon {
...ReadingAnonPagedFragment
}
remote_diags {
...RemoteDiagPagedFragment
}
serial_number
status
trip_summary {
...TripSummaryFragment
}
trips {
...TripPagedFragment
}
updated_at
vehicle_sessions {
...DeviceVehicleSessionPagedFragment
}
vehicles {
...VehiclePagedFragment
}
dashcams {
...dashcam_pagedFragment
}
video_segments {
...video_segment_pagedFragment
}
geofences {
...geofence_paginatedFragment
}
cleaned_positions {
...map_matching_position_paginatedFragment
}
summary_from_journey {
...journey_summaryFragment
}
trip_journeys {
...journey_trip_paginatedFragment
}
trip_tag_schedules {
...trip_tag_schedule_paginatedFragment
}
journey_reports {
... on report_paginated {
...report_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_harshes {
...journey_trip_harsh_paginatedFragment
}
journey_overspeeds {
... on journey_trip_overspeed_paginated {
...journey_trip_overspeed_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_idlings {
... on journey_trip_idling_paginated {
...journey_trip_idling_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_config {
... on device_config_show_nullable {
...device_config_show_nullableFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"device_delete": {
"id": 4,
"active_account": "abc123",
"aggregated_data": AggregatedData,
"alerts": VehicleAlertPaged,
"alerts_state": VehicleAlertsState,
"battery_annotations": BatteryAnnotationPaged,
"created_at": "2007-12-03T10:15:30Z",
"current_vehicle": Vehicle,
"device_type": "abc123",
"fields": FieldPaged,
"first_connection_at": "2007-12-03T10:15:30Z",
"groups": GroupPaged,
"harshes": TripHarshPaged,
"history": DeviceHistoryPaged,
"last_activity_at": "2007-12-03T10:15:30Z",
"last_connection_at": "2007-12-03T10:15:30Z",
"last_connection_reason": "CLOSED_BY_SERVER",
"last_disconnection_at": "2007-12-03T10:15:30Z",
"last_disconnection_reason": "AUTH_FAILED_ACCOUNT",
"last_position": Coordinates,
"last_trip": Trip,
"log_fetches": LogfetchPaged,
"onboarded": true,
"overspeeds": TripOverspeedPaged,
"owner": Account,
"product": Product,
"profile_mode": ProfileDeviceMode,
"profile_modes": ProfileDeviceModePaged,
"profile_privacies": ProfilePrivacyPaged,
"profile_privacy": ProfilePrivacy,
"readings": ReadingPaged,
"readings_anon": ReadingAnonPaged,
"remote_diags": RemoteDiagPaged,
"serial_number": "abc123",
"status": "CONNECTED",
"trip_summary": TripSummary,
"trips": TripPaged,
"updated_at": "2007-12-03T10:15:30Z",
"vehicle_sessions": DeviceVehicleSessionPaged,
"vehicles": VehiclePaged,
"dashcams": dashcam_paged,
"video_segments": video_segment_paged,
"geofences": geofence_paginated,
"cleaned_positions": map_matching_position_paginated,
"summary_from_journey": journey_summary,
"trip_journeys": journey_trip_paginated,
"trip_tag_schedules": trip_tag_schedule_paginated,
"journey_reports": report_paginated,
"journey_harshes": journey_trip_harsh_paginated,
"journey_overspeeds": journey_trip_overspeed_paginated,
"journey_idlings": journey_trip_idling_paginated,
"journey_config": device_config_show_nullable
}
}
}
device_mode_create
Response
Returns a ProfileDeviceMode
Arguments
| Name | Description |
|---|---|
id - ID!
|
Device id |
mode - ProfileDeviceModeClassArg!
|
Example
Query
mutation device_mode_create(
$id: ID!,
$mode: ProfileDeviceModeClassArg!
) {
device_mode_create(
id: $id,
mode: $mode
) {
ended_at
id
mode
restore_default {
...ProfileRestoreDefaultFragment
}
started_at
status
}
}
Variables
{"id": "4", "mode": "TELEMATIC"}
Response
{
"data": {
"device_mode_create": {
"ended_at": "2007-12-03T10:15:30Z",
"id": 4,
"mode": "OTHER",
"restore_default": ProfileRestoreDefault,
"started_at": "2007-12-03T10:15:30Z",
"status": "OTHER"
}
}
}
device_privacy_create
Response
Returns a ProfilePrivacy
Arguments
| Name | Description |
|---|---|
id - ID!
|
Device id |
whitelisted_data - [OnboardingWhitelistedData!]
|
Example
Query
mutation device_privacy_create(
$id: ID!,
$whitelisted_data: [OnboardingWhitelistedData!]
) {
device_privacy_create(
id: $id,
whitelisted_data: $whitelisted_data
) {
created_at
ended_at
id
restore_default {
...ProfileRestoreDefaultFragment
}
started_at
status
whitelisted_data
}
}
Variables
{"id": 4, "whitelisted_data": ["OTHER"]}
Response
{
"data": {
"device_privacy_create": {
"created_at": "2007-12-03T10:15:30Z",
"ended_at": "2007-12-03T10:15:30Z",
"id": 4,
"restore_default": ProfileRestoreDefault,
"started_at": "2007-12-03T10:15:30Z",
"status": "OTHER",
"whitelisted_data": ["OTHER"]
}
}
}
device_set
Description
Set the user's device fields
Response
Returns a Device
Arguments
| Name | Description |
|---|---|
id - ID!
|
Identifier |
input - DeviceInput!
|
Device Input |
Example
Query
mutation device_set(
$id: ID!,
$input: DeviceInput!
) {
device_set(
id: $id,
input: $input
) {
id
active_account
aggregated_data {
...AggregatedDataFragment
}
alerts {
...VehicleAlertPagedFragment
}
alerts_state {
...VehicleAlertsStateFragment
}
battery_annotations {
...BatteryAnnotationPagedFragment
}
created_at
current_vehicle {
...VehicleFragment
}
device_type
fields {
...FieldPagedFragment
}
first_connection_at
groups {
...GroupPagedFragment
}
harshes {
...TripHarshPagedFragment
}
history {
...DeviceHistoryPagedFragment
}
last_activity_at
last_connection_at
last_connection_reason
last_disconnection_at
last_disconnection_reason
last_position {
...CoordinatesFragment
}
last_trip {
...TripFragment
}
log_fetches {
...LogfetchPagedFragment
}
onboarded
overspeeds {
...TripOverspeedPagedFragment
}
owner {
...AccountFragment
}
product {
...ProductFragment
}
profile_mode {
...ProfileDeviceModeFragment
}
profile_modes {
...ProfileDeviceModePagedFragment
}
profile_privacies {
...ProfilePrivacyPagedFragment
}
profile_privacy {
...ProfilePrivacyFragment
}
readings {
...ReadingPagedFragment
}
readings_anon {
...ReadingAnonPagedFragment
}
remote_diags {
...RemoteDiagPagedFragment
}
serial_number
status
trip_summary {
...TripSummaryFragment
}
trips {
...TripPagedFragment
}
updated_at
vehicle_sessions {
...DeviceVehicleSessionPagedFragment
}
vehicles {
...VehiclePagedFragment
}
dashcams {
...dashcam_pagedFragment
}
video_segments {
...video_segment_pagedFragment
}
geofences {
...geofence_paginatedFragment
}
cleaned_positions {
...map_matching_position_paginatedFragment
}
summary_from_journey {
...journey_summaryFragment
}
trip_journeys {
...journey_trip_paginatedFragment
}
trip_tag_schedules {
...trip_tag_schedule_paginatedFragment
}
journey_reports {
... on report_paginated {
...report_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_harshes {
...journey_trip_harsh_paginatedFragment
}
journey_overspeeds {
... on journey_trip_overspeed_paginated {
...journey_trip_overspeed_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_idlings {
... on journey_trip_idling_paginated {
...journey_trip_idling_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_config {
... on device_config_show_nullable {
...device_config_show_nullableFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{
"id": "4",
"input": DeviceInput
}
Response
{
"data": {
"device_set": {
"id": 4,
"active_account": "xyz789",
"aggregated_data": AggregatedData,
"alerts": VehicleAlertPaged,
"alerts_state": VehicleAlertsState,
"battery_annotations": BatteryAnnotationPaged,
"created_at": "2007-12-03T10:15:30Z",
"current_vehicle": Vehicle,
"device_type": "xyz789",
"fields": FieldPaged,
"first_connection_at": "2007-12-03T10:15:30Z",
"groups": GroupPaged,
"harshes": TripHarshPaged,
"history": DeviceHistoryPaged,
"last_activity_at": "2007-12-03T10:15:30Z",
"last_connection_at": "2007-12-03T10:15:30Z",
"last_connection_reason": "CLOSED_BY_SERVER",
"last_disconnection_at": "2007-12-03T10:15:30Z",
"last_disconnection_reason": "AUTH_FAILED_ACCOUNT",
"last_position": Coordinates,
"last_trip": Trip,
"log_fetches": LogfetchPaged,
"onboarded": true,
"overspeeds": TripOverspeedPaged,
"owner": Account,
"product": Product,
"profile_mode": ProfileDeviceMode,
"profile_modes": ProfileDeviceModePaged,
"profile_privacies": ProfilePrivacyPaged,
"profile_privacy": ProfilePrivacy,
"readings": ReadingPaged,
"readings_anon": ReadingAnonPaged,
"remote_diags": RemoteDiagPaged,
"serial_number": "abc123",
"status": "CONNECTED",
"trip_summary": TripSummary,
"trips": TripPaged,
"updated_at": "2007-12-03T10:15:30Z",
"vehicle_sessions": DeviceVehicleSessionPaged,
"vehicles": VehiclePaged,
"dashcams": dashcam_paged,
"video_segments": video_segment_paged,
"geofences": geofence_paginated,
"cleaned_positions": map_matching_position_paginated,
"summary_from_journey": journey_summary,
"trip_journeys": journey_trip_paginated,
"trip_tag_schedules": trip_tag_schedule_paginated,
"journey_reports": report_paginated,
"journey_harshes": journey_trip_harsh_paginated,
"journey_overspeeds": journey_trip_overspeed_paginated,
"journey_idlings": journey_trip_idling_paginated,
"journey_config": device_config_show_nullable
}
}
}
device_vehicle_session_start
Description
Start a device vehicle session
Response
Returns a DeviceVehicleSession
Arguments
| Name | Description |
|---|---|
connection_type - DeviceConnectionType
|
Connection type. Default = DIRECT |
device_id - ID!
|
Device Identifier |
installation_date - DateTime!
|
Installation Date |
km_at_installation - Int!
|
km_at_installation |
vehicle_id - ID!
|
Vehicle Identifier |
Example
Query
mutation device_vehicle_session_start(
$connection_type: DeviceConnectionType,
$device_id: ID!,
$installation_date: DateTime!,
$km_at_installation: Int!,
$vehicle_id: ID!
) {
device_vehicle_session_start(
connection_type: $connection_type,
device_id: $device_id,
installation_date: $installation_date,
km_at_installation: $km_at_installation,
vehicle_id: $vehicle_id
) {
active
connection_type
device {
...DeviceFragment
}
id
installation_date
km_at_installation
owner {
...AccountFragment
}
removal_date
vehicle {
...VehicleFragment
}
}
}
Variables
{
"connection_type": "DIRECT",
"device_id": 4,
"installation_date": "2007-12-03T10:15:30Z",
"km_at_installation": 123,
"vehicle_id": "4"
}
Response
{
"data": {
"device_vehicle_session_start": {
"active": true,
"connection_type": "CABLE",
"device": Device,
"id": 4,
"installation_date": "2007-12-03T10:15:30Z",
"km_at_installation": 123,
"owner": Account,
"removal_date": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
}
}
device_vehicle_session_stop
Description
Stop a device vehicle session
Response
Returns a DeviceVehicleSession
Example
Query
mutation device_vehicle_session_stop(
$device_id: ID,
$id: ID!,
$removal_date: DateTime,
$vehicle_id: ID
) {
device_vehicle_session_stop(
device_id: $device_id,
id: $id,
removal_date: $removal_date,
vehicle_id: $vehicle_id
) {
active
connection_type
device {
...DeviceFragment
}
id
installation_date
km_at_installation
owner {
...AccountFragment
}
removal_date
vehicle {
...VehicleFragment
}
}
}
Variables
{
"device_id": 4,
"id": 4,
"removal_date": "2007-12-03T10:15:30Z",
"vehicle_id": "4"
}
Response
{
"data": {
"device_vehicle_session_stop": {
"active": true,
"connection_type": "CABLE",
"device": Device,
"id": "4",
"installation_date": "2007-12-03T10:15:30Z",
"km_at_installation": 123,
"owner": Account,
"removal_date": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
}
}
device_vehicle_session_update
Description
Start a device vehicle session
Response
Returns a DeviceVehicleSession
Example
Query
mutation device_vehicle_session_update(
$connection_type: DeviceConnectionType,
$device_id: ID,
$id: ID!,
$installation_date: DateTime,
$km_at_installation: Int,
$vehicle_id: ID
) {
device_vehicle_session_update(
connection_type: $connection_type,
device_id: $device_id,
id: $id,
installation_date: $installation_date,
km_at_installation: $km_at_installation,
vehicle_id: $vehicle_id
) {
active
connection_type
device {
...DeviceFragment
}
id
installation_date
km_at_installation
owner {
...AccountFragment
}
removal_date
vehicle {
...VehicleFragment
}
}
}
Variables
{
"connection_type": "CABLE",
"device_id": 4,
"id": "4",
"installation_date": "2007-12-03T10:15:30Z",
"km_at_installation": 123,
"vehicle_id": 4
}
Response
{
"data": {
"device_vehicle_session_update": {
"active": false,
"connection_type": "CABLE",
"device": Device,
"id": "4",
"installation_date": "2007-12-03T10:15:30Z",
"km_at_installation": 987,
"owner": Account,
"removal_date": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
}
}
displacement_set
Description
Set displacement value parameter
Response
Returns a RdcAsyncAck
Example
Query
mutation displacement_set(
$device_id: ID!,
$value: Int!
) {
displacement_set(
device_id: $device_id,
value: $value
) {
attributes
id
type
}
}
Variables
{"device_id": "4", "value": 123}
Response
{
"data": {
"displacement_set": {
"attributes": Json,
"id": "4",
"type": "abc123"
}
}
}
distributor_create
Description
Create onboarding distributor
Response
Returns an OnboardingDistributor
Example
Query
mutation distributor_create(
$label: String,
$manager_id: ID,
$organization_id: ID,
$provider_id: ID,
$send_email_to_munic: Boolean,
$send_email_to_provider: Boolean,
$workshop_id: ID
) {
distributor_create(
label: $label,
manager_id: $manager_id,
organization_id: $organization_id,
provider_id: $provider_id,
send_email_to_munic: $send_email_to_munic,
send_email_to_provider: $send_email_to_provider,
workshop_id: $workshop_id
) {
id
is_active
label
organization_id
provider {
...OnboardingProviderFragment
}
provider_workshop_id
requests {
...OnboardingRequestPagedFragment
}
staff {
...OnboardingStaffPagedFragment
}
workshop {
...WorkshopFragment
}
}
}
Variables
{
"label": "abc123",
"manager_id": 4,
"organization_id": 4,
"provider_id": 4,
"send_email_to_munic": false,
"send_email_to_provider": false,
"workshop_id": 4
}
Response
{
"data": {
"distributor_create": {
"id": "4",
"is_active": false,
"label": "abc123",
"organization_id": "4",
"provider": OnboardingProvider,
"provider_workshop_id": "4",
"requests": OnboardingRequestPaged,
"staff": OnboardingStaffPaged,
"workshop": Workshop
}
}
}
distributor_update
Description
Update onboarding distributor
Response
Returns an OnboardingDistributor
Example
Query
mutation distributor_update(
$id: ID!,
$is_active: Boolean,
$label: String,
$organization_id: ID
) {
distributor_update(
id: $id,
is_active: $is_active,
label: $label,
organization_id: $organization_id
) {
id
is_active
label
organization_id
provider {
...OnboardingProviderFragment
}
provider_workshop_id
requests {
...OnboardingRequestPagedFragment
}
staff {
...OnboardingStaffPagedFragment
}
workshop {
...WorkshopFragment
}
}
}
Variables
{
"id": "4",
"is_active": false,
"label": "abc123",
"organization_id": "4"
}
Response
{
"data": {
"distributor_update": {
"id": 4,
"is_active": false,
"label": "abc123",
"organization_id": "4",
"provider": OnboardingProvider,
"provider_workshop_id": "4",
"requests": OnboardingRequestPaged,
"staff": OnboardingStaffPaged,
"workshop": Workshop
}
}
}
door_toggle
Description
Toggle door action parameter
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
action - DoorAction!
|
Action |
device_id - ID!
|
Device id |
Example
Query
mutation door_toggle(
$action: DoorAction!,
$device_id: ID!
) {
door_toggle(
action: $action,
device_id: $device_id
) {
attributes
id
type
}
}
Variables
{"action": "LOCK", "device_id": "4"}
Response
{
"data": {
"door_toggle": {
"attributes": Json,
"id": "4",
"type": "xyz789"
}
}
}
driver_create
Description
Create a new driver
Response
Returns a Driver
Example
Query
mutation driver_create(
$active: Boolean,
$default_vehicle_id: ID,
$group_id: ID,
$id_key: String,
$label: String!,
$user_contact_id: ID,
$user_profile_id: ID
) {
driver_create(
active: $active,
default_vehicle_id: $default_vehicle_id,
group_id: $group_id,
id_key: $id_key,
label: $label,
user_contact_id: $user_contact_id,
user_profile_id: $user_profile_id
) {
active
created_at
current_vehicle {
...VehicleFragment
}
current_vehicles {
...VehiclePagedFragment
}
default_vehicle {
...VehicleFragment
}
descriptions {
...DescriptionPagedFragment
}
groups {
...GroupPagedFragment
}
id
id_key
label
last_trip {
...TripFragment
}
trips {
...TripPagedFragment
}
updated_at
user_contact {
...AccountFragment
}
user_profile {
...AccountFragment
}
vehicle_sessions {
...DriverVehicleSessionPagedFragment
}
vehicles {
...VehiclePagedFragment
}
auxiliary_devices {
... on auxiliary_device_paginated {
...auxiliary_device_paginatedFragment
}
... on errors {
...errorsFragment
}
}
auxiliary_device {
... on auxiliary_device_show {
...auxiliary_device_showFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{
"active": true,
"default_vehicle_id": 4,
"group_id": "4",
"id_key": "xyz789",
"label": "xyz789",
"user_contact_id": 4,
"user_profile_id": 4
}
Response
{
"data": {
"driver_create": {
"active": true,
"created_at": "2007-12-03T10:15:30Z",
"current_vehicle": Vehicle,
"current_vehicles": VehiclePaged,
"default_vehicle": Vehicle,
"descriptions": DescriptionPaged,
"groups": GroupPaged,
"id": "4",
"id_key": "xyz789",
"label": "abc123",
"last_trip": Trip,
"trips": TripPaged,
"updated_at": "2007-12-03T10:15:30Z",
"user_contact": Account,
"user_profile": Account,
"vehicle_sessions": DriverVehicleSessionPaged,
"vehicles": VehiclePaged,
"auxiliary_devices": auxiliary_device_paginated,
"auxiliary_device": auxiliary_device_show
}
}
}
driver_delete
Description
Delete a user vehicle
driver_service_create
Description
Create driver service
Response
Returns a DriverService
Example
Query
mutation driver_service_create(
$description: String,
$label: String,
$workshop_ids: [ID]
) {
driver_service_create(
description: $description,
label: $label,
workshop_ids: $workshop_ids
) {
id
description
label
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{
"description": "xyz789",
"label": "abc123",
"workshop_ids": [4]
}
Response
{
"data": {
"driver_service_create": {
"id": "4",
"description": "xyz789",
"label": "abc123",
"workshops": WorkshopPaged
}
}
}
driver_service_delete
Description
Delete Driver service
driver_service_update
Description
Update driver service
Response
Returns a DriverService
Example
Query
mutation driver_service_update(
$description: String,
$id: ID!,
$label: String,
$workshop_ids: [ID]
) {
driver_service_update(
description: $description,
id: $id,
label: $label,
workshop_ids: $workshop_ids
) {
id
description
label
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{
"description": "abc123",
"id": "4",
"label": "xyz789",
"workshop_ids": [4]
}
Response
{
"data": {
"driver_service_update": {
"id": "4",
"description": "xyz789",
"label": "abc123",
"workshops": WorkshopPaged
}
}
}
driver_update
Description
Update an existing driver
Response
Returns a Driver
Example
Query
mutation driver_update(
$active: Boolean,
$default_vehicle_id: ID,
$id: ID!,
$id_key: String,
$label: String,
$user_contact_id: ID,
$user_profile_id: ID
) {
driver_update(
active: $active,
default_vehicle_id: $default_vehicle_id,
id: $id,
id_key: $id_key,
label: $label,
user_contact_id: $user_contact_id,
user_profile_id: $user_profile_id
) {
active
created_at
current_vehicle {
...VehicleFragment
}
current_vehicles {
...VehiclePagedFragment
}
default_vehicle {
...VehicleFragment
}
descriptions {
...DescriptionPagedFragment
}
groups {
...GroupPagedFragment
}
id
id_key
label
last_trip {
...TripFragment
}
trips {
...TripPagedFragment
}
updated_at
user_contact {
...AccountFragment
}
user_profile {
...AccountFragment
}
vehicle_sessions {
...DriverVehicleSessionPagedFragment
}
vehicles {
...VehiclePagedFragment
}
auxiliary_devices {
... on auxiliary_device_paginated {
...auxiliary_device_paginatedFragment
}
... on errors {
...errorsFragment
}
}
auxiliary_device {
... on auxiliary_device_show {
...auxiliary_device_showFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{
"active": false,
"default_vehicle_id": "4",
"id": "4",
"id_key": "xyz789",
"label": "abc123",
"user_contact_id": 4,
"user_profile_id": 4
}
Response
{
"data": {
"driver_update": {
"active": true,
"created_at": "2007-12-03T10:15:30Z",
"current_vehicle": Vehicle,
"current_vehicles": VehiclePaged,
"default_vehicle": Vehicle,
"descriptions": DescriptionPaged,
"groups": GroupPaged,
"id": 4,
"id_key": "abc123",
"label": "xyz789",
"last_trip": Trip,
"trips": TripPaged,
"updated_at": "2007-12-03T10:15:30Z",
"user_contact": Account,
"user_profile": Account,
"vehicle_sessions": DriverVehicleSessionPaged,
"vehicles": VehiclePaged,
"auxiliary_devices": auxiliary_device_paginated,
"auxiliary_device": auxiliary_device_show
}
}
}
driver_vehicle_session_start
Description
Start a driver vehicle session
Response
Returns a DriverVehicleSession
Example
Query
mutation driver_vehicle_session_start(
$driver_id: ID!,
$start_at: DateTime,
$vehicle_id: ID!
) {
driver_vehicle_session_start(
driver_id: $driver_id,
start_at: $start_at,
vehicle_id: $vehicle_id
) {
active
driver {
...DriverFragment
}
end_at
id
owner {
...AccountFragment
}
start_at
vehicle {
...VehicleFragment
}
}
}
Variables
{
"driver_id": "4",
"start_at": "2007-12-03T10:15:30Z",
"vehicle_id": 4
}
Response
{
"data": {
"driver_vehicle_session_start": {
"active": false,
"driver": Driver,
"end_at": "2007-12-03T10:15:30Z",
"id": "4",
"owner": Account,
"start_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
}
}
driver_vehicle_session_stop
Description
Stop a driver vehicle session
Response
Returns a DriverVehicleSession
Example
Query
mutation driver_vehicle_session_stop(
$driver_id: ID,
$end_at: DateTime,
$id: ID!,
$vehicle_id: ID
) {
driver_vehicle_session_stop(
driver_id: $driver_id,
end_at: $end_at,
id: $id,
vehicle_id: $vehicle_id
) {
active
driver {
...DriverFragment
}
end_at
id
owner {
...AccountFragment
}
start_at
vehicle {
...VehicleFragment
}
}
}
Variables
{
"driver_id": "4",
"end_at": "2007-12-03T10:15:30Z",
"id": 4,
"vehicle_id": "4"
}
Response
{
"data": {
"driver_vehicle_session_stop": {
"active": true,
"driver": Driver,
"end_at": "2007-12-03T10:15:30Z",
"id": "4",
"owner": Account,
"start_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
}
}
dtc_clean
Description
Clean DTC
Response
Returns a RdcAsyncAck
Example
Query
mutation dtc_clean(
$device_id: ID!,
$type: String!
) {
dtc_clean(
device_id: $device_id,
type: $type
) {
attributes
id
type
}
}
Variables
{"device_id": 4, "type": "abc123"}
Response
{
"data": {
"dtc_clean": {
"attributes": Json,
"id": "4",
"type": "xyz789"
}
}
}
engine_toggle
Description
Toggle engine action parameter
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
action - ToggleAction!
|
On/Off |
device_id - ID!
|
Device id |
Example
Query
mutation engine_toggle(
$action: ToggleAction!,
$device_id: ID!
) {
engine_toggle(
action: $action,
device_id: $device_id
) {
attributes
id
type
}
}
Variables
{"action": "START", "device_id": 4}
Response
{
"data": {
"engine_toggle": {
"attributes": Json,
"id": 4,
"type": "abc123"
}
}
}
geofence_delete_device
Description
Method:
DELETEBase URL:{env.GEOFENCE_API}Path:/v1/devices/{args.id}
[alpha] Delete Device
geofence_delete_geofence
Description
Method:
DELETEBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.id}
[alpha] Delete Geofence
geofence_delete_schedule
Description
Method:
DELETEBase URL:{env.GEOFENCE_API}Path:/v1/schedules/{args.id}
[alpha] Delete Shape
geofence_delete_shape
Description
Method:
DELETEBase URL:{env.GEOFENCE_API}Path:/v1/shapes/{args.id}
[alpha] Delete Shape
geofence_delete_user
Description
Method:
DELETEBase URL:{env.GEOFENCE_API}Path:/v1/users/{args.id}
[alpha] Delete User
geofence_post_alerts
Description
Method:
POSTBase URL:{env.GEOFENCE_API}Path:/v1/alerts
[alpha] Create Alerts
Response
Returns an alert_show
Arguments
| Name | Description |
|---|---|
input - alert_create_Input
|
Example
Query
mutation geofence_post_alerts($input: alert_create_Input) {
geofence_post_alerts(input: $input) {
data {
...geofence_alertFragment
}
}
}
Variables
{"input": alert_create_Input}
Response
{
"data": {
"geofence_post_alerts": {"data": geofence_alert}
}
}
geofence_post_devices
Description
Method:
POSTBase URL:{env.GEOFENCE_API}Path:/v1/devices
[alpha] Create Device
Response
Returns a JSON
Arguments
| Name | Description |
|---|---|
imei - String
|
IMEI (accept partial match) |
input - geofence_device_Input
|
Example
Query
mutation geofence_post_devices(
$imei: String,
$input: geofence_device_Input
) {
geofence_post_devices(
imei: $imei,
input: $input
)
}
Variables
{
"imei": "abc123",
"input": geofence_device_Input
}
Response
{"data": {"geofence_post_devices": {}}}
geofence_post_drop_data_requests
Description
Method:
POSTBase URL:{env.GEOFENCE_API}Path:/v1/drop_data_requests
[alpha] Post Drop Data Request
Response
Returns a JSON
Arguments
| Name | Description |
|---|---|
input - drop_data_request_Input
|
Example
Query
mutation geofence_post_drop_data_requests($input: drop_data_request_Input) {
geofence_post_drop_data_requests(input: $input)
}
Variables
{"input": drop_data_request_Input}
Response
{"data": {"geofence_post_drop_data_requests": {}}}
geofence_post_geofences
Description
Method:
POSTBase URL:{env.GEOFENCE_API}Path:/v1/geofences
[alpha] Create Geofence
Response
Returns a geofence_show
Arguments
| Name | Description |
|---|---|
input - geofence_create_Input
|
Example
Query
mutation geofence_post_geofences($input: geofence_create_Input) {
geofence_post_geofences(input: $input) {
data {
...geofence_geofenceFragment
}
}
}
Variables
{"input": geofence_create_Input}
Response
{
"data": {
"geofence_post_geofences": {"data": geofence_geofence}
}
}
geofence_post_geofences_relationships_devices
Description
Method:
POSTBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.id}/relationships/devices
[alpha] Add Geofence Devices
Response
Returns a Void
Arguments
| Name | Description |
|---|---|
id - String!
|
Device id |
input - device_relationship_Input
|
Example
Query
mutation geofence_post_geofences_relationships_devices(
$id: String!,
$input: device_relationship_Input
) {
geofence_post_geofences_relationships_devices(
id: $id,
input: $input
)
}
Variables
{
"id": "xyz789",
"input": device_relationship_Input
}
Response
{"data": {"geofence_post_geofences_relationships_devices": null}}
geofence_post_geofences_relationships_groups
Description
Method:
POSTBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.id}/relationships/groups
[alpha] Add Geofence Groups
Response
Returns a Void
Arguments
| Name | Description |
|---|---|
id - String!
|
Group id |
input - group_relationship_Input
|
Example
Query
mutation geofence_post_geofences_relationships_groups(
$id: String!,
$input: group_relationship_Input
) {
geofence_post_geofences_relationships_groups(
id: $id,
input: $input
)
}
Variables
{
"id": "xyz789",
"input": group_relationship_Input
}
Response
{"data": {"geofence_post_geofences_relationships_groups": null}}
geofence_post_schedules
Description
Method:
POSTBase URL:{env.GEOFENCE_API}Path:/v1/schedules
[alpha] Create Schedules
Response
Returns a schedule_show
Arguments
| Name | Description |
|---|---|
input - schedule_create_Input
|
Example
Query
mutation geofence_post_schedules($input: schedule_create_Input) {
geofence_post_schedules(input: $input) {
data {
...geofence_scheduleFragment
}
}
}
Variables
{"input": schedule_create_Input}
Response
{
"data": {
"geofence_post_schedules": {"data": geofence_schedule}
}
}
geofence_post_shapes
Description
Method:
POSTBase URL:{env.GEOFENCE_API}Path:/v1/shapes
[alpha] Create Shapes
Response
Returns a shape_show
Arguments
| Name | Description |
|---|---|
input - shape_create_Input
|
Example
Query
mutation geofence_post_shapes($input: shape_create_Input) {
geofence_post_shapes(input: $input) {
data {
...geofence_shapeFragment
}
}
}
Variables
{"input": shape_create_Input}
Response
{
"data": {
"geofence_post_shapes": {"data": geofence_shape}
}
}
geofence_put_alert
Description
Method:
PUTBase URL:{env.GEOFENCE_API}Path:/v1/alerts/{args.id}
[alpha] Update Alert
Response
Returns an alert_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Alert id |
input - alert_update_Input
|
Example
Query
mutation geofence_put_alert(
$id: String!,
$input: alert_update_Input
) {
geofence_put_alert(
id: $id,
input: $input
) {
data {
...geofence_alertFragment
}
}
}
Variables
{
"id": "abc123",
"input": alert_update_Input
}
Response
{"data": {"geofence_put_alert": {"data": geofence_alert}}}
geofence_put_device
Description
Method:
PUTBase URL:{env.GEOFENCE_API}Path:/v1/devices/{args.id}
[alpha] Update Device
Response
Returns a JSON
Arguments
| Name | Description |
|---|---|
id - String!
|
Device imei |
input - geofence_device_Input
|
Example
Query
mutation geofence_put_device(
$id: String!,
$input: geofence_device_Input
) {
geofence_put_device(
id: $id,
input: $input
)
}
Variables
{
"id": "xyz789",
"input": geofence_device_Input
}
Response
{"data": {"geofence_put_device": {}}}
geofence_put_geofence
Description
Method:
PUTBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.id}
[alpha] Update Geofence
Response
Returns a geofence_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Device id |
input - geofence_update_Input
|
Example
Query
mutation geofence_put_geofence(
$id: String!,
$input: geofence_update_Input
) {
geofence_put_geofence(
id: $id,
input: $input
) {
data {
...geofence_geofenceFragment
}
}
}
Variables
{
"id": "abc123",
"input": geofence_update_Input
}
Response
{
"data": {
"geofence_put_geofence": {"data": geofence_geofence}
}
}
geofence_put_geofences_relationships_devices
Description
Method:
PUTBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.id}/relationships/devices
[alpha] Replace Geofence Devices
Response
Returns a Void
Arguments
| Name | Description |
|---|---|
id - String!
|
Device id |
input - device_relationship_Input
|
Example
Query
mutation geofence_put_geofences_relationships_devices(
$id: String!,
$input: device_relationship_Input
) {
geofence_put_geofences_relationships_devices(
id: $id,
input: $input
)
}
Variables
{
"id": "abc123",
"input": device_relationship_Input
}
Response
{"data": {"geofence_put_geofences_relationships_devices": null}}
geofence_put_geofences_relationships_groups
Description
Method:
PUTBase URL:{env.GEOFENCE_API}Path:/v1/geofences/{args.id}/relationships/groups
[alpha] Replace Geofence Groups
Response
Returns a Void
Arguments
| Name | Description |
|---|---|
id - String!
|
Group id |
input - group_relationship_Input
|
Example
Query
mutation geofence_put_geofences_relationships_groups(
$id: String!,
$input: group_relationship_Input
) {
geofence_put_geofences_relationships_groups(
id: $id,
input: $input
)
}
Variables
{
"id": "abc123",
"input": group_relationship_Input
}
Response
{"data": {"geofence_put_geofences_relationships_groups": null}}
geofence_put_schedule
Description
Method:
PUTBase URL:{env.GEOFENCE_API}Path:/v1/schedules/{args.id}
[alpha] Update Schedule
Response
Returns a schedule_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Schedule id |
input - schedule_update_Input
|
Example
Query
mutation geofence_put_schedule(
$id: String!,
$input: schedule_update_Input
) {
geofence_put_schedule(
id: $id,
input: $input
) {
data {
...geofence_scheduleFragment
}
}
}
Variables
{
"id": "xyz789",
"input": schedule_update_Input
}
Response
{
"data": {
"geofence_put_schedule": {"data": geofence_schedule}
}
}
geofence_put_shape
Description
Method:
PUTBase URL:{env.GEOFENCE_API}Path:/v1/shapes/{args.id}
[alpha] Update Shape
Response
Returns a shape_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Shape id |
input - shape_update_Input
|
Example
Query
mutation geofence_put_shape(
$id: String!,
$input: shape_update_Input
) {
geofence_put_shape(
id: $id,
input: $input
) {
data {
...geofence_shapeFragment
}
}
}
Variables
{
"id": "abc123",
"input": shape_update_Input
}
Response
{"data": {"geofence_put_shape": {"data": geofence_shape}}}
geofence_put_user
Description
Method:
PUTBase URL:{env.GEOFENCE_API}Path:/v1/users/{args.id}
[alpha] Update User role
Response
Returns a JSON
Arguments
| Name | Description |
|---|---|
id - String!
|
User id |
input - user_Input
|
Example
Query
mutation geofence_put_user(
$id: String!,
$input: user_Input
) {
geofence_put_user(
id: $id,
input: $input
)
}
Variables
{
"id": "abc123",
"input": user_Input
}
Response
{"data": {"geofence_put_user": {}}}
group_create
Response
Returns a Group
Arguments
| Name | Description |
|---|---|
hierarchy_level - GroupHierarchyLevel
|
Hierarchy level |
label - String!
|
Label |
owner - ID
|
Owner account |
tags - [String]
|
Tags |
Example
Query
mutation group_create(
$hierarchy_level: GroupHierarchyLevel,
$label: String!,
$owner: ID,
$tags: [String]
) {
group_create(
hierarchy_level: $hierarchy_level,
label: $label,
owner: $owner,
tags: $tags
) {
id
alerts {
...VehicleAlertPagedFragment
}
children {
...GroupPagedFragment
}
descriptions {
...DescriptionPagedFragment
}
devices {
...DevicePagedFragment
}
drivers {
...DriverPagedFragment
}
hierarchy_level
label
owner {
...AccountFragment
}
parents {
...GroupPagedFragment
}
tags
users {
...AccountPagedFragment
}
vehicles {
...VehiclePagedFragment
}
device_groups {
...device_group_paginatedFragment
}
user_roles {
...user_role_paginatedFragment
}
geofences {
...geofence_paginatedFragment
}
summary_from_journey {
...journey_summaryFragment
}
journey_reports {
... on report_paginated {
...report_paginatedFragment
}
... on errors {
...errorsFragment
}
}
summary_from_alerts {
... on fleet_summary {
...fleet_summaryFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{
"hierarchy_level": "CENTER",
"label": "xyz789",
"owner": "4",
"tags": ["xyz789"]
}
Response
{
"data": {
"group_create": {
"id": "4",
"alerts": VehicleAlertPaged,
"children": GroupPaged,
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"drivers": DriverPaged,
"hierarchy_level": "CENTER",
"label": "abc123",
"owner": Account,
"parents": GroupPaged,
"tags": ["abc123"],
"users": AccountPaged,
"vehicles": VehiclePaged,
"device_groups": device_group_paginated,
"user_roles": user_role_paginated,
"geofences": geofence_paginated,
"summary_from_journey": journey_summary,
"journey_reports": report_paginated,
"summary_from_alerts": fleet_summary
}
}
}
group_delete
group_update
Response
Returns a Group
Arguments
| Name | Description |
|---|---|
hierarchy_level - GroupHierarchyLevel
|
Hierarchy level |
id - ID!
|
Identifier |
label - String
|
Label |
owner - ID
|
Owner account |
tags - [String]
|
Tags |
Example
Query
mutation group_update(
$hierarchy_level: GroupHierarchyLevel,
$id: ID!,
$label: String,
$owner: ID,
$tags: [String]
) {
group_update(
hierarchy_level: $hierarchy_level,
id: $id,
label: $label,
owner: $owner,
tags: $tags
) {
id
alerts {
...VehicleAlertPagedFragment
}
children {
...GroupPagedFragment
}
descriptions {
...DescriptionPagedFragment
}
devices {
...DevicePagedFragment
}
drivers {
...DriverPagedFragment
}
hierarchy_level
label
owner {
...AccountFragment
}
parents {
...GroupPagedFragment
}
tags
users {
...AccountPagedFragment
}
vehicles {
...VehiclePagedFragment
}
device_groups {
...device_group_paginatedFragment
}
user_roles {
...user_role_paginatedFragment
}
geofences {
...geofence_paginatedFragment
}
summary_from_journey {
...journey_summaryFragment
}
journey_reports {
... on report_paginated {
...report_paginatedFragment
}
... on errors {
...errorsFragment
}
}
summary_from_alerts {
... on fleet_summary {
...fleet_summaryFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{
"hierarchy_level": "CENTER",
"id": 4,
"label": "abc123",
"owner": "4",
"tags": ["xyz789"]
}
Response
{
"data": {
"group_update": {
"id": 4,
"alerts": VehicleAlertPaged,
"children": GroupPaged,
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"drivers": DriverPaged,
"hierarchy_level": "CENTER",
"label": "abc123",
"owner": Account,
"parents": GroupPaged,
"tags": ["abc123"],
"users": AccountPaged,
"vehicles": VehiclePaged,
"device_groups": device_group_paginated,
"user_roles": user_role_paginated,
"geofences": geofence_paginated,
"summary_from_journey": journey_summary,
"journey_reports": report_paginated,
"summary_from_alerts": fleet_summary
}
}
}
group_update_members
Response
Returns an ID
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of group being modified |
ids - [ID]!
|
Ids of members being add/remove to/from group |
op - MemberOperation!
|
Add or remove |
type - GroupMember!
|
Member type |
Example
Query
mutation group_update_members(
$id: ID!,
$ids: [ID]!,
$op: MemberOperation!,
$type: GroupMember!
) {
group_update_members(
id: $id,
ids: $ids,
op: $op,
type: $type
)
}
Variables
{
"id": "4",
"ids": [4],
"op": "ADD",
"type": "CHILD"
}
Response
{"data": {"group_update_members": "4"}}
journey_add_devices_to_trip_tag_schedule
Description
Method:
POSTBase URL:{env.JOURNEY_API}Path:/v1/trip_tag_schedules/{args.id}/relationships/devices
[alpha] Post Trip Tag Schedule
Response
Returns a Void
Arguments
| Name | Description |
|---|---|
id - String!
|
Trip Tag Schedule id |
input - associated_devices_Input
|
Example
Query
mutation journey_add_devices_to_trip_tag_schedule(
$id: String!,
$input: associated_devices_Input
) {
journey_add_devices_to_trip_tag_schedule(
id: $id,
input: $input
)
}
Variables
{
"id": "abc123",
"input": associated_devices_Input
}
Response
{"data": {"journey_add_devices_to_trip_tag_schedule": null}}
journey_delete_devices_from_trip_tag_schedule
Description
Method:
DELETEBase URL:{env.JOURNEY_API}Path:/v1/trip_tag_schedules/{args.id}/relationships/devices
[alpha] Delete Trip Tag Schedule Device
Response
Returns a Void
Arguments
| Name | Description |
|---|---|
id - String!
|
Trip Tag Schedule id |
input - associated_devices_Input
|
Example
Query
mutation journey_delete_devices_from_trip_tag_schedule(
$id: String!,
$input: associated_devices_Input
) {
journey_delete_devices_from_trip_tag_schedule(
id: $id,
input: $input
)
}
Variables
{
"id": "xyz789",
"input": associated_devices_Input
}
Response
{"data": {"journey_delete_devices_from_trip_tag_schedule": null}}
journey_post_device_configs
Description
Method:
POSTBase URL:{env.JOURNEY_API}Path:/v1/device_configsCreate Device Config
Response
Returns a post_device_configs_response
Arguments
| Name | Description |
|---|---|
input - device_config_create_Input
|
Example
Query
mutation journey_post_device_configs($input: device_config_create_Input) {
journey_post_device_configs(input: $input) {
... on device_config_show {
...device_config_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"input": device_config_create_Input}
Response
{
"data": {
"journey_post_device_configs": device_config_show
}
}
journey_post_metadata
Description
Method:
POSTBase URL:{env.JOURNEY_API}Path:/v1/metadata
[alpha] Post Metadata
Response
Returns a post_metadata_response
Arguments
| Name | Description |
|---|---|
input - post_metadata_request_Input
|
Example
Query
mutation journey_post_metadata($input: post_metadata_request_Input) {
journey_post_metadata(input: $input) {
data {
...mutation_post_metadata_dataFragment
}
}
}
Variables
{"input": post_metadata_request_Input}
Response
{
"data": {
"journey_post_metadata": {
"data": mutation_post_metadata_data
}
}
}
journey_post_reports
Description
Method:
POSTBase URL:{env.JOURNEY_API}Path:/v1/reports
[alpha] Post Report
Response
Returns a post_reports_response
Arguments
| Name | Description |
|---|---|
input - report_encapsulated_post_Input
|
Example
Query
mutation journey_post_reports($input: report_encapsulated_post_Input) {
journey_post_reports(input: $input) {
... on report_encapsulated {
...report_encapsulatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"input": report_encapsulated_post_Input}
Response
{"data": {"journey_post_reports": report_encapsulated}}
journey_post_trip_tag_schedules
Description
Method:
POSTBase URL:{env.JOURNEY_API}Path:/v1/trip_tag_schedules
[alpha] Post Trip Tag Schedule
Response
Returns a post_trip_tag_schedules_response
Arguments
| Name | Description |
|---|---|
input - trip_tag_schedule_encapsulated_post_Input
|
Example
Query
mutation journey_post_trip_tag_schedules($input: trip_tag_schedule_encapsulated_post_Input) {
journey_post_trip_tag_schedules(input: $input) {
... on trip_tag_schedule_encapsulated {
...trip_tag_schedule_encapsulatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"input": trip_tag_schedule_encapsulated_post_Input}
Response
{
"data": {
"journey_post_trip_tag_schedules": trip_tag_schedule_encapsulated
}
}
journey_update_trip_tag_schedule
Description
Method:
PUTBase URL:{env.JOURNEY_API}Path:/v1/trip_tag_schedules/{args.id}
[alpha] Update Trip Tag Schedule
Response
Returns a trip_tag_schedule_encapsulated
Arguments
| Name | Description |
|---|---|
id - String!
|
Trip Tag Schedule id |
input - trip_tag_schedule_encapsulated_put_Input
|
Example
Query
mutation journey_update_trip_tag_schedule(
$id: String!,
$input: trip_tag_schedule_encapsulated_put_Input
) {
journey_update_trip_tag_schedule(
id: $id,
input: $input
) {
data {
...journey_trip_tag_scheduleFragment
}
}
}
Variables
{
"id": "xyz789",
"input": trip_tag_schedule_encapsulated_put_Input
}
Response
{
"data": {
"journey_update_trip_tag_schedule": {
"data": journey_trip_tag_schedule
}
}
}
lighthorn_trigger
Description
Trigger lighthorn
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
device_id - ID!
|
Device id |
Example
Query
mutation lighthorn_trigger($device_id: ID!) {
lighthorn_trigger(device_id: $device_id) {
attributes
id
type
}
}
Variables
{"device_id": 4}
Response
{
"data": {
"lighthorn_trigger": {
"attributes": Json,
"id": 4,
"type": "abc123"
}
}
}
logfetch_create
Description
Request a log fetch
Response
Returns a Logfetch
Example
Query
mutation logfetch_create(
$action: String!,
$device_id: ID!,
$reason: String
) {
logfetch_create(
action: $action,
device_id: $device_id,
reason: $reason
) {
account
action_name
created_at
id
reason
status
updated_at
}
}
Variables
{
"action": "abc123",
"device_id": "4",
"reason": "xyz789"
}
Response
{
"data": {
"logfetch_create": {
"account": "abc123",
"action_name": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"reason": "xyz789",
"status": "ABORTED",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
maintenance_historical_delete
Description
Delete historical maintenance
A corresponding upcoming might get regenerated sooner.
maintenance_historical_update
Description
Update historical maintenance
Response
Returns a MaintenanceHistorical
Example
Query
mutation maintenance_historical_update(
$date: DateTime,
$id: ID!,
$mileage: Int
) {
maintenance_historical_update(
date: $date,
id: $id,
mileage: $mileage
) {
id
date
mileage
template {
...MaintenanceTemplateFragment
}
vehicle {
...VehicleFragment
}
}
}
Variables
{
"date": "2007-12-03T10:15:30Z",
"id": "4",
"mileage": 123
}
Response
{
"data": {
"maintenance_historical_update": {
"id": 4,
"date": "2007-12-03T10:15:30Z",
"mileage": 987,
"template": MaintenanceTemplate,
"vehicle": Vehicle
}
}
}
maintenance_upcoming_update
Description
Mark upcoming maintenance as done
This will create a corresponding historical maintenance.
Response
Returns a MaintenanceHistorical
Example
Query
mutation maintenance_upcoming_update(
$date: DateTime,
$id: ID!,
$mileage: Int
) {
maintenance_upcoming_update(
date: $date,
id: $id,
mileage: $mileage
) {
id
date
mileage
template {
...MaintenanceTemplateFragment
}
vehicle {
...VehicleFragment
}
}
}
Variables
{
"date": "2007-12-03T10:15:30Z",
"id": 4,
"mileage": 987
}
Response
{
"data": {
"maintenance_upcoming_update": {
"id": "4",
"date": "2007-12-03T10:15:30Z",
"mileage": 987,
"template": MaintenanceTemplate,
"vehicle": Vehicle
}
}
}
munic_remote_diagnostic_interactive_Interactive_SetTasks
Response
Returns a google__protobuf__Empty
Arguments
| Name | Description |
|---|---|
input - munic__remote_diagnostic__interactive__MetaTask_Input
|
Example
Query
mutation munic_remote_diagnostic_interactive_Interactive_SetTasks($input: munic__remote_diagnostic__interactive__MetaTask_Input) {
munic_remote_diagnostic_interactive_Interactive_SetTasks(input: $input)
}
Variables
{
"input": munic__remote_diagnostic__interactive__MetaTask_Input
}
Response
{
"data": {
"munic_remote_diagnostic_interactive_Interactive_SetTasks": google__protobuf__Empty
}
}
munic_remote_diagnostic_main_TypeExposition_Expose
Response
Returns a google__protobuf__Empty
Arguments
| Name | Description |
|---|---|
input - munic__remote_diagnostic__main__exposedTypes_Input
|
Example
Query
mutation munic_remote_diagnostic_main_TypeExposition_Expose($input: munic__remote_diagnostic__main__exposedTypes_Input) {
munic_remote_diagnostic_main_TypeExposition_Expose(input: $input)
}
Variables
{
"input": munic__remote_diagnostic__main__exposedTypes_Input
}
Response
{
"data": {
"munic_remote_diagnostic_main_TypeExposition_Expose": google__protobuf__Empty
}
}
odometer_set
Description
Set odometer value parameter
Response
Returns a RdcAsyncAck
Example
Query
mutation odometer_set(
$device_id: ID!,
$value: Int!
) {
odometer_set(
device_id: $device_id,
value: $value
) {
attributes
id
type
}
}
Variables
{"device_id": 4, "value": 123}
Response
{
"data": {
"odometer_set": {
"attributes": Json,
"id": 4,
"type": "xyz789"
}
}
}
onboarding_auxiliary_device_add
Description
Add an auxiliary device
Response
Returns an OnboardingAuxiliaryDevice
Arguments
| Name | Description |
|---|---|
connection_type - OnboardingAuxiliaryDeviceConnectionType
|
|
id - ID!
|
Id of existing onboarding request |
kind - OnboardingAuxiliaryDeviceKind!
|
|
label - String
|
|
mac_address_hash - String
|
|
sensor_functions - [OnboardingAuxiliarySensorFunction!]
|
|
serial_number - String
|
|
wifi_password - String
|
|
wifi_ssid - String
|
required if connection_type is wifi |
Example
Query
mutation onboarding_auxiliary_device_add(
$connection_type: OnboardingAuxiliaryDeviceConnectionType,
$id: ID!,
$kind: OnboardingAuxiliaryDeviceKind!,
$label: String,
$mac_address_hash: String,
$sensor_functions: [OnboardingAuxiliarySensorFunction!],
$serial_number: String,
$wifi_password: String,
$wifi_ssid: String
) {
onboarding_auxiliary_device_add(
connection_type: $connection_type,
id: $id,
kind: $kind,
label: $label,
mac_address_hash: $mac_address_hash,
sensor_functions: $sensor_functions,
serial_number: $serial_number,
wifi_password: $wifi_password,
wifi_ssid: $wifi_ssid
) {
asset_manager_id
connection_type
id
id_key
kind
label
mac_address_hash
sensor_functions
serial_number
wifi_password
wifi_ssid
}
}
Variables
{
"connection_type": "BLUETOOTH",
"id": "4",
"kind": "DASHCAM",
"label": "abc123",
"mac_address_hash": "xyz789",
"sensor_functions": ["ACCELERATION"],
"serial_number": "abc123",
"wifi_password": "xyz789",
"wifi_ssid": "xyz789"
}
Response
{
"data": {
"onboarding_auxiliary_device_add": {
"asset_manager_id": "xyz789",
"connection_type": "BLUETOOTH",
"id": "4",
"id_key": "xyz789",
"kind": "DASHCAM",
"label": "xyz789",
"mac_address_hash": "xyz789",
"sensor_functions": ["ACCELERATION"],
"serial_number": "abc123",
"wifi_password": "xyz789",
"wifi_ssid": "xyz789"
}
}
}
onboarding_auxiliary_device_remove
Description
remove an auxiliary device
Response
Returns an ID
Example
Query
mutation onboarding_auxiliary_device_remove(
$auxiliary_device_id: ID!,
$id: ID!
) {
onboarding_auxiliary_device_remove(
auxiliary_device_id: $auxiliary_device_id,
id: $id
)
}
Variables
{"auxiliary_device_id": "4", "id": 4}
Response
{"data": {"onboarding_auxiliary_device_remove": 4}}
onboarding_auxiliary_device_update
Description
Update an auxiliary device
Response
Returns an OnboardingAuxiliaryDevice
Arguments
| Name | Description |
|---|---|
auxiliary_device_id - ID!
|
Id of existing auxiliary device |
connection_type - OnboardingAuxiliaryDeviceConnectionType
|
|
id - ID!
|
Id of existing onboarding request |
kind - OnboardingAuxiliaryDeviceKind!
|
|
label - String
|
|
mac_address_hash - String
|
|
sensor_functions - [OnboardingAuxiliarySensorFunction!]
|
|
serial_number - String
|
|
wifi_password - String
|
|
wifi_ssid - String
|
required if connection_type is wifi |
Example
Query
mutation onboarding_auxiliary_device_update(
$auxiliary_device_id: ID!,
$connection_type: OnboardingAuxiliaryDeviceConnectionType,
$id: ID!,
$kind: OnboardingAuxiliaryDeviceKind!,
$label: String,
$mac_address_hash: String,
$sensor_functions: [OnboardingAuxiliarySensorFunction!],
$serial_number: String,
$wifi_password: String,
$wifi_ssid: String
) {
onboarding_auxiliary_device_update(
auxiliary_device_id: $auxiliary_device_id,
connection_type: $connection_type,
id: $id,
kind: $kind,
label: $label,
mac_address_hash: $mac_address_hash,
sensor_functions: $sensor_functions,
serial_number: $serial_number,
wifi_password: $wifi_password,
wifi_ssid: $wifi_ssid
) {
asset_manager_id
connection_type
id
id_key
kind
label
mac_address_hash
sensor_functions
serial_number
wifi_password
wifi_ssid
}
}
Variables
{
"auxiliary_device_id": "4",
"connection_type": "BLUETOOTH",
"id": "4",
"kind": "DASHCAM",
"label": "xyz789",
"mac_address_hash": "abc123",
"sensor_functions": ["ACCELERATION"],
"serial_number": "xyz789",
"wifi_password": "abc123",
"wifi_ssid": "xyz789"
}
Response
{
"data": {
"onboarding_auxiliary_device_update": {
"asset_manager_id": "abc123",
"connection_type": "BLUETOOTH",
"id": "4",
"id_key": "abc123",
"kind": "DASHCAM",
"label": "xyz789",
"mac_address_hash": "xyz789",
"sensor_functions": ["ACCELERATION"],
"serial_number": "xyz789",
"wifi_password": "xyz789",
"wifi_ssid": "abc123"
}
}
}
onboarding_cancel
Description
Cancel onboarding request
Response
Returns an OnboardingRequest
Example
Query
mutation onboarding_cancel(
$id: ID!,
$reason: String
) {
onboarding_cancel(
id: $id,
reason: $reason
) {
actions {
...OnboardingActionPagedFragment
}
activate_read_write_in_device
auxiliary_devices {
...OnboardingAuxiliaryDevicePagedFragment
}
client_identification_id
cloned_from {
...OnboardingRequestFragment
}
cloned_to {
...OnboardingRequestFragment
}
connection_type
consent {
...OnboardingConsentFragment
}
created_at
created_by {
...AccountFragment
}
device {
...DeviceFragment
}
device_bluetooth
device_created_by {
...AccountFragment
}
device_mode
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
driver_associated_by {
...AccountFragment
}
driver_association_id
driver_created_by {
...AccountFragment
}
driver_validated_by {
...AccountFragment
}
id
km_at_installation
mode
plate_number
profile {
...ProfileOnboardingFragment
}
serial_number
status
updated_at
vehicle {
...VehicleFragment
}
vehicle_associated_by {
...AccountFragment
}
vehicle_connection {
...OnboardingVehicleConnectionFragment
}
vehicle_created_by {
...AccountFragment
}
vehicle_creation_id
vehicle_enriched_by {
...AccountFragment
}
vehicle_enrichments {
...OnboardingVehicleFragment
}
vehicle_label
vin
warnings {
...OnboardingWarningFragment
}
with_code
setup_status {
...request_setup_status_showFragment
}
}
}
Variables
{"id": 4, "reason": "xyz789"}
Response
{
"data": {
"onboarding_cancel": {
"actions": OnboardingActionPaged,
"activate_read_write_in_device": true,
"auxiliary_devices": OnboardingAuxiliaryDevicePaged,
"client_identification_id": 4,
"cloned_from": OnboardingRequest,
"cloned_to": OnboardingRequest,
"connection_type": "CABLE",
"consent": OnboardingConsent,
"created_at": "2007-12-03T10:15:30Z",
"created_by": Account,
"device": Device,
"device_bluetooth": "DEFAULT_MODE",
"device_created_by": Account,
"device_mode": "OTHER",
"distributor": OnboardingDistributor,
"driver": Account,
"driver_associated_by": Account,
"driver_association_id": 4,
"driver_created_by": Account,
"driver_validated_by": Account,
"id": 4,
"km_at_installation": 123,
"mode": "OTHER",
"plate_number": "4",
"profile": ProfileOnboarding,
"serial_number": "xyz789",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle,
"vehicle_associated_by": Account,
"vehicle_connection": OnboardingVehicleConnection,
"vehicle_created_by": Account,
"vehicle_creation_id": "4",
"vehicle_enriched_by": Account,
"vehicle_enrichments": OnboardingVehicle,
"vehicle_label": "xyz789",
"vin": "xyz789",
"warnings": [OnboardingWarning],
"with_code": false,
"setup_status": request_setup_status_show
}
}
}
onboarding_clone
Description
Clone onboarding request
Response
Returns an OnboardingRequest
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing closed onboarding request |
Example
Query
mutation onboarding_clone($id: ID!) {
onboarding_clone(id: $id) {
actions {
...OnboardingActionPagedFragment
}
activate_read_write_in_device
auxiliary_devices {
...OnboardingAuxiliaryDevicePagedFragment
}
client_identification_id
cloned_from {
...OnboardingRequestFragment
}
cloned_to {
...OnboardingRequestFragment
}
connection_type
consent {
...OnboardingConsentFragment
}
created_at
created_by {
...AccountFragment
}
device {
...DeviceFragment
}
device_bluetooth
device_created_by {
...AccountFragment
}
device_mode
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
driver_associated_by {
...AccountFragment
}
driver_association_id
driver_created_by {
...AccountFragment
}
driver_validated_by {
...AccountFragment
}
id
km_at_installation
mode
plate_number
profile {
...ProfileOnboardingFragment
}
serial_number
status
updated_at
vehicle {
...VehicleFragment
}
vehicle_associated_by {
...AccountFragment
}
vehicle_connection {
...OnboardingVehicleConnectionFragment
}
vehicle_created_by {
...AccountFragment
}
vehicle_creation_id
vehicle_enriched_by {
...AccountFragment
}
vehicle_enrichments {
...OnboardingVehicleFragment
}
vehicle_label
vin
warnings {
...OnboardingWarningFragment
}
with_code
setup_status {
...request_setup_status_showFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"onboarding_clone": {
"actions": OnboardingActionPaged,
"activate_read_write_in_device": true,
"auxiliary_devices": OnboardingAuxiliaryDevicePaged,
"client_identification_id": "4",
"cloned_from": OnboardingRequest,
"cloned_to": OnboardingRequest,
"connection_type": "CABLE",
"consent": OnboardingConsent,
"created_at": "2007-12-03T10:15:30Z",
"created_by": Account,
"device": Device,
"device_bluetooth": "DEFAULT_MODE",
"device_created_by": Account,
"device_mode": "OTHER",
"distributor": OnboardingDistributor,
"driver": Account,
"driver_associated_by": Account,
"driver_association_id": 4,
"driver_created_by": Account,
"driver_validated_by": Account,
"id": "4",
"km_at_installation": 123,
"mode": "OTHER",
"plate_number": 4,
"profile": ProfileOnboarding,
"serial_number": "abc123",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle,
"vehicle_associated_by": Account,
"vehicle_connection": OnboardingVehicleConnection,
"vehicle_created_by": Account,
"vehicle_creation_id": 4,
"vehicle_enriched_by": Account,
"vehicle_enrichments": OnboardingVehicle,
"vehicle_label": "abc123",
"vin": "abc123",
"warnings": [OnboardingWarning],
"with_code": true,
"setup_status": request_setup_status_show
}
}
}
onboarding_consent
Description
(re)set user consent
Response
Returns an OnboardingConsent
Arguments
| Name | Description |
|---|---|
consent_id - ID
|
Id of existing onboarding consent |
id - ID!
|
Id of existing onboarding request |
whitelisted_data - [OnboardingWhitelistedDataArg!]!
|
Override whitelisted_data from client identification |
Example
Query
mutation onboarding_consent(
$consent_id: ID,
$id: ID!,
$whitelisted_data: [OnboardingWhitelistedDataArg!]!
) {
onboarding_consent(
consent_id: $consent_id,
id: $id,
whitelisted_data: $whitelisted_data
) {
id
inherited
whitelisted_data
}
}
Variables
{
"consent_id": "4",
"id": "4",
"whitelisted_data": ["POSITION"]
}
Response
{
"data": {
"onboarding_consent": {
"id": 4,
"inherited": false,
"whitelisted_data": ["OTHER"]
}
}
}
onboarding_create
Description
Initiate onboarding request
Response
Returns an OnboardingRequest
Arguments
| Name | Description |
|---|---|
code - String
|
Onboarding code |
distributor_id - ID!
|
Id of existing onboarding distributor |
mode - OnboardingModeArg
|
Example
Query
mutation onboarding_create(
$code: String,
$distributor_id: ID!,
$mode: OnboardingModeArg
) {
onboarding_create(
code: $code,
distributor_id: $distributor_id,
mode: $mode
) {
actions {
...OnboardingActionPagedFragment
}
activate_read_write_in_device
auxiliary_devices {
...OnboardingAuxiliaryDevicePagedFragment
}
client_identification_id
cloned_from {
...OnboardingRequestFragment
}
cloned_to {
...OnboardingRequestFragment
}
connection_type
consent {
...OnboardingConsentFragment
}
created_at
created_by {
...AccountFragment
}
device {
...DeviceFragment
}
device_bluetooth
device_created_by {
...AccountFragment
}
device_mode
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
driver_associated_by {
...AccountFragment
}
driver_association_id
driver_created_by {
...AccountFragment
}
driver_validated_by {
...AccountFragment
}
id
km_at_installation
mode
plate_number
profile {
...ProfileOnboardingFragment
}
serial_number
status
updated_at
vehicle {
...VehicleFragment
}
vehicle_associated_by {
...AccountFragment
}
vehicle_connection {
...OnboardingVehicleConnectionFragment
}
vehicle_created_by {
...AccountFragment
}
vehicle_creation_id
vehicle_enriched_by {
...AccountFragment
}
vehicle_enrichments {
...OnboardingVehicleFragment
}
vehicle_label
vin
warnings {
...OnboardingWarningFragment
}
with_code
setup_status {
...request_setup_status_showFragment
}
}
}
Variables
{
"code": "abc123",
"distributor_id": 4,
"mode": "DISCOVERY"
}
Response
{
"data": {
"onboarding_create": {
"actions": OnboardingActionPaged,
"activate_read_write_in_device": false,
"auxiliary_devices": OnboardingAuxiliaryDevicePaged,
"client_identification_id": 4,
"cloned_from": OnboardingRequest,
"cloned_to": OnboardingRequest,
"connection_type": "CABLE",
"consent": OnboardingConsent,
"created_at": "2007-12-03T10:15:30Z",
"created_by": Account,
"device": Device,
"device_bluetooth": "DEFAULT_MODE",
"device_created_by": Account,
"device_mode": "OTHER",
"distributor": OnboardingDistributor,
"driver": Account,
"driver_associated_by": Account,
"driver_association_id": "4",
"driver_created_by": Account,
"driver_validated_by": Account,
"id": 4,
"km_at_installation": 987,
"mode": "OTHER",
"plate_number": "4",
"profile": ProfileOnboarding,
"serial_number": "abc123",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle,
"vehicle_associated_by": Account,
"vehicle_connection": OnboardingVehicleConnection,
"vehicle_created_by": Account,
"vehicle_creation_id": 4,
"vehicle_enriched_by": Account,
"vehicle_enrichments": OnboardingVehicle,
"vehicle_label": "xyz789",
"vin": "abc123",
"warnings": [OnboardingWarning],
"with_code": true,
"setup_status": request_setup_status_show
}
}
}
onboarding_device_reserve
Description
Reserve device for onboarding request
Response
Returns a Device
Example
Query
mutation onboarding_device_reserve(
$device_id: ID,
$id: ID!,
$serial_number: String
) {
onboarding_device_reserve(
device_id: $device_id,
id: $id,
serial_number: $serial_number
) {
id
active_account
aggregated_data {
...AggregatedDataFragment
}
alerts {
...VehicleAlertPagedFragment
}
alerts_state {
...VehicleAlertsStateFragment
}
battery_annotations {
...BatteryAnnotationPagedFragment
}
created_at
current_vehicle {
...VehicleFragment
}
device_type
fields {
...FieldPagedFragment
}
first_connection_at
groups {
...GroupPagedFragment
}
harshes {
...TripHarshPagedFragment
}
history {
...DeviceHistoryPagedFragment
}
last_activity_at
last_connection_at
last_connection_reason
last_disconnection_at
last_disconnection_reason
last_position {
...CoordinatesFragment
}
last_trip {
...TripFragment
}
log_fetches {
...LogfetchPagedFragment
}
onboarded
overspeeds {
...TripOverspeedPagedFragment
}
owner {
...AccountFragment
}
product {
...ProductFragment
}
profile_mode {
...ProfileDeviceModeFragment
}
profile_modes {
...ProfileDeviceModePagedFragment
}
profile_privacies {
...ProfilePrivacyPagedFragment
}
profile_privacy {
...ProfilePrivacyFragment
}
readings {
...ReadingPagedFragment
}
readings_anon {
...ReadingAnonPagedFragment
}
remote_diags {
...RemoteDiagPagedFragment
}
serial_number
status
trip_summary {
...TripSummaryFragment
}
trips {
...TripPagedFragment
}
updated_at
vehicle_sessions {
...DeviceVehicleSessionPagedFragment
}
vehicles {
...VehiclePagedFragment
}
dashcams {
...dashcam_pagedFragment
}
video_segments {
...video_segment_pagedFragment
}
geofences {
...geofence_paginatedFragment
}
cleaned_positions {
...map_matching_position_paginatedFragment
}
summary_from_journey {
...journey_summaryFragment
}
trip_journeys {
...journey_trip_paginatedFragment
}
trip_tag_schedules {
...trip_tag_schedule_paginatedFragment
}
journey_reports {
... on report_paginated {
...report_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_harshes {
...journey_trip_harsh_paginatedFragment
}
journey_overspeeds {
... on journey_trip_overspeed_paginated {
...journey_trip_overspeed_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_idlings {
... on journey_trip_idling_paginated {
...journey_trip_idling_paginatedFragment
}
... on errors {
...errorsFragment
}
}
journey_config {
... on device_config_show_nullable {
...device_config_show_nullableFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{
"device_id": "4",
"id": 4,
"serial_number": "xyz789"
}
Response
{
"data": {
"onboarding_device_reserve": {
"id": 4,
"active_account": "xyz789",
"aggregated_data": AggregatedData,
"alerts": VehicleAlertPaged,
"alerts_state": VehicleAlertsState,
"battery_annotations": BatteryAnnotationPaged,
"created_at": "2007-12-03T10:15:30Z",
"current_vehicle": Vehicle,
"device_type": "abc123",
"fields": FieldPaged,
"first_connection_at": "2007-12-03T10:15:30Z",
"groups": GroupPaged,
"harshes": TripHarshPaged,
"history": DeviceHistoryPaged,
"last_activity_at": "2007-12-03T10:15:30Z",
"last_connection_at": "2007-12-03T10:15:30Z",
"last_connection_reason": "CLOSED_BY_SERVER",
"last_disconnection_at": "2007-12-03T10:15:30Z",
"last_disconnection_reason": "AUTH_FAILED_ACCOUNT",
"last_position": Coordinates,
"last_trip": Trip,
"log_fetches": LogfetchPaged,
"onboarded": false,
"overspeeds": TripOverspeedPaged,
"owner": Account,
"product": Product,
"profile_mode": ProfileDeviceMode,
"profile_modes": ProfileDeviceModePaged,
"profile_privacies": ProfilePrivacyPaged,
"profile_privacy": ProfilePrivacy,
"readings": ReadingPaged,
"readings_anon": ReadingAnonPaged,
"remote_diags": RemoteDiagPaged,
"serial_number": "xyz789",
"status": "CONNECTED",
"trip_summary": TripSummary,
"trips": TripPaged,
"updated_at": "2007-12-03T10:15:30Z",
"vehicle_sessions": DeviceVehicleSessionPaged,
"vehicles": VehiclePaged,
"dashcams": dashcam_paged,
"video_segments": video_segment_paged,
"geofences": geofence_paginated,
"cleaned_positions": map_matching_position_paginated,
"summary_from_journey": journey_summary,
"trip_journeys": journey_trip_paginated,
"trip_tag_schedules": trip_tag_schedule_paginated,
"journey_reports": report_paginated,
"journey_harshes": journey_trip_harsh_paginated,
"journey_overspeeds": journey_trip_overspeed_paginated,
"journey_idlings": journey_trip_idling_paginated,
"journey_config": device_config_show_nullable
}
}
}
onboarding_driver_associate
Use onboarding_driver_association_create
Example
Query
mutation onboarding_driver_associate(
$driver_id: ID!,
$id: ID!
) {
onboarding_driver_associate(
driver_id: $driver_id,
id: $id
) {
alert_preference {
...AlertPreferenceFragment
}
company_name
confirmed_at
country_code
created_at
descriptions {
...DescriptionPagedFragment
}
devices {
...DevicePagedFragment
}
distributors {
...OnboardingDistributorPagedFragment
}
driver_contacts {
...DriverPagedFragment
}
driver_profiles {
...DriverPagedFragment
}
drivers {
...DriverPagedFragment
}
email
full_name
groups {
...GroupPagedFragment
}
id
language
last_sign_in_at
organization_id
phone
roles {
...AccountRoleFragment
}
short_name
time_zone
updated_at
vehicles {
...VehiclePagedFragment
}
workshops {
...WorkshopPagedFragment
}
sso_user {
... on user {
...userFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{"driver_id": 4, "id": 4}
Response
{
"data": {
"onboarding_driver_associate": {
"alert_preference": AlertPreference,
"company_name": "abc123",
"confirmed_at": "2007-12-03T10:15:30Z",
"country_code": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"distributors": OnboardingDistributorPaged,
"driver_contacts": DriverPaged,
"driver_profiles": DriverPaged,
"drivers": DriverPaged,
"email": "xyz789",
"full_name": "abc123",
"groups": GroupPaged,
"id": 4,
"language": Language,
"last_sign_in_at": "2007-12-03T10:15:30Z",
"organization_id": "4",
"phone": "xyz789",
"roles": [AccountRole],
"short_name": "abc123",
"time_zone": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"vehicles": VehiclePaged,
"workshops": WorkshopPaged,
"sso_user": user
}
}
}
onboarding_driver_association_create
Description
Associate driver to onboarding request
Response
Returns an OnboardingDriverAssociation
Example
Query
mutation onboarding_driver_association_create(
$driver_id: ID!,
$id: ID!
) {
onboarding_driver_association_create(
driver_id: $driver_id,
id: $id
) {
driver {
...AccountFragment
}
id
}
}
Variables
{"driver_id": 4, "id": 4}
Response
{
"data": {
"onboarding_driver_association_create": {
"driver": Account,
"id": 4
}
}
}
onboarding_driver_association_update
Description
Reassociate driver to onboarding request
Response
Returns an OnboardingDriverAssociation
Example
Query
mutation onboarding_driver_association_update(
$driver_association_id: ID!,
$driver_id: ID!,
$id: ID!
) {
onboarding_driver_association_update(
driver_association_id: $driver_association_id,
driver_id: $driver_id,
id: $id
) {
driver {
...AccountFragment
}
id
}
}
Variables
{
"driver_association_id": "4",
"driver_id": 4,
"id": 4
}
Response
{
"data": {
"onboarding_driver_association_update": {
"driver": Account,
"id": "4"
}
}
}
onboarding_driver_create
Description
Create driver for onboarding request
Response
Returns an Account
Example
Query
mutation onboarding_driver_create(
$country_code: String,
$email: String,
$full_name: String,
$id: ID!,
$phone_number: String,
$short_name: String
) {
onboarding_driver_create(
country_code: $country_code,
email: $email,
full_name: $full_name,
id: $id,
phone_number: $phone_number,
short_name: $short_name
) {
alert_preference {
...AlertPreferenceFragment
}
company_name
confirmed_at
country_code
created_at
descriptions {
...DescriptionPagedFragment
}
devices {
...DevicePagedFragment
}
distributors {
...OnboardingDistributorPagedFragment
}
driver_contacts {
...DriverPagedFragment
}
driver_profiles {
...DriverPagedFragment
}
drivers {
...DriverPagedFragment
}
email
full_name
groups {
...GroupPagedFragment
}
id
language
last_sign_in_at
organization_id
phone
roles {
...AccountRoleFragment
}
short_name
time_zone
updated_at
vehicles {
...VehiclePagedFragment
}
workshops {
...WorkshopPagedFragment
}
sso_user {
... on user {
...userFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{
"country_code": "abc123",
"email": "xyz789",
"full_name": "xyz789",
"id": 4,
"phone_number": "abc123",
"short_name": "abc123"
}
Response
{
"data": {
"onboarding_driver_create": {
"alert_preference": AlertPreference,
"company_name": "abc123",
"confirmed_at": "2007-12-03T10:15:30Z",
"country_code": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"distributors": OnboardingDistributorPaged,
"driver_contacts": DriverPaged,
"driver_profiles": DriverPaged,
"drivers": DriverPaged,
"email": "xyz789",
"full_name": "abc123",
"groups": GroupPaged,
"id": 4,
"language": Language,
"last_sign_in_at": "2007-12-03T10:15:30Z",
"organization_id": 4,
"phone": "abc123",
"roles": [AccountRole],
"short_name": "abc123",
"time_zone": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"vehicles": VehiclePaged,
"workshops": WorkshopPaged,
"sso_user": user
}
}
}
onboarding_driver_validate
Description
Validate driver for onboarding request
Response
Returns an Account
Example
Query
mutation onboarding_driver_validate(
$code: String,
$id: ID!
) {
onboarding_driver_validate(
code: $code,
id: $id
) {
alert_preference {
...AlertPreferenceFragment
}
company_name
confirmed_at
country_code
created_at
descriptions {
...DescriptionPagedFragment
}
devices {
...DevicePagedFragment
}
distributors {
...OnboardingDistributorPagedFragment
}
driver_contacts {
...DriverPagedFragment
}
driver_profiles {
...DriverPagedFragment
}
drivers {
...DriverPagedFragment
}
email
full_name
groups {
...GroupPagedFragment
}
id
language
last_sign_in_at
organization_id
phone
roles {
...AccountRoleFragment
}
short_name
time_zone
updated_at
vehicles {
...VehiclePagedFragment
}
workshops {
...WorkshopPagedFragment
}
sso_user {
... on user {
...userFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{
"code": "abc123",
"id": "4"
}
Response
{
"data": {
"onboarding_driver_validate": {
"alert_preference": AlertPreference,
"company_name": "abc123",
"confirmed_at": "2007-12-03T10:15:30Z",
"country_code": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"distributors": OnboardingDistributorPaged,
"driver_contacts": DriverPaged,
"driver_profiles": DriverPaged,
"drivers": DriverPaged,
"email": "xyz789",
"full_name": "xyz789",
"groups": GroupPaged,
"id": "4",
"language": Language,
"last_sign_in_at": "2007-12-03T10:15:30Z",
"organization_id": "4",
"phone": "abc123",
"roles": [AccountRole],
"short_name": "abc123",
"time_zone": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"vehicles": VehiclePaged,
"workshops": WorkshopPaged,
"sso_user": user
}
}
}
onboarding_finalize
Description
Finalize onboarding request
Response
Returns an OnboardingRequest
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing onboarding request |
Example
Query
mutation onboarding_finalize($id: ID!) {
onboarding_finalize(id: $id) {
actions {
...OnboardingActionPagedFragment
}
activate_read_write_in_device
auxiliary_devices {
...OnboardingAuxiliaryDevicePagedFragment
}
client_identification_id
cloned_from {
...OnboardingRequestFragment
}
cloned_to {
...OnboardingRequestFragment
}
connection_type
consent {
...OnboardingConsentFragment
}
created_at
created_by {
...AccountFragment
}
device {
...DeviceFragment
}
device_bluetooth
device_created_by {
...AccountFragment
}
device_mode
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
driver_associated_by {
...AccountFragment
}
driver_association_id
driver_created_by {
...AccountFragment
}
driver_validated_by {
...AccountFragment
}
id
km_at_installation
mode
plate_number
profile {
...ProfileOnboardingFragment
}
serial_number
status
updated_at
vehicle {
...VehicleFragment
}
vehicle_associated_by {
...AccountFragment
}
vehicle_connection {
...OnboardingVehicleConnectionFragment
}
vehicle_created_by {
...AccountFragment
}
vehicle_creation_id
vehicle_enriched_by {
...AccountFragment
}
vehicle_enrichments {
...OnboardingVehicleFragment
}
vehicle_label
vin
warnings {
...OnboardingWarningFragment
}
with_code
setup_status {
...request_setup_status_showFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"onboarding_finalize": {
"actions": OnboardingActionPaged,
"activate_read_write_in_device": true,
"auxiliary_devices": OnboardingAuxiliaryDevicePaged,
"client_identification_id": "4",
"cloned_from": OnboardingRequest,
"cloned_to": OnboardingRequest,
"connection_type": "CABLE",
"consent": OnboardingConsent,
"created_at": "2007-12-03T10:15:30Z",
"created_by": Account,
"device": Device,
"device_bluetooth": "DEFAULT_MODE",
"device_created_by": Account,
"device_mode": "OTHER",
"distributor": OnboardingDistributor,
"driver": Account,
"driver_associated_by": Account,
"driver_association_id": "4",
"driver_created_by": Account,
"driver_validated_by": Account,
"id": "4",
"km_at_installation": 987,
"mode": "OTHER",
"plate_number": 4,
"profile": ProfileOnboarding,
"serial_number": "xyz789",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle,
"vehicle_associated_by": Account,
"vehicle_connection": OnboardingVehicleConnection,
"vehicle_created_by": Account,
"vehicle_creation_id": 4,
"vehicle_enriched_by": Account,
"vehicle_enrichments": OnboardingVehicle,
"vehicle_label": "abc123",
"vin": "xyz789",
"warnings": [OnboardingWarning],
"with_code": false,
"setup_status": request_setup_status_show
}
}
}
onboarding_offboard
Description
Unlink device and delete/reset data associated with a closed onboarding request
Response
Returns an OnboardingRequest
Example
Query
mutation onboarding_offboard(
$id: ID!,
$reset_data: Boolean!
) {
onboarding_offboard(
id: $id,
reset_data: $reset_data
) {
actions {
...OnboardingActionPagedFragment
}
activate_read_write_in_device
auxiliary_devices {
...OnboardingAuxiliaryDevicePagedFragment
}
client_identification_id
cloned_from {
...OnboardingRequestFragment
}
cloned_to {
...OnboardingRequestFragment
}
connection_type
consent {
...OnboardingConsentFragment
}
created_at
created_by {
...AccountFragment
}
device {
...DeviceFragment
}
device_bluetooth
device_created_by {
...AccountFragment
}
device_mode
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
driver_associated_by {
...AccountFragment
}
driver_association_id
driver_created_by {
...AccountFragment
}
driver_validated_by {
...AccountFragment
}
id
km_at_installation
mode
plate_number
profile {
...ProfileOnboardingFragment
}
serial_number
status
updated_at
vehicle {
...VehicleFragment
}
vehicle_associated_by {
...AccountFragment
}
vehicle_connection {
...OnboardingVehicleConnectionFragment
}
vehicle_created_by {
...AccountFragment
}
vehicle_creation_id
vehicle_enriched_by {
...AccountFragment
}
vehicle_enrichments {
...OnboardingVehicleFragment
}
vehicle_label
vin
warnings {
...OnboardingWarningFragment
}
with_code
setup_status {
...request_setup_status_showFragment
}
}
}
Variables
{"id": 4, "reset_data": false}
Response
{
"data": {
"onboarding_offboard": {
"actions": OnboardingActionPaged,
"activate_read_write_in_device": true,
"auxiliary_devices": OnboardingAuxiliaryDevicePaged,
"client_identification_id": "4",
"cloned_from": OnboardingRequest,
"cloned_to": OnboardingRequest,
"connection_type": "CABLE",
"consent": OnboardingConsent,
"created_at": "2007-12-03T10:15:30Z",
"created_by": Account,
"device": Device,
"device_bluetooth": "DEFAULT_MODE",
"device_created_by": Account,
"device_mode": "OTHER",
"distributor": OnboardingDistributor,
"driver": Account,
"driver_associated_by": Account,
"driver_association_id": 4,
"driver_created_by": Account,
"driver_validated_by": Account,
"id": "4",
"km_at_installation": 987,
"mode": "OTHER",
"plate_number": 4,
"profile": ProfileOnboarding,
"serial_number": "xyz789",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle,
"vehicle_associated_by": Account,
"vehicle_connection": OnboardingVehicleConnection,
"vehicle_created_by": Account,
"vehicle_creation_id": 4,
"vehicle_enriched_by": Account,
"vehicle_enrichments": OnboardingVehicle,
"vehicle_label": "abc123",
"vin": "xyz789",
"warnings": [OnboardingWarning],
"with_code": true,
"setup_status": request_setup_status_show
}
}
}
onboarding_post_client_identifications
Description
Method:
POSTBase URL:{env.ONBOARDING_API}Path:/v2/client_identifications
[alpha] Create Client Identification
Response
Returns a client_identification_v2_show
Arguments
| Name | Description |
|---|---|
input - client_identification_v2_create_Input
|
Example
Query
mutation onboarding_post_client_identifications($input: client_identification_v2_create_Input) {
onboarding_post_client_identifications(input: $input) {
data {
...client_identification_v2Fragment
}
}
}
Variables
{"input": client_identification_v2_create_Input}
Response
{
"data": {
"onboarding_post_client_identifications": {
"data": client_identification_v2
}
}
}
onboarding_reconfigure_device
Description
Reconfigure onboarded device
Response
Returns an OnboardingRequest
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing onboarding request |
Example
Query
mutation onboarding_reconfigure_device($id: ID!) {
onboarding_reconfigure_device(id: $id) {
actions {
...OnboardingActionPagedFragment
}
activate_read_write_in_device
auxiliary_devices {
...OnboardingAuxiliaryDevicePagedFragment
}
client_identification_id
cloned_from {
...OnboardingRequestFragment
}
cloned_to {
...OnboardingRequestFragment
}
connection_type
consent {
...OnboardingConsentFragment
}
created_at
created_by {
...AccountFragment
}
device {
...DeviceFragment
}
device_bluetooth
device_created_by {
...AccountFragment
}
device_mode
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
driver_associated_by {
...AccountFragment
}
driver_association_id
driver_created_by {
...AccountFragment
}
driver_validated_by {
...AccountFragment
}
id
km_at_installation
mode
plate_number
profile {
...ProfileOnboardingFragment
}
serial_number
status
updated_at
vehicle {
...VehicleFragment
}
vehicle_associated_by {
...AccountFragment
}
vehicle_connection {
...OnboardingVehicleConnectionFragment
}
vehicle_created_by {
...AccountFragment
}
vehicle_creation_id
vehicle_enriched_by {
...AccountFragment
}
vehicle_enrichments {
...OnboardingVehicleFragment
}
vehicle_label
vin
warnings {
...OnboardingWarningFragment
}
with_code
setup_status {
...request_setup_status_showFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"onboarding_reconfigure_device": {
"actions": OnboardingActionPaged,
"activate_read_write_in_device": true,
"auxiliary_devices": OnboardingAuxiliaryDevicePaged,
"client_identification_id": 4,
"cloned_from": OnboardingRequest,
"cloned_to": OnboardingRequest,
"connection_type": "CABLE",
"consent": OnboardingConsent,
"created_at": "2007-12-03T10:15:30Z",
"created_by": Account,
"device": Device,
"device_bluetooth": "DEFAULT_MODE",
"device_created_by": Account,
"device_mode": "OTHER",
"distributor": OnboardingDistributor,
"driver": Account,
"driver_associated_by": Account,
"driver_association_id": 4,
"driver_created_by": Account,
"driver_validated_by": Account,
"id": "4",
"km_at_installation": 123,
"mode": "OTHER",
"plate_number": 4,
"profile": ProfileOnboarding,
"serial_number": "abc123",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle,
"vehicle_associated_by": Account,
"vehicle_connection": OnboardingVehicleConnection,
"vehicle_created_by": Account,
"vehicle_creation_id": 4,
"vehicle_enriched_by": Account,
"vehicle_enrichments": OnboardingVehicle,
"vehicle_label": "abc123",
"vin": "xyz789",
"warnings": [OnboardingWarning],
"with_code": true,
"setup_status": request_setup_status_show
}
}
}
onboarding_regen_validation
Description
Resend onboarding driver validation code
onboarding_require_intervention
Description
Require intervention on onboarding
Response
Returns an OnboardingRequest
Example
Query
mutation onboarding_require_intervention(
$id: ID!,
$reason: String!
) {
onboarding_require_intervention(
id: $id,
reason: $reason
) {
actions {
...OnboardingActionPagedFragment
}
activate_read_write_in_device
auxiliary_devices {
...OnboardingAuxiliaryDevicePagedFragment
}
client_identification_id
cloned_from {
...OnboardingRequestFragment
}
cloned_to {
...OnboardingRequestFragment
}
connection_type
consent {
...OnboardingConsentFragment
}
created_at
created_by {
...AccountFragment
}
device {
...DeviceFragment
}
device_bluetooth
device_created_by {
...AccountFragment
}
device_mode
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
driver_associated_by {
...AccountFragment
}
driver_association_id
driver_created_by {
...AccountFragment
}
driver_validated_by {
...AccountFragment
}
id
km_at_installation
mode
plate_number
profile {
...ProfileOnboardingFragment
}
serial_number
status
updated_at
vehicle {
...VehicleFragment
}
vehicle_associated_by {
...AccountFragment
}
vehicle_connection {
...OnboardingVehicleConnectionFragment
}
vehicle_created_by {
...AccountFragment
}
vehicle_creation_id
vehicle_enriched_by {
...AccountFragment
}
vehicle_enrichments {
...OnboardingVehicleFragment
}
vehicle_label
vin
warnings {
...OnboardingWarningFragment
}
with_code
setup_status {
...request_setup_status_showFragment
}
}
}
Variables
{"id": 4, "reason": "abc123"}
Response
{
"data": {
"onboarding_require_intervention": {
"actions": OnboardingActionPaged,
"activate_read_write_in_device": true,
"auxiliary_devices": OnboardingAuxiliaryDevicePaged,
"client_identification_id": 4,
"cloned_from": OnboardingRequest,
"cloned_to": OnboardingRequest,
"connection_type": "CABLE",
"consent": OnboardingConsent,
"created_at": "2007-12-03T10:15:30Z",
"created_by": Account,
"device": Device,
"device_bluetooth": "DEFAULT_MODE",
"device_created_by": Account,
"device_mode": "OTHER",
"distributor": OnboardingDistributor,
"driver": Account,
"driver_associated_by": Account,
"driver_association_id": "4",
"driver_created_by": Account,
"driver_validated_by": Account,
"id": 4,
"km_at_installation": 987,
"mode": "OTHER",
"plate_number": "4",
"profile": ProfileOnboarding,
"serial_number": "abc123",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle,
"vehicle_associated_by": Account,
"vehicle_connection": OnboardingVehicleConnection,
"vehicle_created_by": Account,
"vehicle_creation_id": "4",
"vehicle_enriched_by": Account,
"vehicle_enrichments": OnboardingVehicle,
"vehicle_label": "abc123",
"vin": "xyz789",
"warnings": [OnboardingWarning],
"with_code": false,
"setup_status": request_setup_status_show
}
}
}
onboarding_restore_default_settings
Description
Require intervention on onboarding
Response
Returns an OnboardingRequest
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing onboarding request |
Example
Query
mutation onboarding_restore_default_settings($id: ID!) {
onboarding_restore_default_settings(id: $id) {
actions {
...OnboardingActionPagedFragment
}
activate_read_write_in_device
auxiliary_devices {
...OnboardingAuxiliaryDevicePagedFragment
}
client_identification_id
cloned_from {
...OnboardingRequestFragment
}
cloned_to {
...OnboardingRequestFragment
}
connection_type
consent {
...OnboardingConsentFragment
}
created_at
created_by {
...AccountFragment
}
device {
...DeviceFragment
}
device_bluetooth
device_created_by {
...AccountFragment
}
device_mode
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
driver_associated_by {
...AccountFragment
}
driver_association_id
driver_created_by {
...AccountFragment
}
driver_validated_by {
...AccountFragment
}
id
km_at_installation
mode
plate_number
profile {
...ProfileOnboardingFragment
}
serial_number
status
updated_at
vehicle {
...VehicleFragment
}
vehicle_associated_by {
...AccountFragment
}
vehicle_connection {
...OnboardingVehicleConnectionFragment
}
vehicle_created_by {
...AccountFragment
}
vehicle_creation_id
vehicle_enriched_by {
...AccountFragment
}
vehicle_enrichments {
...OnboardingVehicleFragment
}
vehicle_label
vin
warnings {
...OnboardingWarningFragment
}
with_code
setup_status {
...request_setup_status_showFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"onboarding_restore_default_settings": {
"actions": OnboardingActionPaged,
"activate_read_write_in_device": false,
"auxiliary_devices": OnboardingAuxiliaryDevicePaged,
"client_identification_id": "4",
"cloned_from": OnboardingRequest,
"cloned_to": OnboardingRequest,
"connection_type": "CABLE",
"consent": OnboardingConsent,
"created_at": "2007-12-03T10:15:30Z",
"created_by": Account,
"device": Device,
"device_bluetooth": "DEFAULT_MODE",
"device_created_by": Account,
"device_mode": "OTHER",
"distributor": OnboardingDistributor,
"driver": Account,
"driver_associated_by": Account,
"driver_association_id": "4",
"driver_created_by": Account,
"driver_validated_by": Account,
"id": "4",
"km_at_installation": 987,
"mode": "OTHER",
"plate_number": 4,
"profile": ProfileOnboarding,
"serial_number": "xyz789",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle,
"vehicle_associated_by": Account,
"vehicle_connection": OnboardingVehicleConnection,
"vehicle_created_by": Account,
"vehicle_creation_id": "4",
"vehicle_enriched_by": Account,
"vehicle_enrichments": OnboardingVehicle,
"vehicle_label": "abc123",
"vin": "abc123",
"warnings": [OnboardingWarning],
"with_code": true,
"setup_status": request_setup_status_show
}
}
}
onboarding_staff_create
Response
Returns an OnboardingStaff
Arguments
| Name | Description |
|---|---|
account_id - ID!
|
Account id |
distributor_id - ID!
|
Distributor id |
role - OnboardingStaffRole!
|
Staff role |
Example
Query
mutation onboarding_staff_create(
$account_id: ID!,
$distributor_id: ID!,
$role: OnboardingStaffRole!
) {
onboarding_staff_create(
account_id: $account_id,
distributor_id: $distributor_id,
role: $role
) {
account {
...AccountFragment
}
is_active
role
}
}
Variables
{"account_id": 4, "distributor_id": 4, "role": "MANAGER"}
Response
{
"data": {
"onboarding_staff_create": {
"account": Account,
"is_active": true,
"role": "MANAGER"
}
}
}
onboarding_staff_update
Response
Returns an OnboardingStaff
Arguments
| Name | Description |
|---|---|
distributor_id - ID!
|
Distributor id |
id - ID!
|
Staff id |
is_active - Boolean
|
|
role - OnboardingStaffRole
|
Example
Query
mutation onboarding_staff_update(
$distributor_id: ID!,
$id: ID!,
$is_active: Boolean,
$role: OnboardingStaffRole
) {
onboarding_staff_update(
distributor_id: $distributor_id,
id: $id,
is_active: $is_active,
role: $role
) {
account {
...AccountFragment
}
is_active
role
}
}
Variables
{
"distributor_id": "4",
"id": "4",
"is_active": false,
"role": "MANAGER"
}
Response
{
"data": {
"onboarding_staff_update": {
"account": Account,
"is_active": true,
"role": "MANAGER"
}
}
}
onboarding_vehicle_connection
Use OnboardingVehicleConnectionUpdate
Response
Returns an ID
Arguments
| Name | Description |
|---|---|
activate_read_write_in_device - Boolean
|
Enable writing or leave read-only |
connection_type - DeviceConnectionType
|
Connection type |
device_bluetooth - OnboardingDeviceBluetoothMode
|
Specify device bluetooth mode |
device_mode - ProfileDeviceModeClassArg
|
Specify device mode |
id - ID!
|
Id of existing onboarding request |
km_at_installation - Int
|
Vehicle mileage (km) at installation |
Example
Query
mutation onboarding_vehicle_connection(
$activate_read_write_in_device: Boolean,
$connection_type: DeviceConnectionType,
$device_bluetooth: OnboardingDeviceBluetoothMode,
$device_mode: ProfileDeviceModeClassArg,
$id: ID!,
$km_at_installation: Int
) {
onboarding_vehicle_connection(
activate_read_write_in_device: $activate_read_write_in_device,
connection_type: $connection_type,
device_bluetooth: $device_bluetooth,
device_mode: $device_mode,
id: $id,
km_at_installation: $km_at_installation
)
}
Variables
{
"activate_read_write_in_device": false,
"connection_type": "CABLE",
"device_bluetooth": "DEFAULT_MODE",
"device_mode": "TELEMATIC",
"id": 4,
"km_at_installation": 123
}
Response
{
"data": {
"onboarding_vehicle_connection": "4"
}
}
onboarding_vehicle_connection_update
Description
Set vehicle connection of an onboarding request
Response
Returns an OnboardingVehicleConnection
Arguments
| Name | Description |
|---|---|
activate_read_write_in_device - Boolean
|
Enable writing or leave read-only |
connection_type - DeviceConnectionType
|
Connection type |
device_bluetooth - OnboardingDeviceBluetoothMode
|
Specify device bluetooth mode |
device_mode - ProfileDeviceModeClassArg
|
Specify device mode |
id - ID!
|
Id of existing onboarding request |
km_at_installation - Int
|
Vehicle mileage (km) at installation |
Example
Query
mutation onboarding_vehicle_connection_update(
$activate_read_write_in_device: Boolean,
$connection_type: DeviceConnectionType,
$device_bluetooth: OnboardingDeviceBluetoothMode,
$device_mode: ProfileDeviceModeClassArg,
$id: ID!,
$km_at_installation: Int
) {
onboarding_vehicle_connection_update(
activate_read_write_in_device: $activate_read_write_in_device,
connection_type: $connection_type,
device_bluetooth: $device_bluetooth,
device_mode: $device_mode,
id: $id,
km_at_installation: $km_at_installation
) {
activate_read_write_in_device
connection_type
device_bluetooth
device_mode
id
km_at_installation
}
}
Variables
{
"activate_read_write_in_device": false,
"connection_type": "CABLE",
"device_bluetooth": "DEFAULT_MODE",
"device_mode": "TELEMATIC",
"id": "4",
"km_at_installation": 987
}
Response
{
"data": {
"onboarding_vehicle_connection_update": {
"activate_read_write_in_device": false,
"connection_type": "CABLE",
"device_bluetooth": "DEFAULT_MODE",
"device_mode": "OTHER",
"id": 4,
"km_at_installation": 123
}
}
}
onboarding_vehicle_create
Description
Create vehicle for onboarding request
Response
Returns an ID
Example
Query
mutation onboarding_vehicle_create(
$id: ID!,
$label: String,
$plate_number: String,
$vin: String
) {
onboarding_vehicle_create(
id: $id,
label: $label,
plate_number: $plate_number,
vin: $vin
)
}
Variables
{
"id": "4",
"label": "xyz789",
"plate_number": "xyz789",
"vin": "xyz789"
}
Response
{"data": {"onboarding_vehicle_create": "4"}}
onboarding_vehicle_enrichment
Description
Add vehicle information to onboarding request
Response
Returns an OnboardingVehicle
Arguments
| Name | Description |
|---|---|
ac_is_remote_controlled - Boolean
|
|
alarm_is_present - Boolean
|
|
brand - String
|
The vehicle's brand |
brand_model - String
|
The vehicle's model |
color - String
|
Color of the vehicle |
connectivity - String
|
|
ev_plug_position - String
|
|
ev_plug_type - String
|
|
front_brake_installation - String
|
Odometer (km) at last front brake change |
front_brake_wear - String
|
|
front_tire_installation - String
|
Odometer (km) at last front tires change |
front_tire_wear - String
|
|
fuel_type - OnboardingEnergyTypeArg
|
|
fuel_type_secondary - OnboardingEnergyTypeArg
|
|
id - ID!
|
Id of existing onboarding request |
kba - ID
|
Kraftfahrbundesamt (Germany and Austria) |
last_date_battery_changed - DateTime
|
Date of last battery change |
model_id - ID
|
Vehicle model id. Fetched from AppStore api, or created if == -1 |
rear_brake_installation - String
|
Odometer (km) at last rear brake change |
rear_brake_wear - String
|
|
rear_tire_installation - String
|
Odometer (km) at last rear tires change |
rear_tire_wear - String
|
|
tank_size - Int
|
Tank size (l), -1 if unknown |
tyres_type - TyreTypeArg
|
|
vehicle_type - VehicleTypeName
|
Vehicle type |
year_of_first_circulation - Int
|
Example
Query
mutation onboarding_vehicle_enrichment(
$ac_is_remote_controlled: Boolean,
$alarm_is_present: Boolean,
$brand: String,
$brand_model: String,
$color: String,
$connectivity: String,
$ev_plug_position: String,
$ev_plug_type: String,
$front_brake_installation: String,
$front_brake_wear: String,
$front_tire_installation: String,
$front_tire_wear: String,
$fuel_type: OnboardingEnergyTypeArg,
$fuel_type_secondary: OnboardingEnergyTypeArg,
$id: ID!,
$kba: ID,
$last_date_battery_changed: DateTime,
$model_id: ID,
$rear_brake_installation: String,
$rear_brake_wear: String,
$rear_tire_installation: String,
$rear_tire_wear: String,
$tank_size: Int,
$tyres_type: TyreTypeArg,
$vehicle_type: VehicleTypeName,
$year_of_first_circulation: Int
) {
onboarding_vehicle_enrichment(
ac_is_remote_controlled: $ac_is_remote_controlled,
alarm_is_present: $alarm_is_present,
brand: $brand,
brand_model: $brand_model,
color: $color,
connectivity: $connectivity,
ev_plug_position: $ev_plug_position,
ev_plug_type: $ev_plug_type,
front_brake_installation: $front_brake_installation,
front_brake_wear: $front_brake_wear,
front_tire_installation: $front_tire_installation,
front_tire_wear: $front_tire_wear,
fuel_type: $fuel_type,
fuel_type_secondary: $fuel_type_secondary,
id: $id,
kba: $kba,
last_date_battery_changed: $last_date_battery_changed,
model_id: $model_id,
rear_brake_installation: $rear_brake_installation,
rear_brake_wear: $rear_brake_wear,
rear_tire_installation: $rear_tire_installation,
rear_tire_wear: $rear_tire_wear,
tank_size: $tank_size,
tyres_type: $tyres_type,
vehicle_type: $vehicle_type,
year_of_first_circulation: $year_of_first_circulation
) {
ac_is_remote_controlled
alarm_is_present
brand
brand_model
color
connectivity
ev_plug_position
ev_plug_type
front_brake_installation
front_brake_wear
front_tire_installation
front_tire_wear
fuel_type
fuel_type_secondary
kba
last_date_battery_changed
model_id
rear_brake_installation
rear_brake_wear
rear_tire_installation
rear_tire_wear
tank_size
tyres_type
vehicle_type
vin_descriptions {
...DecodeVinResultFragment
}
year_of_first_circulation
}
}
Variables
{
"ac_is_remote_controlled": true,
"alarm_is_present": true,
"brand": "abc123",
"brand_model": "xyz789",
"color": "abc123",
"connectivity": "abc123",
"ev_plug_position": "abc123",
"ev_plug_type": "abc123",
"front_brake_installation": "xyz789",
"front_brake_wear": "abc123",
"front_tire_installation": "abc123",
"front_tire_wear": "abc123",
"fuel_type": "DIESEL",
"fuel_type_secondary": "DIESEL",
"id": 4,
"kba": "4",
"last_date_battery_changed": "2007-12-03T10:15:30Z",
"model_id": 4,
"rear_brake_installation": "xyz789",
"rear_brake_wear": "xyz789",
"rear_tire_installation": "xyz789",
"rear_tire_wear": "abc123",
"tank_size": 987,
"tyres_type": "ALL_SEASONS",
"vehicle_type": "CAR",
"year_of_first_circulation": 123
}
Response
{
"data": {
"onboarding_vehicle_enrichment": {
"ac_is_remote_controlled": false,
"alarm_is_present": false,
"brand": "abc123",
"brand_model": "xyz789",
"color": "abc123",
"connectivity": "abc123",
"ev_plug_position": "xyz789",
"ev_plug_type": "abc123",
"front_brake_installation": "xyz789",
"front_brake_wear": "xyz789",
"front_tire_installation": "xyz789",
"front_tire_wear": "abc123",
"fuel_type": "ADBLUE",
"fuel_type_secondary": "ADBLUE",
"kba": "4",
"last_date_battery_changed": "2007-12-03T10:15:30Z",
"model_id": "4",
"rear_brake_installation": "abc123",
"rear_brake_wear": "xyz789",
"rear_tire_installation": "abc123",
"rear_tire_wear": "abc123",
"tank_size": 987,
"tyres_type": "ALL_SEASONS",
"vehicle_type": "CAR",
"vin_descriptions": DecodeVinResult,
"year_of_first_circulation": 123
}
}
}
onboarding_vehicle_update
Description
Upate vehicle for onboarding request
Response
Returns an ID
Example
Query
mutation onboarding_vehicle_update(
$id: ID!,
$plate_number: String,
$vehicle_creation_id: ID!,
$vin: String
) {
onboarding_vehicle_update(
id: $id,
plate_number: $plate_number,
vehicle_creation_id: $vehicle_creation_id,
vin: $vin
)
}
Variables
{
"id": 4,
"plate_number": "abc123",
"vehicle_creation_id": 4,
"vin": "abc123"
}
Response
{"data": {"onboarding_vehicle_update": 4}}
partner_create
Response
Returns an OnboardingPartner
Example
Query
mutation partner_create(
$name: String!,
$organisation_id: ID!,
$project_id: ID
) {
partner_create(
name: $name,
organisation_id: $organisation_id,
project_id: $project_id
) {
id
name
organization_id
project {
...ProjectFragment
}
providers {
...OnboardingProviderPagedFragment
}
}
}
Variables
{
"name": "abc123",
"organisation_id": 4,
"project_id": 4
}
Response
{
"data": {
"partner_create": {
"id": "4",
"name": "abc123",
"organization_id": "4",
"project": Project,
"providers": OnboardingProviderPaged
}
}
}
partner_update
Response
Returns an OnboardingPartner
Example
Query
mutation partner_update(
$emails: [String!],
$id: ID!
) {
partner_update(
emails: $emails,
id: $id
) {
id
name
organization_id
project {
...ProjectFragment
}
providers {
...OnboardingProviderPagedFragment
}
}
}
Variables
{"emails": ["abc123"], "id": 4}
Response
{
"data": {
"partner_update": {
"id": 4,
"name": "xyz789",
"organization_id": "4",
"project": Project,
"providers": OnboardingProviderPaged
}
}
}
password_reset
Description
Set new password using reset token
Response
Returns a Boolean
Example
Query
mutation password_reset(
$password: String!,
$token: String!
) {
password_reset(
password: $password,
token: $token
)
}
Variables
{
"password": "abc123",
"token": "abc123"
}
Response
{"data": {"password_reset": true}}
password_reset_token
Description
Request password reset (token will be sent via side channel)
Response
Returns an ID
Arguments
| Name | Description |
|---|---|
channel - PasswordResetChannel!
|
Side channel type |
id - ID!
|
Side channel id |
Example
Query
mutation password_reset_token(
$channel: PasswordResetChannel!,
$id: ID!
) {
password_reset_token(
channel: $channel,
id: $id
)
}
Variables
{"channel": "EMAIL", "id": "4"}
Response
{"data": {"password_reset_token": 4}}
post_driver_auxiliary_devices
Description
Method:
POSTBase URL:{env.ASSET_MANAGER_API}Path:/v1/drivers/{args.driver_id}/auxiliary_devices
[beta] create a new auxilary device
Response
Returns a post_driver_auxiliary_devices_response
Arguments
| Name | Description |
|---|---|
driver_id - String!
|
Driver ID |
input - auxiliary_device_create_Input
|
Example
Query
mutation post_driver_auxiliary_devices(
$driver_id: String!,
$input: auxiliary_device_create_Input
) {
post_driver_auxiliary_devices(
driver_id: $driver_id,
input: $input
) {
... on auxiliary_device_show {
...auxiliary_device_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"driver_id": "xyz789",
"input": auxiliary_device_create_Input
}
Response
{
"data": {
"post_driver_auxiliary_devices": auxiliary_device_show
}
}
post_organization
Description
Method:
POSTBase URL:{env.MUNIC_CONNECT_API}Path:/api/v2/organizations
[alpha] Post Organization
Response
Returns a post_organization_response
Arguments
| Name | Description |
|---|---|
input - organization_encapsulated_post_Input
|
Example
Query
mutation post_organization($input: organization_encapsulated_post_Input) {
post_organization(input: $input) {
... on organization_encapsulated {
...organization_encapsulatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"input": organization_encapsulated_post_Input}
Response
{"data": {"post_organization": organization_encapsulated}}
post_user_unlock_requests
Description
Method:
POSTBase URL:{env.MUNIC_CONNECT_API}Path:/api/v2/user_unlock_requests
[alpha] Request a user unlock
Response
Returns a post_user_unlock_requests_response
Arguments
| Name | Description |
|---|---|
input - user_unlock_request_create_Input
|
Example
Query
mutation post_user_unlock_requests($input: user_unlock_request_create_Input) {
post_user_unlock_requests(input: $input) {
... on user_unlock_request_show {
...user_unlock_request_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"input": user_unlock_request_create_Input}
Response
{
"data": {
"post_user_unlock_requests": user_unlock_request_show
}
}
post_user_unlocks
Description
Method:
POSTBase URL:{env.MUNIC_CONNECT_API}Path:/api/v2/user_unlocks
[alpha] Request a user unlock
Response
Returns a post_user_unlocks_response
Arguments
| Name | Description |
|---|---|
input - user_unlock_create_Input
|
Example
Query
mutation post_user_unlocks($input: user_unlock_create_Input) {
post_user_unlocks(input: $input) {
... on user_unlock_show {
...user_unlock_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"input": user_unlock_create_Input}
Response
{"data": {"post_user_unlocks": user_unlock_show}}
post_v1_user_alert_notifications
Description
Method:
POSTBase URL:{env.VEHICLE_ALERTS_API}Path:/v1/user_alert_notifications
[alpha] Create user_alert_notification
Response
Arguments
| Name | Description |
|---|---|
input - post_user_alert_notification_Input
|
Example
Query
mutation post_v1_user_alert_notifications($input: post_user_alert_notification_Input) {
post_v1_user_alert_notifications(input: $input) {
... on fetch_user_alert_notification_encapsulated {
...fetch_user_alert_notification_encapsulatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{"input": post_user_alert_notification_Input}
Response
{
"data": {
"post_v1_user_alert_notifications": fetch_user_alert_notification_encapsulated
}
}
post_vehicle_auxiliary_devices
Description
Method:
POSTBase URL:{env.ASSET_MANAGER_API}Path:/v1/vehicles/{args.vehicle_id}/auxiliary_devices
[beta] create a new auxilary device
Response
Returns a post_vehicle_auxiliary_devices_response
Arguments
| Name | Description |
|---|---|
vehicle_id - String!
|
Vehicle ID |
input - auxiliary_device_create_Input
|
Example
Query
mutation post_vehicle_auxiliary_devices(
$vehicle_id: String!,
$input: auxiliary_device_create_Input
) {
post_vehicle_auxiliary_devices(
vehicle_id: $vehicle_id,
input: $input
) {
... on auxiliary_device_show {
...auxiliary_device_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"vehicle_id": "abc123",
"input": auxiliary_device_create_Input
}
Response
{
"data": {
"post_vehicle_auxiliary_devices": auxiliary_device_show
}
}
project_create
Description
Create a new project
Response
Returns a Project
Example
Query
mutation project_create(
$label: String!,
$owner_id: ID
) {
project_create(
label: $label,
owner_id: $owner_id
) {
id
devices {
...DevicePagedFragment
}
drivers {
...DriverPagedFragment
}
groups {
...GroupPagedFragment
}
label
owner {
...AccountFragment
}
users {
...AccountPagedFragment
}
vehicles {
...VehiclePagedFragment
}
}
}
Variables
{
"label": "xyz789",
"owner_id": "4"
}
Response
{
"data": {
"project_create": {
"id": "4",
"devices": DevicePaged,
"drivers": DriverPaged,
"groups": GroupPaged,
"label": "xyz789",
"owner": Account,
"users": AccountPaged,
"vehicles": VehiclePaged
}
}
}
project_delete
Description
Delete project
project_update
Description
Update project fields
Response
Returns a Project
Example
Query
mutation project_update(
$id: ID!,
$label: String,
$owner_id: ID
) {
project_update(
id: $id,
label: $label,
owner_id: $owner_id
) {
id
devices {
...DevicePagedFragment
}
drivers {
...DriverPagedFragment
}
groups {
...GroupPagedFragment
}
label
owner {
...AccountFragment
}
users {
...AccountPagedFragment
}
vehicles {
...VehiclePagedFragment
}
}
}
Variables
{"id": 4, "label": "xyz789", "owner_id": 4}
Response
{
"data": {
"project_update": {
"id": "4",
"devices": DevicePaged,
"drivers": DriverPaged,
"groups": GroupPaged,
"label": "xyz789",
"owner": Account,
"users": AccountPaged,
"vehicles": VehiclePaged
}
}
}
project_update_members
Response
Returns an ID
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of project being modified |
ids - [ID]!
|
Ids of members being add/remove to/from project |
op - MemberOperation!
|
Add or remove |
type - ProjectMember!
|
Member type |
Example
Query
mutation project_update_members(
$id: ID!,
$ids: [ID]!,
$op: MemberOperation!,
$type: ProjectMember!
) {
project_update_members(
id: $id,
ids: $ids,
op: $op,
type: $type
)
}
Variables
{
"id": "4",
"ids": [4],
"op": "ADD",
"type": "DEVICE"
}
Response
{"data": {"project_update_members": 4}}
provider_create
Response
Returns an OnboardingProvider
Example
Query
mutation provider_create(
$emails: [String!],
$name: String!,
$partner_id: ID!,
$send_poke: Boolean
) {
provider_create(
emails: $emails,
name: $name,
partner_id: $partner_id,
send_poke: $send_poke
) {
emails
id
munic_support_emails
name
partner {
...OnboardingPartnerFragment
}
send_poke
}
}
Variables
{
"emails": ["abc123"],
"name": "abc123",
"partner_id": "4",
"send_poke": false
}
Response
{
"data": {
"provider_create": {
"emails": ["xyz789"],
"id": "4",
"munic_support_emails": ["xyz789"],
"name": "abc123",
"partner": OnboardingPartner,
"send_poke": false
}
}
}
provider_update
Response
Returns an OnboardingProvider
Example
Query
mutation provider_update(
$emails: [String!],
$id: ID!
) {
provider_update(
emails: $emails,
id: $id
) {
emails
id
munic_support_emails
name
partner {
...OnboardingPartnerFragment
}
send_poke
}
}
Variables
{"emails": ["xyz789"], "id": 4}
Response
{
"data": {
"provider_update": {
"emails": ["xyz789"],
"id": "4",
"munic_support_emails": ["xyz789"],
"name": "abc123",
"partner": OnboardingPartner,
"send_poke": true
}
}
}
put_driver_auxiliary_device
Description
Method:
PUTBase URL:{env.ASSET_MANAGER_API}Path:/v1/drivers/{args.driver_id}/auxiliary_devices/{args.aux_id}
[beta] update auxiliary device info
Response
Returns a put_driver_auxiliary_device_response
Arguments
| Name | Description |
|---|---|
driver_id - String!
|
Driver ID |
aux_id - String!
|
Auxiliary Device ID |
input - auxiliary_device_update_Input
|
Example
Query
mutation put_driver_auxiliary_device(
$driver_id: String!,
$aux_id: String!,
$input: auxiliary_device_update_Input
) {
put_driver_auxiliary_device(
driver_id: $driver_id,
aux_id: $aux_id,
input: $input
) {
... on auxiliary_device_show {
...auxiliary_device_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"driver_id": "xyz789",
"aux_id": "xyz789",
"input": auxiliary_device_update_Input
}
Response
{
"data": {
"put_driver_auxiliary_device": auxiliary_device_show
}
}
put_v1_user_alert_notifications_by_id
Description
Method:
PUTBase URL:{env.VEHICLE_ALERTS_API}Path:/v1/user_alert_notifications/{args.id}
[alpha] Update user_alert_notification
Response
Arguments
| Name | Description |
|---|---|
id - String!
|
User Alert Notification id |
input - put_user_alert_notification_Input
|
Example
Query
mutation put_v1_user_alert_notifications_by_id(
$id: String!,
$input: put_user_alert_notification_Input
) {
put_v1_user_alert_notifications_by_id(
id: $id,
input: $input
) {
... on fetch_user_alert_notification_encapsulated {
...fetch_user_alert_notification_encapsulatedFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"id": "abc123",
"input": put_user_alert_notification_Input
}
Response
{
"data": {
"put_v1_user_alert_notifications_by_id": fetch_user_alert_notification_encapsulated
}
}
put_vehicle_auxiliary_device
Description
Method:
PUTBase URL:{env.ASSET_MANAGER_API}Path:/v1/vehicles/{args.vehicle_id}/auxiliary_devices/{args.aux_id}
[beta] update auxiliary device info
Response
Returns a put_vehicle_auxiliary_device_response
Arguments
| Name | Description |
|---|---|
vehicle_id - String!
|
Vehicle ID |
aux_id - String!
|
Auxiliary Device ID |
input - auxiliary_device_update_Input
|
Example
Query
mutation put_vehicle_auxiliary_device(
$vehicle_id: String!,
$aux_id: String!,
$input: auxiliary_device_update_Input
) {
put_vehicle_auxiliary_device(
vehicle_id: $vehicle_id,
aux_id: $aux_id,
input: $input
) {
... on auxiliary_device_show {
...auxiliary_device_showFragment
}
... on errors {
...errorsFragment
}
}
}
Variables
{
"vehicle_id": "abc123",
"aux_id": "abc123",
"input": auxiliary_device_update_Input
}
Response
{
"data": {
"put_vehicle_auxiliary_device": auxiliary_device_show
}
}
quotation_create
Description
Create quotation
Response
Returns a Quotation
Example
Query
mutation quotation_create(
$maintenance_code: String!,
$plate_number: String!,
$workshop_id: ID!
) {
quotation_create(
maintenance_code: $maintenance_code,
plate_number: $plate_number,
workshop_id: $workshop_id
) {
id
booking_id
currency
maintenance_code
plate_number
price
provider_quotation_id
taxes
taxes_price
workshop {
...WorkshopFragment
}
}
}
Variables
{
"maintenance_code": "xyz789",
"plate_number": "xyz789",
"workshop_id": "4"
}
Response
{
"data": {
"quotation_create": {
"id": 4,
"booking_id": 4,
"currency": "xyz789",
"maintenance_code": "xyz789",
"plate_number": "xyz789",
"price": 123,
"provider_quotation_id": "4",
"taxes": 987,
"taxes_price": 987,
"workshop": Workshop
}
}
}
rating_create
Description
Create rating
Response
Returns a Rating
Example
Query
mutation rating_create(
$booking_id: ID,
$message: String,
$stars: Int,
$workshop_id: ID
) {
rating_create(
booking_id: $booking_id,
message: $message,
stars: $stars,
workshop_id: $workshop_id
) {
id
booking {
...BookingFragment
}
created_at
message
response
response_date
stars
status
workshop {
...WorkshopFragment
}
}
}
Variables
{
"booking_id": 4,
"message": "abc123",
"stars": 987,
"workshop_id": "4"
}
Response
{
"data": {
"rating_create": {
"id": "4",
"booking": Booking,
"created_at": "2007-12-03T10:15:30Z",
"message": "abc123",
"response": "abc123",
"response_date": "2007-12-03T10:15:30Z",
"stars": 123,
"status": "NOT_VERIFIED",
"workshop": Workshop
}
}
}
rating_delete
Description
Delete rating
rating_update
Description
Update rating
Response
Returns a Rating
Example
Query
mutation rating_update(
$booking_id: ID,
$id: ID!,
$message: String,
$stars: Int
) {
rating_update(
booking_id: $booking_id,
id: $id,
message: $message,
stars: $stars
) {
id
booking {
...BookingFragment
}
created_at
message
response
response_date
stars
status
workshop {
...WorkshopFragment
}
}
}
Variables
{
"booking_id": "4",
"id": "4",
"message": "abc123",
"stars": 123
}
Response
{
"data": {
"rating_update": {
"id": 4,
"booking": Booking,
"created_at": "2007-12-03T10:15:30Z",
"message": "xyz789",
"response": "abc123",
"response_date": "2007-12-03T10:15:30Z",
"stars": 987,
"status": "NOT_VERIFIED",
"workshop": Workshop
}
}
}
rdc_ekko_initialize
Description
Initialize Ekko
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
device_id - ID!
|
Device id |
displacement - Int
|
Displacement |
energy_type - EnergyType
|
Energy type |
odometer - Int
|
Odometer (km) |
vin - String
|
Vehicle Identification Number |
Example
Query
mutation rdc_ekko_initialize(
$device_id: ID!,
$displacement: Int,
$energy_type: EnergyType,
$odometer: Int,
$vin: String
) {
rdc_ekko_initialize(
device_id: $device_id,
displacement: $displacement,
energy_type: $energy_type,
odometer: $odometer,
vin: $vin
) {
attributes
id
type
}
}
Variables
{
"device_id": 4,
"displacement": 987,
"energy_type": "ADBLUE",
"odometer": 123,
"vin": "xyz789"
}
Response
{
"data": {
"rdc_ekko_initialize": {
"attributes": Json,
"id": 4,
"type": "abc123"
}
}
}
rdc_gps_toggle
Description
Temporarily stop gps tracking
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
action - ToggleAction!
|
Start/Stop |
device_id - ID!
|
Device id |
duration - Int!
|
Duration (minutes) |
Example
Query
mutation rdc_gps_toggle(
$action: ToggleAction!,
$device_id: ID!,
$duration: Int!
) {
rdc_gps_toggle(
action: $action,
device_id: $device_id,
duration: $duration
) {
attributes
id
type
}
}
Variables
{"action": "START", "device_id": 4, "duration": 123}
Response
{
"data": {
"rdc_gps_toggle": {
"attributes": Json,
"id": 4,
"type": "xyz789"
}
}
}
rdc_post_doors_toggle_requests
Description
Method:
POSTBase URL:{env.REMOTE_DEVICE_COMMAND_API}Path:/v1/public/doors/requests/togglesToggle Doors sms
Response
Returns a doors_toggle_request_show
Arguments
| Name | Description |
|---|---|
input - doors_toggle_request_create_Input
|
Example
Query
mutation rdc_post_doors_toggle_requests($input: doors_toggle_request_create_Input) {
rdc_post_doors_toggle_requests(input: $input) {
data {
...doors_toggle_requestFragment
}
}
}
Variables
{"input": doors_toggle_request_create_Input}
Response
{
"data": {
"rdc_post_doors_toggle_requests": {
"data": doors_toggle_request
}
}
}
rdc_post_engine_immobilizer_requests
Description
Method:
POSTBase URL:{env.REMOTE_DEVICE_COMMAND_API}Path:/v1/public/engine/requests/immobilizersEngine immobilizers
Response
Returns an engine_immobilizer_request_show
Arguments
| Name | Description |
|---|---|
input - engine_immobilizer_request_create_Input
|
Example
Query
mutation rdc_post_engine_immobilizer_requests($input: engine_immobilizer_request_create_Input) {
rdc_post_engine_immobilizer_requests(input: $input) {
data {
...engine_immobilizer_requestFragment
}
}
}
Variables
{"input": engine_immobilizer_request_create_Input}
Response
{
"data": {
"rdc_post_engine_immobilizer_requests": {
"data": engine_immobilizer_request
}
}
}
rdc_system_reboot
Description
Reboot the device
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
device_id - ID!
|
Device id |
Example
Query
mutation rdc_system_reboot($device_id: ID!) {
rdc_system_reboot(device_id: $device_id) {
attributes
id
type
}
}
Variables
{"device_id": 4}
Response
{
"data": {
"rdc_system_reboot": {
"attributes": Json,
"id": "4",
"type": "abc123"
}
}
}
remote_diag_action_create
Response
Returns a RemoteDiagAction
Arguments
| Name | Description |
|---|---|
action - RemoteDiagActionTypeArg!
|
Action type |
ecus - [ID!]
|
Selected ECUs by id |
pids - [ID!]
|
Selected parameters by id |
pids_names - [String!]
|
Selected parameters by name |
remote_diag_id - ID!
|
Id of remote diagnostic session |
Example
Query
mutation remote_diag_action_create(
$action: RemoteDiagActionTypeArg!,
$ecus: [ID!],
$pids: [ID!],
$pids_names: [String!],
$remote_diag_id: ID!
) {
remote_diag_action_create(
action: $action,
ecus: $ecus,
pids: $pids,
pids_names: $pids_names,
remote_diag_id: $remote_diag_id
) {
created_at
dtcs {
...RemoteDiagResultDtcPagedFragment
}
ecus
failure_reason
id
pids
progress
snapshots {
...RemoteDiagResultSnapshotPagedFragment
}
status
supported_parameters {
...RemoteDiagSupportedParameterPagedFragment
}
type
updated_at
}
}
Variables
{
"action": "CANCEL_LIVE_PARAMETERS",
"ecus": [4],
"pids": [4],
"pids_names": ["abc123"],
"remote_diag_id": "4"
}
Response
{
"data": {
"remote_diag_action_create": {
"created_at": "2007-12-03T10:15:30Z",
"dtcs": RemoteDiagResultDtcPaged,
"ecus": ["4"],
"failure_reason": "xyz789",
"id": 4,
"pids": [4],
"progress": 123.45,
"snapshots": RemoteDiagResultSnapshotPaged,
"status": "ABORT",
"supported_parameters": RemoteDiagSupportedParameterPaged,
"type": "OTHER",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
remote_diag_action_update
Response
Returns a RemoteDiagAction
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
status - RemoteDiagActionStatusArg!
|
Example
Query
mutation remote_diag_action_update(
$id: ID!,
$status: RemoteDiagActionStatusArg!
) {
remote_diag_action_update(
id: $id,
status: $status
) {
created_at
dtcs {
...RemoteDiagResultDtcPagedFragment
}
ecus
failure_reason
id
pids
progress
snapshots {
...RemoteDiagResultSnapshotPagedFragment
}
status
supported_parameters {
...RemoteDiagSupportedParameterPagedFragment
}
type
updated_at
}
}
Variables
{"id": "4", "status": "ABORT"}
Response
{
"data": {
"remote_diag_action_update": {
"created_at": "2007-12-03T10:15:30Z",
"dtcs": RemoteDiagResultDtcPaged,
"ecus": [4],
"failure_reason": "xyz789",
"id": 4,
"pids": ["4"],
"progress": 123.45,
"snapshots": RemoteDiagResultSnapshotPaged,
"status": "ABORT",
"supported_parameters": RemoteDiagSupportedParameterPaged,
"type": "OTHER",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
remote_diag_cancel
Description
Close a remote diagnostic session
Response
Returns a RemoteDiag
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of remote diagnostic session |
Example
Query
mutation remote_diag_cancel($id: ID!) {
remote_diag_cancel(id: $id) {
id
actions {
...RemoteDiagActionPagedFragment
}
created_at
current_step
language
provider_name
result {
...RemoteDiagResultFragment
}
status
steps {
...RemoteDiagStepPagedFragment
}
updated_at
vci {
...RemoteDiagEndpointFragment
}
vud {
...RemoteDiagEndpointFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"remote_diag_cancel": {
"id": "4",
"actions": RemoteDiagActionPaged,
"created_at": "2007-12-03T10:15:30Z",
"current_step": "OTHER",
"language": Language,
"provider_name": "abc123",
"result": RemoteDiagResult,
"status": "xyz789",
"steps": RemoteDiagStepPaged,
"updated_at": "2007-12-03T10:15:30Z",
"vci": RemoteDiagEndpoint,
"vud": RemoteDiagEndpoint
}
}
}
remote_diag_create
Description
Setup a remote diagnostic session
Response
Returns a RemoteDiag
Example
Query
mutation remote_diag_create(
$language: Language,
$provider_name: String,
$vin: String,
$vud_device_id: ID!
) {
remote_diag_create(
language: $language,
provider_name: $provider_name,
vin: $vin,
vud_device_id: $vud_device_id
) {
id
actions {
...RemoteDiagActionPagedFragment
}
created_at
current_step
language
provider_name
result {
...RemoteDiagResultFragment
}
status
steps {
...RemoteDiagStepPagedFragment
}
updated_at
vci {
...RemoteDiagEndpointFragment
}
vud {
...RemoteDiagEndpointFragment
}
}
}
Variables
{
"language": Language,
"provider_name": "xyz789",
"vin": "xyz789",
"vud_device_id": "4"
}
Response
{
"data": {
"remote_diag_create": {
"id": "4",
"actions": RemoteDiagActionPaged,
"created_at": "2007-12-03T10:15:30Z",
"current_step": "OTHER",
"language": Language,
"provider_name": "abc123",
"result": RemoteDiagResult,
"status": "xyz789",
"steps": RemoteDiagStepPaged,
"updated_at": "2007-12-03T10:15:30Z",
"vci": RemoteDiagEndpoint,
"vud": RemoteDiagEndpoint
}
}
}
remote_diag_start
Description
Start the remote diagnostic session
Response
Returns a RemoteDiag
Arguments
| Name | Description |
|---|---|
country_specific_id - CountrySpecificIdArg
|
Custom country-specific id |
id - ID!
|
Id of remote diagnostic session |
should_validate_vin - Boolean
|
|
vci - ID
|
Custom VCI (Vehicle Communication Interface device). Should only be specified at the first READ_DTC action |
vin - String
|
Custom VIN |
Example
Query
mutation remote_diag_start(
$country_specific_id: CountrySpecificIdArg,
$id: ID!,
$should_validate_vin: Boolean,
$vci: ID,
$vin: String
) {
remote_diag_start(
country_specific_id: $country_specific_id,
id: $id,
should_validate_vin: $should_validate_vin,
vci: $vci,
vin: $vin
) {
id
actions {
...RemoteDiagActionPagedFragment
}
created_at
current_step
language
provider_name
result {
...RemoteDiagResultFragment
}
status
steps {
...RemoteDiagStepPagedFragment
}
updated_at
vci {
...RemoteDiagEndpointFragment
}
vud {
...RemoteDiagEndpointFragment
}
}
}
Variables
{
"country_specific_id": CountrySpecificIdArg,
"id": "4",
"should_validate_vin": false,
"vci": "4",
"vin": "abc123"
}
Response
{
"data": {
"remote_diag_start": {
"id": 4,
"actions": RemoteDiagActionPaged,
"created_at": "2007-12-03T10:15:30Z",
"current_step": "OTHER",
"language": Language,
"provider_name": "xyz789",
"result": RemoteDiagResult,
"status": "abc123",
"steps": RemoteDiagStepPaged,
"updated_at": "2007-12-03T10:15:30Z",
"vci": RemoteDiagEndpoint,
"vud": RemoteDiagEndpoint
}
}
}
remote_diagnostic_put_action
Description
Method:
PUTBase URL:{env.REMOTE_DIAGNOSTIC_API}Path:/v1/actions/{args.id}Update Action
Response
Returns an action_show
Arguments
| Name | Description |
|---|---|
id - String!
|
Action id |
input - action_put_Input
|
Example
Query
mutation remote_diagnostic_put_action(
$id: String!,
$input: action_put_Input
) {
remote_diagnostic_put_action(
id: $id,
input: $input
) {
data {
...actionFragment
}
}
}
Variables
{
"id": "xyz789",
"input": action_put_Input
}
Response
{
"data": {
"remote_diagnostic_put_action": {"data": action}
}
}
ticket_create
Description
Create support ticket
Response
Returns a Ticket
Arguments
| Name | Description |
|---|---|
body - String
|
|
source - TicketSource!
|
|
title - String!
|
Example
Query
mutation ticket_create(
$body: String,
$source: TicketSource!,
$title: String!
) {
ticket_create(
body: $body,
source: $source,
title: $title
) {
account {
...AccountFragment
}
created_at
id
source
title
}
}
Variables
{
"body": "xyz789",
"source": "ONBOARDING",
"title": "xyz789"
}
Response
{
"data": {
"ticket_create": {
"account": Account,
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"source": "ONBOARDING",
"title": "abc123"
}
}
}
towing_session_start
Description
Start a vehicle towing session
Response
Returns a TowingSession
Example
Query
mutation towing_session_start(
$start_at: DateTime,
$towing_vehicle_id: ID!,
$trailer_vehicle_id: ID!
) {
towing_session_start(
start_at: $start_at,
towing_vehicle_id: $towing_vehicle_id,
trailer_vehicle_id: $trailer_vehicle_id
) {
closed_by {
...AccountFragment
}
created_by {
...AccountFragment
}
end_at
id
start_at
towing_vehicle {
...VehicleFragment
}
trailer_vehicle {
...VehicleFragment
}
}
}
Variables
{
"start_at": "2007-12-03T10:15:30Z",
"towing_vehicle_id": "4",
"trailer_vehicle_id": "4"
}
Response
{
"data": {
"towing_session_start": {
"closed_by": Account,
"created_by": Account,
"end_at": "2007-12-03T10:15:30Z",
"id": 4,
"start_at": "2007-12-03T10:15:30Z",
"towing_vehicle": Vehicle,
"trailer_vehicle": Vehicle
}
}
}
towing_session_stop
Description
Stop a driver vehicle session
Response
Returns a TowingSession
Example
Query
mutation towing_session_stop(
$end_at: DateTime!,
$id: ID!
) {
towing_session_stop(
end_at: $end_at,
id: $id
) {
closed_by {
...AccountFragment
}
created_by {
...AccountFragment
}
end_at
id
start_at
towing_vehicle {
...VehicleFragment
}
trailer_vehicle {
...VehicleFragment
}
}
}
Variables
{"end_at": "2007-12-03T10:15:30Z", "id": 4}
Response
{
"data": {
"towing_session_stop": {
"closed_by": Account,
"created_by": Account,
"end_at": "2007-12-03T10:15:30Z",
"id": 4,
"start_at": "2007-12-03T10:15:30Z",
"towing_vehicle": Vehicle,
"trailer_vehicle": Vehicle
}
}
}
update_metadatum
Description
Update metdatum
Response
Returns a TripMetadatum
Example
Query
mutation update_metadatum(
$id: ID!,
$key: String,
$value: String
) {
update_metadatum(
id: $id,
key: $key,
value: $value
) {
created_at
id
key
trip_id
updated_at
value
}
}
Variables
{
"id": 4,
"key": "xyz789",
"value": "xyz789"
}
Response
{
"data": {
"update_metadatum": {
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"key": "abc123",
"trip_id": 4,
"updated_at": "2007-12-03T10:15:30Z",
"value": "abc123"
}
}
}
vehicle_alert_create
Response
Returns a VehicleAlert
Arguments
| Name | Description |
|---|---|
device_id - ID
|
|
end_time - DateTime
|
|
language - LangArg!
|
Content language |
start_time - DateTime
|
|
status - VehicleAlertStatusArg!
|
|
type - VehicleAlertTypeArg!
|
|
vehicle_id - ID
|
Example
Query
mutation vehicle_alert_create(
$device_id: ID,
$end_time: DateTime,
$language: LangArg!,
$start_time: DateTime,
$status: VehicleAlertStatusArg!,
$type: VehicleAlertTypeArg!,
$vehicle_id: ID
) {
vehicle_alert_create(
device_id: $device_id,
end_time: $end_time,
language: $language,
start_time: $start_time,
status: $status,
type: $type,
vehicle_id: $vehicle_id
) {
aggregated_data {
...AggregatedDataFragment
}
created_at
device {
...DeviceFragment
}
feedback_status
feedbacks {
...VehicleAlertFeedbackPagedFragment
}
icon
id
language
last_received
last_reported
source
status
type
updated_at
vehicle {
...VehicleFragment
}
}
}
Variables
{
"device_id": 4,
"end_time": "2007-12-03T10:15:30Z",
"language": "EN",
"start_time": "2007-12-03T10:15:30Z",
"status": "CLOSED",
"type": "BAD_INSTALLATION",
"vehicle_id": "4"
}
Response
{
"data": {
"vehicle_alert_create": {
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"icon": "xyz789",
"id": "4",
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"source": "OTHER",
"status": "CLOSED",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
}
}
vehicle_alert_feedback_create
Response
Returns a VehicleAlertFeedback
Arguments
| Name | Description |
|---|---|
alert_id - ID!
|
|
description - String
|
|
language - LangArg
|
Description language |
status - VehicleAlertFeedbackStatusArg!
|
Example
Query
mutation vehicle_alert_feedback_create(
$alert_id: ID!,
$description: String,
$language: LangArg,
$status: VehicleAlertFeedbackStatusArg!
) {
vehicle_alert_feedback_create(
alert_id: $alert_id,
description: $description,
language: $language,
status: $status
) {
alert {
...VehicleAlertFragment
}
created_at
description
id
language
status
updated_at
}
}
Variables
{
"alert_id": 4,
"description": "xyz789",
"language": "EN",
"status": "CONFIRMED"
}
Response
{
"data": {
"vehicle_alert_feedback_create": {
"alert": VehicleAlert,
"created_at": "2007-12-03T10:15:30Z",
"description": "abc123",
"id": "4",
"language": "OTHER",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
vehicle_create
Description
Create a new vehicle owned by the logged-in user
Response
Returns a Vehicle
Arguments
| Name | Description |
|---|---|
fuel_type - String
|
Primary fuel type |
fuel_type_secondary - String
|
Secondary fuel type |
group_id - ID
|
group id to add the vehicle to |
kba - String
|
KBA |
ktype - String
|
KType |
label - String
|
Label |
make - String
|
Model make |
model - String
|
Model |
model_id - ID
|
Model ID |
owner_id - ID
|
OwnerID |
plate - String
|
Plate |
tags - [String]
|
Tags |
vin - String
|
Vin |
year - String
|
Model Year |
Example
Query
mutation vehicle_create(
$fuel_type: String,
$fuel_type_secondary: String,
$group_id: ID,
$kba: String,
$ktype: String,
$label: String,
$make: String,
$model: String,
$model_id: ID,
$owner_id: ID,
$plate: String,
$tags: [String],
$vin: String,
$year: String
) {
vehicle_create(
fuel_type: $fuel_type,
fuel_type_secondary: $fuel_type_secondary,
group_id: $group_id,
kba: $kba,
ktype: $ktype,
label: $label,
make: $make,
model: $model,
model_id: $model_id,
owner_id: $owner_id,
plate: $plate,
tags: $tags,
vin: $vin,
year: $year
) {
id
alerts {
...VehicleAlertPagedFragment
}
alerts_state {
...VehicleAlertsStateFragment
}
archived
can_be_towed
can_tow
current_device {
...DeviceFragment
}
current_devices {
...DevicePagedFragment
}
current_driver {
...DriverFragment
}
current_towing_session_as_towing_vehicle {
...TowingSessionFragment
}
current_towing_session_as_trailer_vehicle {
...TowingSessionFragment
}
current_towing_vehicle {
...VehicleFragment
}
current_trailer_vehicle {
...VehicleFragment
}
descriptions {
...DescriptionPagedFragment
}
doors_lock_status
doors_lock_status_updated_at
driver_sessions {
...DriverVehicleSessionPagedFragment
}
fuel_type
fuel_type_secondary
garage_mode_status
garage_mode_status_updated_at
groups {
...GroupPagedFragment
}
has_driver
hybrid
immobilizer_status
immobilizer_status_updated_at
kba
ktype
label
last_trip {
...TripFragment
}
maintenance_schedules {
...MaintenanceSchedulePagedFragment
}
maintenance_templates {
...MaintenanceTemplatePagedFragment
}
maintenances_historical {
...MaintenanceHistoricalPagedFragment
}
maintenances_upcoming {
...MaintenanceUpcomingPagedFragment
}
make
model
model_id
onboarded
owner {
...AccountFragment
}
plate
tags
towing_sessions_as_towing_vehicle {
...TowingSessionPagedFragment
}
towing_sessions_as_trailer_vehicle {
...TowingSessionPagedFragment
}
trips {
...TripPagedFragment
}
vehicle_type
vin
vin_descriptions {
...DecodeVinResultFragment
}
year
authorized_drivers {
... on vehicle_driver_paginated {
...vehicle_driver_paginatedFragment
}
... on errors {
...errorsFragment
}
}
auxiliary_devices {
... on auxiliary_device_paginated {
...auxiliary_device_paginatedFragment
}
... on errors {
...errorsFragment
}
}
auxiliary_device {
... on auxiliary_device_show {
...auxiliary_device_showFragment
}
... on errors {
...errorsFragment
}
}
refills {
... on refill_paged {
...refill_pagedFragment
}
... on errors {
...errorsFragment
}
}
refills_summary {
... on vehicle_summary_show {
...vehicle_summary_showFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{
"fuel_type": "abc123",
"fuel_type_secondary": "xyz789",
"group_id": "4",
"kba": "abc123",
"ktype": "abc123",
"label": "abc123",
"make": "abc123",
"model": "abc123",
"model_id": 4,
"owner_id": 4,
"plate": "xyz789",
"tags": ["abc123"],
"vin": "xyz789",
"year": "xyz789"
}
Response
{
"data": {
"vehicle_create": {
"id": 4,
"alerts": VehicleAlertPaged,
"alerts_state": VehicleAlertsState,
"archived": false,
"can_be_towed": true,
"can_tow": false,
"current_device": Device,
"current_devices": DevicePaged,
"current_driver": Driver,
"current_towing_session_as_towing_vehicle": TowingSession,
"current_towing_session_as_trailer_vehicle": TowingSession,
"current_towing_vehicle": Vehicle,
"current_trailer_vehicle": Vehicle,
"descriptions": DescriptionPaged,
"doors_lock_status": "LOCKED",
"doors_lock_status_updated_at": "2007-12-03T10:15:30Z",
"driver_sessions": DriverVehicleSessionPaged,
"fuel_type": "abc123",
"fuel_type_secondary": "xyz789",
"garage_mode_status": "DISABLED",
"garage_mode_status_updated_at": "2007-12-03T10:15:30Z",
"groups": GroupPaged,
"has_driver": true,
"hybrid": false,
"immobilizer_status": "DISABLED",
"immobilizer_status_updated_at": "2007-12-03T10:15:30Z",
"kba": "xyz789",
"ktype": "abc123",
"label": "abc123",
"last_trip": Trip,
"maintenance_schedules": MaintenanceSchedulePaged,
"maintenance_templates": MaintenanceTemplatePaged,
"maintenances_historical": MaintenanceHistoricalPaged,
"maintenances_upcoming": MaintenanceUpcomingPaged,
"make": "xyz789",
"model": "xyz789",
"model_id": 4,
"onboarded": false,
"owner": Account,
"plate": "abc123",
"tags": ["abc123"],
"towing_sessions_as_towing_vehicle": TowingSessionPaged,
"towing_sessions_as_trailer_vehicle": TowingSessionPaged,
"trips": TripPaged,
"vehicle_type": "CAR",
"vin": "abc123",
"vin_descriptions": DecodeVinResult,
"year": "abc123",
"authorized_drivers": vehicle_driver_paginated,
"auxiliary_devices": auxiliary_device_paginated,
"auxiliary_device": auxiliary_device_show,
"refills": refill_paged,
"refills_summary": vehicle_summary_show
}
}
}
vehicle_delete
Description
Delete a user vehicle
vehicle_service_create
Description
Create vehicle service
Response
Returns a VehicleService
Example
Query
mutation vehicle_service_create(
$description: String,
$label: String,
$workshop_ids: [ID]
) {
vehicle_service_create(
description: $description,
label: $label,
workshop_ids: $workshop_ids
) {
id
description
label
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{
"description": "xyz789",
"label": "abc123",
"workshop_ids": ["4"]
}
Response
{
"data": {
"vehicle_service_create": {
"id": "4",
"description": "abc123",
"label": "abc123",
"workshops": WorkshopPaged
}
}
}
vehicle_service_delete
Description
Delete Vehicle service
vehicle_service_update
Description
Update Vehicle service
Response
Returns a VehicleService
Example
Query
mutation vehicle_service_update(
$id: ID!,
$label: String
) {
vehicle_service_update(
id: $id,
label: $label
) {
id
description
label
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{"id": 4, "label": "abc123"}
Response
{
"data": {
"vehicle_service_update": {
"id": "4",
"description": "abc123",
"label": "abc123",
"workshops": WorkshopPaged
}
}
}
vehicle_type_create
Description
Create vehicle type
Response
Returns a VehicleType
Example
Query
mutation vehicle_type_create(
$description: String,
$label: String,
$workshop_ids: [ID]
) {
vehicle_type_create(
description: $description,
label: $label,
workshop_ids: $workshop_ids
) {
id
description
label
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{
"description": "xyz789",
"label": "abc123",
"workshop_ids": [4]
}
Response
{
"data": {
"vehicle_type_create": {
"id": 4,
"description": "xyz789",
"label": "abc123",
"workshops": WorkshopPaged
}
}
}
vehicle_type_delete
Description
Delete Vehicle type
vehicle_type_update
Description
Update Vehicle type
Response
Returns a VehicleType
Example
Query
mutation vehicle_type_update(
$id: ID!,
$label: String
) {
vehicle_type_update(
id: $id,
label: $label
) {
id
description
label
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{
"id": "4",
"label": "xyz789"
}
Response
{
"data": {
"vehicle_type_update": {
"id": 4,
"description": "abc123",
"label": "abc123",
"workshops": WorkshopPaged
}
}
}
vehicle_update
Description
Set the user's vehicule fields
Response
Returns a Vehicle
Arguments
| Name | Description |
|---|---|
archived - Boolean
|
Archived vehicle |
fuel_type - String
|
Primary fuel type |
fuel_type_secondary - String
|
Secondary fuel type |
id - ID!
|
Identifier |
kba - String
|
KBA |
ktype - String
|
KType |
label - String
|
Label |
make - String
|
Model make |
model - String
|
Model |
model_id - ID
|
Model ID |
owner_id - ID
|
OwnerID |
plate - String
|
Plate |
tags - [String]
|
Tags |
vin - String
|
VIN |
year - String
|
Model Year |
Example
Query
mutation vehicle_update(
$archived: Boolean,
$fuel_type: String,
$fuel_type_secondary: String,
$id: ID!,
$kba: String,
$ktype: String,
$label: String,
$make: String,
$model: String,
$model_id: ID,
$owner_id: ID,
$plate: String,
$tags: [String],
$vin: String,
$year: String
) {
vehicle_update(
archived: $archived,
fuel_type: $fuel_type,
fuel_type_secondary: $fuel_type_secondary,
id: $id,
kba: $kba,
ktype: $ktype,
label: $label,
make: $make,
model: $model,
model_id: $model_id,
owner_id: $owner_id,
plate: $plate,
tags: $tags,
vin: $vin,
year: $year
) {
id
alerts {
...VehicleAlertPagedFragment
}
alerts_state {
...VehicleAlertsStateFragment
}
archived
can_be_towed
can_tow
current_device {
...DeviceFragment
}
current_devices {
...DevicePagedFragment
}
current_driver {
...DriverFragment
}
current_towing_session_as_towing_vehicle {
...TowingSessionFragment
}
current_towing_session_as_trailer_vehicle {
...TowingSessionFragment
}
current_towing_vehicle {
...VehicleFragment
}
current_trailer_vehicle {
...VehicleFragment
}
descriptions {
...DescriptionPagedFragment
}
doors_lock_status
doors_lock_status_updated_at
driver_sessions {
...DriverVehicleSessionPagedFragment
}
fuel_type
fuel_type_secondary
garage_mode_status
garage_mode_status_updated_at
groups {
...GroupPagedFragment
}
has_driver
hybrid
immobilizer_status
immobilizer_status_updated_at
kba
ktype
label
last_trip {
...TripFragment
}
maintenance_schedules {
...MaintenanceSchedulePagedFragment
}
maintenance_templates {
...MaintenanceTemplatePagedFragment
}
maintenances_historical {
...MaintenanceHistoricalPagedFragment
}
maintenances_upcoming {
...MaintenanceUpcomingPagedFragment
}
make
model
model_id
onboarded
owner {
...AccountFragment
}
plate
tags
towing_sessions_as_towing_vehicle {
...TowingSessionPagedFragment
}
towing_sessions_as_trailer_vehicle {
...TowingSessionPagedFragment
}
trips {
...TripPagedFragment
}
vehicle_type
vin
vin_descriptions {
...DecodeVinResultFragment
}
year
authorized_drivers {
... on vehicle_driver_paginated {
...vehicle_driver_paginatedFragment
}
... on errors {
...errorsFragment
}
}
auxiliary_devices {
... on auxiliary_device_paginated {
...auxiliary_device_paginatedFragment
}
... on errors {
...errorsFragment
}
}
auxiliary_device {
... on auxiliary_device_show {
...auxiliary_device_showFragment
}
... on errors {
...errorsFragment
}
}
refills {
... on refill_paged {
...refill_pagedFragment
}
... on errors {
...errorsFragment
}
}
refills_summary {
... on vehicle_summary_show {
...vehicle_summary_showFragment
}
... on errors {
...errorsFragment
}
}
}
}
Variables
{
"archived": true,
"fuel_type": "abc123",
"fuel_type_secondary": "xyz789",
"id": 4,
"kba": "abc123",
"ktype": "abc123",
"label": "xyz789",
"make": "abc123",
"model": "xyz789",
"model_id": 4,
"owner_id": "4",
"plate": "xyz789",
"tags": ["xyz789"],
"vin": "abc123",
"year": "xyz789"
}
Response
{
"data": {
"vehicle_update": {
"id": "4",
"alerts": VehicleAlertPaged,
"alerts_state": VehicleAlertsState,
"archived": false,
"can_be_towed": false,
"can_tow": true,
"current_device": Device,
"current_devices": DevicePaged,
"current_driver": Driver,
"current_towing_session_as_towing_vehicle": TowingSession,
"current_towing_session_as_trailer_vehicle": TowingSession,
"current_towing_vehicle": Vehicle,
"current_trailer_vehicle": Vehicle,
"descriptions": DescriptionPaged,
"doors_lock_status": "LOCKED",
"doors_lock_status_updated_at": "2007-12-03T10:15:30Z",
"driver_sessions": DriverVehicleSessionPaged,
"fuel_type": "xyz789",
"fuel_type_secondary": "xyz789",
"garage_mode_status": "DISABLED",
"garage_mode_status_updated_at": "2007-12-03T10:15:30Z",
"groups": GroupPaged,
"has_driver": false,
"hybrid": false,
"immobilizer_status": "DISABLED",
"immobilizer_status_updated_at": "2007-12-03T10:15:30Z",
"kba": "abc123",
"ktype": "xyz789",
"label": "xyz789",
"last_trip": Trip,
"maintenance_schedules": MaintenanceSchedulePaged,
"maintenance_templates": MaintenanceTemplatePaged,
"maintenances_historical": MaintenanceHistoricalPaged,
"maintenances_upcoming": MaintenanceUpcomingPaged,
"make": "abc123",
"model": "xyz789",
"model_id": "4",
"onboarded": false,
"owner": Account,
"plate": "xyz789",
"tags": ["abc123"],
"towing_sessions_as_towing_vehicle": TowingSessionPaged,
"towing_sessions_as_trailer_vehicle": TowingSessionPaged,
"trips": TripPaged,
"vehicle_type": "CAR",
"vin": "xyz789",
"vin_descriptions": DecodeVinResult,
"year": "xyz789",
"authorized_drivers": vehicle_driver_paginated,
"auxiliary_devices": auxiliary_device_paginated,
"auxiliary_device": auxiliary_device_show,
"refills": refill_paged,
"refills_summary": vehicle_summary_show
}
}
}
wifi_credentials
Description
Set wifi ssid/password
Response
Returns a RdcAsyncAck
Example
Query
mutation wifi_credentials(
$device_id: ID!,
$password: String,
$ssid: String!
) {
wifi_credentials(
device_id: $device_id,
password: $password,
ssid: $ssid
) {
attributes
id
type
}
}
Variables
{
"device_id": "4",
"password": "xyz789",
"ssid": "abc123"
}
Response
{
"data": {
"wifi_credentials": {
"attributes": Json,
"id": 4,
"type": "xyz789"
}
}
}
wifi_toggle
Description
Start or stop the wifi
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
action - ToggleAction!
|
Start/Stop |
device_id - ID!
|
Device id |
Example
Query
mutation wifi_toggle(
$action: ToggleAction!,
$device_id: ID!
) {
wifi_toggle(
action: $action,
device_id: $device_id
) {
attributes
id
type
}
}
Variables
{"action": "START", "device_id": "4"}
Response
{
"data": {
"wifi_toggle": {
"attributes": Json,
"id": "4",
"type": "xyz789"
}
}
}
workday_create
Description
Create workday
Response
Returns a Workday
Example
Query
mutation workday_create(
$closing_hour_1: String,
$closing_hour_2: String,
$day: Weekday,
$opening_hour_1: String,
$opening_hour_2: String,
$workshop_id: ID!
) {
workday_create(
closing_hour_1: $closing_hour_1,
closing_hour_2: $closing_hour_2,
day: $day,
opening_hour_1: $opening_hour_1,
opening_hour_2: $opening_hour_2,
workshop_id: $workshop_id
) {
id
closing_hour_1
closing_hour_2
day
opening_hour_1
opening_hour_2
workshop {
...WorkshopFragment
}
}
}
Variables
{
"closing_hour_1": "abc123",
"closing_hour_2": "abc123",
"day": "FRIDAY",
"opening_hour_1": "abc123",
"opening_hour_2": "abc123",
"workshop_id": 4
}
Response
{
"data": {
"workday_create": {
"id": 4,
"closing_hour_1": "abc123",
"closing_hour_2": "abc123",
"day": "FRIDAY",
"opening_hour_1": "xyz789",
"opening_hour_2": "abc123",
"workshop": Workshop
}
}
}
workday_delete
Description
Delete workday
workday_update
Description
Update workday
Response
Returns a Workday
Example
Query
mutation workday_update(
$closing_hour_1: String,
$closing_hour_2: String,
$day: Weekday,
$id: ID!,
$opening_hour_1: String,
$opening_hour_2: String
) {
workday_update(
closing_hour_1: $closing_hour_1,
closing_hour_2: $closing_hour_2,
day: $day,
id: $id,
opening_hour_1: $opening_hour_1,
opening_hour_2: $opening_hour_2
) {
id
closing_hour_1
closing_hour_2
day
opening_hour_1
opening_hour_2
workshop {
...WorkshopFragment
}
}
}
Variables
{
"closing_hour_1": "xyz789",
"closing_hour_2": "xyz789",
"day": "FRIDAY",
"id": "4",
"opening_hour_1": "abc123",
"opening_hour_2": "xyz789"
}
Response
{
"data": {
"workday_update": {
"id": 4,
"closing_hour_1": "abc123",
"closing_hour_2": "xyz789",
"day": "FRIDAY",
"opening_hour_1": "xyz789",
"opening_hour_2": "xyz789",
"workshop": Workshop
}
}
}
workshop_create
Description
Create workshop
Response
Returns a Workshop
Arguments
| Name | Description |
|---|---|
address - String
|
|
brand - String
|
|
city - String
|
|
code - String!
|
|
country - String
|
|
email - String
|
|
fax - String
|
|
icon - String
|
|
international_phone - String
|
|
language - Language
|
|
lat - Float
|
|
lon - Float
|
|
name - String!
|
|
phone - String
|
|
postal_code - String
|
|
provider - String
|
|
provider_workshop_id - ID
|
|
province - String
|
|
time_zone - String
|
|
web - String
|
Example
Query
mutation workshop_create(
$address: String,
$brand: String,
$city: String,
$code: String!,
$country: String,
$email: String,
$fax: String,
$icon: String,
$international_phone: String,
$language: Language,
$lat: Float,
$lon: Float,
$name: String!,
$phone: String,
$postal_code: String,
$provider: String,
$provider_workshop_id: ID,
$province: String,
$time_zone: String,
$web: String
) {
workshop_create(
address: $address,
brand: $brand,
city: $city,
code: $code,
country: $country,
email: $email,
fax: $fax,
icon: $icon,
international_phone: $international_phone,
language: $language,
lat: $lat,
lon: $lon,
name: $name,
phone: $phone,
postal_code: $postal_code,
provider: $provider,
provider_workshop_id: $provider_workshop_id,
province: $province,
time_zone: $time_zone,
web: $web
) {
id
address
average_stars
bookings {
...BookingPagedFragment
}
brand
city
code
country
driver_services {
...DriverServicePagedFragment
}
email
fax
icon
international_phone
language
lat
lon
managers {
...WorkshopManagerPagedFragment
}
name
phone
postal_code
provider
provider_workshop_id
province
quotations {
...QuotationPagedFragment
}
ratings {
...RatingPagedFragment
}
time_zone
vehicle_services {
...VehicleServicePagedFragment
}
vehicle_types {
...VehicleTypePagedFragment
}
web
workdays {
...WorkdayPagedFragment
}
}
}
Variables
{
"address": "xyz789",
"brand": "abc123",
"city": "abc123",
"code": "xyz789",
"country": "abc123",
"email": "abc123",
"fax": "abc123",
"icon": "xyz789",
"international_phone": "xyz789",
"language": Language,
"lat": 987.65,
"lon": 987.65,
"name": "abc123",
"phone": "abc123",
"postal_code": "xyz789",
"provider": "xyz789",
"provider_workshop_id": "4",
"province": "abc123",
"time_zone": "abc123",
"web": "abc123"
}
Response
{
"data": {
"workshop_create": {
"id": "4",
"address": "xyz789",
"average_stars": 123.45,
"bookings": BookingPaged,
"brand": "xyz789",
"city": "xyz789",
"code": "xyz789",
"country": "abc123",
"driver_services": DriverServicePaged,
"email": "abc123",
"fax": "xyz789",
"icon": "abc123",
"international_phone": "abc123",
"language": Language,
"lat": 123.45,
"lon": 123.45,
"managers": WorkshopManagerPaged,
"name": "xyz789",
"phone": "xyz789",
"postal_code": "abc123",
"provider": "abc123",
"provider_workshop_id": "4",
"province": "abc123",
"quotations": QuotationPaged,
"ratings": RatingPaged,
"time_zone": "xyz789",
"vehicle_services": VehicleServicePaged,
"vehicle_types": VehicleTypePaged,
"web": "abc123",
"workdays": WorkdayPaged
}
}
}
workshop_delete
Description
Delete Workshop
workshop_update
Description
Update Workshop
Response
Returns a Workshop
Arguments
| Name | Description |
|---|---|
address - String
|
|
brand - String
|
|
city - String
|
|
code - String
|
|
country - String
|
|
email - String
|
|
fax - String
|
|
icon - String
|
|
id - ID!
|
Workshop ID |
international_phone - String
|
|
language - Language
|
|
lat - Float
|
|
lon - Float
|
|
name - String
|
|
phone - String
|
|
postal_code - String
|
|
provider - String
|
|
provider_workshop_id - ID
|
|
province - String
|
|
time_zone - String
|
|
web - String
|
Example
Query
mutation workshop_update(
$address: String,
$brand: String,
$city: String,
$code: String,
$country: String,
$email: String,
$fax: String,
$icon: String,
$id: ID!,
$international_phone: String,
$language: Language,
$lat: Float,
$lon: Float,
$name: String,
$phone: String,
$postal_code: String,
$provider: String,
$provider_workshop_id: ID,
$province: String,
$time_zone: String,
$web: String
) {
workshop_update(
address: $address,
brand: $brand,
city: $city,
code: $code,
country: $country,
email: $email,
fax: $fax,
icon: $icon,
id: $id,
international_phone: $international_phone,
language: $language,
lat: $lat,
lon: $lon,
name: $name,
phone: $phone,
postal_code: $postal_code,
provider: $provider,
provider_workshop_id: $provider_workshop_id,
province: $province,
time_zone: $time_zone,
web: $web
) {
id
address
average_stars
bookings {
...BookingPagedFragment
}
brand
city
code
country
driver_services {
...DriverServicePagedFragment
}
email
fax
icon
international_phone
language
lat
lon
managers {
...WorkshopManagerPagedFragment
}
name
phone
postal_code
provider
provider_workshop_id
province
quotations {
...QuotationPagedFragment
}
ratings {
...RatingPagedFragment
}
time_zone
vehicle_services {
...VehicleServicePagedFragment
}
vehicle_types {
...VehicleTypePagedFragment
}
web
workdays {
...WorkdayPagedFragment
}
}
}
Variables
{
"address": "abc123",
"brand": "abc123",
"city": "abc123",
"code": "xyz789",
"country": "abc123",
"email": "xyz789",
"fax": "xyz789",
"icon": "abc123",
"id": 4,
"international_phone": "abc123",
"language": Language,
"lat": 987.65,
"lon": 123.45,
"name": "xyz789",
"phone": "abc123",
"postal_code": "xyz789",
"provider": "abc123",
"provider_workshop_id": 4,
"province": "abc123",
"time_zone": "xyz789",
"web": "xyz789"
}
Response
{
"data": {
"workshop_update": {
"id": "4",
"address": "abc123",
"average_stars": 123.45,
"bookings": BookingPaged,
"brand": "abc123",
"city": "xyz789",
"code": "xyz789",
"country": "abc123",
"driver_services": DriverServicePaged,
"email": "xyz789",
"fax": "xyz789",
"icon": "xyz789",
"international_phone": "xyz789",
"language": Language,
"lat": 987.65,
"lon": 987.65,
"managers": WorkshopManagerPaged,
"name": "abc123",
"phone": "xyz789",
"postal_code": "abc123",
"provider": "abc123",
"provider_workshop_id": 4,
"province": "abc123",
"quotations": QuotationPaged,
"ratings": RatingPaged,
"time_zone": "xyz789",
"vehicle_services": VehicleServicePaged,
"vehicle_types": VehicleTypePaged,
"web": "xyz789",
"workdays": WorkdayPaged
}
}
}
Subscriptions
device_notifications
Description
Receive the notification linked to a device
Response
Returns [DeviceNotification!]!
Arguments
| Name | Description |
|---|---|
device_ids - [ID!]!
|
List of Device Id (IMEI) to listen to |
Example
Query
subscription device_notifications($device_ids: [ID!]!) {
device_notifications(device_ids: $device_ids) {
device {
...DeviceFragment
}
}
}
Variables
{"device_ids": ["4"]}
Response
{"data": {"device_notifications": [{"device": Device}]}}
vehicle_notifications
Description
Receive the notification linked to a vehicle
Response
Returns [VehicleNotification!]!
Arguments
| Name | Description |
|---|---|
vehicle_ids - [ID!]!
|
List of Vehicle Id to listen to |
Example
Query
subscription vehicle_notifications($vehicle_ids: [ID!]!) {
vehicle_notifications(vehicle_ids: $vehicle_ids) {
vehicle {
...VehicleFragment
}
}
}
Variables
{"vehicle_ids": [4]}
Response
{
"data": {
"vehicle_notifications": [{"vehicle": Vehicle}]
}
}
Types
Account
Description
Munic Connect user account
Fields
| Field Name | Description |
|---|---|
alert_preference - AlertPreference
|
Alert preference |
company_name - String
|
Company name |
confirmed_at - DateTime
|
Account confirmation date |
country_code - String
|
Country code |
created_at - DateTime
|
Account creation date |
descriptions - DescriptionPaged
|
Descriptions |
Arguments
|
|
devices - DevicePaged
|
Devices |
Arguments
|
|
distributors - OnboardingDistributorPaged
|
Onboarding distributors |
driver_contacts - DriverPaged
|
Driver contacts |
driver_profiles - DriverPaged
|
Driver profiles |
drivers - DriverPaged
|
Use driverProfiles |
email - String
|
|
full_name - String
|
Full name |
groups - GroupPaged
|
Groups |
Arguments
|
|
id - ID!
|
Account id |
language - Language
|
Interface language |
last_sign_in_at - DateTime
|
Last account sign-in date |
organization_id - ID
|
Organization id |
phone - String
|
Phone number |
roles - [AccountRole]
|
Roles |
Arguments
|
|
short_name - String
|
Short name |
time_zone - String
|
Time zone |
updated_at - DateTime
|
Last account update date |
vehicles - VehiclePaged
|
Vehicles |
Arguments
|
|
workshops - WorkshopPaged
|
Workshops |
sso_user - sso_user_response
|
|
Example
{
"alert_preference": AlertPreference,
"company_name": "abc123",
"confirmed_at": "2007-12-03T10:15:30Z",
"country_code": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"distributors": OnboardingDistributorPaged,
"driver_contacts": DriverPaged,
"driver_profiles": DriverPaged,
"drivers": DriverPaged,
"email": "abc123",
"full_name": "xyz789",
"groups": GroupPaged,
"id": "4",
"language": Language,
"last_sign_in_at": "2007-12-03T10:15:30Z",
"organization_id": 4,
"phone": "xyz789",
"roles": [AccountRole],
"short_name": "xyz789",
"time_zone": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"vehicles": VehiclePaged,
"workshops": WorkshopPaged,
"sso_user": user
}
AccountConfirmation
Example
{
"force_reset_at_confirmation": false,
"force_reset_password": false,
"id": 4,
"updated_at": "2007-12-03T10:15:30Z"
}
AccountPaged
Description
Paginated account results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Account!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [Account],
"next": "4"
}
AccountRole
AddressAttributes
Description
Address model.
Fields
| Field Name | Description |
|---|---|
city - String
|
City |
country - String
|
Country |
country_code - String
|
ISO 3166 code of country |
county - String
|
County name |
district - String
|
District name |
latitude - Float
|
Latitude |
longitude - Float
|
Longitude |
postal_code - String
|
Postal code |
state - String
|
State name |
street - String
|
Street |
street_number - String
|
Street_number |
Example
{
"city": "xyz789",
"country": "abc123",
"country_code": "abc123",
"county": "xyz789",
"district": "abc123",
"latitude": 987.65,
"longitude": 123.45,
"postal_code": "xyz789",
"state": "abc123",
"street": "xyz789",
"street_number": "abc123"
}
AggregatedData
Description
Fields aggregated from multiple sources
Fields
| Field Name | Description |
|---|---|
mileage - AggregatedDataFloat
|
Vehicle mileage (km) |
position - Coordinates
|
Example
{
"mileage": AggregatedDataFloat,
"position": Coordinates
}
AggregatedDataFloat
AlertAttachment
Example
{
"content_type": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"name": "xyz789",
"path": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"version": "abc123"
}
AlertAttachmentPaged
Description
Paginated alert_attachment results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [AlertAttachment!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [AlertAttachment],
"next": "4"
}
AlertJob
Example
{
"channel_name": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"retries_count": 123,
"status": "SUCEEDED",
"updated_at": "2007-12-03T10:15:30Z"
}
AlertJobPaged
Description
Paginated alert_job results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [AlertJob!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [AlertJob],
"next": "4"
}
AlertNotification
Fields
| Field Name | Description |
|---|---|
created_at - DateTime
|
|
failed_at - DateTime
|
|
force_channel - Boolean
|
|
id - ID
|
|
jobs - AlertJobPaged
|
|
queue - AlertQueue
|
|
receiver - Account
|
|
sender - Account
|
|
sent_at - DateTime
|
|
status - AlertNotificationStatus
|
|
template - AlertTemplate
|
|
template_context - Json
|
|
updated_at - DateTime
|
|
Example
{
"created_at": "2007-12-03T10:15:30Z",
"failed_at": "2007-12-03T10:15:30Z",
"force_channel": false,
"id": "4",
"jobs": AlertJobPaged,
"queue": AlertQueue,
"receiver": Account,
"sender": Account,
"sent_at": "2007-12-03T10:15:30Z",
"status": "SUCEEDED",
"template": AlertTemplate,
"template_context": Json,
"updated_at": "2007-12-03T10:15:30Z"
}
AlertNotificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUCEEDED"
AlertPreference
Description
User alert preferences
Fields
| Field Name | Description |
|---|---|
firebase_messaging_token - String
|
|
id - ID
|
|
preferred_channels - [AlertPreferredChannel]
|
|
stop_notifications - Boolean
|
Example
{
"firebase_messaging_token": "abc123",
"id": "4",
"preferred_channels": ["EMAIL"],
"stop_notifications": true
}
AlertPreferredChannel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EMAIL"
AlertQueue
Fields
| Field Name | Description |
|---|---|
created_at - DateTime
|
|
id - ID!
|
|
metadata - Json
|
|
name - String!
|
|
notification_definition_name - String
|
|
notification_definition_version - String
|
|
preferred_channels - [AlertPreferredChannel]
|
|
priority - Int
|
|
template_context - Json
|
|
timeout - String
|
|
updated_at - DateTime
|
|
version - String
|
Example
{
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"metadata": Json,
"name": "abc123",
"notification_definition_name": "xyz789",
"notification_definition_version": "abc123",
"preferred_channels": ["EMAIL"],
"priority": 987,
"template_context": Json,
"timeout": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"version": "xyz789"
}
AlertTemplate
Example
{
"id": 4,
"attachments": AlertAttachmentPaged,
"channel_name": "abc123",
"content_type": "HTML",
"created_at": "2007-12-03T10:15:30Z",
"default_context": Json,
"definition": "xyz789",
"locked": true,
"name": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"version": "xyz789"
}
AlertTemplateContent
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HTML"
AlertTemplatePaged
Description
Paginated alert_template results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [AlertTemplate!]!
|
|
next - ID
|
Example
{"count": 123, "list": [AlertTemplate], "next": 4}
AlertWarningLightLevel
Description
Warning light level
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized warning light level |
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
AlertWarningLightLevelArg
Description
Warning light level argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVISORY"
Alpr
Description
Munic Alpr model
Fields
| Field Name | Description |
|---|---|
plate - Plate
|
Vehicle plates propositions |
vehicle - VehicleInfo
|
Vehicle info |
Example
{
"plate": Plate,
"vehicle": VehicleInfo
}
AnyPercent
Description
Percentage, as a floating point number of any value
Example
AnyPercent
BatteryAnnotation
Description
Battery annotation
Fields
| Field Name | Description |
|---|---|
duration - Int
|
Duration (seconds) |
electric_potentials - [Float]
|
All electric potential readings (volt) |
end_time - DateTime
|
End time |
id - ID!
|
Annotation id |
readings - BatteryReadingPaged
|
Filterable battery readings |
start_time - DateTime
|
Start time |
tags - [BatteryAnnotationTag]
|
Tags |
temperatures - [Float]
|
All temperature readings (celsius) |
times - [DateTime]
|
All timestamp readings |
Example
{
"duration": 123,
"electric_potentials": [987.65],
"end_time": "2007-12-03T10:15:30Z",
"id": 4,
"readings": BatteryReadingPaged,
"start_time": "2007-12-03T10:15:30Z",
"tags": ["OTHER"],
"temperatures": [123.45],
"times": ["2007-12-03T10:15:30Z"]
}
BatteryAnnotationPaged
Description
Paginated battery_annotation results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [BatteryAnnotation!]!
|
|
next - ID
|
Example
{"count": 123, "list": [BatteryAnnotation], "next": 4}
BatteryAnnotationTag
Description
battery annotation tag
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized battery annotation tag |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
BatteryAnnotationTagArg
Description
battery annotation tag argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CRANK"
BatteryChargeLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHARGED"
BatteryDischargeLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CRITICAL_DISCHARGE"
BatteryReadingPaged
Example
{
"count": 123,
"electric_potential": [987.65],
"id": ["4"],
"next": "4",
"temperature": [123.45],
"timestamp": ["2007-12-03T10:15:30Z"]
}
BigInt
Description
The BigInt scalar type represents non-fractional signed whole numeric values.
Example
{}
Booking
Description
Workshop booking
Fields
| Field Name | Description |
|---|---|
id - ID
|
Booking ID |
additional_information - String
|
|
booking_date - DateTime
|
Booking date |
city - String
|
|
contact_method - WorkshopContactMethod
|
|
country - String
|
|
plate_number - String
|
Vehicle plate number |
preferred_language - Language
|
|
quotation_ids - [ID]
|
Booking quotations |
status - BookingStatus
|
Booking status |
user_email - String
|
|
user_name - String
|
|
user_phone_number - String
|
|
vehicle_make - String
|
|
vehicle_model - String
|
|
vehicle_year - String
|
|
vin - String
|
|
workshop - Workshop
|
Workshop |
Example
{
"id": 4,
"additional_information": "xyz789",
"booking_date": "2007-12-03T10:15:30Z",
"city": "abc123",
"contact_method": "EMAIL",
"country": "abc123",
"plate_number": "abc123",
"preferred_language": Language,
"quotation_ids": ["4"],
"status": "CONFIRMED",
"user_email": "abc123",
"user_name": "xyz789",
"user_phone_number": "xyz789",
"vehicle_make": "abc123",
"vehicle_model": "xyz789",
"vehicle_year": "xyz789",
"vin": "abc123",
"workshop": Workshop
}
BookingPaged
Description
Paginated booking results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Booking!]!
|
|
next - ID
|
Example
{"count": 123, "list": [Booking], "next": 4}
BookingStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CONFIRMED"
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
BooleanObj
Fields
| Field Name | Description |
|---|---|
value - Boolean!
|
Example
{"value": true}
Byte
Description
The Byte scalar type represents byte value as a Buffer
Example
[196, 189, 173, 171, 167, 163]
BytesObj
Fields
| Field Name | Description |
|---|---|
value - String!
|
Base64-encoded |
Example
{"value": "abc123"}
CIRCLE_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"CIRCLE"
CacheInfo
Fields
| Field Name | Description |
|---|---|
extend_ttl - Boolean!
|
Wether cache hits extend the time to live |
scope - CacheScope!
|
|
soft_flush - String
|
Ignore cache entries before this date |
ttl - Int!
|
Time to live (seconds) |
Example
{
"extend_ttl": true,
"scope": "LOGIN",
"soft_flush": "abc123",
"ttl": 123
}
CacheScope
Description
Delimits the context in which cached results are be available
Values
| Enum Value | Description |
|---|---|
|
|
Current SSO login / JWT token (recommended) |
|
|
Current GraphQL query (for volatile data) |
|
|
Current user (for unchanging data, shared with other clients) |
Example
"LOGIN"
Campaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
configurations - [ID!]
|
|
created_at - DateTime!
|
|
devices_status - [CampaignDevice!]
|
|
name - String!
|
|
status - CampaignStatus!
|
Example
{
"id": "4",
"configurations": [4],
"created_at": "2007-12-03T10:15:30Z",
"devices_status": [CampaignDevice],
"name": "xyz789",
"status": "OTHER"
}
CampaignDevice
Fields
| Field Name | Description |
|---|---|
device - Device
|
|
status - CampaignStatus
|
Example
{"device": Device, "status": "OTHER"}
CampaignPaged
Description
Paginated campaign results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Campaign!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [Campaign],
"next": "4"
}
CampaignStatus
Description
campaign status
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized campaign status |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
ClientIdentification
Fields
| Field Name | Description |
|---|---|
client_reference - ID
|
|
client_reference_type - ClientReferenceType
|
|
code - String
|
|
created_by - Account
|
|
default_account - Account
|
|
default_whitelisted_data - [OnboardingWhitelistedData!]
|
|
distributor - OnboardingDistributor
|
|
id - ID
|
|
label - String
|
|
number_of_onboardings - Int
|
|
number_of_started_onboardings - Int
|
|
revoked - Boolean
|
Example
{
"client_reference": "4",
"client_reference_type": "GROUP",
"code": "xyz789",
"created_by": Account,
"default_account": Account,
"default_whitelisted_data": ["OTHER"],
"distributor": OnboardingDistributor,
"id": 4,
"label": "xyz789",
"number_of_onboardings": 123,
"number_of_started_onboardings": 987,
"revoked": false
}
ClientIdentificationPaged
Description
Paginated client_identification results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [ClientIdentification!]!
|
|
next - ID
|
Example
{"count": 987, "list": [ClientIdentification], "next": 4}
ClientReferenceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"GROUP"
CloudEventStatus
Fields
| Field Name | Description |
|---|---|
node - String!
|
|
peers - [String!]!
|
Example
{
"node": "abc123",
"peers": ["abc123"]
}
ConnectivityState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"IDLE"
ConnectorType
Description
The selected connector type
Values
| Enum Value | Description |
|---|---|
|
|
AVCON Connector |
|
|
Better place plug/socket |
|
|
Domestic plug/socket type A |
|
|
Domestic plug/socket type B |
|
|
Domestic plug/socket type C |
|
|
Domestic plug/socket type D |
|
|
Domestic plug/socket type E |
|
|
Domestic plug/socket type E+F |
|
|
Domestic plug/socket type F |
|
|
Domestic plug/socket type G |
|
|
Domestic plug/socket type H |
|
|
Domestic plug/socket type I |
|
|
Domestic plug/socket type IEC 60906-1 |
|
|
Domestic plug/socket type J |
|
|
Domestic plug/socket type K |
|
|
Domestic plug/socket type L |
|
|
Domestic plug/socket type M |
|
|
I-type AS/NZ 3112 |
|
|
IEC 60309 : industrial |
|
|
IEC 61851-1 |
|
|
IEC 62196-2 type 1 |
|
|
IEC 62196-2 type 2 |
|
|
IEC 62196-2 type 3c |
|
|
IEC 62196-3 type 1 |
|
|
IEC 62196-3 type 2 |
|
|
JEVS G 105 (CHAdeMO) |
|
|
Large Paddle Inductive |
|
|
Marechal plug/socket |
|
|
Unrecognized or uncategorized energy type |
|
|
Small Paddle Inductive |
|
|
Tesla Connector |
Example
"AVCON_CONNECTOR"
Coordinates
CoordinatesInput
CountrySpecificId
Fields
| Field Name | Description |
|---|---|
type - CountrySpecificIdType!
|
|
value - ID!
|
Example
{"type": "KBA", "value": "4"}
CountrySpecificIdArg
Fields
| Input Field | Description |
|---|---|
type - CountrySpecificIdType
|
|
value - ID!
|
Example
{"type": "KBA", "value": 4}
CountrySpecificIdType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"KBA"
CoverageBlacklist
Description
Vehicles matching this might not support all features
Fields
| Field Name | Description |
|---|---|
comment - String
|
Reason for the blacklist Always null |
declaration_date - DateTime!
|
Declaration date |
error_type - String
|
Always null |
id - ID!
|
Id |
level - CoverageBlacklistLevel
|
Always null |
make - String
|
Make |
model - String
|
Model |
resolution - String
|
Resolution info Always null |
resolution_date - DateTime
|
Resolution date Always null |
root_cause - CoverageBlacklistRootCause
|
Always null |
status - CoverageBlacklistStatus
|
Always null |
year_end - Int
|
Ending year |
year_start - Int
|
Starting year |
Example
{
"comment": "abc123",
"declaration_date": "2007-12-03T10:15:30Z",
"error_type": "xyz789",
"id": 4,
"level": "OTHER",
"make": "abc123",
"model": "xyz789",
"resolution": "abc123",
"resolution_date": "2007-12-03T10:15:30Z",
"root_cause": "OTHER",
"status": "OTHER",
"year_end": 123,
"year_start": 123
}
CoverageBlacklistLevel
Values
| Enum Value | Description |
|---|---|
|
|
Unknown or unrecognized blacklist level |
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
CoverageBlacklistPaged
Description
Paginated coverage_blacklist results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [CoverageBlacklist!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [CoverageBlacklist],
"next": "4"
}
CoverageBlacklistRootCause
Values
| Enum Value | Description |
|---|---|
|
|
Unknown or unrecognized blacklist root cause |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
CoverageBlacklistStatus
Values
| Enum Value | Description |
|---|---|
|
|
Unknown or unrecognized blacklist status |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
CoverageEnergyTypeArg
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DIESEL"
CoverageMake
CoverageMakePaged
Description
Paginated coverage_make results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [CoverageMake!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [CoverageMake],
"next": "4"
}
CoverageModel
CoverageModelPaged
Description
Paginated coverage_model results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [CoverageModel!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [CoverageModel],
"next": "4"
}
CoverageParameter
Example
{
"cloud_field": "xyz789",
"device_field": "abc123",
"id": "4",
"level": "xyz789",
"need_cable": true,
"need_mux": true,
"providers": ["xyz789"]
}
CoverageParameterPaged
Description
Paginated coverage_parameter results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [CoverageParameter!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [CoverageParameter],
"next": "4"
}
CoveragePowertrain
Description
coverage powertrain
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized coverage powertrain |
|
|
|
|
|
Example
"OTHER"
CoveragePowertrainArg
Description
coverage powertrain argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HEV"
CoverageRegion
Description
coverage region
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized coverage region |
|
|
|
|
|
Example
"OTHER"
CoverageRegionArg
Description
coverage region argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EUROPE"
CoverageVehicle
Description
Vehicle coverage info
Fields
| Field Name | Description |
|---|---|
blacklist_level - CoverageBlacklistLevel!
|
Blacklist level |
blacklists - CoverageBlacklistPaged!
|
Blacklist details |
energy_types - [EnergyType!]!
|
Energy types |
id - ID!
|
Id |
installation_instructions - [DongleInstallationInstruction!]!
|
|
make - String!
|
Make |
model - String!
|
Model |
need_cable - Boolean!
|
Aggregate of parameters.need_cable |
need_mux - Boolean!
|
Aggregate of parameters.need_mux |
parameter_groups - [String!]
|
|
parameters - CoverageParameterPaged
|
Covered parameters |
powertrain - CoveragePowertrain!
|
Power train type |
regions - [CoverageRegion!]!
|
World regions |
year - Int!
|
Year |
Example
{
"blacklist_level": "OTHER",
"blacklists": CoverageBlacklistPaged,
"energy_types": ["ADBLUE"],
"id": "4",
"installation_instructions": ["OTHER"],
"make": "abc123",
"model": "abc123",
"need_cable": true,
"need_mux": true,
"parameter_groups": ["xyz789"],
"parameters": CoverageParameterPaged,
"powertrain": "OTHER",
"regions": ["OTHER"],
"year": 123
}
CoverageVehiclePaged
Description
Paginated coverage_vehicle results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [CoverageVehicle!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [CoverageVehicle],
"next": "4"
}
DateTime
Description
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
"2007-12-03T10:15:30Z"
DecodeVinResult
Description
Vehicle description
Fields
| Field Name | Description |
|---|---|
acceleration - Float
|
Acceleration 0-100km/h (s) |
advanced_model - String
|
Vehicle model |
body_type - String
|
Body type |
body_type_code - String
|
Body type code |
brakes_abs - String
|
Brakes abs |
brakes_front_type - String
|
Brakes front type |
brakes_rear_type - String
|
Brakes rear type |
brakes_system - String
|
Brakes system |
cargo_capacity - Int
|
Cargo capacity (kg) |
co_2_emission - Int
|
CO2 emission (g/km) |
co_emission - Float
|
CO emission (g/km) |
color - String
|
Color |
company_id - ID
|
Company id |
country - String
|
Manufacturing country |
critair - String
|
Crit'air rating |
curb_weight - Int
|
Curb weight (kg) |
day_of_first_circulation - Int
|
Day of first circulation |
day_of_sale - Int
|
Day of first sale |
decoding_region - String
|
Decoding region |
doors - Int
|
Door count |
drive_type - String
|
Drive type |
electric_vehicle_battery_capacity - Float
|
Electric vehicle battery capacity (kW/h) |
electric_vehicle_battery_voltage - Float
|
Electric vehicle battery voltage (v) |
emission_standard - String
|
Emission standard |
engine_aspiration - String
|
Engine aspiration |
engine_bore - Float
|
Engine bore number (mm) |
engine_code - String
|
Engine code |
engine_configuration - String
|
Engine configuration |
engine_cylinder_head_type - String
|
Engine cylinder head type |
engine_cylinders - Int
|
Engine cylinder count |
engine_displacement - Int
|
Engine displacement (ccm) |
engine_extra - String
|
Engine extra |
engine_fiscal_power - Int
|
Engine fiscal power |
engine_fuel_type - EnergyType
|
Engine fuel type |
engine_fuel_type_secondary - EnergyType
|
Engine fuel type secondary |
engine_fuel_type_tertiary - EnergyType
|
Engine fuel type tertiary |
engine_ignition_system - String
|
Engine ignition system |
engine_manufacturer - String
|
Engine manufacturer |
engine_output_power - Int
|
Engine ouput power (kW) |
engine_output_power_ps - Int
|
Engine output power (PS) |
engine_rpm_idle_max - Int
|
Engine rpm idle max |
engine_rpm_idle_min - Int
|
Engine rpm idle min |
engine_rpm_max - Int
|
Engine rpm max |
engine_stroke - Float
|
Engine stroke (mm) |
engine_valves - Int
|
Engine valves |
engine_version - String
|
Engine version |
engine_with_turbo - Boolean
|
Engine with turbo |
extra_info - VinExtraInfo
|
Extra information |
front_overhang - Int
|
Front overhang (mm) |
front_track - Int
|
Front track (mm) |
fuel_efficiency_city - Float
|
Fuel efficiency city |
fuel_efficiency_combined - Float
|
Fuel efficiency combined |
fuel_efficiency_highway - Float
|
Fuel efficiency highway |
fuel_injection_control_type - String
|
Fuel injection control type |
fuel_injection_subtype - String
|
Fuel injection subtype |
fuel_injection_system_design - String
|
Fuel injection system design |
fuel_injection_type - String
|
Fuel injection type |
gearbox_speed - Int
|
Gearbox speeds count |
gearbox_type - String
|
Gearbox type |
gross_weight - Int
|
Gross wieght (kg) |
hc_emission - Float
|
HC emission (g/km) |
hc_nox_emission - Float
|
HC Nox emission (g/km) |
height - Int
|
Height (mm) |
hip_room_front - Int
|
Hip room front (mm) |
hip_room_rear - Int
|
Hip room rear (mm) |
id - ID!
|
Vehicle ID |
k_type - String
|
Vehicle kType |
kba - ID
|
Kraftfahrbundesamt (Germany and Austria) |
length - Int
|
Length (mm) |
make - String
|
Make |
manufacturer - String
|
Manufacturer |
max_roof_load - Int
|
Max roof load (kg) |
max_tow_bar_download - Int
|
Max tow bar download (kg) |
max_trailer_load_b_license - Int
|
Max trailer load B license (kg) |
max_trailer_load_braked_12 - Int
|
Max trailer load braked at 12% (kg) |
max_trailer_load_unbraked - Int
|
Max trailer load unbraked (kg) |
model - String
|
Model |
model_code - String
|
Model code |
model_version_code - String
|
Model version code |
month_of_first_circulation - Int
|
Month of first circulation |
month_of_sale - Int
|
Month of first sale |
nox_emission - Float
|
NOX emission (g/km) |
oil_temperature_emission - Float
|
Oil temperature emission - C° |
options - [DescriptionOption]
|
Options |
plate - String
|
Plate |
price - Int
|
Price |
rear_overhang - Int
|
Rear overhang (mm) |
rear_track - Int
|
Rear track (mm) |
seats - Int
|
Seats |
sli_battery_capacity - Float
|
Sli battery capacity (Ah) |
springs_front_type - String
|
Springs front type |
springs_rear_type - String
|
Springs rear type |
steering_system - String
|
Steering system |
steering_type - String
|
Steering type |
tank_volume - Int
|
Tank volume (l) |
top_speed - Int
|
Top speed (km/h) |
transmission_electronic_control - String
|
Transmission electronic control |
transmission_manufacturer_code - String
|
Transmission manufacturer code |
transmission_type - String
|
Transmission type |
trunk_volume - Int
|
Trunk volume |
url_vehicle_image - String
|
URL of vehicle image |
vehicle_type - String
|
Vehicle type |
verified - Boolean
|
Is vehicle verified |
vin - String
|
Vehicle VIN |
wheel_base - Int
|
Wheel base (mm) |
wheels_dimension - String
|
Wheels dimension |
width - Int
|
Width (mm) |
year_of_first_circulation - Int
|
Year of first circulation |
year_of_sale - Int
|
Year of first sale |
Example
{
"acceleration": 123.45,
"advanced_model": "abc123",
"body_type": "abc123",
"body_type_code": "abc123",
"brakes_abs": "xyz789",
"brakes_front_type": "xyz789",
"brakes_rear_type": "xyz789",
"brakes_system": "abc123",
"cargo_capacity": 123,
"co_2_emission": 987,
"co_emission": 987.65,
"color": "xyz789",
"company_id": "4",
"country": "xyz789",
"critair": "xyz789",
"curb_weight": 987,
"day_of_first_circulation": 123,
"day_of_sale": 987,
"decoding_region": "abc123",
"doors": 123,
"drive_type": "abc123",
"electric_vehicle_battery_capacity": 123.45,
"electric_vehicle_battery_voltage": 987.65,
"emission_standard": "xyz789",
"engine_aspiration": "xyz789",
"engine_bore": 987.65,
"engine_code": "xyz789",
"engine_configuration": "xyz789",
"engine_cylinder_head_type": "abc123",
"engine_cylinders": 987,
"engine_displacement": 123,
"engine_extra": "xyz789",
"engine_fiscal_power": 123,
"engine_fuel_type": "ADBLUE",
"engine_fuel_type_secondary": "ADBLUE",
"engine_fuel_type_tertiary": "ADBLUE",
"engine_ignition_system": "abc123",
"engine_manufacturer": "xyz789",
"engine_output_power": 987,
"engine_output_power_ps": 987,
"engine_rpm_idle_max": 123,
"engine_rpm_idle_min": 123,
"engine_rpm_max": 987,
"engine_stroke": 123.45,
"engine_valves": 123,
"engine_version": "xyz789",
"engine_with_turbo": true,
"extra_info": VinExtraInfo,
"front_overhang": 123,
"front_track": 987,
"fuel_efficiency_city": 987.65,
"fuel_efficiency_combined": 987.65,
"fuel_efficiency_highway": 123.45,
"fuel_injection_control_type": "abc123",
"fuel_injection_subtype": "xyz789",
"fuel_injection_system_design": "abc123",
"fuel_injection_type": "abc123",
"gearbox_speed": 987,
"gearbox_type": "xyz789",
"gross_weight": 123,
"hc_emission": 123.45,
"hc_nox_emission": 987.65,
"height": 123,
"hip_room_front": 987,
"hip_room_rear": 123,
"id": "4",
"k_type": "abc123",
"kba": "4",
"length": 123,
"make": "abc123",
"manufacturer": "xyz789",
"max_roof_load": 123,
"max_tow_bar_download": 123,
"max_trailer_load_b_license": 987,
"max_trailer_load_braked_12": 987,
"max_trailer_load_unbraked": 987,
"model": "xyz789",
"model_code": "xyz789",
"model_version_code": "xyz789",
"month_of_first_circulation": 123,
"month_of_sale": 123,
"nox_emission": 123.45,
"oil_temperature_emission": 987.65,
"options": [DescriptionOption],
"plate": "abc123",
"price": 987,
"rear_overhang": 987,
"rear_track": 123,
"seats": 123,
"sli_battery_capacity": 123.45,
"springs_front_type": "xyz789",
"springs_rear_type": "xyz789",
"steering_system": "xyz789",
"steering_type": "xyz789",
"tank_volume": 987,
"top_speed": 987,
"transmission_electronic_control": "abc123",
"transmission_manufacturer_code": "xyz789",
"transmission_type": "abc123",
"trunk_volume": 987,
"url_vehicle_image": "abc123",
"vehicle_type": "xyz789",
"verified": true,
"vin": "xyz789",
"wheel_base": 123,
"wheels_dimension": "xyz789",
"width": 987,
"year_of_first_circulation": 987,
"year_of_sale": 123
}
Description
Description
Description base interface. Every description_* inheritor possess a hidden type field with a different type
Fields
| Field Name | Description |
|---|---|
created_at - DateTime
|
Creation datetime |
id - ID!
|
Identifier |
label - String!
|
Label |
source - String!
|
Source |
updated_at - DateTime
|
Update datetime |
value - String
|
Value |
Possible Types
| Description Types |
|---|
Example
{
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"label": "xyz789",
"source": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"value": "xyz789"
}
DescriptionCreate
Fields
| Input Field | Description |
|---|---|
file - Upload
|
|
label - String!
|
|
type - DescriptionType!
|
|
value - String
|
Example
{
"file": Upload,
"label": "abc123",
"type": "FILE",
"value": "abc123"
}
DescriptionFile
Description
File Description
Example
{
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"label": "xyz789",
"source": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"value": "xyz789"
}
DescriptionImage
Description
Image Description
Example
{
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"label": "abc123",
"preview": "abc123",
"source": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"value": "abc123"
}
DescriptionInteger
Description
Integer Description
Example
{
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"label": "xyz789",
"source": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"value": "abc123"
}
DescriptionOption
DescriptionPaged
Description
Paginated description results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Description!]!
|
|
next - ID
|
Example
{"count": 987, "list": [Description], "next": 4}
DescriptionSort
Description
description sorting
Fields
| Input Field | Description |
|---|---|
by - DescriptionSortKey!
|
|
order - SortOrder!
|
Example
{"by": "CREATED_AT", "order": "A"}
DescriptionSortKey
Description
description sorting key
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
DescriptionString
Description
String Description
Example
{
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"label": "xyz789",
"source": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"value": "xyz789"
}
DescriptionSubject
Description
Object being described
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
type - DescriptionSubjectType!
|
Example
{"id": "4", "type": "DRIVERS"}
DescriptionSubjectType
Description
Description subject type Enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DRIVERS"
DescriptionType
Description
Description type Enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FILE"
DescriptionUpdate
Device
Description
Device Object
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier |
active_account - String
|
Active Account |
aggregated_data - AggregatedData
|
Fields aggregated from multiple sources |
Arguments
|
|
alerts - VehicleAlertPaged
|
|
Arguments
|
|
alerts_state - VehicleAlertsState
|
|
battery_annotations - BatteryAnnotationPaged
|
|
created_at - DateTime
|
Always null |
current_vehicle - Vehicle
|
Current Vehicle |
device_type - String
|
Device Type |
fields - FieldPaged
|
Last value of device fields |
first_connection_at - DateTime
|
First connection date |
groups - GroupPaged
|
Groups |
harshes - TripHarshPaged
|
Harsh events |
history - DeviceHistoryPaged
|
Device history |
last_activity_at - DateTime
|
Last network activity date |
last_connection_at - DateTime
|
Last connection date |
last_connection_reason - DeviceConnectionReason
|
Last connection reason |
last_disconnection_at - DateTime
|
Last disconnection date |
last_disconnection_reason - DeviceDisconnectionReason
|
Last disconnection reason |
last_position - Coordinates
|
Last received vehicle position |
last_trip - Trip
|
Last trip |
Arguments
|
|
log_fetches - LogfetchPaged
|
|
Arguments
|
|
onboarded - Boolean
|
Onboarded |
overspeeds - TripOverspeedPaged
|
Overspeed events |
owner - Account
|
Owner |
product - Product
|
|
profile_mode - ProfileDeviceMode
|
|
profile_modes - ProfileDeviceModePaged
|
|
profile_privacies - ProfilePrivacyPaged
|
|
profile_privacy - ProfilePrivacy
|
|
readings - ReadingPaged
|
|
Arguments
|
|
readings_anon - ReadingAnonPaged
|
|
Arguments
|
|
remote_diags - RemoteDiagPaged!
|
|
serial_number - String
|
Serial Number |
status - DeviceStatus
|
Use *connection_at |
trip_summary - TripSummary
|
Aggregated trip statistics |
trips - TripPaged
|
Trips |
Arguments
|
|
updated_at - DateTime
|
Always null |
vehicle_sessions - DeviceVehicleSessionPaged
|
Vehicle Sessions |
vehicles - VehiclePaged
|
Vehicles |
dashcams - dashcam_paged
|
|
video_segments - video_segment_paged
|
|
Arguments
|
|
geofences - geofence_paginated
|
|
cleaned_positions - map_matching_position_paginated
|
|
summary_from_journey - journey_summary
|
|
trip_journeys - journey_trip_paginated
|
|
trip_tag_schedules - trip_tag_schedule_paginated
|
|
journey_reports - reports_response
|
|
Arguments
|
|
journey_harshes - journey_trip_harsh_paginated
|
|
journey_overspeeds - trip_overspeeds_response
|
|
journey_idlings - trip_idlings_response
|
|
journey_config - devices_device_config_response
|
|
Example
{
"id": 4,
"active_account": "abc123",
"aggregated_data": AggregatedData,
"alerts": VehicleAlertPaged,
"alerts_state": VehicleAlertsState,
"battery_annotations": BatteryAnnotationPaged,
"created_at": "2007-12-03T10:15:30Z",
"current_vehicle": Vehicle,
"device_type": "abc123",
"fields": FieldPaged,
"first_connection_at": "2007-12-03T10:15:30Z",
"groups": GroupPaged,
"harshes": TripHarshPaged,
"history": DeviceHistoryPaged,
"last_activity_at": "2007-12-03T10:15:30Z",
"last_connection_at": "2007-12-03T10:15:30Z",
"last_connection_reason": "CLOSED_BY_SERVER",
"last_disconnection_at": "2007-12-03T10:15:30Z",
"last_disconnection_reason": "AUTH_FAILED_ACCOUNT",
"last_position": Coordinates,
"last_trip": Trip,
"log_fetches": LogfetchPaged,
"onboarded": false,
"overspeeds": TripOverspeedPaged,
"owner": Account,
"product": Product,
"profile_mode": ProfileDeviceMode,
"profile_modes": ProfileDeviceModePaged,
"profile_privacies": ProfilePrivacyPaged,
"profile_privacy": ProfilePrivacy,
"readings": ReadingPaged,
"readings_anon": ReadingAnonPaged,
"remote_diags": RemoteDiagPaged,
"serial_number": "xyz789",
"status": "CONNECTED",
"trip_summary": TripSummary,
"trips": TripPaged,
"updated_at": "2007-12-03T10:15:30Z",
"vehicle_sessions": DeviceVehicleSessionPaged,
"vehicles": VehiclePaged,
"dashcams": dashcam_paged,
"video_segments": video_segment_paged,
"geofences": geofence_paginated,
"cleaned_positions": map_matching_position_paginated,
"summary_from_journey": journey_summary,
"trip_journeys": journey_trip_paginated,
"trip_tag_schedules": trip_tag_schedule_paginated,
"journey_reports": report_paginated,
"journey_harshes": journey_trip_harsh_paginated,
"journey_overspeeds": journey_trip_overspeed_paginated,
"journey_idlings": journey_trip_idling_paginated,
"journey_config": device_config_show_nullable
}
DeviceConnectionReason
Description
Device connection reason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLOSED_BY_SERVER"
DeviceConnectionType
Description
How the device is connected to the vehicle
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CABLE"
DeviceDisconnectionReason
Description
Device disconnection reason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTH_FAILED_ACCOUNT"
DeviceHistory
Fields
| Field Name | Description |
|---|---|
action - DeviceHistoryAction
|
|
id - ID!
|
|
label_new - String
|
|
label_previous - String
|
Example
{
"action": "ACTIVE_ACCOUNT_CHANGED",
"id": 4,
"label_new": "xyz789",
"label_previous": "xyz789"
}
DeviceHistoryAction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE_ACCOUNT_CHANGED"
DeviceHistoryPaged
Description
Paginated device_history results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [DeviceHistory!]!
|
|
next - ID
|
Example
{"count": 123, "list": [DeviceHistory], "next": 4}
DeviceInput
Description
Device Input
Example
{
"active_account": "abc123",
"device_type": "abc123",
"id": 4,
"owner_id": 4,
"serial_number": "abc123"
}
DeviceNotification
Description
Device notification
Fields
| Field Name | Description |
|---|---|
device - Device
|
Device |
Possible Types
| DeviceNotification Types |
|---|
Example
{"device": Device}
DevicePaged
Description
Paginated device results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Device!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [Device],
"next": "4"
}
DevicePresence
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CONNECTED"
DeviceStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CONNECTED"
DeviceVehicleSession
Description
Vehiclie session of a device
Fields
| Field Name | Description |
|---|---|
active - Boolean
|
Active |
connection_type - DeviceConnectionType
|
Device connection type |
device - Device
|
Device |
id - ID!
|
Identifier |
installation_date - DateTime!
|
Installation Date |
km_at_installation - Int!
|
KM At Installation |
owner - Account
|
Owner |
removal_date - DateTime
|
Removal Date |
vehicle - Vehicle
|
Vehicle |
Example
{
"active": true,
"connection_type": "CABLE",
"device": Device,
"id": 4,
"installation_date": "2007-12-03T10:15:30Z",
"km_at_installation": 987,
"owner": Account,
"removal_date": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
DeviceVehicleSessionPaged
Description
Paginated device_vehicle_session results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [DeviceVehicleSession!]!
|
|
next - ID
|
Example
{"count": 123, "list": [DeviceVehicleSession], "next": 4}
DongleInstallationInstruction
Description
Dongle physical installation instruction
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized dongle physical installation instruction |
|
|
Cable makes installation easier |
|
|
Cable is needed |
|
|
Cannot close cover after installation |
|
|
Installation requires specific knowledge |
Example
"OTHER"
DoorAction
Description
Lock or unlock the door
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LOCK"
DoorsLockStatus
Values
| Enum Value | Description |
|---|---|
|
|
The vehicle doors are locked. |
|
|
The doors lock state is not reported, not supported or cannot be determined. |
|
|
The vehicle doors are unlocked. |
Example
"LOCKED"
Driver
Description
Driver information
Fields
| Field Name | Description |
|---|---|
active - Boolean
|
Active |
created_at - DateTime
|
Created At Always null |
current_vehicle - Vehicle
|
Current Vehicle |
current_vehicles - VehiclePaged
|
Current Vehicles |
default_vehicle - Vehicle
|
Default Vehicle |
descriptions - DescriptionPaged
|
Descriptions |
Arguments
|
|
groups - GroupPaged
|
Groups |
id - ID!
|
Identifier |
id_key - String
|
ID Key |
label - String!
|
Label |
last_trip - Trip
|
Last trip |
Arguments
|
|
trips - TripPaged
|
Trips |
updated_at - DateTime
|
Updated At Always null |
user_contact - Account
|
Driver User Contact |
user_profile - Account
|
Driver User Profile |
vehicle_sessions - DriverVehicleSessionPaged
|
Vehicle Sessions |
vehicles - VehiclePaged
|
Vehicles |
auxiliary_devices - driver_auxiliary_devices_response
|
|
Arguments
|
|
auxiliary_device - get_driver_auxiliary_device_response
|
|
Arguments
|
|
Example
{
"active": true,
"created_at": "2007-12-03T10:15:30Z",
"current_vehicle": Vehicle,
"current_vehicles": VehiclePaged,
"default_vehicle": Vehicle,
"descriptions": DescriptionPaged,
"groups": GroupPaged,
"id": 4,
"id_key": "abc123",
"label": "abc123",
"last_trip": Trip,
"trips": TripPaged,
"updated_at": "2007-12-03T10:15:30Z",
"user_contact": Account,
"user_profile": Account,
"vehicle_sessions": DriverVehicleSessionPaged,
"vehicles": VehiclePaged,
"auxiliary_devices": auxiliary_device_paginated,
"auxiliary_device": auxiliary_device_show
}
DriverPaged
Description
Paginated driver results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Driver!]!
|
|
next - ID
|
Example
{"count": 987, "list": [Driver], "next": 4}
DriverService
Description
Workshop driver service
Example
{
"id": "4",
"description": "xyz789",
"label": "xyz789",
"workshops": WorkshopPaged
}
DriverServicePaged
Description
Paginated driver_service results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [DriverService!]!
|
|
next - ID
|
Example
{"count": 123, "list": [DriverService], "next": 4}
DriverVehicleSession
Description
DriverVehicleSession Object
Example
{
"active": false,
"driver": Driver,
"end_at": "2007-12-03T10:15:30Z",
"id": 4,
"owner": Account,
"start_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
DriverVehicleSessionPaged
Description
Paginated driver_vehicle_session results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [DriverVehicleSession!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [DriverVehicleSession],
"next": "4"
}
Dtc
Description
DTC code informations
Fields
| Field Name | Description |
|---|---|
cause - String
|
Cause related to the dtc code. |
classification - String
|
Dtc code classification |
code - String
|
Dtc code |
description - String
|
Dtc code general context and description / category of the affected function and system |
effect - String
|
Effect may be caused by the dtc code. |
id - ID!
|
Dtc decoded information ID |
information - String
|
This usually provides more specific info or the way it works about the component or system that is affected by the Dtc code |
mdi_dtc - String
|
MDI Dtc translation |
protocol - String
|
Dtc code protocol |
recommendation - String
|
Code recemmendation |
risk_availability - DtcRisk
|
Assesses the potential impact of the fault on the vehicle's ability to operate reliably, if applicable; Supported values: critical, major, minor, no |
risk_damage - DtcRisk
|
Assesses the potential risk of further damage or accelerated wear to vehicle components and systems due to the fault, if applicable; Supported values: critical, major, minor, no |
risk_emissions - DtcRisk
|
Assesses the potential impact of the fault on the vehicle's emission levels and compliance, if applicable; Supported values: critical, major, minor, no |
risk_safety - DtcRisk
|
Assesses the potential risk to the safety of the driver and other occupants if the vehicle continues to operate with the fault, if applicable; Supported values: critical, major, minor, no |
subdescription - String
|
Dtc code additional description / sub category of the affected system/function |
system_category - String
|
System category of the DTC, if applicable |
warning - String
|
In case of working with the affected component which can be dangerous, certain warnings are shown, if applicable |
warning_img - String
|
Warning image URL, if applicable |
Example
{
"cause": "abc123",
"classification": "xyz789",
"code": "xyz789",
"description": "abc123",
"effect": "xyz789",
"id": 4,
"information": "xyz789",
"mdi_dtc": "xyz789",
"protocol": "xyz789",
"recommendation": "xyz789",
"risk_availability": "CRITICAL",
"risk_damage": "CRITICAL",
"risk_emissions": "CRITICAL",
"risk_safety": "CRITICAL",
"subdescription": "xyz789",
"system_category": "xyz789",
"warning": "xyz789",
"warning_img": "abc123"
}
DtcClassification
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVISORY"
DtcFreezeFrameParam
DtcFreezeFrames
Fields
| Field Name | Description |
|---|---|
description - String
|
|
params - [DtcFreezeFrameParam]
|
Example
{
"description": "xyz789",
"params": [DtcFreezeFrameParam]
}
DtcMode
Values
| Enum Value | Description |
|---|---|
|
|
Absent (polled, and disappeared afterwards) |
|
|
Active |
|
|
Historical (aka permanent) |
|
|
Intermittent |
|
|
Unkown |
Example
"ABSENT"
DtcProtocol
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
DtcRegion
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EU"
DtcRisk
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CRITICAL"
DtcSource
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
EndOfProcess_Input
Fields
| Input Field | Description |
|---|---|
status - mutationInput_put_action_input_data_attributes_stack_oneOf_1_status!
|
|
details - String
|
Example
{"status": "SUCCESS", "details": "abc123"}
EnergyType
Values
| Enum Value | Description |
|---|---|
|
|
Diesel exhaust additive fluid |
|
|
Aral ultimate |
|
|
Bio diesel |
|
|
Blue One |
|
|
Compressed Natural Gas |
|
|
Petroleum diesel |
|
|
May contain up to 10% of ethanol |
|
|
May contain up to 85% of ethanol |
|
|
Electric vehicle |
|
|
Ethanol |
|
|
Gasoline |
|
|
Hybrid |
|
|
Hydrogen |
|
|
Leaded four star petrol |
|
|
Liquefied Petroleum Gas |
|
|
Lead Replacement Petrol |
|
|
Methane |
|
|
Methanol |
|
|
Mid-grade octane rating |
|
|
Unrecognized or uncategorized energy type |
|
|
Premium octane rating |
|
|
Regular octane rating |
|
|
Unleaded petrol |
|
|
Unleaded with ethanol |
|
|
Shell V-Power |
Example
"ADBLUE"
EventPokeArg
Description
Poke event arg
Example
{
"device_id": "4",
"id": "4",
"namespace": "abc123",
"payload": "xyz789",
"sender": "xyz789"
}
EventPositionArg
Fields
| Input Field | Description |
|---|---|
device_id - ID!
|
|
pos - [CoordinatesInput!]!
|
Example
{
"device_id": "4",
"pos": [CoordinatesInput]
}
EventPresenceArg
Fields
| Input Field | Description |
|---|---|
connection_reason - DeviceConnectionReason
|
|
device_id - ID!
|
|
disconnection_reason - DeviceDisconnectionReason
|
|
status - DevicePresence!
|
Example
{
"connection_reason": "CLOSED_BY_SERVER",
"device_id": 4,
"disconnection_reason": "AUTH_FAILED_ACCOUNT",
"status": "CONNECTED"
}
EventRemotediagArg
EventTrackArg
Description
Track event arg
Fields
| Input Field | Description |
|---|---|
device_id - ID!
|
Device that sent the track |
fields - [FieldNotify!]!
|
fields |
Example
{"device_id": 4, "fields": [FieldNotify]}
Field
Description
Field base interface. Every field_* inheritor possess a value field with a different type
Fields
| Field Name | Description |
|---|---|
coordinates - Coordinates
|
Field {lat,long,alt}itude and time coordinates |
name - String
|
Field name |
Possible Types
| Field Types |
|---|
Example
{
"coordinates": Coordinates,
"name": "abc123"
}
FieldBoolean
Description
Boolean field
Fields
| Field Name | Description |
|---|---|
coordinates - Coordinates
|
Field {lat,long,alt}itude and time coordinates |
name - String
|
Field name |
value - Boolean
|
Field value |
Example
{
"coordinates": Coordinates,
"name": "abc123",
"value": false
}
FieldFloat
Description
Float field
Fields
| Field Name | Description |
|---|---|
coordinates - Coordinates
|
Field {lat,long,alt}itude and time coordinates |
name - String
|
Field name |
value - Float
|
Field value |
Example
{
"coordinates": Coordinates,
"name": "abc123",
"value": 123.45
}
FieldInteger
Description
Integer field
Fields
| Field Name | Description |
|---|---|
coordinates - Coordinates
|
Field {lat,long,alt}itude and time coordinates |
name - String
|
Field name |
value - Int
|
Field value |
Example
{
"coordinates": Coordinates,
"name": "xyz789",
"value": 123
}
FieldNotify
Description
Field mutation input
Example
{
"bvalue": false,
"coordinates": CoordinatesInput,
"fvalue": 123.45,
"ivalue": 987,
"name": "abc123",
"svalue": "abc123"
}
FieldPaged
FieldString
Description
String field
Fields
| Field Name | Description |
|---|---|
coordinates - Coordinates
|
Field {lat,long,alt}itude and time coordinates |
name - String
|
Field name |
value - String
|
Field value |
Example
{
"coordinates": Coordinates,
"name": "xyz789",
"value": "xyz789"
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
FloatObj
Fields
| Field Name | Description |
|---|---|
value - Float!
|
Example
{"value": 987.65}
FloatTensor
FunctionNameType
Description
Function name enum
Values
| Enum Value | Description |
|---|---|
|
|
Delete a profile |
|
|
Download and enable a new profile |
|
|
Download a new profile |
|
|
Enable a profile |
|
|
Get eUICC information |
|
|
List all profiles |
|
|
Set the nickname of a profile |
Example
"DELETE_PROFILE"
GarageModeStatus
Values
| Enum Value | Description |
|---|---|
|
|
The garage mode is inactive. |
|
|
The garage mode is active. |
|
|
The garage mode state is not reported, not supported or cannot be determined. |
Example
"DISABLED"
Geodecode
Description
Reverse Geocoding
Fields
| Field Name | Description |
|---|---|
elements - GeodecodeElements
|
|
extent - GeodecodeExtent
|
Bounding box extent of all elements in WGS84 format |
Example
{
"elements": GeodecodeElements,
"extent": GeodecodeExtent
}
GeodecodeClassId
GeodecodeCoordinate
Example
{
"distance_from_request": 987.65,
"length_unity": "abc123",
"x": 123.45,
"y": 987.65
}
GeodecodeElement
Fields
| Field Name | Description |
|---|---|
angle - Float
|
Angle of matched road segment. Value is a double in degrees. |
coordinate - GeodecodeCoordinate
|
Matched coordinate. |
postal_address - GeodecodePostalAddress
|
|
relevance_score - Float
|
Scoring of last (deepest) item found. Range value is a double between 0 to 1. the best matching is 1. |
speed_limit - Float
|
Administrative speed limit in km/h. |
types - [GeodecodeTypes]
|
List of type. |
Example
{
"angle": 987.65,
"coordinate": GeodecodeCoordinate,
"postal_address": GeodecodePostalAddress,
"relevance_score": 987.65,
"speed_limit": 987.65,
"types": [GeodecodeTypes]
}
GeodecodeElements
Fields
| Field Name | Description |
|---|---|
count - Int
|
The number of elements found. |
element - [GeodecodeElement]
|
The response element of reverse-geocoding. |
Example
{"count": 123, "element": [GeodecodeElement]}
GeodecodeExtent
Description
The bounding box of matched element. Coordinates are in in WGS84. The bounding box contains a couple of coordinates that represent the bottom left corn and the top right corn
Example
{"max_x": 123.45, "max_y": 123.45, "min_x": 987.65, "min_y": 123.45}
GeodecodePostalAddress
Fields
| Field Name | Description |
|---|---|
city - String
|
Name of city. |
class_id - GeodecodeClassId
|
|
country - String
|
name of country. |
country_code - String
|
ISO code of country. |
county - String
|
Nam of county. |
district - String
|
Name of district. |
opposite_street_number - String
|
The opposite street number. |
postal_code - String
|
The postal code (Zip code). |
state - String
|
Name of state. |
street - String
|
Name of street. |
street_number - String
|
Name of street. |
Example
{
"city": "abc123",
"class_id": GeodecodeClassId,
"country": "abc123",
"country_code": "abc123",
"county": "abc123",
"district": "xyz789",
"opposite_street_number": "abc123",
"postal_code": "xyz789",
"state": "xyz789",
"street": "xyz789",
"street_number": "abc123"
}
GeodecodeTypes
Fields
| Field Name | Description |
|---|---|
type - String
|
Administrative level of network. |
Example
{"type": "xyz789"}
GeofencingEvent
Description
geofencing event
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized geofencing event |
|
|
|
|
|
|
|
|
Example
"OTHER"
GeofencingState
Description
geofencing state
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized geofencing state |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
Group
Description
Group information
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier |
alerts - VehicleAlertPaged
|
|
Arguments
|
|
children - GroupPaged
|
Children |
Arguments
|
|
descriptions - DescriptionPaged
|
Descriptions |
Arguments
|
|
devices - DevicePaged
|
Devices |
Arguments
|
|
drivers - DriverPaged
|
Drivers |
Arguments
|
|
hierarchy_level - GroupHierarchyLevel!
|
Hierarchy level |
label - String!
|
Label |
owner - Account
|
Owner |
parents - GroupPaged
|
Parents |
Arguments
|
|
tags - [String!]
|
Tags |
users - AccountPaged
|
Users |
vehicles - VehiclePaged
|
Vehicles |
Arguments
|
|
device_groups - device_group_paginated
|
|
user_roles - user_role_paginated
|
|
geofences - geofence_paginated
|
|
summary_from_journey - journey_summary
|
|
journey_reports - reports_response
|
|
Arguments
|
|
summary_from_alerts - post_v1_fleet_summaries_response!
|
|
Example
{
"id": 4,
"alerts": VehicleAlertPaged,
"children": GroupPaged,
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"drivers": DriverPaged,
"hierarchy_level": "CENTER",
"label": "xyz789",
"owner": Account,
"parents": GroupPaged,
"tags": ["xyz789"],
"users": AccountPaged,
"vehicles": VehiclePaged,
"device_groups": device_group_paginated,
"user_roles": user_role_paginated,
"geofences": geofence_paginated,
"summary_from_journey": journey_summary,
"journey_reports": report_paginated,
"summary_from_alerts": fleet_summary
}
GroupHierarchyLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CENTER"
GroupMember
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHILD"
GroupPaged
HTTPMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"GET"
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
Idcoordinates
Description
Spatial coordinates and timestamp, with id
Example
{
"alt": 987,
"id": 4,
"lat": 123.45,
"lng": 987.65,
"max_speed": 987,
"speed": 987,
"time": "2007-12-03T10:15:30Z"
}
IdcoordinatesPaged
Description
Paginated idcoordinates results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Idcoordinates!]!
|
|
next - ID
|
Example
{"count": 123, "list": [Idcoordinates], "next": 4}
ImmobilizerStatus
Values
| Enum Value | Description |
|---|---|
|
|
The immobilizer is inactive, allowing the vehicle to start and operate normally. |
|
|
The immobilizer is active, preventing the vehicle from being started or moved. |
|
|
The immobilizer state is not reported, not supported or cannot be determined. |
Example
"DISABLED"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
IntegerObj
Fields
| Field Name | Description |
|---|---|
value - Int!
|
Example
{"value": 123}
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
Json
Description
The Json scalar type represents arbitrary json string data, represented as UTF-8 character sequences. The Json type is most often used to represent a free-form human-readable json string.
Example
Json
JsonObj
Fields
| Field Name | Description |
|---|---|
value - Json
|
Debugging purpose only |
Example
{"value": Json}
Lang
Description
Limited list of ISO 639-1 language codes
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized language |
|
|
English |
|
|
Français - French |
|
|
Deutch - German |
|
|
Italiano - Italian |
|
|
Español - Spanish |
Example
"OTHER"
LangArg
Description
Limited list of ISO 639-1 language codes argument
Values
| Enum Value | Description |
|---|---|
|
|
English |
|
|
Français - French |
|
|
Deutch - German |
|
|
Italiano - Italian |
|
|
Español - Spanish |
Example
"EN"
Language
Description
Language string, formatted according to IETF's BCP 47 (a leading two-lowercase-letter tag, optionaly followed by subtags)
Example
Language
Logfetch
Description
Log fetch request
Example
{
"account": "xyz789",
"action_name": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"reason": "xyz789",
"status": "ABORTED",
"updated_at": "2007-12-03T10:15:30Z"
}
LogfetchAction
LogfetchActionPaged
Description
Paginated logfetch_action results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [LogfetchAction!]!
|
|
next - ID
|
Example
{"count": 987, "list": [LogfetchAction], "next": 4}
LogfetchPaged
Description
Paginated logfetch results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Logfetch!]!
|
|
next - ID
|
Example
{"count": 123, "list": [Logfetch], "next": 4}
LogfetchStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ABORTED"
Lpa
Description
Munic LPA model
Fields
| Field Name | Description |
|---|---|
function_name - String
|
Function name |
id - ID
|
Request id |
imei - ID
|
Device imei |
parameters - Parameters
|
Associated parameters |
status - String
|
The request status, it can have the following values: CREATED/STARTED/TIMEOUT/SUCCEEDED |
Example
{
"function_name": "abc123",
"id": 4,
"imei": 4,
"parameters": Parameters,
"status": "xyz789"
}
MaintenanceCriticality
Description
maintenance criticality
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized maintenance criticality |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
MaintenanceCriticalityArg
Description
maintenance criticality argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"HIGH"
MaintenanceCriticalityThreshold
Example
{
"criticality": 987,
"description": "abc123",
"id": 4,
"remaining_distance": 987,
"remaining_duration": 987
}
MaintenanceCriticalityThresholdPaged
Description
Paginated maintenance_criticality_threshold results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [MaintenanceCriticalityThreshold!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [MaintenanceCriticalityThreshold],
"next": "4"
}
MaintenanceHistorical
Description
Historical vehicle maintenance
When an upcoming maintenance is "done'.
Fields
| Field Name | Description |
|---|---|
id - ID
|
Historical maintenance ID |
date - DateTime
|
Maintenance date |
mileage - Int
|
Mileage (km) |
template - MaintenanceTemplate
|
Maintenance template |
vehicle - Vehicle
|
Vehicle |
Example
{
"id": "4",
"date": "2007-12-03T10:15:30Z",
"mileage": 987,
"template": MaintenanceTemplate,
"vehicle": Vehicle
}
MaintenanceHistoricalPaged
Description
Paginated maintenance_historical results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [MaintenanceHistorical!]!
|
|
next - ID
|
Example
{"count": 123, "list": [MaintenanceHistorical], "next": 4}
MaintenanceSchedule
Description
Maintenance schedule
Combined with maintenante templates to generate upcoming maintenances
Fields
| Field Name | Description |
|---|---|
distance - Int
|
Distance until next maintenance (km) |
duration - Int
|
Time until next maintenance (seconds) |
id - ID
|
Schedule Id |
model_id - Int
|
Vehicle model ID |
rule - MaintenanceScheduleRule
|
Schedule rule |
template - MaintenanceTemplate
|
Maintenance template |
Example
{
"distance": 987,
"duration": 987,
"id": 4,
"model_id": 987,
"rule": MaintenanceScheduleRule,
"template": MaintenanceTemplate
}
MaintenanceSchedulePaged
Description
Paginated maintenance_schedule results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [MaintenanceSchedule!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [MaintenanceSchedule],
"next": "4"
}
MaintenanceScheduleRule
Fields
| Field Name | Description |
|---|---|
mileage - Int
|
Trigger after distance travelled (km) |
month - Int
|
Trigger after time elapsed (months) |
type - MaintenanceScheduleRuleType
|
Example
{"mileage": 987, "month": 123, "type": "AT"}
MaintenanceScheduleRuleType
Values
| Enum Value | Description |
|---|---|
|
|
One-off schedule |
|
|
Recurring schedule |
Example
"AT"
MaintenanceSystem
MaintenanceTemplate
Description
Maintenance template
Combined with maintenante schedules to generate upcoming maintenances
Fields
| Field Name | Description |
|---|---|
id - ID
|
Maintenance template ID |
description - String
|
Maintenance description |
from_external_service - Boolean
|
|
system - MaintenanceSystem!
|
Maintenance system |
Example
{
"id": "4",
"description": "xyz789",
"from_external_service": true,
"system": MaintenanceSystem
}
MaintenanceTemplatePaged
Description
Paginated maintenance_template results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [MaintenanceTemplate!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [MaintenanceTemplate],
"next": "4"
}
MaintenanceUpcoming
Description
Upcoming vehicle maintenance
Fields
| Field Name | Description |
|---|---|
id - ID
|
Maintenance ID |
criticality - MaintenanceCriticalityThreshold
|
Maintenance criticality |
date_deadline - DateTime
|
Maintenance deadline date |
mileage_deadline - Int
|
Maintenance deadline mileage (km) |
remaining_days_to_drive - Int
|
Maintenance remaining days |
remaining_distance_to_drive - Int
|
Maintenance remaining distance (km) |
template - MaintenanceTemplate
|
Maintenance template |
vehicle - Vehicle
|
Vehicle |
Example
{
"id": "4",
"criticality": MaintenanceCriticalityThreshold,
"date_deadline": "2007-12-03T10:15:30Z",
"mileage_deadline": 987,
"remaining_days_to_drive": 987,
"remaining_distance_to_drive": 987,
"template": MaintenanceTemplate,
"vehicle": Vehicle
}
MaintenanceUpcomingPaged
Description
Paginated maintenance_upcoming results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [MaintenanceUpcoming!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [MaintenanceUpcoming],
"next": "4"
}
MemberOperation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ADD"
Metric
Example
{
"description": "xyz789",
"id": "4",
"name": "abc123",
"tensor_shape": [123],
"type": "OTHER",
"unit_name": "abc123",
"unit_notation": "xyz789"
}
MetricPaged
Description
Paginated metric results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Metric!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [Metric],
"next": "4"
}
MetricType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
NonNegativeInt
Description
Integers that will have a value of 0 or more.
Example
123
ObjMap
Example
ObjMap
OnboardingAction
Fields
| Field Name | Description |
|---|---|
action - OnboardingActionAction!
|
|
created_at - DateTime!
|
|
id - ID!
|
|
triggered_by - Account
|
Example
{
"action": "OTHER",
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"triggered_by": Account
}
OnboardingActionAction
Description
Action type
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized action type |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
OnboardingActionPaged
Description
Paginated onboarding_action results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [OnboardingAction!]!
|
|
next - ID
|
Example
{"count": 987, "list": [OnboardingAction], "next": 4}
OnboardingAuxiliaryDevice
Fields
| Field Name | Description |
|---|---|
asset_manager_id - String
|
|
connection_type - OnboardingAuxiliaryDeviceConnectionType
|
|
id - ID!
|
|
id_key - String
|
|
kind - OnboardingAuxiliaryDeviceKind!
|
|
label - String
|
|
mac_address_hash - String
|
|
sensor_functions - [OnboardingAuxiliarySensorFunction!]
|
|
serial_number - String
|
|
wifi_password - String
|
WiFi password if connection type is wifi |
wifi_ssid - String
|
WiFi SSID if connection type is wifi |
Example
{
"asset_manager_id": "abc123",
"connection_type": "BLUETOOTH",
"id": "4",
"id_key": "xyz789",
"kind": "DASHCAM",
"label": "xyz789",
"mac_address_hash": "abc123",
"sensor_functions": ["ACCELERATION"],
"serial_number": "abc123",
"wifi_password": "abc123",
"wifi_ssid": "abc123"
}
OnboardingAuxiliaryDeviceConnectionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BLUETOOTH"
OnboardingAuxiliaryDeviceKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DASHCAM"
OnboardingAuxiliaryDevicePaged
Description
Paginated onboarding_auxiliary_device results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [OnboardingAuxiliaryDevice!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [OnboardingAuxiliaryDevice],
"next": "4"
}
OnboardingAuxiliarySensorFunction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCELERATION"
OnboardingConsent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
inherited - Boolean!
|
Inherited from client identification |
whitelisted_data - [OnboardingWhitelistedData!]
|
Example
{"id": 4, "inherited": false, "whitelisted_data": ["OTHER"]}
OnboardingDeviceBluetoothMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DEFAULT_MODE"
OnboardingDistributor
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Distributor id |
is_active - Boolean
|
|
label - String
|
|
organization_id - ID
|
Organization id |
provider - OnboardingProvider
|
|
provider_workshop_id - ID
|
Workshop third-party (provider) id |
requests - OnboardingRequestPaged
|
|
Arguments
|
|
staff - OnboardingStaffPaged
|
|
workshop - Workshop
|
|
Example
{
"id": 4,
"is_active": true,
"label": "abc123",
"organization_id": "4",
"provider": OnboardingProvider,
"provider_workshop_id": 4,
"requests": OnboardingRequestPaged,
"staff": OnboardingStaffPaged,
"workshop": Workshop
}
OnboardingDistributorPaged
Description
Paginated onboarding_distributor results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [OnboardingDistributor!]!
|
|
next - ID
|
Example
{"count": 123, "list": [OnboardingDistributor], "next": 4}
OnboardingDriverAssociation
OnboardingEnergyTypeArg
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DIESEL"
OnboardingMode
Description
onboarding mode
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized onboarding mode |
|
|
Only device_reservation step is required. The request will be finalized automatically when VIN is sent if decoded successfully. |
|
|
All steps are required, and request should be finalized manually. |
|
|
For GPS trackers that do not need custom configuration. Only device_reservation and vehicle_creation steps are required. |
Example
"OTHER"
OnboardingModeArg
Description
onboarding mode argument
Values
| Enum Value | Description |
|---|---|
|
|
Only device_reservation step is required. The request will be finalized automatically when VIN is sent if decoded successfully. |
|
|
All steps are required, and request should be finalized manually. |
|
|
For GPS trackers that do not need custom configuration. Only device_reservation and vehicle_creation steps are required. |
Example
"DISCOVERY"
OnboardingPartner
Example
{
"id": 4,
"name": "abc123",
"organization_id": "4",
"project": Project,
"providers": OnboardingProviderPaged
}
OnboardingPartnerPaged
Description
Paginated onboarding_partner results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [OnboardingPartner!]!
|
|
next - ID
|
Example
{"count": 987, "list": [OnboardingPartner], "next": 4}
OnboardingProvider
OnboardingProviderPaged
Description
Paginated onboarding_provider results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [OnboardingProvider!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [OnboardingProvider],
"next": "4"
}
OnboardingRequest
Description
Pending onboarding request
Fields
| Field Name | Description |
|---|---|
actions - OnboardingActionPaged
|
Action history |
activate_read_write_in_device - Boolean
|
Whether read-write is enabled |
auxiliary_devices - OnboardingAuxiliaryDevicePaged
|
|
Arguments
|
|
client_identification_id - ID
|
Client Identification id |
cloned_from - OnboardingRequest
|
Parent request this request was cloned from |
cloned_to - OnboardingRequest
|
Child request this request was cloned to |
connection_type - DeviceConnectionType
|
Device connection type |
consent - OnboardingConsent
|
Privacy consent |
created_at - DateTime
|
Request creation datetime |
created_by - Account
|
Account that created this request |
device - Device
|
Device IMEI |
device_bluetooth - OnboardingDeviceBluetoothMode
|
Device Bluetooth mode |
device_created_by - Account
|
Account that created this request's device |
device_mode - ProfileDeviceModeClass
|
|
distributor - OnboardingDistributor
|
Request distributor |
driver - Account
|
Account created by this request |
driver_associated_by - Account
|
Account that associated this request's driver |
driver_association_id - ID
|
Driver association id |
driver_created_by - Account
|
Account that created this request's driver |
driver_validated_by - Account
|
Account that validated this request's driver |
id - ID!
|
Request id |
km_at_installation - Int
|
Odometer (km) at installation |
mode - OnboardingMode
|
Onboarding mode |
plate_number - ID
|
Vehicle plate number |
profile - ProfileOnboarding
|
Profile status |
serial_number - String
|
Device serial number |
status - OnboardingStatus
|
Is the request still ongoing |
updated_at - DateTime
|
Request update datetime |
vehicle - Vehicle
|
Vehicle created by this request |
vehicle_associated_by - Account
|
Account that associated this request's vehicle |
vehicle_connection - OnboardingVehicleConnection
|
Vehicle connection |
vehicle_created_by - Account
|
Account that created this request's vehicle |
vehicle_creation_id - ID
|
Vehicle creation id |
vehicle_enriched_by - Account
|
Account that enriched this request's vehicle |
vehicle_enrichments - OnboardingVehicle
|
Vehicle enrichments |
vehicle_label - String
|
Vehicle label |
vin - String
|
Vehicle VIN |
warnings - [OnboardingWarning!]
|
Errors encountered |
with_code - Boolean
|
Whether an onboarding code was used |
setup_status - request_setup_status_show
|
|
Example
{
"actions": OnboardingActionPaged,
"activate_read_write_in_device": false,
"auxiliary_devices": OnboardingAuxiliaryDevicePaged,
"client_identification_id": 4,
"cloned_from": OnboardingRequest,
"cloned_to": OnboardingRequest,
"connection_type": "CABLE",
"consent": OnboardingConsent,
"created_at": "2007-12-03T10:15:30Z",
"created_by": Account,
"device": Device,
"device_bluetooth": "DEFAULT_MODE",
"device_created_by": Account,
"device_mode": "OTHER",
"distributor": OnboardingDistributor,
"driver": Account,
"driver_associated_by": Account,
"driver_association_id": 4,
"driver_created_by": Account,
"driver_validated_by": Account,
"id": 4,
"km_at_installation": 123,
"mode": "OTHER",
"plate_number": 4,
"profile": ProfileOnboarding,
"serial_number": "xyz789",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle,
"vehicle_associated_by": Account,
"vehicle_connection": OnboardingVehicleConnection,
"vehicle_created_by": Account,
"vehicle_creation_id": "4",
"vehicle_enriched_by": Account,
"vehicle_enrichments": OnboardingVehicle,
"vehicle_label": "xyz789",
"vin": "abc123",
"warnings": [OnboardingWarning],
"with_code": true,
"setup_status": request_setup_status_show
}
OnboardingRequestPaged
Description
Paginated onboarding_request results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [OnboardingRequest!]!
|
|
next - ID
|
Example
{"count": 987, "list": [OnboardingRequest], "next": 4}
OnboardingRequestSort
Description
onboarding_request sorting
Fields
| Input Field | Description |
|---|---|
by - OnboardingRequestSortKey!
|
|
order - SortOrder!
|
Example
{"by": "CREATED_AT", "order": "A"}
OnboardingRequestSortKey
Description
onboarding_request sorting key
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
OnboardingStaff
Fields
| Field Name | Description |
|---|---|
account - Account
|
|
is_active - Boolean!
|
|
role - OnboardingStaffRole!
|
Example
{"account": Account, "is_active": true, "role": "MANAGER"}
OnboardingStaffPaged
Description
Paginated onboarding_staff results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [OnboardingStaff!]!
|
|
next - ID
|
Example
{"count": 987, "list": [OnboardingStaff], "next": 4}
OnboardingStaffRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MANAGER"
OnboardingStatus
Description
onboarding status
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized onboarding status |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Has been cloned and the clone has been finalized |
Example
"OTHER"
OnboardingVehicle
Fields
| Field Name | Description |
|---|---|
ac_is_remote_controlled - Boolean
|
|
alarm_is_present - Boolean
|
|
brand - String
|
The vehicle's brand |
brand_model - String
|
The vehicle's model |
color - String
|
|
connectivity - String
|
|
ev_plug_position - String
|
|
ev_plug_type - String
|
|
front_brake_installation - String
|
Odometer (km) at last front brake change |
front_brake_wear - String
|
|
front_tire_installation - String
|
Odometer (km) at last front tires change |
front_tire_wear - String
|
|
fuel_type - EnergyType
|
|
fuel_type_secondary - EnergyType
|
|
kba - ID
|
Kraftfahrbundesamt (Germany and Austria) |
last_date_battery_changed - DateTime
|
|
model_id - ID
|
|
rear_brake_installation - String
|
Odometer (km) at last rear brake change |
rear_brake_wear - String
|
|
rear_tire_installation - String
|
Odometer (km) at last rear tires change |
rear_tire_wear - String
|
|
tank_size - Int
|
Tank size (l), -1 if unknown |
tyres_type - TyreType
|
|
vehicle_type - VehicleTypeName
|
Vehicle type |
vin_descriptions - DecodeVinResult
|
|
year_of_first_circulation - Int
|
Example
{
"ac_is_remote_controlled": true,
"alarm_is_present": true,
"brand": "xyz789",
"brand_model": "xyz789",
"color": "abc123",
"connectivity": "abc123",
"ev_plug_position": "abc123",
"ev_plug_type": "abc123",
"front_brake_installation": "xyz789",
"front_brake_wear": "abc123",
"front_tire_installation": "xyz789",
"front_tire_wear": "xyz789",
"fuel_type": "ADBLUE",
"fuel_type_secondary": "ADBLUE",
"kba": "4",
"last_date_battery_changed": "2007-12-03T10:15:30Z",
"model_id": "4",
"rear_brake_installation": "abc123",
"rear_brake_wear": "abc123",
"rear_tire_installation": "abc123",
"rear_tire_wear": "xyz789",
"tank_size": 123,
"tyres_type": "ALL_SEASONS",
"vehicle_type": "CAR",
"vin_descriptions": DecodeVinResult,
"year_of_first_circulation": 987
}
OnboardingVehicleConnection
Fields
| Field Name | Description |
|---|---|
activate_read_write_in_device - Boolean
|
Whether read-write is enabled |
connection_type - DeviceConnectionType
|
Device connection type |
device_bluetooth - OnboardingDeviceBluetoothMode
|
Device Bluetooth mode |
device_mode - ProfileDeviceModeClass
|
Device mode |
id - ID!
|
Vehicle connection id |
km_at_installation - Int
|
Odometer (km) at installation |
Example
{
"activate_read_write_in_device": true,
"connection_type": "CABLE",
"device_bluetooth": "DEFAULT_MODE",
"device_mode": "OTHER",
"id": 4,
"km_at_installation": 987
}
OnboardingWarning
Fields
| Field Name | Description |
|---|---|
step - String!
|
|
warnings - [String!]!
|
Example
{
"step": "abc123",
"warnings": ["abc123"]
}
OnboardingWhitelistedData
Description
Kind of data that can be sent
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized data type |
|
|
|
|
|
|
|
|
Example
"OTHER"
OnboardingWhitelistedDataArg
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"POSITION"
OpeningHoursAttributes
Description
Opening_hours model.
Fields
| Field Name | Description |
|---|---|
days - [String]
|
A table of days (if the table contains all days, they will be replaced by every day) |
open_24x_7 - Boolean
|
True if the facilty doesn’t close (if True, the other attributes will be nil) |
periods - [Period]
|
Table that contains periods when the facility will be open, it has two attributes from and to |
Example
{
"days": ["abc123"],
"open_24x_7": true,
"periods": [Period]
}
Parameters
Description
Lpa parameters submodel
Fields
| Field Name | Description |
|---|---|
activation_code - String
|
Activation code. Can be prefixed with “lpa” |
enable - Int
|
Enable Set to 1 to enable the profile immediatly after the download is complete |
iccid - String
|
ICCID of the profile to enable |
nickname - String
|
ICCID of the profile to enable |
purpose - Int
|
Purpose (0: Telematics only, 1: Wifi Telematics, 2: Backup) |
telematics_apn - String
|
Telematics apn |
wifi_apn - String
|
Wifi APN (Not checked if Purpose == 0) |
Example
{
"activation_code": "abc123",
"enable": 987,
"iccid": "xyz789",
"nickname": "abc123",
"purpose": 987,
"telematics_apn": "abc123",
"wifi_apn": "abc123"
}
ParametersType
Description
input object parameters
Fields
| Input Field | Description |
|---|---|
activation_code - String
|
Activation code. Can be prefixed with “lpa” |
enable - Int
|
Enable Set to 1 to enable the profile immediatly after the download is complete |
iccid - String
|
ICCID of the profile to enable |
nickname - String
|
Nickname of the profile to set |
purpose - Int
|
Purpose (0: Telematics only, 1: Wifi Telematics, 2: Backup) |
telematics_apn - String
|
Telematics apn |
wifi_apn - String
|
Wifi APN (Not checked if Purpose == 0) |
Example
{
"activation_code": "xyz789",
"enable": 987,
"iccid": "abc123",
"nickname": "xyz789",
"purpose": 123,
"telematics_apn": "abc123",
"wifi_apn": "abc123"
}
Parking
Description
Vehicle parking
Fields
| Field Name | Description |
|---|---|
address - AddressAttributes
|
The address of the facility. |
brand - String
|
Parking brand |
distance - Int
|
Distance (meters) between the position sent in the request and the facility. |
id - ID
|
Parking ID |
logo - String
|
Parking logo url |
name - String
|
Parking name |
opening_hours - [OpeningHoursAttributes]
|
Table of The opening hours of the facility. |
payment_info - PaymentInfo
|
Payment information |
pricing - [PricingInfo]
|
Extra information about the station, such as connector type in the electric station case. |
status - StatusAttributes
|
State of the facility (open or closed) at the time of the request. |
type - String
|
Parking type |
Example
{
"address": AddressAttributes,
"brand": "xyz789",
"distance": 123,
"id": 4,
"logo": "abc123",
"name": "abc123",
"opening_hours": [OpeningHoursAttributes],
"payment_info": PaymentInfo,
"pricing": [PricingInfo],
"status": "CLOSED",
"type": "xyz789"
}
ParkingPaged
Description
Paginated parking results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Parking!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [Parking],
"next": "4"
}
PasswordResetChannel
Description
Side channel to send the reset token
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EMAIL"
PaymentInfo
Fields
| Field Name | Description |
|---|---|
methods - [PaymentMethod]
|
|
note - String
|
|
subscription - Boolean
|
Example
{
"methods": ["AMEX"],
"note": "xyz789",
"subscription": false
}
PaymentMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AMEX"
Percent
Description
Percentage, as a floating point number between 0 and 100
Example
Percent
Perf
Fields
| Field Name | Description |
|---|---|
events - [PerfEvent!]
|
|
id - ID!
|
Example
{
"events": [PerfEvent],
"id": "4"
}
PerfEvent
Period
Plate
Description
plate Alpr submodel
Fields
| Field Name | Description |
|---|---|
candidates - [Plates]
|
Vehicle plates candidtes |
Example
{"candidates": [Plates]}
Plates
PositionNotification
Fields
| Field Name | Description |
|---|---|
coordinates - [Coordinates!]
|
Device positions (last item is also avaliable via device.last_position) |
device - Device
|
Device |
Example
{
"coordinates": [Coordinates],
"device": Device
}
PositiveInt
Description
Integers that will have a value greater than 0.
Example
123
PresenceNotification
Fields
| Field Name | Description |
|---|---|
connection_reason - DeviceConnectionReason
|
Connection reason |
device - Device
|
Device |
disconnection_reason - DeviceDisconnectionReason
|
Disconnection reason |
status - DevicePresence
|
Example
{
"connection_reason": "CLOSED_BY_SERVER",
"device": Device,
"disconnection_reason": "AUTH_FAILED_ACCOUNT",
"status": "CONNECTED"
}
PricingInfo
Description
Pricing info submodel.
Fields
| Field Name | Description |
|---|---|
currency - String
|
The currency code. ISO 4217 is used. |
days - [String]
|
A table of days (if the table contains all days, they will be replaced by every day) |
max_minutes - Int
|
The max time a person should stay in the parking so this price will be used. |
min_minutes - Int
|
The min time a person should stay in the parking so this price will be used. |
price - Float
|
The price of the energy for each unit. |
Example
{
"currency": "xyz789",
"days": ["xyz789"],
"max_minutes": 123,
"min_minutes": 987,
"price": 987.65
}
Product
Description
Product Object
Fields
| Field Name | Description |
|---|---|
bluetooth - Boolean
|
|
id - ID!
|
Identifier |
market - ProductMarket
|
|
name - String!
|
Name |
network - ProductNetwork
|
|
wifi - Boolean
|
Reference |
Example
{
"bluetooth": false,
"id": "4",
"market": "EU",
"name": "abc123",
"network": "_2G",
"wifi": false
}
ProductMarket
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EU"
ProductNetwork
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"_2G"
ProfileDeviceMode
Fields
| Field Name | Description |
|---|---|
ended_at - DateTime
|
|
id - ID!
|
|
mode - ProfileDeviceModeClass!
|
|
restore_default - ProfileRestoreDefault
|
|
started_at - DateTime!
|
|
status - ProfileMigrationStatus!
|
Example
{
"ended_at": "2007-12-03T10:15:30Z",
"id": "4",
"mode": "OTHER",
"restore_default": ProfileRestoreDefault,
"started_at": "2007-12-03T10:15:30Z",
"status": "OTHER"
}
ProfileDeviceModeClass
Description
Device mode
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized device mode |
|
|
|
|
|
Example
"OTHER"
ProfileDeviceModeClassArg
Description
Device mode argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"TELEMATIC"
ProfileDeviceModePaged
Description
Paginated profile_device_mode results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [ProfileDeviceMode!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [ProfileDeviceMode],
"next": "4"
}
ProfileMigrationStatus
Description
Migration status
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized migration status |
|
|
Migration canceled by user |
|
|
Migration failed |
|
|
Migration started, waiting for device to apply it |
|
|
Migration is not compatible with the apps linked to the device |
|
|
Migration validated, waiting for campaign to be generated |
|
|
Migration finished successfully |
|
|
Migration failed because of timeout |
Example
"OTHER"
ProfileOnboarding
Fields
| Field Name | Description |
|---|---|
campaign_id - ID
|
|
configuration_ids - [ID]
|
|
created_at - DateTime!
|
|
ended_at - DateTime
|
|
id - ID!
|
|
privacy - ProfilePrivacy
|
|
restore_default - ProfileRestoreDefault
|
|
started_at - DateTime!
|
|
status - ProfileMigrationStatus!
|
|
vehicle_desc - DecodeVinResult
|
Example
{
"campaign_id": "4",
"configuration_ids": ["4"],
"created_at": "2007-12-03T10:15:30Z",
"ended_at": "2007-12-03T10:15:30Z",
"id": 4,
"privacy": ProfilePrivacy,
"restore_default": ProfileRestoreDefault,
"started_at": "2007-12-03T10:15:30Z",
"status": "OTHER",
"vehicle_desc": DecodeVinResult
}
ProfilePrivacy
Fields
| Field Name | Description |
|---|---|
created_at - DateTime!
|
|
ended_at - DateTime
|
|
id - ID!
|
|
restore_default - ProfileRestoreDefault
|
|
started_at - DateTime!
|
|
status - ProfileMigrationStatus!
|
|
whitelisted_data - [OnboardingWhitelistedData!]
|
Example
{
"created_at": "2007-12-03T10:15:30Z",
"ended_at": "2007-12-03T10:15:30Z",
"id": "4",
"restore_default": ProfileRestoreDefault,
"started_at": "2007-12-03T10:15:30Z",
"status": "OTHER",
"whitelisted_data": ["OTHER"]
}
ProfilePrivacyPaged
Description
Paginated profile_privacy results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [ProfilePrivacy!]!
|
|
next - ID
|
Example
{"count": 123, "list": [ProfilePrivacy], "next": 4}
ProfileRestoreDefault
Fields
| Field Name | Description |
|---|---|
campaign_id - ID
|
|
created_at - DateTime!
|
|
ended_at - DateTime
|
|
id - ID!
|
|
mode - ProfileDeviceModeClass!
|
|
started_at - DateTime!
|
|
status - ProfileMigrationStatus!
|
Example
{
"campaign_id": "4",
"created_at": "2007-12-03T10:15:30Z",
"ended_at": "2007-12-03T10:15:30Z",
"id": 4,
"mode": "OTHER",
"started_at": "2007-12-03T10:15:30Z",
"status": "OTHER"
}
Project
Description
Project Object
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier |
devices - DevicePaged
|
Devices |
Arguments
|
|
drivers - DriverPaged
|
Drivers |
groups - GroupPaged
|
Groups |
label - String!
|
Label |
owner - Account
|
Owner |
users - AccountPaged
|
Users |
vehicles - VehiclePaged
|
Vehicles |
Arguments
|
|
Example
{
"id": "4",
"devices": DevicePaged,
"drivers": DriverPaged,
"groups": GroupPaged,
"label": "xyz789",
"owner": Account,
"users": AccountPaged,
"vehicles": VehiclePaged
}
ProjectMember
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DEVICE"
ProjectPaged
Description
Paginated project results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Project!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [Project],
"next": "4"
}
ProvidedEnergy
Description
Fuel/energy info
Fields
| Field Name | Description |
|---|---|
capacity - String
|
Electric connector capacity |
connector_count - Int
|
Number of available electric connectors |
connector_support - String
|
Supported electric connector |
connector_type - ConnectorType
|
The standardized type of electric connector |
connector_type_full - String
|
The full type of electric connector |
currency - String
|
The currency code. ISO 4217 is used. |
price - Float
|
The price of the energy for each unit. |
type - EnergyType
|
The standardized type of energy/fuel this station provide. |
type_full - String
|
The full type of energy/fuel this station provide. |
unit - String
|
The unit of the energy. |
Example
{
"capacity": "abc123",
"connector_count": 987,
"connector_support": "abc123",
"connector_type": "AVCON_CONNECTOR",
"connector_type_full": "abc123",
"currency": "xyz789",
"price": 987.65,
"type": "ADBLUE",
"type_full": "abc123",
"unit": "xyz789"
}
Quotation
Description
Workshop quotation
Fields
| Field Name | Description |
|---|---|
id - ID
|
Quotation ID |
booking_id - ID
|
Booking ID |
currency - String
|
Currency |
maintenance_code - String
|
Maintenance codes |
plate_number - String
|
Plate number |
price - Int
|
Price |
provider_quotation_id - ID
|
Provider quotation ID |
taxes - Int
|
Taxes |
taxes_price - Int
|
Taxes price |
workshop - Workshop
|
Workshop |
Example
{
"id": 4,
"booking_id": "4",
"currency": "xyz789",
"maintenance_code": "abc123",
"plate_number": "abc123",
"price": 987,
"provider_quotation_id": "4",
"taxes": 123,
"taxes_price": 987,
"workshop": Workshop
}
QuotationPaged
Description
Paginated quotation results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Quotation!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [Quotation],
"next": "4"
}
Rating
Description
Workshop rating
Fields
| Field Name | Description |
|---|---|
id - ID
|
Rating ID |
booking - Booking
|
Booking |
created_at - DateTime
|
Creation datetime |
message - String
|
Rating message |
response - String
|
Response message |
response_date - DateTime
|
Response datetime |
stars - Int
|
Stars |
status - RatingStatus
|
Wether rating is verified |
workshop - Workshop
|
Workshop |
Example
{
"id": "4",
"booking": Booking,
"created_at": "2007-12-03T10:15:30Z",
"message": "abc123",
"response": "abc123",
"response_date": "2007-12-03T10:15:30Z",
"stars": 987,
"status": "NOT_VERIFIED",
"workshop": Workshop
}
RatingPaged
Description
Paginated rating results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Rating!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [Rating],
"next": "4"
}
RatingStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NOT_VERIFIED"
RdcAsyncAck
Description
Asynchroneous reply
This is an aknowledgement that the command has been sent. Actual reply must be fetched using notifications.
Example
{
"attributes": Json,
"id": 4,
"type": "abc123"
}
RdcEndpoint
Description
Type of RemoteDeviceCommand query/mutation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DISPLACEMENT_SET"
Reading
Fields
| Field Name | Description |
|---|---|
event_id - ID
|
The cloud event this reading is extracted from |
id - ID!
|
|
metric - Metric!
|
|
time - DateTime!
|
|
value - ReadingValue!
|
Example
{
"event_id": 4,
"id": "4",
"metric": Metric,
"time": "2007-12-03T10:15:30Z",
"value": BooleanObj
}
ReadingAggregate
Description
Aggregate readings (grouped by metric id) instead of returning the whole list
Values
| Enum Value | Description |
|---|---|
|
|
Return only value changes |
|
|
Return the first reading only |
|
|
Return the last reading only |
|
|
Return all readings |
Example
"CHANGES"
ReadingAnon
Fields
| Field Name | Description |
|---|---|
metric - Metric!
|
|
time - DateTime
|
|
value - ReadingValue!
|
Example
{
"metric": Metric,
"time": "2007-12-03T10:15:30Z",
"value": BooleanObj
}
ReadingAnonAggregate
Values
| Enum Value | Description |
|---|---|
|
|
Return the number of readings |
|
|
Return Largest Triangle Tree Buckets |
Example
"COUNT"
ReadingAnonPaged
Description
Paginated reading_anon results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [ReadingAnon!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [ReadingAnon],
"next": "4"
}
ReadingPaged
Description
Paginated reading results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Reading!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [Reading],
"next": "4"
}
ReadingSort
Description
reading sorting
Fields
| Input Field | Description |
|---|---|
by - ReadingSortKey!
|
|
order - SortOrder!
|
Example
{"by": "TIME", "order": "A"}
ReadingSortKey
Description
reading sorting key
Values
| Enum Value | Description |
|---|---|
|
|
Example
"TIME"
ReadingValue
Types
| Union Types |
|---|
Example
BooleanObj
RemoteDiag
Description
Remote diagnostic session
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Remote diagnostic session id |
actions - RemoteDiagActionPaged
|
List of previous actions |
created_at - DateTime!
|
Creation date |
current_step - RemoteDiagCurrentStep!
|
Current session step |
language - Language!
|
Language |
provider_name - String
|
|
result - RemoteDiagResult
|
|
status - String
|
Current status |
steps - RemoteDiagStepPaged
|
|
updated_at - DateTime!
|
Update date |
vci - RemoteDiagEndpoint
|
Vehicle Communication Interface |
vud - RemoteDiagEndpoint
|
Vehicle Under Diagnostic |
Example
{
"id": 4,
"actions": RemoteDiagActionPaged,
"created_at": "2007-12-03T10:15:30Z",
"current_step": "OTHER",
"language": Language,
"provider_name": "xyz789",
"result": RemoteDiagResult,
"status": "xyz789",
"steps": RemoteDiagStepPaged,
"updated_at": "2007-12-03T10:15:30Z",
"vci": RemoteDiagEndpoint,
"vud": RemoteDiagEndpoint
}
RemoteDiagAction
Fields
| Field Name | Description |
|---|---|
created_at - DateTime!
|
Creation date |
dtcs - RemoteDiagResultDtcPaged
|
|
ecus - [ID!]
|
|
failure_reason - String
|
|
id - ID!
|
Action id |
pids - [ID!]
|
|
progress - Float
|
|
snapshots - RemoteDiagResultSnapshotPaged
|
|
status - RemoteDiagActionStatus!
|
|
supported_parameters - RemoteDiagSupportedParameterPaged
|
|
type - RemoteDiagActionType
|
|
updated_at - DateTime!
|
Update date |
Example
{
"created_at": "2007-12-03T10:15:30Z",
"dtcs": RemoteDiagResultDtcPaged,
"ecus": ["4"],
"failure_reason": "xyz789",
"id": 4,
"pids": ["4"],
"progress": 987.65,
"snapshots": RemoteDiagResultSnapshotPaged,
"status": "ABORT",
"supported_parameters": RemoteDiagSupportedParameterPaged,
"type": "OTHER",
"updated_at": "2007-12-03T10:15:30Z"
}
RemoteDiagActionPaged
Description
Paginated remote_diag_action results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [RemoteDiagAction!]!
|
|
next - ID
|
Example
{"count": 123, "list": [RemoteDiagAction], "next": 4}
RemoteDiagActionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Action failed |
|
|
No action started |
|
|
Action requested |
|
|
Action in progress |
|
|
Action processed successfully |
Example
"ABORT"
RemoteDiagActionStatusArg
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ABORT"
RemoteDiagActionType
Description
Action
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized action |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
RemoteDiagActionTypeArg
Description
Action argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCEL_LIVE_PARAMETERS"
RemoteDiagCurrentStep
Description
Step
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized step |
|
|
Session closure in progress |
|
|
Session closed |
|
|
Session error |
|
|
Session ready, waiting for user request |
|
|
Session processing user request |
|
|
Session setup in progress |
Example
"OTHER"
RemoteDiagEndpoint
Description
Remote diagnostic endpoint
Fields
| Field Name | Description |
|---|---|
country_specific_id - CountrySpecificId
|
|
device - Device
|
Diagnostic device |
failure_code - Int!
|
Failure reason code, if any |
failure_reason - RemoteDiagFailureReason!
|
Failure reason, if any |
vin - String
|
Session VehicleIdentificationNumber |
vin_from_vehicle - String
|
VehicleIdentificationNumber reported by vehicle |
Example
{
"country_specific_id": CountrySpecificId,
"device": Device,
"failure_code": 987,
"failure_reason": "OK",
"vin": "abc123",
"vin_from_vehicle": "abc123"
}
RemoteDiagFailureReason
Description
Failure reason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized failure reason |
Example
"OK"
RemoteDiagFreezeFrame
RemoteDiagNotification
Fields
| Field Name | Description |
|---|---|
device - Device
|
Device |
remote_diag - RemoteDiag!
|
Example
{
"device": Device,
"remote_diag": RemoteDiag
}
RemoteDiagPaged
Description
Paginated remote_diag results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [RemoteDiag!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [RemoteDiag],
"next": "4"
}
RemoteDiagResult
Fields
| Field Name | Description |
|---|---|
actions_count - Int
|
|
created_at - DateTime!
|
Creation date |
dtcs - RemoteDiagResultDtcPaged
|
|
ecus - RemoteDiagResultEcuPaged
|
|
failure_reason - String
|
|
progress - Float
|
|
snapshots - RemoteDiagResultSnapshotPaged
|
|
status - RemoteDiagActionStatus!
|
|
supported_parameters - RemoteDiagSupportedParameterPaged
|
|
updated_at - DateTime!
|
Update date |
Example
{
"actions_count": 987,
"created_at": "2007-12-03T10:15:30Z",
"dtcs": RemoteDiagResultDtcPaged,
"ecus": RemoteDiagResultEcuPaged,
"failure_reason": "abc123",
"progress": 987.65,
"snapshots": RemoteDiagResultSnapshotPaged,
"status": "ABORT",
"supported_parameters": RemoteDiagSupportedParameterPaged,
"updated_at": "2007-12-03T10:15:30Z"
}
RemoteDiagResultDtc
Fields
| Field Name | Description |
|---|---|
cause - String
|
Cause related to the dtc code. |
classification - DtcClassification!
|
|
code - String!
|
|
code_description - String
|
|
code_subdescription - String
|
|
created_at - DateTime!
|
Creation date |
dtc_freeze_frames - [RemoteDiagFreezeFrame]
|
|
effect - String
|
Effect may be caused by the dtc code. |
group_name - String
|
|
id - ID!
|
|
mode - DtcMode!
|
|
protocol - DtcProtocol!
|
|
recommendation - String
|
|
source_name - String
|
|
status - RemoteDiagResultDtcStatus!
|
|
updated_at - DateTime!
|
Update date |
Example
{
"cause": "xyz789",
"classification": "ADVISORY",
"code": "xyz789",
"code_description": "xyz789",
"code_subdescription": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"dtc_freeze_frames": [RemoteDiagFreezeFrame],
"effect": "abc123",
"group_name": "xyz789",
"id": 4,
"mode": "ABSENT",
"protocol": "UNKNOWN",
"recommendation": "abc123",
"source_name": "xyz789",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z"
}
RemoteDiagResultDtcPaged
Description
Paginated remote_diag_result_dtc results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [RemoteDiagResultDtc!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [RemoteDiagResultDtc],
"next": "4"
}
RemoteDiagResultDtcStatus
Description
dtc status
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized dtc status |
|
|
|
|
|
|
|
|
Example
"OTHER"
RemoteDiagResultEcu
Fields
| Field Name | Description |
|---|---|
created_at - DateTime!
|
Creation date |
dtcs - RemoteDiagResultDtcPaged
|
|
group_name - String
|
|
id - ID!
|
|
mil - Boolean
|
|
source_name - String
|
|
status_code - Int
|
|
status_description - String!
|
|
success - Boolean!
|
|
supported_parameters - RemoteDiagSupportedParameterPaged
|
|
updated_at - DateTime!
|
Update date |
Example
{
"created_at": "2007-12-03T10:15:30Z",
"dtcs": RemoteDiagResultDtcPaged,
"group_name": "xyz789",
"id": "4",
"mil": true,
"source_name": "xyz789",
"status_code": 123,
"status_description": "abc123",
"success": false,
"supported_parameters": RemoteDiagSupportedParameterPaged,
"updated_at": "2007-12-03T10:15:30Z"
}
RemoteDiagResultEcuPaged
Description
Paginated remote_diag_result_ecu results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [RemoteDiagResultEcu!]!
|
|
next - ID
|
Example
{"count": 987, "list": [RemoteDiagResultEcu], "next": 4}
RemoteDiagResultSnapshot
Example
{
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"name": "abc123",
"timestamp": "2007-12-03T10:15:30Z",
"unit": "OTHER",
"unit_name": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"value": "xyz789"
}
RemoteDiagResultSnapshotPaged
Description
Paginated remote_diag_result_snapshot results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [RemoteDiagResultSnapshot!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [RemoteDiagResultSnapshot],
"next": "4"
}
RemoteDiagStep
Example
{
"created_at": "2007-12-03T10:15:30Z",
"description": "xyz789",
"id": "4",
"instance_id": "4",
"mandatory_success": true,
"name": "abc123",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z"
}
RemoteDiagStepPaged
Description
Paginated remote_diag_step results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [RemoteDiagStep!]!
|
|
next - ID
|
Example
{"count": 123, "list": [RemoteDiagStep], "next": 4}
RemoteDiagStepStatus
Description
Step status
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized step status |
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
RemoteDiagSupportedParameter
Fields
| Field Name | Description |
|---|---|
created_at - DateTime!
|
|
feature_name - String
|
|
group_name - String
|
|
id - ID!
|
|
name - String!
|
|
preferred - Boolean!
|
|
readings - SupportedParameterReadingsPaged!
|
|
source_name - String
|
|
unit - Unit!
|
Standardized unit |
unit_name - String!
|
Raw unit |
updated_at - DateTime!
|
|
Example
{
"created_at": "2007-12-03T10:15:30Z",
"feature_name": "xyz789",
"group_name": "abc123",
"id": "4",
"name": "abc123",
"preferred": true,
"readings": SupportedParameterReadingsPaged,
"source_name": "abc123",
"unit": "OTHER",
"unit_name": "xyz789",
"updated_at": "2007-12-03T10:15:30Z"
}
RemoteDiagSupportedParameterPaged
Description
Paginated remote_diag_supported_parameter results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [RemoteDiagSupportedParameter!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [RemoteDiagSupportedParameter],
"next": "4"
}
RoleInput
Fields
| Input Field | Description |
|---|---|
role - RoleUpdateMeta!
|
Meta role to apply |
target_id - ID
|
Apply account roles to this target only |
target_type - RoleUpdateTarget
|
Type for target_id. Default = GROUP |
Example
{
"role": "ADMIN",
"target_id": "4",
"target_type": "GROUP"
}
RoleUpdateMeta
Description
Meta role
Maps to a set of real account roles.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ADMIN"
RoleUpdateTarget
Values
| Enum Value | Description |
|---|---|
|
|
Apply role to this group and its children |
Example
"GROUP"
SortOrder
Values
| Enum Value | Description |
|---|---|
|
|
Sort smaller/older values first |
|
|
Sort smaller/older values first |
|
|
Sort bigger/newer values first |
|
|
Sort bigger/newer values first |
Example
"A"
Stack_Input
Fields
Example
{
"buses": [
mutationInput_put_action_input_data_attributes_stack_oneOf_0_buses_items_Input
],
"ecus": [
mutationInput_put_action_input_data_attributes_stack_oneOf_0_ecus_items_Input
],
"operations": [
mutationInput_put_action_input_data_attributes_stack_oneOf_0_operations_items_Input
],
"commands": [
mutationInput_put_action_input_data_attributes_stack_oneOf_0_commands_items_Input
]
}
StateOfHealthLowVoltageLevel
Values
| Enum Value | Description |
|---|---|
|
|
A voltage lower than 9 volts had been observed in the last three 3 trips |
|
|
A voltage lower than 9 volts had been observed in one of the last 3 trips |
|
|
No voltage lower than 9 volts had been observed in the last 3 trips |
|
|
|
|
|
A voltage lower than 9 volts had been observed in two of the last 3 trips |
Example
"ALERT"
StateOfHealthUserClassification
Description
state of health user classification
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized state of health user classification |
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
Station
Description
Petrol or charging station
Fields
| Field Name | Description |
|---|---|
address - AddressAttributes
|
The address of the facility. |
brand - String
|
Station brand |
distance - Int
|
Distance (meters) between the position sent in the request and the facility. |
id - ID
|
Station ID |
logo - String
|
Station logo url |
name - String
|
Station name |
opening_hours - [OpeningHoursAttributes]
|
Table of The opening hours of the facility. |
payment_info - PaymentInfo
|
Payment information |
provided_energy - [ProvidedEnergy]
|
Extra information about the station, such as connector type in the electric station case. |
status - StatusAttributes
|
State of the facility (open or closed) at the time of the request. |
Example
{
"address": AddressAttributes,
"brand": "abc123",
"distance": 123,
"id": 4,
"logo": "abc123",
"name": "xyz789",
"opening_hours": [OpeningHoursAttributes],
"payment_info": PaymentInfo,
"provided_energy": [ProvidedEnergy],
"status": "CLOSED"
}
StationPaged
Description
Paginated station results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Station!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [Station],
"next": "4"
}
StatusAttributes
Description
Whether a facility is currently open
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CLOSED"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
StringObj
Fields
| Field Name | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SupportedParameterReadingsBoolean
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
next - ID
|
|
relative_timestamps - [Float!]
|
|
timestamps - [DateTime!]
|
|
values - [Boolean!]
|
Example
{
"count": 987,
"next": "4",
"relative_timestamps": [123.45],
"timestamps": ["2007-12-03T10:15:30Z"],
"values": [true]
}
SupportedParameterReadingsFloat
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
next - ID
|
|
relative_timestamps - [Float!]
|
|
timestamps - [DateTime!]
|
|
values - [Float!]
|
Example
{
"count": 987,
"next": 4,
"relative_timestamps": [123.45],
"timestamps": ["2007-12-03T10:15:30Z"],
"values": [987.65]
}
SupportedParameterReadingsInteger
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
next - ID
|
|
relative_timestamps - [Float!]
|
|
timestamps - [DateTime!]
|
|
values - [Int!]
|
Example
{
"count": 123,
"next": 4,
"relative_timestamps": [123.45],
"timestamps": ["2007-12-03T10:15:30Z"],
"values": [987]
}
SupportedParameterReadingsPaged
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
next - ID
|
|
relative_timestamps - [Float!]
|
|
timestamps - [DateTime!]
|
Possible Types
| SupportedParameterReadingsPaged Types |
|---|
Example
{
"count": 987,
"next": 4,
"relative_timestamps": [123.45],
"timestamps": ["2007-12-03T10:15:30Z"]
}
SupportedParameterReadingsSort
Description
supported_parameter_readings sorting
Fields
| Input Field | Description |
|---|---|
by - SupportedParameterReadingsSortKey!
|
|
order - SortOrder!
|
Example
{"by": "RELATIVE_TIMESTAMP", "order": "A"}
SupportedParameterReadingsSortKey
Description
supported_parameter_readings sorting key
Values
| Enum Value | Description |
|---|---|
|
|
Example
"RELATIVE_TIMESTAMP"
SupportedParameterReadingsString
Example
{
"count": 123,
"mixed": false,
"next": 4,
"relative_timestamps": [987.65],
"timestamps": ["2007-12-03T10:15:30Z"],
"values": ["xyz789"]
}
SystemInfo
Description
System info
Versioning follows X.Y.Z format with semver compatibility garantees:
XFor backward-breaking changesYFor new featuresZFor bugfixes
Fields
| Field Name | Description |
|---|---|
extra - Json
|
Private |
hash - String
|
Version control hash |
schema - String!
|
Graphql schema version |
services - [SystemService!]
|
List of web service hosts |
software - String!
|
Software version |
Example
{
"extra": Json,
"hash": "xyz789",
"schema": "xyz789",
"services": [SystemService],
"software": "xyz789"
}
SystemService
Ticket
Description
Support ticket
Fields
| Field Name | Description |
|---|---|
account - Account
|
|
created_at - DateTime
|
|
id - ID
|
|
source - TicketSource
|
|
title - String
|
Example
{
"account": Account,
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"source": "ONBOARDING",
"title": "abc123"
}
TicketPaged
Description
Paginated ticket results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Ticket!]!
|
|
next - ID
|
Example
{"count": 123, "list": [Ticket], "next": 4}
TicketSource
Description
Support ticket source
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ONBOARDING"
ToggleAction
Description
Start or stop the component
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"START"
TowingSession
Description
TowingSession Object
Example
{
"closed_by": Account,
"created_by": Account,
"end_at": "2007-12-03T10:15:30Z",
"id": "4",
"start_at": "2007-12-03T10:15:30Z",
"towing_vehicle": Vehicle,
"trailer_vehicle": Vehicle
}
TowingSessionPaged
Description
Paginated towing_session results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [TowingSession!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [TowingSession],
"next": "4"
}
TrackNotification
TransportOptions
Example
TransportOptions
Trip
Description
Trip
Fields
| Field Name | Description |
|---|---|
id - ID
|
Trip id |
activities - TripActivityPaged
|
Activity events |
average_speed - Float
|
Average speed while moving (km/h) |
co_2_estimation - Int
|
CO2 Estimation (grams) |
distance - Int
|
Total trip distance (meters) |
distance_in_day - Percent
|
Percentage of distance travelled during the day |
driving_duration - Int
|
Driving duration, vehicle not idle (seconds) |
driving_percentage - Percent
|
Driving percentage (0.0 .. 100.0) |
duration - Int
|
Total duration (seconds) |
eco_driving_score - Percent
|
Eco Driving Score (0 Poor .. 100 Perfect) |
end_event - Idcoordinates
|
End event coordinates |
end_postal_address - AddressAttributes
|
End postal address |
end_weather - Weather
|
End weather |
fuel_efficiency - Float
|
Fuel Efficiency / Economy (L/100Km) |
fuel_estimation - Int
|
Fuel consumption estimation (milliliters) |
harshes - TripHarshPaged
|
Harsh events |
idling_duration - Int
|
Idling duration (seconds) |
idling_percentage - Percent
|
Idling percentage (0.0 .. 100.0) |
locations - IdcoordinatesPaged
|
Trip locations |
max_idling_duration - Int
|
Maximum idling duration (seconds) |
max_speed - Float
|
Maximum speed (km/h) |
metadata - TripMetadatumPaged
|
Metadata |
movements - TripMovementPaged
|
Movement events |
nb_harsh_acceleration - Int
|
Harsh acceleration events count |
nb_harsh_braking - Int
|
Harsh deceleration events count |
nb_harsh_cornering - Int
|
Harsh left/right turn events count |
nb_overspeed - Int
|
Overspeed count |
nb_postprocessed_overspeed - Int
|
Post processed Overspeed count (extracted w.r.t. road network for example) |
overconsumption_gap - AnyPercent
|
Fuel overconsumption compared to fuel reference consumption |
overemission_gap - AnyPercent
|
CO2 overemission comapred to CO2 reference emission |
overspeed_distance - Int
|
Overspeed distance (m) |
overspeed_duration - Int
|
Overspeed duration (s) |
overspeed_score - Percent
|
Overspeed score |
overspeeds - TripOverspeedPaged
|
Overspeed events |
safety_score - Percent
|
Safety Score (0 Poor .. 100 Perfect) |
start_event - Idcoordinates
|
Start event coordinates |
start_postal_address - AddressAttributes
|
Start postal address |
start_weather - Weather
|
Start weather |
status - TripStatus
|
Whether the trip is already closed or ongoing |
stops - TripStopPaged
|
Stop events |
tow_away - Boolean
|
Is the vehicle being towed away |
journey_harshes - journey_trip_harsh_paginated
|
|
journey_overspeeds - trip_overspeeds_response
|
|
journey_idlings - trip_idlings_response
|
|
Example
{
"id": 4,
"activities": TripActivityPaged,
"average_speed": 123.45,
"co_2_estimation": 987,
"distance": 123,
"distance_in_day": Percent,
"driving_duration": 987,
"driving_percentage": Percent,
"duration": 987,
"eco_driving_score": Percent,
"end_event": Idcoordinates,
"end_postal_address": AddressAttributes,
"end_weather": Weather,
"fuel_efficiency": 987.65,
"fuel_estimation": 987,
"harshes": TripHarshPaged,
"idling_duration": 987,
"idling_percentage": Percent,
"locations": IdcoordinatesPaged,
"max_idling_duration": 987,
"max_speed": 987.65,
"metadata": TripMetadatumPaged,
"movements": TripMovementPaged,
"nb_harsh_acceleration": 987,
"nb_harsh_braking": 123,
"nb_harsh_cornering": 123,
"nb_overspeed": 987,
"nb_postprocessed_overspeed": 987,
"overconsumption_gap": AnyPercent,
"overemission_gap": AnyPercent,
"overspeed_distance": 987,
"overspeed_duration": 123,
"overspeed_score": Percent,
"overspeeds": TripOverspeedPaged,
"safety_score": Percent,
"start_event": Idcoordinates,
"start_postal_address": AddressAttributes,
"start_weather": Weather,
"status": "CLOSED",
"stops": TripStopPaged,
"tow_away": true,
"journey_harshes": journey_trip_harsh_paginated,
"journey_overspeeds": journey_trip_overspeed_paginated,
"journey_idlings": journey_trip_idling_paginated
}
TripActivity
Description
Trip activity
Fields
| Field Name | Description |
|---|---|
created_at - DateTime
|
Activity creation datetime |
duration - Int
|
Activity duration (seconds) |
end_event - Idcoordinates
|
End event coordinates |
id - ID
|
Trip id |
imei - ID
|
Device id |
start_event - Idcoordinates
|
Start event coordinates |
state - TripActivityState
|
Activity type |
updated_at - DateTime
|
Activity update datetime |
Example
{
"created_at": "2007-12-03T10:15:30Z",
"duration": 987,
"end_event": Idcoordinates,
"id": 4,
"imei": "4",
"start_event": Idcoordinates,
"state": "MOVEMENT",
"updated_at": "2007-12-03T10:15:30Z"
}
TripActivityPaged
Description
Paginated trip_activity results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [TripActivity!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [TripActivity],
"next": "4"
}
TripActivityState
Description
Activity type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MOVEMENT"
TripHarsh
Fields
| Field Name | Description |
|---|---|
created_at - DateTime
|
Creation datetime |
duration - Int
|
Duration (seconds) |
end_event - Coordinates
|
End event coordinates |
id - ID
|
Event id |
kind - TripHarshKind
|
Event kind |
mean_acceleration - Float
|
Mean acceleration |
peak_acceleration - Float
|
Peak acceleration |
start_event - Coordinates
|
Start event coordinates |
updated_at - DateTime
|
Update datetime |
Example
{
"created_at": "2007-12-03T10:15:30Z",
"duration": 123,
"end_event": Coordinates,
"id": 4,
"kind": "ACCELERATION",
"mean_acceleration": 987.65,
"peak_acceleration": 987.65,
"start_event": Coordinates,
"updated_at": "2007-12-03T10:15:30Z"
}
TripHarshKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCELERATION"
TripHarshPaged
Description
Paginated trip_harsh results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [TripHarsh!]!
|
|
next - ID
|
Example
{"count": 123, "list": [TripHarsh], "next": 4}
TripMetadatum
Description
Trip metadatum
Example
{
"created_at": "2007-12-03T10:15:30Z",
"id": 4,
"key": "xyz789",
"trip_id": "4",
"updated_at": "2007-12-03T10:15:30Z",
"value": "xyz789"
}
TripMetadatumPaged
Description
Paginated trip_metadatum results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [TripMetadatum!]!
|
|
next - ID
|
Example
{"count": 123, "list": [TripMetadatum], "next": 4}
TripMovement
Description
Trip movement
Fields
| Field Name | Description |
|---|---|
created_at - DateTime
|
Activity creation datetime |
duration - Int
|
Activity duration (seconds) |
end_event - Idcoordinates
|
End event coordinates |
id - ID
|
Trip id |
imei - ID
|
Device id |
start_event - Idcoordinates
|
Start event coordinates |
updated_at - DateTime
|
Activity update datetime |
Example
{
"created_at": "2007-12-03T10:15:30Z",
"duration": 987,
"end_event": Idcoordinates,
"id": "4",
"imei": "4",
"start_event": Idcoordinates,
"updated_at": "2007-12-03T10:15:30Z"
}
TripMovementPaged
Description
Paginated trip_movement results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [TripMovement!]!
|
|
next - ID
|
Example
{"count": 123, "list": [TripMovement], "next": 4}
TripNotification
TripOverspeed
Fields
| Field Name | Description |
|---|---|
created_at - DateTime
|
Creation datetime |
distance - Float
|
Distance (m) |
duration - Int
|
Duration (seconds) |
end_event - Coordinates
|
End event coordinates |
id - ID
|
Event id |
mean_overspeed - Float
|
Mean speed over threshold |
mean_speed - Float
|
Mean speed |
peak_overspeed - Float
|
Peak speed over threshold |
peak_speed - Float
|
Peak speed |
speed_threshold - Int
|
Speed threshold |
start_event - Coordinates
|
Start event coordinates |
updated_at - DateTime
|
Update datetime |
Example
{
"created_at": "2007-12-03T10:15:30Z",
"distance": 123.45,
"duration": 987,
"end_event": Coordinates,
"id": "4",
"mean_overspeed": 123.45,
"mean_speed": 987.65,
"peak_overspeed": 987.65,
"peak_speed": 987.65,
"speed_threshold": 123,
"start_event": Coordinates,
"updated_at": "2007-12-03T10:15:30Z"
}
TripOverspeedPaged
Description
Paginated trip_overspeed results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [TripOverspeed!]!
|
|
next - ID
|
Example
{"count": 987, "list": [TripOverspeed], "next": 4}
TripPaged
TripStatus
Description
Whether the trip is already closed or ongoing
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CLOSED"
TripStop
Description
Trip stop
Fields
| Field Name | Description |
|---|---|
created_at - DateTime
|
Activity creation datetime |
duration - Int
|
Activity duration (seconds) |
end_event - Idcoordinates
|
End event coordinates |
id - ID
|
Trip id |
imei - ID
|
Device id |
location - Coordinates
|
Location |
radius - Float
|
Radius (meters) |
start_event - Idcoordinates
|
Start event coordinates |
updated_at - DateTime
|
Activity update datetime |
Example
{
"created_at": "2007-12-03T10:15:30Z",
"duration": 123,
"end_event": Idcoordinates,
"id": 4,
"imei": "4",
"location": Coordinates,
"radius": 123.45,
"start_event": Idcoordinates,
"updated_at": "2007-12-03T10:15:30Z"
}
TripStopPaged
Description
Paginated trip_stop results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [TripStop!]!
|
|
next - ID
|
Example
{"count": 123, "list": [TripStop], "next": 4}
TripSummary
Description
Aggregated trip statistics
Fields
| Field Name | Description |
|---|---|
distance - Int
|
Distance (m) |
driving_duration - Int
|
Driving duration (s) |
eco_driving_score - Percent
|
Eco driving score (0 Poor .. 100 Perfect) |
fuel_efficiency - Float
|
Fuel efficiency (l/100km) |
idling_duration - Int
|
Idling duration (s) |
nb_overspeed - Int
|
Overspeed count |
overspeed_distance - Int
|
Overspeed distance (m) |
overspeed_duration - Int
|
Overspeed duration (s) |
overspeed_score - Percent
|
Overspeed Score (0 Poor .. 100 Perfect) |
safety_score - Percent
|
Safety Score (0 Poor .. 100 Perfect) |
Example
{
"distance": 123,
"driving_duration": 987,
"eco_driving_score": Percent,
"fuel_efficiency": 987.65,
"idling_duration": 987,
"nb_overspeed": 123,
"overspeed_distance": 123,
"overspeed_duration": 123,
"overspeed_score": Percent,
"safety_score": Percent
}
TyreType
Description
Tyre type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Unrecognized tyre type |
|
|
|
|
|
Example
"ALL_SEASONS"
TyreTypeArg
Description
Tyre type argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL_SEASONS"
URL
Description
A field whose value conforms to the standard URL format as specified in RFC3986: https://www.ietf.org/rfc/rfc3986.txt.
Example
"http://www.test.com/"
UUID
Description
A field whose value is a generic Universally Unique Identifier: https://en.wikipedia.org/wiki/Universally_unique_identifier.
Example
"e04a1950-b9b6-4a17-9376-8d48adf480c2"
Unit
Values
| Enum Value | Description |
|---|---|
|
|
Unknown unit (check unit_name) |
|
|
Dimentionless value |
|
|
Percentage |
|
|
Frequency |
|
|
Electric intensity |
|
|
Grams per second |
|
|
Distance |
|
|
Speed |
|
|
Pressure |
|
|
Volume |
|
|
Light intensity |
|
|
Electric intensity |
|
|
Pressure |
|
|
Duration |
|
|
Electric resistance |
|
|
Revolutions per minute |
|
|
Duration |
|
|
? per minute |
|
|
Electric potential |
|
|
Temperature |
Example
"OTHER"
UnsignedInt
Description
Integers that will have a value of 0 or more.
Example
123
Upload
Description
Represents an uploaded file.
Example
Upload
Vehicle
Description
Vehicle Object
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier |
alerts - VehicleAlertPaged
|
|
Arguments
|
|
alerts_state - VehicleAlertsState
|
|
archived - Boolean
|
archived |
can_be_towed - Boolean
|
can be used as trailer vehicle |
can_tow - Boolean
|
can be used as towing vehicle |
current_device - Device
|
Current Device |
current_devices - DevicePaged
|
Last trip |
Arguments
|
|
current_driver - Driver
|
Current Driver |
current_towing_session_as_towing_vehicle - TowingSession
|
current towing session where this vehicle is the towing vehicle |
current_towing_session_as_trailer_vehicle - TowingSession
|
current towing session where this vehicle is the trailer vehicle |
current_towing_vehicle - Vehicle
|
current towing vehicle |
current_trailer_vehicle - Vehicle
|
current trailer vehicle |
descriptions - DescriptionPaged
|
AssetManager descriptions |
Arguments
|
|
doors_lock_status - DoorsLockStatus
|
Doors lock status |
doors_lock_status_updated_at - DateTime
|
Doors lock status reported time |
driver_sessions - DriverVehicleSessionPaged
|
Driver Sessions |
fuel_type - String
|
Primary fuel type |
fuel_type_secondary - String
|
Secondary fuel type |
garage_mode_status - GarageModeStatus
|
Garage mode status |
garage_mode_status_updated_at - DateTime
|
Garage mode status reported time |
groups - GroupPaged
|
Groups |
has_driver - Boolean
|
Has a driver |
hybrid - Boolean
|
hybrid |
immobilizer_status - ImmobilizerStatus
|
Immobilizer status |
immobilizer_status_updated_at - DateTime
|
Immobilizer status reported time |
kba - String
|
KBA |
ktype - String
|
KType |
label - String
|
Label |
last_trip - Trip
|
Last trip |
Arguments
|
|
maintenance_schedules - MaintenanceSchedulePaged
|
Maintenance schedules |
Arguments
|
|
maintenance_templates - MaintenanceTemplatePaged
|
Maintenance templates |
maintenances_historical - MaintenanceHistoricalPaged
|
Historical maintenances |
maintenances_upcoming - MaintenanceUpcomingPaged
|
Upcoming maintenances |
Arguments
|
|
make - String
|
Model make |
model - String
|
Model |
model_id - ID
|
Model ID |
onboarded - Boolean
|
onboarded |
owner - Account
|
Vehicle owner |
plate - String
|
Plate |
tags - [String!]
|
tags |
towing_sessions_as_towing_vehicle - TowingSessionPaged
|
List towing sessions where this vehicle is the towing vehicle |
towing_sessions_as_trailer_vehicle - TowingSessionPaged
|
List towing sessions where this vehicle is the trailer vehicle |
trips - TripPaged
|
Trips |
vehicle_type - VehicleTypeName
|
vehicle type |
vin - String
|
VIN |
vin_descriptions - DecodeVinResult
|
VIN descriptions |
year - String
|
Model Year |
authorized_drivers - vehicle_authorized_drivers_response
|
|
auxiliary_devices - vehicle_auxiliary_devices_response
|
|
Arguments
|
|
auxiliary_device - get_vehicle_auxiliary_device_response
|
|
Arguments
|
|
refills - vehicles_refills_response
|
|
refills_summary - vehicles_summary_response
|
|
Example
{
"id": "4",
"alerts": VehicleAlertPaged,
"alerts_state": VehicleAlertsState,
"archived": true,
"can_be_towed": true,
"can_tow": true,
"current_device": Device,
"current_devices": DevicePaged,
"current_driver": Driver,
"current_towing_session_as_towing_vehicle": TowingSession,
"current_towing_session_as_trailer_vehicle": TowingSession,
"current_towing_vehicle": Vehicle,
"current_trailer_vehicle": Vehicle,
"descriptions": DescriptionPaged,
"doors_lock_status": "LOCKED",
"doors_lock_status_updated_at": "2007-12-03T10:15:30Z",
"driver_sessions": DriverVehicleSessionPaged,
"fuel_type": "xyz789",
"fuel_type_secondary": "xyz789",
"garage_mode_status": "DISABLED",
"garage_mode_status_updated_at": "2007-12-03T10:15:30Z",
"groups": GroupPaged,
"has_driver": true,
"hybrid": true,
"immobilizer_status": "DISABLED",
"immobilizer_status_updated_at": "2007-12-03T10:15:30Z",
"kba": "xyz789",
"ktype": "abc123",
"label": "xyz789",
"last_trip": Trip,
"maintenance_schedules": MaintenanceSchedulePaged,
"maintenance_templates": MaintenanceTemplatePaged,
"maintenances_historical": MaintenanceHistoricalPaged,
"maintenances_upcoming": MaintenanceUpcomingPaged,
"make": "xyz789",
"model": "xyz789",
"model_id": 4,
"onboarded": false,
"owner": Account,
"plate": "xyz789",
"tags": ["abc123"],
"towing_sessions_as_towing_vehicle": TowingSessionPaged,
"towing_sessions_as_trailer_vehicle": TowingSessionPaged,
"trips": TripPaged,
"vehicle_type": "CAR",
"vin": "abc123",
"vin_descriptions": DecodeVinResult,
"year": "xyz789",
"authorized_drivers": vehicle_driver_paginated,
"auxiliary_devices": auxiliary_device_paginated,
"auxiliary_device": auxiliary_device_show,
"refills": refill_paged,
"refills_summary": vehicle_summary_show
}
VehicleAlert
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
device - Device
|
Null if no permission |
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Possible Types
| VehicleAlert Types |
|---|
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"icon": "xyz789",
"id": 4,
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"source": "OTHER",
"status": "CLOSED",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertAggregateDateArg
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
VehicleAlertBadInstallation
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
device - Device
|
Null if no permission |
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
history - VehicleAlertHistoryBadInstallationPaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
sporadic_unplug - Boolean
|
Device gets unpluged sporadically |
status - VehicleAlertStatus!
|
|
timestamp - DateTime
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"history": VehicleAlertHistoryBadInstallationPaged,
"icon": "abc123",
"id": 4,
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"source": "OTHER",
"sporadic_unplug": false,
"status": "CLOSED",
"timestamp": "2007-12-03T10:15:30Z",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertBatteryDischarge
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
device - Device
|
Null if no permission |
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
history - VehicleAlertHistoryBatteryDischargePaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
level - BatteryDischargeLevel
|
|
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
timestamp - DateTime!
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"history": VehicleAlertHistoryBatteryDischargePaged,
"icon": "xyz789",
"id": "4",
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"level": "CRITICAL_DISCHARGE",
"source": "OTHER",
"status": "CLOSED",
"timestamp": "2007-12-03T10:15:30Z",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertBatteryExcessiveCrankValley
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
device - Device
|
Null if no permission |
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
history - VehicleAlertHistoryBatteryExcessiveCrankValleyPaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
number_of_valleys - Int!
|
|
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
timestamp - DateTime!
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"history": VehicleAlertHistoryBatteryExcessiveCrankValleyPaged,
"icon": "xyz789",
"id": 4,
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"number_of_valleys": 987,
"source": "OTHER",
"status": "CLOSED",
"timestamp": "2007-12-03T10:15:30Z",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertBatteryStateOfCharge
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
device - Device
|
Null if no permission |
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
history - VehicleAlertHistoryBatteryStateOfChargePaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
level - BatteryChargeLevel
|
State of Charge (enum) |
ocv - Float
|
Open-Circuit Voltage (millivolt) |
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
timestamp - DateTime!
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
value - Percent
|
State of Charge (percentage) |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"history": VehicleAlertHistoryBatteryStateOfChargePaged,
"icon": "abc123",
"id": 4,
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"level": "CHARGED",
"ocv": 123.45,
"source": "OTHER",
"status": "CLOSED",
"timestamp": "2007-12-03T10:15:30Z",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"value": Percent,
"vehicle": Vehicle
}
VehicleAlertBatteryStateOfHealthLowVoltage
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
device - Device
|
Null if no permission |
duration_in_milliseconds - Int!
|
|
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
first_occurrence_timestamp_start - DateTime
|
|
history - VehicleAlertHistoryBatteryStateOfHealthLowVoltagePaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_occurrence_timestamp_end - DateTime
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
level - StateOfHealthLowVoltageLevel
|
|
lowest_value - Float!
|
|
mean_value - Float
|
|
occurred - Boolean!
|
|
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
timestamp - DateTime!
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"duration_in_milliseconds": 123,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"first_occurrence_timestamp_start": "2007-12-03T10:15:30Z",
"history": VehicleAlertHistoryBatteryStateOfHealthLowVoltagePaged,
"icon": "xyz789",
"id": "4",
"language": "OTHER",
"last_occurrence_timestamp_end": "2007-12-03T10:15:30Z",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"level": "ALERT",
"lowest_value": 123.45,
"mean_value": 987.65,
"occurred": false,
"source": "OTHER",
"status": "CLOSED",
"timestamp": "2007-12-03T10:15:30Z",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertBatteryStateOfHealthUser
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
calculated_date - DateTime
|
|
classification - StateOfHealthUserClassification
|
|
created_at - DateTime!
|
|
description - String
|
|
device - Device
|
Null if no permission |
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
history - VehicleAlertHistoryBatteryStateOfHealthUserPaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
recommendation - String
|
|
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"calculated_date": "2007-12-03T10:15:30Z",
"classification": "OTHER",
"created_at": "2007-12-03T10:15:30Z",
"description": "abc123",
"device": Device,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"history": VehicleAlertHistoryBatteryStateOfHealthUserPaged,
"icon": "abc123",
"id": 4,
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"recommendation": "xyz789",
"source": "OTHER",
"status": "CLOSED",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertBatteryType
Description
Battery type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DISCHARGE"
VehicleAlertBatteryVoltageHighLevelGap
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
device - Device
|
Null if no permission |
duration_between_plateaus - Int
|
Duration between plateaus (ms) |
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
history - VehicleAlertHistoryBatteryVoltageHighLevelGapPaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
timestamp - DateTime!
|
|
timestamp_end_first_plateau - DateTime
|
|
timestamp_end_second_plateau - DateTime
|
|
timestamp_start_first_plateau - DateTime
|
|
timestamp_start_second_plateau - DateTime
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
voltage_difference - Float
|
|
voltage_first_plateau - Float
|
|
voltage_second_plateau - Float
|
|
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"duration_between_plateaus": 987,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"history": VehicleAlertHistoryBatteryVoltageHighLevelGapPaged,
"icon": "abc123",
"id": "4",
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"source": "OTHER",
"status": "CLOSED",
"timestamp": "2007-12-03T10:15:30Z",
"timestamp_end_first_plateau": "2007-12-03T10:15:30Z",
"timestamp_end_second_plateau": "2007-12-03T10:15:30Z",
"timestamp_start_first_plateau": "2007-12-03T10:15:30Z",
"timestamp_start_second_plateau": "2007-12-03T10:15:30Z",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle,
"voltage_difference": 123.45,
"voltage_first_plateau": 987.65,
"voltage_second_plateau": 123.45
}
VehicleAlertCrash
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
confidence - Percent!
|
|
coordinates - Coordinates!
|
|
created_at - DateTime!
|
|
device - Device
|
Null if no permission |
end_time - DateTime!
|
|
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
history - VehicleAlertHistoryCrashPaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
severity - Percent!
|
|
severity_classification - VehicleAlertCrashSeverity!
|
|
source - VehicleAlertSource!
|
|
start_time - DateTime!
|
|
status - VehicleAlertStatus!
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"confidence": Percent,
"coordinates": Coordinates,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"end_time": "2007-12-03T10:15:30Z",
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"history": VehicleAlertHistoryCrashPaged,
"icon": "abc123",
"id": 4,
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"severity": Percent,
"severity_classification": "OTHER",
"source": "OTHER",
"start_time": "2007-12-03T10:15:30Z",
"status": "CLOSED",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertCrashSeverity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Crash with fatalities |
|
|
Crash with injuries |
|
|
Property damage only |
|
|
Unknown severity class |
Example
"OTHER"
VehicleAlertDifferentVin
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
alternative_vin - String!
|
|
created_at - DateTime!
|
|
device - Device
|
Null if no permission |
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
history - VehicleAlertHistoryDifferentVinPaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
onboarding_vin - String!
|
|
recorded_at - DateTime!
|
|
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"alternative_vin": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"history": VehicleAlertHistoryDifferentVinPaged,
"icon": "abc123",
"id": 4,
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"onboarding_vin": "xyz789",
"recorded_at": "2007-12-03T10:15:30Z",
"source": "OTHER",
"status": "CLOSED",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertDtc
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
device - Device
|
Null if no permission |
dtc - VehicleAlertDtcDtc
|
|
dtc_status - VehicleAlertDtcStatus
|
|
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
freeze_frames - DtcFreezeFrames
|
|
history - VehicleAlertHistoryDtcPaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"dtc": VehicleAlertDtcDtc,
"dtc_status": VehicleAlertDtcStatus,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"freeze_frames": DtcFreezeFrames,
"history": VehicleAlertHistoryDtcPaged,
"icon": "abc123",
"id": 4,
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"source": "OTHER",
"status": "CLOSED",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertDtcDtc
Fields
| Field Name | Description |
|---|---|
cause - String
|
|
classification - DtcClassification
|
|
code - String
|
|
code_description - String
|
|
code_subdescription - String
|
|
effect - String
|
|
is_oem - Boolean
|
|
protocol - DtcProtocol
|
|
recommendation - String
|
|
risk_availability - DtcRisk
|
|
risk_damage - DtcRisk
|
|
risk_emissions - DtcRisk
|
|
risk_safety - DtcRisk
|
|
sensor - String
|
|
sensor_description - String
|
|
source - DtcSource
|
|
source_description - String
|
|
source_id - String
|
|
source_name - String
|
|
system_category - String
|
|
warning - String
|
Example
{
"cause": "xyz789",
"classification": "ADVISORY",
"code": "xyz789",
"code_description": "abc123",
"code_subdescription": "xyz789",
"effect": "abc123",
"is_oem": true,
"protocol": "UNKNOWN",
"recommendation": "xyz789",
"risk_availability": "CRITICAL",
"risk_damage": "CRITICAL",
"risk_emissions": "CRITICAL",
"risk_safety": "CRITICAL",
"sensor": "xyz789",
"sensor_description": "abc123",
"source": "OTHER",
"source_description": "abc123",
"source_id": "abc123",
"source_name": "abc123",
"system_category": "abc123",
"warning": "xyz789"
}
VehicleAlertDtcStatus
VehicleAlertFeedback
Fields
| Field Name | Description |
|---|---|
alert - VehicleAlert
|
|
created_at - DateTime!
|
|
description - String
|
|
id - ID!
|
|
language - Lang
|
|
status - VehicleAlertFeedbackStatus!
|
|
updated_at - DateTime!
|
Example
{
"alert": VehicleAlert,
"created_at": "2007-12-03T10:15:30Z",
"description": "abc123",
"id": 4,
"language": "OTHER",
"status": "OTHER",
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertFeedbackPaged
Description
Paginated vehicle_alert_feedback results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertFeedback!]!
|
|
next - ID
|
Example
{"count": 123, "list": [VehicleAlertFeedback], "next": 4}
VehicleAlertFeedbackStatus
Description
vehicle alert feedback status
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized vehicle alert feedback status |
|
|
|
|
|
|
|
|
Example
"OTHER"
VehicleAlertFeedbackStatusArg
Description
vehicle alert feedback status argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CONFIRMED"
VehicleAlertGeofencing
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
coordinates - Coordinates
|
Use StartCoordinates |
created_at - DateTime!
|
|
description - String
|
|
device - Device
|
Null if no permission |
end_coordinates - Coordinates
|
|
end_time - DateTime
|
|
event - GeofencingEvent
|
|
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
geofence_id - ID
|
|
history - VehicleAlertHistoryGeofencingPaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
label - String
|
|
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
start_coordinates - Coordinates
|
|
start_time - DateTime
|
|
state - GeofencingState
|
|
status - VehicleAlertStatus!
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"coordinates": Coordinates,
"created_at": "2007-12-03T10:15:30Z",
"description": "abc123",
"device": Device,
"end_coordinates": Coordinates,
"end_time": "2007-12-03T10:15:30Z",
"event": "OTHER",
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"geofence_id": "4",
"history": VehicleAlertHistoryGeofencingPaged,
"icon": "xyz789",
"id": "4",
"label": "abc123",
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"source": "OTHER",
"start_coordinates": Coordinates,
"start_time": "2007-12-03T10:15:30Z",
"state": "OTHER",
"status": "CLOSED",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertHistoryBadInstallation
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
id - ID
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
occurence - Int!
|
|
sporadic_unplug - Boolean
|
Device gets unpluged sporadically |
timestamp - DateTime
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"occurence": 987,
"sporadic_unplug": true,
"timestamp": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryBadInstallationPaged
Description
Paginated vehicle_alert_history_bad_installation results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryBadInstallation!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [VehicleAlertHistoryBadInstallation],
"next": "4"
}
VehicleAlertHistoryBatteryDischarge
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
id - ID
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
level - BatteryDischargeLevel
|
|
occurence - Int!
|
|
timestamp - DateTime!
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"level": "CRITICAL_DISCHARGE",
"occurence": 987,
"timestamp": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryBatteryDischargePaged
Description
Paginated vehicle_alert_history_battery_discharge results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryBatteryDischarge!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [VehicleAlertHistoryBatteryDischarge],
"next": 4
}
VehicleAlertHistoryBatteryExcessiveCrankValley
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
id - ID
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
number_of_valleys - Int!
|
|
occurence - Int!
|
|
timestamp - DateTime!
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"number_of_valleys": 987,
"occurence": 123,
"timestamp": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryBatteryExcessiveCrankValleyPaged
Description
Paginated vehicle_alert_history_battery_excessive_crank_valley results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryBatteryExcessiveCrankValley!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [
VehicleAlertHistoryBatteryExcessiveCrankValley
],
"next": 4
}
VehicleAlertHistoryBatteryStateOfCharge
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
id - ID
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
level - BatteryChargeLevel
|
State of Charge (enum) |
occurence - Int!
|
|
ocv - Float
|
Open-Circuit Voltage (millivolt) |
timestamp - DateTime!
|
|
updated_at - DateTime!
|
|
value - Percent
|
State of Charge (percentage) |
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"level": "CHARGED",
"occurence": 987,
"ocv": 123.45,
"timestamp": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"value": Percent
}
VehicleAlertHistoryBatteryStateOfChargePaged
Description
Paginated vehicle_alert_history_battery_state_of_charge results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryBatteryStateOfCharge!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [VehicleAlertHistoryBatteryStateOfCharge],
"next": "4"
}
VehicleAlertHistoryBatteryStateOfHealthLowVoltage
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
duration_in_milliseconds - Int!
|
|
first_occurrence_timestamp_start - DateTime
|
|
id - ID
|
|
last_occurrence_timestamp_end - DateTime
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
level - StateOfHealthLowVoltageLevel
|
|
lowest_value - Float!
|
|
mean_value - Float
|
|
occurence - Int!
|
|
occurred - Boolean!
|
|
timestamp - DateTime!
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"duration_in_milliseconds": 123,
"first_occurrence_timestamp_start": "2007-12-03T10:15:30Z",
"id": 4,
"last_occurrence_timestamp_end": "2007-12-03T10:15:30Z",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"level": "ALERT",
"lowest_value": 123.45,
"mean_value": 987.65,
"occurence": 123,
"occurred": false,
"timestamp": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryBatteryStateOfHealthLowVoltagePaged
Description
Paginated vehicle_alert_history_battery_state_of_health_low_voltage results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryBatteryStateOfHealthLowVoltage!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [
VehicleAlertHistoryBatteryStateOfHealthLowVoltage
],
"next": "4"
}
VehicleAlertHistoryBatteryStateOfHealthUser
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
calculated_date - DateTime
|
|
classification - StateOfHealthUserClassification
|
|
created_at - DateTime!
|
|
description - String
|
|
id - ID
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
occurence - Int!
|
|
recommendation - String
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"calculated_date": "2007-12-03T10:15:30Z",
"classification": "OTHER",
"created_at": "2007-12-03T10:15:30Z",
"description": "xyz789",
"id": "4",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"occurence": 123,
"recommendation": "abc123",
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryBatteryStateOfHealthUserPaged
Description
Paginated vehicle_alert_history_battery_state_of_health_user results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryBatteryStateOfHealthUser!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [VehicleAlertHistoryBatteryStateOfHealthUser],
"next": 4
}
VehicleAlertHistoryBatteryVoltageHighLevelGap
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
duration_between_plateaus - Int
|
Duration between plateaus (ms) |
id - ID
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
occurence - Int!
|
|
timestamp - DateTime!
|
|
timestamp_end_first_plateau - DateTime
|
|
timestamp_end_second_plateau - DateTime
|
|
timestamp_start_first_plateau - DateTime
|
|
timestamp_start_second_plateau - DateTime
|
|
updated_at - DateTime!
|
|
voltage_difference - Float
|
|
voltage_first_plateau - Float
|
|
voltage_second_plateau - Float
|
|
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"duration_between_plateaus": 123,
"id": 4,
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"occurence": 987,
"timestamp": "2007-12-03T10:15:30Z",
"timestamp_end_first_plateau": "2007-12-03T10:15:30Z",
"timestamp_end_second_plateau": "2007-12-03T10:15:30Z",
"timestamp_start_first_plateau": "2007-12-03T10:15:30Z",
"timestamp_start_second_plateau": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"voltage_difference": 123.45,
"voltage_first_plateau": 987.65,
"voltage_second_plateau": 123.45
}
VehicleAlertHistoryBatteryVoltageHighLevelGapPaged
Description
Paginated vehicle_alert_history_battery_voltage_high_level_gap results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryBatteryVoltageHighLevelGap!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [VehicleAlertHistoryBatteryVoltageHighLevelGap],
"next": "4"
}
VehicleAlertHistoryCrash
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
confidence - Percent!
|
|
coordinates - Coordinates!
|
|
created_at - DateTime!
|
|
end_time - DateTime!
|
|
id - ID
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
occurence - Int!
|
|
severity - Percent!
|
|
severity_classification - VehicleAlertCrashSeverity!
|
|
start_time - DateTime!
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"confidence": Percent,
"coordinates": Coordinates,
"created_at": "2007-12-03T10:15:30Z",
"end_time": "2007-12-03T10:15:30Z",
"id": 4,
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"occurence": 123,
"severity": Percent,
"severity_classification": "OTHER",
"start_time": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryCrashPaged
Description
Paginated vehicle_alert_history_crash results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryCrash!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [VehicleAlertHistoryCrash],
"next": 4
}
VehicleAlertHistoryDifferentVin
Description
VIN differs between onboarding and other sources
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
alternative_vin - String!
|
|
created_at - DateTime!
|
|
id - ID
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
occurence - Int!
|
|
onboarding_vin - String!
|
|
recorded_at - DateTime!
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"alternative_vin": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"occurence": 987,
"onboarding_vin": "abc123",
"recorded_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryDifferentVinPaged
Description
Paginated vehicle_alert_history_different_vin results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryDifferentVin!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [VehicleAlertHistoryDifferentVin],
"next": "4"
}
VehicleAlertHistoryDtc
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
dtc - VehicleAlertDtcDtc
|
|
dtc_status - VehicleAlertDtcStatus
|
|
freeze_frames - DtcFreezeFrames
|
|
id - ID
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
occurence - Int!
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"dtc": VehicleAlertDtcDtc,
"dtc_status": VehicleAlertDtcStatus,
"freeze_frames": DtcFreezeFrames,
"id": "4",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"occurence": 987,
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryDtcPaged
Description
Paginated vehicle_alert_history_dtc results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryDtc!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [VehicleAlertHistoryDtc],
"next": 4
}
VehicleAlertHistoryGeofencing
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
coordinates - Coordinates
|
Use StartCoordinates |
created_at - DateTime!
|
|
description - String
|
|
end_coordinates - Coordinates
|
|
end_time - DateTime
|
|
event - GeofencingEvent
|
|
geofence_id - ID
|
|
id - ID
|
|
label - String
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
occurence - Int!
|
|
start_coordinates - Coordinates
|
|
start_time - DateTime
|
|
state - GeofencingState
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"coordinates": Coordinates,
"created_at": "2007-12-03T10:15:30Z",
"description": "xyz789",
"end_coordinates": Coordinates,
"end_time": "2007-12-03T10:15:30Z",
"event": "OTHER",
"geofence_id": "4",
"id": 4,
"label": "xyz789",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"occurence": 987,
"start_coordinates": Coordinates,
"start_time": "2007-12-03T10:15:30Z",
"state": "OTHER",
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryGeofencingPaged
Description
Paginated vehicle_alert_history_geofencing results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryGeofencing!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [VehicleAlertHistoryGeofencing],
"next": "4"
}
VehicleAlertHistoryPlugUnplug
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
id - ID
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
occurence - Int!
|
|
plug - VehicleAlertPlug
|
|
unplug - VehicleAlertUnplug
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"occurence": 123,
"plug": VehicleAlertPlug,
"unplug": VehicleAlertUnplug,
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryPlugUnplugPaged
Description
Paginated vehicle_alert_history_plug_unplug results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryPlugUnplug!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [VehicleAlertHistoryPlugUnplug],
"next": "4"
}
VehicleAlertHistoryUnknown
Description
Fallback for unexpected alert types
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
content - Json
|
|
created_at - DateTime!
|
|
id - ID
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
occurence - Int!
|
|
type_str - String
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"content": Json,
"created_at": "2007-12-03T10:15:30Z",
"id": "4",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"occurence": 123,
"type_str": "abc123",
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryUnknownPaged
Description
Paginated vehicle_alert_history_unknown results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryUnknown!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [VehicleAlertHistoryUnknown],
"next": 4
}
VehicleAlertHistoryUpcomingMaintenance
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
criticality - MaintenanceCriticality!
|
|
date_deadline - DateTime
|
|
description - String!
|
|
distance_to_next - Int
|
|
from_vehicle - Boolean!
|
|
id - ID
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
mileage_deadline - Int
|
Mileage deadline (km) |
occurence - Int!
|
|
system - MaintenanceSystem!
|
|
time_to_next - Int
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"criticality": "OTHER",
"date_deadline": "2007-12-03T10:15:30Z",
"description": "abc123",
"distance_to_next": 123,
"from_vehicle": false,
"id": 4,
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"mileage_deadline": 123,
"occurence": 987,
"system": MaintenanceSystem,
"time_to_next": 123,
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryUpcomingMaintenancePaged
Description
Paginated vehicle_alert_history_upcoming_maintenance results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryUpcomingMaintenance!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [VehicleAlertHistoryUpcomingMaintenance],
"next": 4
}
VehicleAlertHistoryWarningLight
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
code - String
|
|
created_at - DateTime!
|
|
description - String
|
|
extra_information - String
|
|
id - ID
|
|
is_active - Boolean
|
|
last_received - DateTime!
|
|
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
level - AlertWarningLightLevel
|
|
name - String
|
|
occurence - Int!
|
|
updated_at - DateTime!
|
|
Example
{
"aggregated_data": AggregatedData,
"code": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"description": "abc123",
"extra_information": "xyz789",
"id": "4",
"is_active": true,
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"level": "OTHER",
"name": "abc123",
"occurence": 123,
"updated_at": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryWarningLightPaged
Description
Paginated vehicle_alert_history_warning_light results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlertHistoryWarningLight!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [VehicleAlertHistoryWarningLight],
"next": "4"
}
VehicleAlertNotification
Fields
| Field Name | Description |
|---|---|
alerts - [VehicleAlert!]
|
|
vehicle - Vehicle
|
Vehicle |
Example
{
"alerts": [VehicleAlert],
"vehicle": Vehicle
}
VehicleAlertPaged
Description
Paginated vehicle_alert results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleAlert!]!
|
|
next - ID
|
Example
{"count": 987, "list": [VehicleAlert], "next": 4}
VehicleAlertPlug
Fields
| Field Name | Description |
|---|---|
coordinates - Coordinates
|
|
mileage - Int
|
|
potential - Float
|
Example
{
"coordinates": Coordinates,
"mileage": 987,
"potential": 987.65
}
VehicleAlertPlugUnplug
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
device - Device
|
Null if no permission |
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
history - VehicleAlertHistoryPlugUnplugPaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
plug - VehicleAlertPlug
|
|
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
type - VehicleAlertType!
|
|
unplug - VehicleAlertUnplug
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"history": VehicleAlertHistoryPlugUnplugPaged,
"icon": "xyz789",
"id": "4",
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"plug": VehicleAlertPlug,
"source": "OTHER",
"status": "CLOSED",
"type": "BAD_INSTALLATION",
"unplug": VehicleAlertUnplug,
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertSort
Description
vehicle_alert sorting
Fields
| Input Field | Description |
|---|---|
by - VehicleAlertSortKey!
|
|
order - SortOrder!
|
Example
{"by": "CREATED_AT", "order": "A"}
VehicleAlertSortKey
Description
vehicle_alert sorting key
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
VehicleAlertSource
Description
Alert source
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized alert source |
|
|
Alerts created by the device |
|
|
Alerts created by the user |
Example
"OTHER"
VehicleAlertSourceArg
Values
| Enum Value | Description |
|---|---|
|
|
Alerts created by the device |
|
|
Alerts created by the user |
Example
"DEVICE"
VehicleAlertStatus
Description
Alert status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized alert status |
Example
"CLOSED"
VehicleAlertStatusArg
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CLOSED"
VehicleAlertType
Description
Alert type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized alert type |
|
|
|
|
|
|
|
|
Example
"BAD_INSTALLATION"
VehicleAlertTypeArg
Description
Alert type argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BAD_INSTALLATION"
VehicleAlertUnknown
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
content - Json
|
|
created_at - DateTime!
|
|
device - Device
|
Null if no permission |
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
history - VehicleAlertHistoryUnknownPaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
type - VehicleAlertType!
|
|
type_str - String
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"content": Json,
"created_at": "2007-12-03T10:15:30Z",
"device": Device,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"history": VehicleAlertHistoryUnknownPaged,
"icon": "abc123",
"id": 4,
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"source": "OTHER",
"status": "CLOSED",
"type": "BAD_INSTALLATION",
"type_str": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertUnplug
Fields
| Field Name | Description |
|---|---|
coordinates - Coordinates
|
|
duration - Int
|
|
mileage - Int
|
|
potential - Float
|
Example
{
"coordinates": Coordinates,
"duration": 987,
"mileage": 123,
"potential": 987.65
}
VehicleAlertUpcomingMaintenance
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
created_at - DateTime!
|
|
criticality - MaintenanceCriticality!
|
|
date_deadline - DateTime
|
|
description - String!
|
|
device - Device
|
Null if no permission |
distance_to_next - Int
|
|
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
from_vehicle - Boolean!
|
|
history - VehicleAlertHistoryUpcomingMaintenancePaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
mileage_deadline - Int
|
Mileage deadline (km) |
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
system - MaintenanceSystem!
|
|
time_to_next - Int
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"created_at": "2007-12-03T10:15:30Z",
"criticality": "OTHER",
"date_deadline": "2007-12-03T10:15:30Z",
"description": "xyz789",
"device": Device,
"distance_to_next": 987,
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"from_vehicle": true,
"history": VehicleAlertHistoryUpcomingMaintenancePaged,
"icon": "abc123",
"id": 4,
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"mileage_deadline": 987,
"source": "OTHER",
"status": "CLOSED",
"system": MaintenanceSystem,
"time_to_next": 123,
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertWarningLight
Fields
| Field Name | Description |
|---|---|
aggregated_data - AggregatedData
|
|
Arguments
|
|
code - String
|
|
created_at - DateTime!
|
|
description - String
|
|
device - Device
|
Null if no permission |
extra_information - String
|
|
feedback_status - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
history - VehicleAlertHistoryWarningLightPaged
|
|
icon - String!
|
|
id - ID
|
Alert id (null in subscriptions) |
is_active - Boolean
|
|
language - Lang
|
|
last_received - DateTime!
|
Last time the alert was received |
last_reported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
level - AlertWarningLightLevel
|
|
name - String
|
|
source - VehicleAlertSource!
|
|
status - VehicleAlertStatus!
|
|
type - VehicleAlertType!
|
|
updated_at - DateTime!
|
|
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
Example
{
"aggregated_data": AggregatedData,
"code": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"description": "xyz789",
"device": Device,
"extra_information": "xyz789",
"feedback_status": "OTHER",
"feedbacks": VehicleAlertFeedbackPaged,
"history": VehicleAlertHistoryWarningLightPaged,
"icon": "abc123",
"id": "4",
"is_active": true,
"language": "OTHER",
"last_received": "2007-12-03T10:15:30Z",
"last_reported": "2007-12-03T10:15:30Z",
"level": "OTHER",
"name": "abc123",
"source": "OTHER",
"status": "CLOSED",
"type": "BAD_INSTALLATION",
"updated_at": "2007-12-03T10:15:30Z",
"vehicle": Vehicle
}
VehicleAlertsState
Fields
| Field Name | Description |
|---|---|
active_critical_dtc_alerts - Int!
|
|
active_dtc_alerts - Int!
|
|
active_information_dtc_alerts - Int!
|
|
active_warning_dtc_alerts - Int!
|
|
active_warning_lights_alerts - Int!
|
|
bad_installation_alerts - Int!
|
|
battery_alerts - Int!
|
|
contact_workshop - Boolean!
|
True if MIL is true and/or a CRITICAL or a WARNING DTC is currently active |
crash_alerts - Int!
|
|
intermittent_dtc_alerts - Int!
|
|
is_plugged - Boolean
|
Whether device is currently plugged in (null: no plug/unplug alert was received yet) |
last_battery_discharge_alert - DateTime
|
|
last_battery_state_of_charge_alert - DateTime
|
|
last_crash_alert - DateTime
|
|
last_excessive_crank_valleys_alert - DateTime
|
|
last_plug_unplug_alert - DateTime
|
|
last_voltage_high_level_gap_alert - DateTime
|
|
mil - Boolean
|
True when MIL warning W0031 and/or W0006 is currently active |
open_circuit_voltage - Float
|
Most recent received ocv value |
plug_unplug_alerts - Int!
|
|
severity_index - Float!
|
Device severity index |
state_of_health_low_voltage_level - StateOfHealthLowVoltageLevel
|
Most recent received state of health low voltage battery alert level |
total_alerts - Int!
|
|
upcoming_maintenance_date - DateTime
|
Closest upcoming maintenance date (null: device never received upcoming maintenance alert) |
upcoming_maintenance_mileage - Int
|
Closest upcoming maintenance mileage (null: device never received upcoming maintenance alert) |
upcoming_maintenances - Int!
|
Example
{
"active_critical_dtc_alerts": 987,
"active_dtc_alerts": 987,
"active_information_dtc_alerts": 987,
"active_warning_dtc_alerts": 123,
"active_warning_lights_alerts": 123,
"bad_installation_alerts": 123,
"battery_alerts": 987,
"contact_workshop": false,
"crash_alerts": 987,
"intermittent_dtc_alerts": 123,
"is_plugged": true,
"last_battery_discharge_alert": "2007-12-03T10:15:30Z",
"last_battery_state_of_charge_alert": "2007-12-03T10:15:30Z",
"last_crash_alert": "2007-12-03T10:15:30Z",
"last_excessive_crank_valleys_alert": "2007-12-03T10:15:30Z",
"last_plug_unplug_alert": "2007-12-03T10:15:30Z",
"last_voltage_high_level_gap_alert": "2007-12-03T10:15:30Z",
"mil": true,
"open_circuit_voltage": 987.65,
"plug_unplug_alerts": 987,
"severity_index": 987.65,
"state_of_health_low_voltage_level": "ALERT",
"total_alerts": 123,
"upcoming_maintenance_date": "2007-12-03T10:15:30Z",
"upcoming_maintenance_mileage": 123,
"upcoming_maintenances": 123
}
VehicleInfo
VehicleNotification
Description
Vehicle notification
Fields
| Field Name | Description |
|---|---|
vehicle - Vehicle
|
Vehicle |
Possible Types
| VehicleNotification Types |
|---|
Example
{"vehicle": Vehicle}
VehiclePaged
Description
Paginated vehicle results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Vehicle!]!
|
|
next - ID
|
Example
{
"count": 123,
"list": [Vehicle],
"next": "4"
}
VehicleService
Description
Workshop vehicle service
Example
{
"id": 4,
"description": "xyz789",
"label": "abc123",
"workshops": WorkshopPaged
}
VehicleServicePaged
Description
Paginated vehicle_service results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleService!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [VehicleService],
"next": "4"
}
VehicleSort
Description
vehicle sorting
Fields
| Input Field | Description |
|---|---|
by - VehicleSortKey!
|
|
order - SortOrder!
|
Example
{"by": "PLATE", "order": "A"}
VehicleSortKey
Description
vehicle sorting key
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PLATE"
VehicleType
Description
Workshop vehicle type
Example
{
"id": "4",
"description": "abc123",
"label": "abc123",
"workshops": WorkshopPaged
}
VehicleTypeName
Values
| Enum Value | Description |
|---|---|
|
|
Car |
|
|
Equipment |
|
|
Other |
|
|
Trailer |
|
|
Truck |
|
|
Unpowered |
Example
"CAR"
VehicleTypePaged
Description
Paginated vehicle_type results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [VehicleType!]!
|
|
next - ID
|
Example
{
"count": 987,
"list": [VehicleType],
"next": "4"
}
VinExtraInfo
Description
Extra vehicle info from other providers
Fields
| Field Name | Description |
|---|---|
fuel_types - [EnergyType]
|
Supported fuel types |
need_cable - Boolean
|
Whether vehicle needs a special fiat cable |
need_mux - Boolean
|
Whether vehicle needs a hardware multiplexing cable |
obd_port_positions - [Int]
|
Position of OBD port |
tank_sizes - [Int]
|
Fuel tanks sizes (l) |
Example
{
"fuel_types": ["ADBLUE"],
"need_cable": false,
"need_mux": false,
"obd_port_positions": [987],
"tank_sizes": [123]
}
Void
Description
Represents empty values
Void_container
Fields
| Field Name | Description |
|---|---|
Void - Void
|
Example
{"Void": null}
WarningIcon
Example
{
"code": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"icon": "xyz789",
"name": "xyz789",
"updated_at": "2007-12-03T10:15:30Z"
}
WarningIconPaged
Description
Paginated warning_icon results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [WarningIcon!]!
|
|
next - ID
|
Example
{"count": 987, "list": [WarningIcon], "next": 4}
Weather
Description
Weather
Fields
| Field Name | Description |
|---|---|
description - String
|
Description |
temperature - Float
|
Temperature |
type - WeatherType!
|
Weather type |
Example
{
"description": "xyz789",
"temperature": 123.45,
"type": "THUNDERSTORM_LIGHT_RAIN"
}
WeatherCoordinates
Description
Weather with coordinates
Example
{
"latitude": 987.65,
"longitude": 987.65,
"temperature": 123.45,
"time": "2007-12-03T10:15:30Z",
"weather": "xyz789",
"weather_id": 987
}
WeatherType
Values
| Enum Value | Description |
|---|---|
|
|
thunderstorm with light rain |
|
|
thunderstorm with rain |
|
|
thunderstorm with heavy rain |
|
|
light thunderstorm |
|
|
thunderstorm |
|
|
heavy thunderstorm |
|
|
ragged thunderstorm |
|
|
thunderstorm with light drizzle |
|
|
thunderstorm with drizzle |
|
|
thunderstorm with heavy drizzle |
|
|
light intensity drizzle |
|
|
drizzle |
|
|
heavy intensity drizzle |
|
|
light intensity drizzle rain |
|
|
drizzle rain |
|
|
heavy intensity drizzle rain |
|
|
shower rain and drizzle |
|
|
heavy shower rain and drizzle |
|
|
shower drizzle |
|
|
light rain |
|
|
moderate rain |
|
|
heavy intensity rain |
|
|
very heavy rain |
|
|
extreme rain |
|
|
freezing rain |
|
|
light intensity shower rain |
|
|
shower rain |
|
|
heavy intensity shower rain |
|
|
ragged shower rain |
|
|
light snow |
|
|
snow |
|
|
heavy snow |
|
|
sleet |
|
|
light shower sleet |
|
|
shower sleet |
|
|
light rain and snow |
|
|
rain and snow |
|
|
light shower snow |
|
|
shower snow |
|
|
heavy shower snow |
|
|
mist |
|
|
smoke |
|
|
haze |
|
|
sand/dust whirls |
|
|
fog |
|
|
sand |
|
|
dust |
|
|
volcanic ash |
|
|
squalls |
|
|
tornado |
|
|
clear sky |
|
|
few clouds: 11-25% |
|
|
scattered clouds: 25-50% |
|
|
broken clouds: 51-84% |
|
|
overcast clouds: 85-100% |
|
|
Example
"THUNDERSTORM_LIGHT_RAIN"
Weekday
Description
Day of the week
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FRIDAY"
Workday
Description
Worshop workday
Example
{
"id": 4,
"closing_hour_1": "xyz789",
"closing_hour_2": "xyz789",
"day": "FRIDAY",
"opening_hour_1": "abc123",
"opening_hour_2": "abc123",
"workshop": Workshop
}
WorkdayPaged
Description
Paginated workday results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Workday!]!
|
|
next - ID
|
Example
{"count": 987, "list": [Workday], "next": 4}
Workshop
Description
Workshop
Fields
| Field Name | Description |
|---|---|
id - ID
|
Workshop id |
address - String
|
Workshop address |
average_stars - Float
|
Average stars of all ratings |
bookings - BookingPaged
|
Workshop bookings |
brand - String
|
Workshop brand |
city - String
|
Workshop city |
code - String
|
Workshop code |
country - String
|
Workshop country |
driver_services - DriverServicePaged
|
Workshop driver services |
email - String
|
Workshop email |
fax - String
|
Workshop fax |
icon - String
|
Workshop public url to icon |
international_phone - String
|
Workshop international phone number |
language - Language
|
Workshop Language |
lat - Float
|
Workshop latitude |
lon - Float
|
Workshop longitude |
managers - WorkshopManagerPaged
|
Workshop managers |
name - String
|
Workshop name |
phone - String
|
Workshop phone number |
postal_code - String
|
Workshop postal code |
provider - String
|
Workshop provider |
provider_workshop_id - ID
|
Workshop provider id |
province - String
|
Workshop province |
quotations - QuotationPaged
|
Workshop quotations |
ratings - RatingPaged
|
Workshop ratings |
time_zone - String
|
Workshop Time zone |
vehicle_services - VehicleServicePaged
|
Workshop vehicle services |
vehicle_types - VehicleTypePaged
|
Workshop vehicle types |
web - String
|
Workshop web |
workdays - WorkdayPaged
|
Workshop workdays |
Example
{
"id": 4,
"address": "abc123",
"average_stars": 987.65,
"bookings": BookingPaged,
"brand": "abc123",
"city": "xyz789",
"code": "abc123",
"country": "xyz789",
"driver_services": DriverServicePaged,
"email": "abc123",
"fax": "abc123",
"icon": "abc123",
"international_phone": "abc123",
"language": Language,
"lat": 987.65,
"lon": 987.65,
"managers": WorkshopManagerPaged,
"name": "xyz789",
"phone": "xyz789",
"postal_code": "xyz789",
"provider": "xyz789",
"provider_workshop_id": 4,
"province": "xyz789",
"quotations": QuotationPaged,
"ratings": RatingPaged,
"time_zone": "xyz789",
"vehicle_services": VehicleServicePaged,
"vehicle_types": VehicleTypePaged,
"web": "abc123",
"workdays": WorkdayPaged
}
WorkshopContactMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EMAIL"
WorkshopManager
WorkshopManagerPaged
Description
Paginated workshop_manager results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [WorkshopManager!]!
|
|
next - ID
|
Example
{"count": 123, "list": [WorkshopManager], "next": 4}
WorkshopPaged
Description
Paginated workshop results
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
list - [Workshop!]!
|
|
next - ID
|
Example
{"count": 987, "list": [Workshop], "next": 4}
_DirectiveExtensions
Example
_DirectiveExtensions
action
Fields
| Field Name | Description |
|---|---|
type - actions_const!
|
|
id - ID!
|
|
attributes - mutation_put_action_data_attributes!
|
|
links - links_for_resource
|
Example
{
"type": "actions",
"id": 4,
"attributes": mutation_put_action_data_attributes,
"links": links_for_resource
}
action_put_Input
Fields
| Input Field | Description |
|---|---|
data - mutationInput_put_action_input_data_Input
|
Example
{"data": mutationInput_put_action_input_data_Input}
action_show
Fields
| Field Name | Description |
|---|---|
data - action!
|
Example
{"data": action}
actions_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"actions"
alert_create_Input
Fields
| Input Field | Description |
|---|---|
data - alert_input_Input!
|
Example
{"data": alert_input_Input}
alert_input_Input
Fields
| Input Field | Description |
|---|---|
type - alerts_const!
|
|
attributes - mutationInput_post_alerts_input_data_attributes_Input!
|
Example
{
"type": "alerts",
"attributes": mutationInput_post_alerts_input_data_attributes_Input
}
alert_input_with_id_Input
Fields
| Input Field | Description |
|---|---|
type - alerts_const!
|
|
id - String!
|
|
attributes - mutationInput_put_alert_input_data_attributes_Input!
|
Example
{
"type": "alerts",
"id": "xyz789",
"attributes": mutationInput_put_alert_input_data_attributes_Input
}
alert_paginated
Fields
| Field Name | Description |
|---|---|
data - [geofence_alert]!
|
|
meta - meta!
|
Example
{
"data": [geofence_alert],
"meta": meta
}
alert_show
Fields
| Field Name | Description |
|---|---|
data - geofence_alert!
|
Example
{"data": geofence_alert}
alert_update_Input
Fields
| Input Field | Description |
|---|---|
data - alert_input_with_id_Input!
|
Example
{"data": alert_input_with_id_Input}
alerts_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"alerts"
am_auxiliary_device
Description
connected phones, captures ...
Fields
| Field Name | Description |
|---|---|
type - auxiliary_devices_const!
|
|
id - ID!
|
|
attributes - query_driver_auxiliary_devices_oneOf_0_data_items_attributes!
|
Example
{
"type": "auxiliary_devices",
"id": "4",
"attributes": query_driver_auxiliary_devices_oneOf_0_data_items_attributes
}
am_device_group
Fields
| Field Name | Description |
|---|---|
type - device_groups_const!
|
|
id - ID!
|
|
attributes - am_device_group_attributes!
|
Example
{
"type": "device_groups",
"id": 4,
"attributes": am_device_group_attributes
}
am_device_group_attributes
am_user_role
Fields
| Field Name | Description |
|---|---|
type - user_roles_const!
|
|
id - ID!
|
|
attributes - am_user_role_attributes!
|
Example
{
"type": "user_roles",
"id": "4",
"attributes": am_user_role_attributes
}
am_user_role_attributes
am_vehicle_driver
Fields
| Field Name | Description |
|---|---|
type - drivers_const!
|
|
id - ID!
|
|
attributes - query_vehicle_authorized_drivers_oneOf_0_data_items_attributes!
|
Example
{
"type": "drivers",
"id": "4",
"attributes": query_vehicle_authorized_drivers_oneOf_0_data_items_attributes
}
associated_device_Input
Fields
| Input Field | Description |
|---|---|
type - devices_const!
|
|
id - ID!
|
Example
{"type": "devices", "id": 4}
associated_devices_Input
Fields
| Input Field | Description |
|---|---|
data - [associated_device_Input]!
|
Example
{"data": [associated_device_Input]}
autocomplete_create_Input
Fields
| Input Field | Description |
|---|---|
data - autocomplete_post_Input!
|
Example
{"data": autocomplete_post_Input}
autocomplete_get
Fields
| Field Name | Description |
|---|---|
type - autocompletes_const!
|
|
id - ID!
|
|
attributes - query_autocompletes_oneOf_0_data_attributes!
|
|
links - links_for_resource
|
Example
{
"type": "autocompletes",
"id": 4,
"attributes": query_autocompletes_oneOf_0_data_attributes,
"links": links_for_resource
}
autocomplete_post_Input
Fields
| Input Field | Description |
|---|---|
type - autocompletes_const!
|
|
attributes - queryInput_autocompletes_input_data_attributes_Input!
|
Example
{
"type": "autocompletes",
"attributes": queryInput_autocompletes_input_data_attributes_Input
}
autocomplete_show
Fields
| Field Name | Description |
|---|---|
data - autocomplete_get!
|
Example
{"data": autocomplete_get}
autocompletes_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"autocompletes"
autocompletes_response
Types
| Union Types |
|---|
Example
autocomplete_show
auxiliary_device_connection_type
Description
Auxiliary device connection type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"unknown"
auxiliary_device_create_Input
Fields
| Input Field | Description |
|---|---|
data - auxiliary_device_input_Input!
|
Example
{"data": auxiliary_device_input_Input}
auxiliary_device_input_Input
Fields
| Input Field | Description |
|---|---|
type - auxiliary_devices_const!
|
|
attributes - mutationInput_post_driver_auxiliary_devices_input_data_attributes_Input!
|
Example
{
"type": "auxiliary_devices",
"attributes": mutationInput_post_driver_auxiliary_devices_input_data_attributes_Input
}
auxiliary_device_input_with_id_Input
Description
connected phones, captures ...
Fields
| Input Field | Description |
|---|---|
type - auxiliary_devices_const!
|
|
id - ID!
|
|
attributes - mutationInput_put_driver_auxiliary_device_input_data_attributes_Input!
|
Example
{
"type": "auxiliary_devices",
"id": 4,
"attributes": mutationInput_put_driver_auxiliary_device_input_data_attributes_Input
}
auxiliary_device_kind
Description
Auxiliary device kind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"phone"
auxiliary_device_paginated
Fields
| Field Name | Description |
|---|---|
data - [am_auxiliary_device]!
|
|
meta - meta!
|
Example
{
"data": [am_auxiliary_device],
"meta": meta
}
auxiliary_device_sensor_function
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"temperature"
auxiliary_device_settings
Fields
| Field Name | Description |
|---|---|
min_signal_power_connect - Int
|
an integer between -127 and 127, if provided, min_signal_power_disconnect will be required |
min_signal_power_disconnect - Int
|
an integer between -127 and 127, if provided, min_signal_power_connect will be required |
max_time_idling_disconnect - Int
|
in seconds, an integer between 0 and 1800 |
Example
{
"min_signal_power_connect": 987,
"min_signal_power_disconnect": 987,
"max_time_idling_disconnect": 987
}
auxiliary_device_settings_Input
Fields
| Input Field | Description |
|---|---|
min_signal_power_connect - Int
|
an integer between -127 and 127, if provided, min_signal_power_disconnect will be required |
min_signal_power_disconnect - Int
|
an integer between -127 and 127, if provided, min_signal_power_connect will be required |
max_time_idling_disconnect - Int
|
in seconds, an integer between 0 and 1800 |
Example
{
"min_signal_power_connect": 987,
"min_signal_power_disconnect": 987,
"max_time_idling_disconnect": 987
}
auxiliary_device_show
Fields
| Field Name | Description |
|---|---|
data - am_auxiliary_device!
|
Example
{"data": am_auxiliary_device}
auxiliary_device_update_Input
Fields
| Input Field | Description |
|---|---|
data - auxiliary_device_input_with_id_Input!
|
Example
{"data": auxiliary_device_input_with_id_Input}
auxiliary_devices_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"auxiliary_devices"
circle
circle_Input
Fields
| Input Field | Description |
|---|---|
center - point_Input!
|
|
radius - Int!
|
In meter |
Example
{"center": point_Input, "radius": 123}
client_identification_v2
Fields
| Field Name | Description |
|---|---|
type - client_identifications_const!
|
|
id - ID!
|
|
attributes - onboarding_query_client_identifications_data_items_attributes!
|
Example
{
"type": "client_identifications",
"id": "4",
"attributes": onboarding_query_client_identifications_data_items_attributes
}
client_identification_v2_create_Input
Fields
| Input Field | Description |
|---|---|
data - client_identification_v2_input_Input!
|
Example
{"data": client_identification_v2_input_Input}
client_identification_v2_input_Input
Fields
| Input Field | Description |
|---|---|
type - client_identifications_const!
|
|
attributes - mutationInput_post_client_identifications_input_data_attributes_Input!
|
Example
{
"type": "client_identifications",
"attributes": mutationInput_post_client_identifications_input_data_attributes_Input
}
client_identification_v2_paginated
Fields
| Field Name | Description |
|---|---|
data - [client_identification_v2]!
|
|
meta - meta!
|
Example
{
"data": [client_identification_v2],
"meta": meta
}
client_identification_v2_show
Fields
| Field Name | Description |
|---|---|
data - client_identification_v2!
|
Example
{"data": client_identification_v2}
client_identifications_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"client_identifications"
create_device_token_response
Types
| Union Types |
|---|
Example
device_token_show
dashcam
Fields
| Field Name | Description |
|---|---|
type - dashcams_const!
|
|
id - String!
|
|
attributes - query_dashcam_files_dashcam_data_attributes!
|
|
links - JSON
|
|
relationships - JSON
|
|
dashcam_files - dashcam_file_paged
|
|
Arguments |
|
Example
{
"type": "dashcams",
"id": "abc123",
"attributes": query_dashcam_files_dashcam_data_attributes,
"links": {},
"relationships": {},
"dashcam_files": dashcam_file_paged
}
dashcam_action_Input
Fields
| Input Field | Description |
|---|---|
get_status - Boolean
|
Request the dashcam to send its current status |
power - Boolean
|
Set the dashcam power state |
configure - mutationInput_put_dashcam_input_data_attributes_action_configure_Input
|
|
record - Boolean
|
Start or stop recording |
live_stream - mutationInput_put_dashcam_input_data_attributes_action_live_stream_Input
|
|
take_photo - Boolean
|
Request the dashcam to take a photo |
list - mutationInput_put_dashcam_input_data_attributes_action_list_Input
|
|
erase - Boolean
|
Request the dashcam to erase all files |
Example
{
"get_status": false,
"power": true,
"configure": mutationInput_put_dashcam_input_data_attributes_action_configure_Input,
"record": true,
"live_stream": mutationInput_put_dashcam_input_data_attributes_action_live_stream_Input,
"take_photo": true,
"list": mutationInput_put_dashcam_input_data_attributes_action_list_Input,
"erase": true
}
dashcam_data_usage
Fields
| Field Name | Description |
|---|---|
livestream_total_tx_kbytes - NonNegativeInt!
|
|
livestream_total_rx_kbytes - NonNegativeInt!
|
|
livestream_total_duration_seconds - NonNegativeInt!
|
|
download_total_kbytes - NonNegativeInt!
|
Example
{
"livestream_total_tx_kbytes": 123,
"livestream_total_rx_kbytes": 123,
"livestream_total_duration_seconds": 123,
"download_total_kbytes": 123
}
dashcam_file
Fields
| Field Name | Description |
|---|---|
type - dashcam_files_const!
|
|
id - String!
|
|
attributes - query_dashcam_file_data_attributes!
|
|
links - JSON
|
|
relationships - JSON
|
|
dashcam - dashcam_show
|
Example
{
"type": "dashcam_files",
"id": "xyz789",
"attributes": query_dashcam_file_data_attributes,
"links": {},
"relationships": {},
"dashcam": dashcam_show
}
dashcam_file_action_Input
Example
{"protect": false, "download": false, "remove": true, "thumbnail": false}
dashcam_file_paged
Fields
| Field Name | Description |
|---|---|
data - [dashcam_file]!
|
|
meta - meta!
|
|
links - JSON
|
Example
{
"data": [dashcam_file],
"meta": meta,
"links": {}
}
dashcam_file_put_input_Input
Fields
| Input Field | Description |
|---|---|
type - dashcam_files_const!
|
|
id - String!
|
|
attributes - mutationInput_put_dashcam_file_input_data_attributes_Input!
|
Example
{
"type": "dashcam_files",
"id": "abc123",
"attributes": mutationInput_put_dashcam_file_input_data_attributes_Input
}
dashcam_file_recording_type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"continuous"
dashcam_file_show
Fields
| Field Name | Description |
|---|---|
data - dashcam_file!
|
Example
{"data": dashcam_file}
dashcam_file_storage_status
Description
Storage status of the dashcam file
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"not_stored"
dashcam_file_update_Input
Fields
| Input Field | Description |
|---|---|
data - dashcam_file_put_input_Input!
|
Example
{"data": dashcam_file_put_input_Input}
dashcam_files_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"dashcam_files"
dashcam_lens
Description
Lens of the dashcam file
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"front"
dashcam_paged
Fields
| Field Name | Description |
|---|---|
data - [dashcam]!
|
|
meta - meta!
|
|
links - JSON
|
Example
{
"data": [dashcam],
"meta": meta,
"links": {}
}
dashcam_put_input_Input
Fields
| Input Field | Description |
|---|---|
type - dashcams_const!
|
|
id - String!
|
|
attributes - mutationInput_put_dashcam_input_data_attributes_Input!
|
Example
{
"type": "dashcams",
"id": "xyz789",
"attributes": mutationInput_put_dashcam_input_data_attributes_Input
}
dashcam_sd_card
Fields
| Field Name | Description |
|---|---|
total_space - NonNegativeInt
|
|
free_space - NonNegativeInt
|
|
videos_count - NonNegativeInt
|
|
videos_size - NonNegativeInt
|
|
pictures_count - NonNegativeInt
|
|
pictures_size - NonNegativeInt
|
|
events_size - NonNegativeInt
|
|
oldest_file - String
|
Example
{
"total_space": 123,
"free_space": 123,
"videos_count": 123,
"videos_size": 123,
"pictures_count": 123,
"pictures_size": 123,
"events_size": 123,
"oldest_file": "xyz789"
}
dashcam_settings
Fields
| Field Name | Description |
|---|---|
resolution - query_dashcam_files_dashcam_data_attributes_settings_resolution!
|
|
fps - PositiveInt!
|
|
microphone - Boolean!
|
|
stamp - query_dashcam_files_dashcam_data_attributes_settings_stamp!
|
|
parking_mode - Boolean!
|
|
front_lens_only - Boolean
|
|
movement_detection_sensitivity - query_dashcam_files_dashcam_data_attributes_settings_movement_detection_sensitivity!
|
|
record_duration - PositiveInt
|
Example
{
"resolution": "_720p",
"fps": 123,
"microphone": true,
"stamp": "none",
"parking_mode": false,
"front_lens_only": false,
"movement_detection_sensitivity": "low",
"record_duration": 123
}
dashcam_show
Fields
| Field Name | Description |
|---|---|
data - dashcam!
|
Example
{"data": dashcam}
dashcam_status
dashcam_update_Input
Fields
| Input Field | Description |
|---|---|
data - dashcam_put_input_Input!
|
Example
{"data": dashcam_put_input_Input}
dashcams_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"dashcams"
data_fusion_refill
Fields
| Field Name | Description |
|---|---|
type - refills_const!
|
|
id - ID!
|
|
attributes - query_vehicles_refills_oneOf_0_data_items_attributes!
|
|
links - links_for_resource
|
|
relationships - relationships
|
Example
{
"type": "refills",
"id": 4,
"attributes": query_vehicles_refills_oneOf_0_data_items_attributes,
"links": links_for_resource,
"relationships": relationships
}
delete_driver_auxiliary_device_response
Types
| Union Types |
|---|
Example
Void_container
delete_vehicle_auxiliary_device_response
Types
| Union Types |
|---|
Example
Void_container
device_config
Fields
| Field Name | Description |
|---|---|
type - device_configs_const!
|
|
id - ID!
|
|
attributes - mutation_post_device_configs_oneOf_0_data_attributes!
|
|
links - JSON
|
|
relationships - JSON
|
Example
{
"type": "device_configs",
"id": 4,
"attributes": mutation_post_device_configs_oneOf_0_data_attributes,
"links": {},
"relationships": {}
}
device_config_create_Input
Fields
| Input Field | Description |
|---|---|
data - device_config_post_input_Input!
|
Example
{"data": device_config_post_input_Input}
device_config_post_input_Input
Fields
| Input Field | Description |
|---|---|
type - device_configs_const!
|
|
attributes - mutationInput_post_device_configs_input_data_attributes_Input!
|
Example
{
"type": "device_configs",
"attributes": mutationInput_post_device_configs_input_data_attributes_Input
}
device_config_show
Fields
| Field Name | Description |
|---|---|
data - device_config!
|
Example
{"data": device_config}
device_config_show_nullable
Fields
| Field Name | Description |
|---|---|
data - device_config
|
Example
{"data": device_config}
device_configs_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"device_configs"
device_group_paginated
Fields
| Field Name | Description |
|---|---|
data - [am_device_group]!
|
|
meta - meta
|
Example
{
"data": [am_device_group],
"meta": meta
}
device_groups_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"device_groups"
device_harshes_response
Types
| Union Types |
|---|
Example
journey_trip_harsh_paginated
device_idlings_response
Types
| Union Types |
|---|
Example
journey_trip_idling_paginated
device_overspeeds_response
Types
| Union Types |
|---|
Example
journey_trip_overspeed_paginated
device_relationship_Input
Fields
| Input Field | Description |
|---|---|
data - [mutationInput_post_geofences_relationships_devices_input_data_items_Input]
|
Example
{
"data": [
mutationInput_post_geofences_relationships_devices_input_data_items_Input
]
}
device_reports_response
Types
| Union Types |
|---|
Example
report_paginated
device_show
Fields
| Field Name | Description |
|---|---|
data - geofence_device!
|
Example
{"data": geofence_device}
device_token
Fields
| Field Name | Description |
|---|---|
type - device_tokens_const!
|
|
id - ID!
|
|
attributes - mutation_create_device_token_oneOf_0_data_attributes!
|
Example
{
"type": "device_tokens",
"id": "4",
"attributes": mutation_create_device_token_oneOf_0_data_attributes
}
device_token_create_Input
Fields
| Input Field | Description |
|---|---|
data - device_token_input_Input!
|
Example
{"data": device_token_input_Input}
device_token_input_Input
Fields
| Input Field | Description |
|---|---|
type - device_tokens_const!
|
|
attributes - device_token_input_attributes_Input!
|
Example
{
"type": "device_tokens",
"attributes": device_token_input_attributes_Input
}
device_token_input_attributes_Input
Fields
| Input Field | Description |
|---|---|
device_ids - [ID]!
|
A list of device IDs (dongle IMEIs) that restrict the token's usage to specific devices. If provided, the token will only be valid for the specified devices. A maximum of 20 device IDs can be specified. |
start_at - DateTime
|
|
end_at - DateTime
|
|
aux_id_key - String!
|
|
driver_id_key - String!
|
|
settings - auxiliary_device_settings_Input
|
Example
{
"device_ids": [4],
"start_at": "2007-12-03T10:15:30Z",
"end_at": "2007-12-03T10:15:30Z",
"aux_id_key": "abc123",
"driver_id_key": "abc123",
"settings": auxiliary_device_settings_Input
}
device_token_show
Fields
| Field Name | Description |
|---|---|
data - device_token!
|
Example
{"data": device_token}
device_tokens_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"device_tokens"
devices_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"devices"
devices_device_config_response
Types
| Union Types |
|---|
Example
device_config_show_nullable
doors_toggle_request
Fields
| Field Name | Description |
|---|---|
type - toggles_const!
|
|
id - ID
|
|
attributes - query_doors_toggle_requests_data_items_attributes!
|
Example
{
"type": "toggles",
"id": 4,
"attributes": query_doors_toggle_requests_data_items_attributes
}
doors_toggle_request_create_Input
Fields
| Input Field | Description |
|---|---|
data - doors_toggle_request_input_Input!
|
Example
{"data": doors_toggle_request_input_Input}
doors_toggle_request_input_Input
Fields
| Input Field | Description |
|---|---|
type - toggles_const!
|
|
attributes - mutationInput_post_doors_toggle_requests_input_data_attributes_Input!
|
Example
{
"type": "toggles",
"attributes": mutationInput_post_doors_toggle_requests_input_data_attributes_Input
}
doors_toggle_request_paginated
Fields
| Field Name | Description |
|---|---|
data - [doors_toggle_request]!
|
|
meta - meta!
|
Example
{
"data": [doors_toggle_request],
"meta": meta
}
doors_toggle_request_show
Fields
| Field Name | Description |
|---|---|
data - doors_toggle_request!
|
Example
{"data": doors_toggle_request}
driver_auxiliary_devices_response
Types
| Union Types |
|---|
Example
auxiliary_device_paginated
drivers_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"drivers"
drop_data_request_Input
Fields
| Input Field | Description |
|---|---|
data - mutationInput_post_drop_data_requests_input_data_Input
|
Example
{
"data": mutationInput_post_drop_data_requests_input_data_Input
}
drop_data_requests_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"drop_data_requests"
engine_immobilizer_request
Fields
| Field Name | Description |
|---|---|
type - immobilizers_const!
|
|
id - ID
|
|
attributes - query_engine_immobilizer_requests_data_items_attributes!
|
Example
{
"type": "immobilizers",
"id": "4",
"attributes": query_engine_immobilizer_requests_data_items_attributes
}
engine_immobilizer_request_create_Input
Fields
| Input Field | Description |
|---|---|
data - engine_immobilizer_request_input_Input!
|
Example
{"data": engine_immobilizer_request_input_Input}
engine_immobilizer_request_input_Input
Fields
| Input Field | Description |
|---|---|
type - immobilizers_const!
|
|
attributes - mutationInput_post_engine_immobilizer_requests_input_data_attributes_Input!
|
Example
{
"type": "immobilizers",
"attributes": mutationInput_post_engine_immobilizer_requests_input_data_attributes_Input
}
engine_immobilizer_request_paginated
Fields
| Field Name | Description |
|---|---|
data - [engine_immobilizer_request]!
|
|
meta - meta!
|
Example
{
"data": [engine_immobilizer_request],
"meta": meta
}
engine_immobilizer_request_show
Fields
| Field Name | Description |
|---|---|
data - engine_immobilizer_request!
|
Example
{"data": engine_immobilizer_request}
error
error_source
Fields
| Field Name | Description |
|---|---|
pointer - String
|
Example
{"pointer": "abc123"}
errors
Fields
| Field Name | Description |
|---|---|
errors - [error]!
|
Example
{"errors": [error]}
fetch_user_alert_notification_encapsulated
Fields
| Field Name | Description |
|---|---|
data - va_fetch_user_alert_notification
|
Example
{"data": va_fetch_user_alert_notification}
fetch_user_alert_notification_paginated
Fields
| Field Name | Description |
|---|---|
data - [va_fetch_user_alert_notification]
|
|
meta - meta
|
Example
{
"data": [va_fetch_user_alert_notification],
"meta": meta
}
fleet_summaries_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"fleet_summaries"
fleet_summary
Fields
| Field Name | Description |
|---|---|
data - query_post_v1_fleet_summaries_oneOf_0_data
|
Example
{"data": query_post_v1_fleet_summaries_oneOf_0_data}
fleet_summary_Input
Fields
| Input Field | Description |
|---|---|
data - query_post_v1_fleet_summaries_oneOf_0_data_Input
|
Example
{"data": query_post_v1_fleet_summaries_oneOf_0_data_Input}
geocode_create_Input
Fields
| Input Field | Description |
|---|---|
data - geocode_post_Input!
|
Example
{"data": geocode_post_Input}
geocode_get
Fields
| Field Name | Description |
|---|---|
type - geocodes_const!
|
|
id - ID!
|
|
attributes - query_geocodes_oneOf_0_data_attributes!
|
|
links - links_for_resource
|
Example
{
"type": "geocodes",
"id": 4,
"attributes": query_geocodes_oneOf_0_data_attributes,
"links": links_for_resource
}
geocode_post_Input
Fields
| Input Field | Description |
|---|---|
type - geocodes_const!
|
|
attributes - queryInput_geocodes_input_data_attributes_Input!
|
Example
{
"type": "geocodes",
"attributes": queryInput_geocodes_input_data_attributes_Input
}
geocode_show
Fields
| Field Name | Description |
|---|---|
data - geocode_get!
|
Example
{"data": geocode_get}
geocodes_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"geocodes"
geocodes_response
Types
| Union Types |
|---|
Example
geocode_show
geofence_alert
Fields
| Field Name | Description |
|---|---|
type - alerts_const!
|
|
id - ID!
|
|
attributes - geofence_query_alerts_data_items_attributes!
|
Example
{
"type": "alerts",
"id": "4",
"attributes": geofence_query_alerts_data_items_attributes
}
geofence_create_Input
Fields
| Input Field | Description |
|---|---|
data - geofence_input_Input!
|
Example
{"data": geofence_input_Input}
geofence_device
Fields
| Field Name | Description |
|---|---|
type - devices_const!
|
|
id - ID!
|
|
attributes - query_device_data_attributes!
|
Example
{
"type": "devices",
"id": 4,
"attributes": query_device_data_attributes
}
geofence_device_Input
Fields
| Input Field | Description |
|---|---|
type - devices_const!
|
|
id - ID!
|
|
attributes - query_device_data_attributes_Input!
|
Example
{
"type": "devices",
"id": 4,
"attributes": query_device_data_attributes_Input
}
geofence_device_paginated
Fields
| Field Name | Description |
|---|---|
data - [geofence_device]!
|
|
meta - meta!
|
Example
{
"data": [geofence_device],
"meta": meta
}
geofence_event_type
Description
Event Type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ENTRY"
geofence_geofence
Fields
| Field Name | Description |
|---|---|
type - geofences_const!
|
|
id - ID!
|
|
attributes - geofence_query_geofences_data_items_attributes!
|
|
schedules - schedule_paginated
|
|
user_alert_notifications - fetch_user_alert_notification_paginated
|
|
Arguments |
|
shapes - shape_paginated
|
|
devices - geofence_device_paginated
|
|
Example
{
"type": "geofences",
"id": "4",
"attributes": geofence_query_geofences_data_items_attributes,
"schedules": schedule_paginated,
"user_alert_notifications": fetch_user_alert_notification_paginated,
"shapes": shape_paginated,
"devices": geofence_device_paginated
}
geofence_input_Input
Fields
| Input Field | Description |
|---|---|
type - geofences_const!
|
|
attributes - mutationInput_post_geofences_input_data_attributes_Input!
|
Example
{
"type": "geofences",
"attributes": mutationInput_post_geofences_input_data_attributes_Input
}
geofence_input_with_id_Input
Fields
| Input Field | Description |
|---|---|
type - geofences_const!
|
|
id - String!
|
|
attributes - mutationInput_put_geofence_input_data_attributes_Input!
|
Example
{
"type": "geofences",
"id": "xyz789",
"attributes": mutationInput_put_geofence_input_data_attributes_Input
}
geofence_paginated
Fields
| Field Name | Description |
|---|---|
data - [geofence_geofence]!
|
|
meta - meta!
|
Example
{
"data": [geofence_geofence],
"meta": meta
}
geofence_query_alerts_data_items_attributes
Fields
| Field Name | Description |
|---|---|
imei - String!
|
|
geofence_id - ID!
|
|
group_id - ID
|
|
state - query_alerts_data_items_attributes_state!
|
|
event_type - query_alerts_data_items_attributes_event_type!
|
|
position - point!
|
|
started_at - DateTime
|
|
ended_at - DateTime
|
|
created_at - DateTime
|
|
updated_at - DateTime
|
Example
{
"imei": "abc123",
"geofence_id": 4,
"group_id": "4",
"state": "UNKNOWN",
"event_type": "ENTRY",
"position": point,
"started_at": "2007-12-03T10:15:30Z",
"ended_at": "2007-12-03T10:15:30Z",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
geofence_query_geofences_data_items_attributes
Example
{
"label": "xyz789",
"description": "abc123",
"active": true,
"group_id": "4",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
geofence_query_schedules_data_items_attributes
Example
{
"week_days": query_schedules_data_items_attributes_week_days,
"geofence_id": "4",
"group_id": "4",
"time_zone": "Africa_Abidjan",
"outside_of_slots": false,
"start_at": "2007-12-03T10:15:30Z",
"end_at": "2007-12-03T10:15:30Z",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
geofence_query_shapes_data_items_attributes
Example
{
"geofence_id": "4",
"group_id": "4",
"geometry_type": "CIRCLE",
"geometry_center": point,
"definition": circle,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
geofence_query_user_data
Fields
| Field Name | Description |
|---|---|
type - users_const!
|
|
id - ID!
|
|
attributes - geofence_query_user_data_attributes!
|
Example
{
"type": "users",
"id": 4,
"attributes": geofence_query_user_data_attributes
}
geofence_query_user_data_attributes
Fields
| Field Name | Description |
|---|---|
uid - ID!
|
|
full_name - String
|
|
role - query_user_data_attributes_role!
|
Example
{
"uid": 4,
"full_name": "abc123",
"role": "user"
}
geofence_schedule
Fields
| Field Name | Description |
|---|---|
type - schedules_const!
|
|
id - ID!
|
|
attributes - geofence_query_schedules_data_items_attributes!
|
Example
{
"type": "schedules",
"id": 4,
"attributes": geofence_query_schedules_data_items_attributes
}
geofence_shape
Fields
| Field Name | Description |
|---|---|
type - shapes_const!
|
|
id - ID!
|
|
attributes - geofence_query_shapes_data_items_attributes!
|
Example
{
"type": "shapes",
"id": "4",
"attributes": geofence_query_shapes_data_items_attributes
}
geofence_show
Fields
| Field Name | Description |
|---|---|
data - geofence_geofence!
|
Example
{"data": geofence_geofence}
geofence_update_Input
Fields
| Input Field | Description |
|---|---|
data - geofence_input_with_id_Input!
|
Example
{"data": geofence_input_with_id_Input}
geofence_user
Fields
| Field Name | Description |
|---|---|
data - geofence_query_user_data
|
Example
{"data": geofence_query_user_data}
geofences_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"geofences"
geofencing_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"geofencing"
get_driver_auxiliary_device_response
Types
| Union Types |
|---|
Example
auxiliary_device_show
get_trip_response
Types
| Union Types |
|---|
Example
journey_trip_encapsulated
get_vehicle_auxiliary_device_response
Types
| Union Types |
|---|
Example
auxiliary_device_show
google__protobuf__Empty
Example
google__protobuf__Empty
group_relationship_Input
Fields
| Input Field | Description |
|---|---|
data - [mutationInput_post_geofences_relationships_groups_input_data_items_Input]
|
Example
{
"data": [
mutationInput_post_geofences_relationships_groups_input_data_items_Input
]
}
group_reports_response
Types
| Union Types |
|---|
Example
report_paginated
groups_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"groups"
harsh_response
Types
| Union Types |
|---|
Example
trip_harsh_encapsulated
harshes_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"harshes"
idling_response
Types
| Union Types |
|---|
Example
trip_idling_encapsulated
idlings_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"idlings"
immobilizers_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"immobilizers"
j2534__DataFilter
Fields
| Field Name | Description |
|---|---|
mask - j2534__PassThruMsg
|
|
filter - j2534__PassThruMsg
|
|
filter_type - j2534__FilterType
|
Example
{
"mask": j2534__PassThruMsg,
"filter": j2534__PassThruMsg,
"filter_type": "UNKNOWN_FILTER"
}
j2534__DataFilter_Input
Fields
| Input Field | Description |
|---|---|
mask - j2534__PassThruMsg_Input
|
|
filter - j2534__PassThruMsg_Input
|
|
filter_type - j2534__FilterType
|
Example
{
"mask": j2534__PassThruMsg_Input,
"filter": j2534__PassThruMsg_Input,
"filter_type": "UNKNOWN_FILTER"
}
j2534__FilterType
Values
| Enum Value | Description |
|---|---|
|
|
Protobuf wants something for 0 |
|
|
|
|
|
|
|
|
Example
"UNKNOWN_FILTER"
j2534__IoctlId
Description
IOCTL
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Reserved for SAE: 0x0f-0xfff; |
|
|
Reserved for Tool manufacturer: 0x10000-0xfffffff; |
|
|
Example
"UNKNOWN_IOCTL"
j2534__IoctlParameter
Fields
| Field Name | Description |
|---|---|
none - UnsignedInt
|
|
message - j2534__PassThruMsg
|
|
sconfig_list - j2534__SconfigList
|
|
sbyte_array - Byte
|
Example
{
"none": 123,
"message": j2534__PassThruMsg,
"sconfig_list": j2534__SconfigList,
"sbyte_array": [196, 189, 173, 171, 167, 163]
}
j2534__IoctlParameter_Input
Fields
| Input Field | Description |
|---|---|
none - UnsignedInt
|
|
message - j2534__PassThruMsg_Input
|
|
sconfig_list - j2534__SconfigList_Input
|
|
sbyte_array - Byte
|
Example
{
"none": 123,
"message": j2534__PassThruMsg_Input,
"sconfig_list": j2534__SconfigList_Input,
"sbyte_array": [196, 189, 173, 171, 167, 163]
}
j2534__J2534Msg
Fields
| Field Name | Description |
|---|---|
version - String
|
|
id - BigInt
|
|
timestamp - BigInt
|
|
request - j2534__J2534Request
|
|
response - j2534__J2534Response
|
Example
{
"version": "abc123",
"id": {},
"timestamp": {},
"request": j2534__J2534Request,
"response": j2534__J2534Response
}
j2534__J2534Msg_Input
Fields
| Input Field | Description |
|---|---|
version - String
|
|
id - BigInt
|
|
timestamp - BigInt
|
|
request - j2534__J2534Request_Input
|
|
response - j2534__J2534Response_Input
|
Example
{
"version": "abc123",
"id": {},
"timestamp": {},
"request": j2534__J2534Request_Input,
"response": j2534__J2534Response_Input
}
j2534__J2534Request
Fields
| Field Name | Description |
|---|---|
connect - j2534__PassThruConnectRequest
|
|
disconnect - j2534__PassThruDisconnectRequest
|
|
ioctl - j2534__PassThruIoctlRequest
|
|
write_msgs - j2534__PassThruWriteMsgsRequest
|
|
read_msgs - j2534__PassThruReadMsgsRequest
|
|
start_periodic_msg - j2534__PassThruStartPeriodicMsgRequest
|
|
stop_periodic_msg - j2534__PassThruStopPeriodicMsgRequest
|
|
start_msg_filter - j2534__PassThruStartMsgFilterRequest
|
|
stop_msg_filter - j2534__PassThruStopMsgFilterRequest
|
|
read_version - j2534__PassThruReadVersionRequest
|
|
get_last_error - j2534__PassThruGetLastErrorRequest
|
|
set_programming_voltage - j2534__PassThruSetProgrammingVoltageRequest
|
|
start_periodic_read_msg - j2534__PassThruStartPeriodicReadMsgRequest
|
|
stop_periodic_read_msg - j2534__PassThruStopPeriodicReadMsgRequest
|
Example
{
"connect": j2534__PassThruConnectRequest,
"disconnect": j2534__PassThruDisconnectRequest,
"ioctl": j2534__PassThruIoctlRequest,
"write_msgs": j2534__PassThruWriteMsgsRequest,
"read_msgs": j2534__PassThruReadMsgsRequest,
"start_periodic_msg": j2534__PassThruStartPeriodicMsgRequest,
"stop_periodic_msg": j2534__PassThruStopPeriodicMsgRequest,
"start_msg_filter": j2534__PassThruStartMsgFilterRequest,
"stop_msg_filter": j2534__PassThruStopMsgFilterRequest,
"read_version": j2534__PassThruReadVersionRequest,
"get_last_error": j2534__PassThruGetLastErrorRequest,
"set_programming_voltage": j2534__PassThruSetProgrammingVoltageRequest,
"start_periodic_read_msg": j2534__PassThruStartPeriodicReadMsgRequest,
"stop_periodic_read_msg": j2534__PassThruStopPeriodicReadMsgRequest
}
j2534__J2534Request_Input
Fields
| Input Field | Description |
|---|---|
connect - j2534__PassThruConnectRequest_Input
|
|
disconnect - j2534__PassThruDisconnectRequest_Input
|
|
ioctl - j2534__PassThruIoctlRequest_Input
|
|
write_msgs - j2534__PassThruWriteMsgsRequest_Input
|
|
read_msgs - j2534__PassThruReadMsgsRequest_Input
|
|
start_periodic_msg - j2534__PassThruStartPeriodicMsgRequest_Input
|
|
stop_periodic_msg - j2534__PassThruStopPeriodicMsgRequest_Input
|
|
start_msg_filter - j2534__PassThruStartMsgFilterRequest_Input
|
|
stop_msg_filter - j2534__PassThruStopMsgFilterRequest_Input
|
|
read_version - j2534__PassThruReadVersionRequest_Input
|
|
get_last_error - j2534__PassThruGetLastErrorRequest_Input
|
|
set_programming_voltage - j2534__PassThruSetProgrammingVoltageRequest_Input
|
|
start_periodic_read_msg - j2534__PassThruStartPeriodicReadMsgRequest_Input
|
|
stop_periodic_read_msg - j2534__PassThruStopPeriodicReadMsgRequest_Input
|
Example
{
"connect": j2534__PassThruConnectRequest_Input,
"disconnect": j2534__PassThruDisconnectRequest_Input,
"ioctl": j2534__PassThruIoctlRequest_Input,
"write_msgs": j2534__PassThruWriteMsgsRequest_Input,
"read_msgs": j2534__PassThruReadMsgsRequest_Input,
"start_periodic_msg": j2534__PassThruStartPeriodicMsgRequest_Input,
"stop_periodic_msg": j2534__PassThruStopPeriodicMsgRequest_Input,
"start_msg_filter": j2534__PassThruStartMsgFilterRequest_Input,
"stop_msg_filter": j2534__PassThruStopMsgFilterRequest_Input,
"read_version": j2534__PassThruReadVersionRequest_Input,
"get_last_error": j2534__PassThruGetLastErrorRequest_Input,
"set_programming_voltage": j2534__PassThruSetProgrammingVoltageRequest_Input,
"start_periodic_read_msg": j2534__PassThruStartPeriodicReadMsgRequest_Input,
"stop_periodic_read_msg": j2534__PassThruStopPeriodicReadMsgRequest_Input
}
j2534__J2534Response
Fields
| Field Name | Description |
|---|---|
unsupported - j2534__PassThruUnsupported
|
|
connect - j2534__PassThruConnectResponse
|
|
disconnect - j2534__PassThruDisconnectResponse
|
|
ioctl - j2534__PassThruIoctlResponse
|
|
write_msgs - j2534__PassThruWriteMsgsResponse
|
|
read_msgs - j2534__PassThruReadMsgsResponse
|
|
start_periodic_msg - j2534__PassThruStartPeriodicMsgResponse
|
|
stop_periodic_msg - j2534__PassThruStopPeriodicMsgResponse
|
|
start_msg_filter - j2534__PassThruStartMsgFilterResponse
|
|
stop_msg_filter - j2534__PassThruStopMsgFilterResponse
|
|
read_version - j2534__PassThruReadVersionResponse
|
|
get_last_error - j2534__PassThruGetLastErrorResponse
|
|
set_programming_voltage - j2534__PassThruSetProgrammingVoltageResponse
|
|
start_periodic_read_msg - j2534__PassThruStartPeriodicReadMsgResponse
|
|
stop_periodic_read_msg - j2534__PassThruStopPeriodicReadMsgResponse
|
Example
{
"unsupported": j2534__PassThruUnsupported,
"connect": j2534__PassThruConnectResponse,
"disconnect": j2534__PassThruDisconnectResponse,
"ioctl": j2534__PassThruIoctlResponse,
"write_msgs": j2534__PassThruWriteMsgsResponse,
"read_msgs": j2534__PassThruReadMsgsResponse,
"start_periodic_msg": j2534__PassThruStartPeriodicMsgResponse,
"stop_periodic_msg": j2534__PassThruStopPeriodicMsgResponse,
"start_msg_filter": j2534__PassThruStartMsgFilterResponse,
"stop_msg_filter": j2534__PassThruStopMsgFilterResponse,
"read_version": j2534__PassThruReadVersionResponse,
"get_last_error": j2534__PassThruGetLastErrorResponse,
"set_programming_voltage": j2534__PassThruSetProgrammingVoltageResponse,
"start_periodic_read_msg": j2534__PassThruStartPeriodicReadMsgResponse,
"stop_periodic_read_msg": j2534__PassThruStopPeriodicReadMsgResponse
}
j2534__J2534Response_Input
Fields
| Input Field | Description |
|---|---|
unsupported - j2534__PassThruUnsupported_Input
|
|
connect - j2534__PassThruConnectResponse_Input
|
|
disconnect - j2534__PassThruDisconnectResponse_Input
|
|
ioctl - j2534__PassThruIoctlResponse_Input
|
|
write_msgs - j2534__PassThruWriteMsgsResponse_Input
|
|
read_msgs - j2534__PassThruReadMsgsResponse_Input
|
|
start_periodic_msg - j2534__PassThruStartPeriodicMsgResponse_Input
|
|
stop_periodic_msg - j2534__PassThruStopPeriodicMsgResponse_Input
|
|
start_msg_filter - j2534__PassThruStartMsgFilterResponse_Input
|
|
stop_msg_filter - j2534__PassThruStopMsgFilterResponse_Input
|
|
read_version - j2534__PassThruReadVersionResponse_Input
|
|
get_last_error - j2534__PassThruGetLastErrorResponse_Input
|
|
set_programming_voltage - j2534__PassThruSetProgrammingVoltageResponse_Input
|
|
start_periodic_read_msg - j2534__PassThruStartPeriodicReadMsgResponse_Input
|
|
stop_periodic_read_msg - j2534__PassThruStopPeriodicReadMsgResponse_Input
|
Example
{
"unsupported": j2534__PassThruUnsupported_Input,
"connect": j2534__PassThruConnectResponse_Input,
"disconnect": j2534__PassThruDisconnectResponse_Input,
"ioctl": j2534__PassThruIoctlResponse_Input,
"write_msgs": j2534__PassThruWriteMsgsResponse_Input,
"read_msgs": j2534__PassThruReadMsgsResponse_Input,
"start_periodic_msg": j2534__PassThruStartPeriodicMsgResponse_Input,
"stop_periodic_msg": j2534__PassThruStopPeriodicMsgResponse_Input,
"start_msg_filter": j2534__PassThruStartMsgFilterResponse_Input,
"stop_msg_filter": j2534__PassThruStopMsgFilterResponse_Input,
"read_version": j2534__PassThruReadVersionResponse_Input,
"get_last_error": j2534__PassThruGetLastErrorResponse_Input,
"set_programming_voltage": j2534__PassThruSetProgrammingVoltageResponse_Input,
"start_periodic_read_msg": j2534__PassThruStartPeriodicReadMsgResponse_Input,
"stop_periodic_read_msg": j2534__PassThruStopPeriodicReadMsgResponse_Input
}
j2534__PassThruConnectRequest
Description
CONNECT
Fields
| Field Name | Description |
|---|---|
protocol_id - j2534__Protocol
|
|
flags - UnsignedInt
|
|
channel_id - UnsignedInt
|
Example
{"protocol_id": "UNKNOWN_PROTOCOL", "flags": 123, "channel_id": 123}
j2534__PassThruConnectRequest_Input
Description
CONNECT
Fields
| Input Field | Description |
|---|---|
protocol_id - j2534__Protocol
|
|
flags - UnsignedInt
|
|
channel_id - UnsignedInt
|
Example
{"protocol_id": "UNKNOWN_PROTOCOL", "flags": 123, "channel_id": 123}
j2534__PassThruConnectResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
|
channel_id - UnsignedInt
|
Example
{"status": "NOERROR", "channel_id": 123}
j2534__PassThruConnectResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
|
channel_id - UnsignedInt
|
Example
{"status": "NOERROR", "channel_id": 123}
j2534__PassThruDisconnectRequest
Description
DISCONNECT
Fields
| Field Name | Description |
|---|---|
channel_id - UnsignedInt
|
Example
{"channel_id": 123}
j2534__PassThruDisconnectRequest_Input
Description
DISCONNECT
Fields
| Input Field | Description |
|---|---|
channel_id - UnsignedInt
|
Example
{"channel_id": 123}
j2534__PassThruDisconnectResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
Example
{"status": "NOERROR"}
j2534__PassThruDisconnectResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
Example
{"status": "NOERROR"}
j2534__PassThruGetLastErrorRequest
Example
j2534__PassThruGetLastErrorRequest
j2534__PassThruGetLastErrorRequest_Input
Example
j2534__PassThruGetLastErrorRequest_Input
j2534__PassThruGetLastErrorResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
|
p_error_description - String
|
Example
{
"status": "NOERROR",
"p_error_description": "abc123"
}
j2534__PassThruGetLastErrorResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
|
p_error_description - String
|
Example
{
"status": "NOERROR",
"p_error_description": "abc123"
}
j2534__PassThruIoctlRequest
Description
message SconfigList
Fields
| Field Name | Description |
|---|---|
channel_id - UnsignedInt
|
|
ioctl_id - j2534__IoctlId
|
|
p_input - j2534__IoctlParameter
|
Example
{
"channel_id": 123,
"ioctl_id": "UNKNOWN_IOCTL",
"p_input": j2534__IoctlParameter
}
j2534__PassThruIoctlRequest_Input
Description
message SconfigList
Fields
| Input Field | Description |
|---|---|
channel_id - UnsignedInt
|
|
ioctl_id - j2534__IoctlId
|
|
p_input - j2534__IoctlParameter_Input
|
Example
{
"channel_id": 123,
"ioctl_id": "UNKNOWN_IOCTL",
"p_input": j2534__IoctlParameter_Input
}
j2534__PassThruIoctlResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
|
p_output - j2534__IoctlParameter
|
Example
{"status": "NOERROR", "p_output": j2534__IoctlParameter}
j2534__PassThruIoctlResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
|
p_output - j2534__IoctlParameter_Input
|
Example
{
"status": "NOERROR",
"p_output": j2534__IoctlParameter_Input
}
j2534__PassThruMsg
Fields
| Field Name | Description |
|---|---|
protocol_id - j2534__Protocol
|
|
rx_status - UnsignedInt
|
|
tx_flags - UnsignedInt
|
The Tx flags used when transmitting messages. |
data_size - UnsignedInt
|
The size of the message data. |
extra_data_index - UnsignedInt
|
|
data - Byte
|
The message data. |
flag_id - UnsignedInt
|
|
timestamp - BigInt
|
|
tx_flag_bits - [j2534__TxFlagBit]
|
|
Arguments
|
|
rx_status_bits - [j2534__RxStatusBit]
|
|
Arguments
|
|
Example
{
"protocol_id": "UNKNOWN_PROTOCOL",
"rx_status": 123,
"tx_flags": 123,
"data_size": 123,
"extra_data_index": 123,
"data": [196, 189, 173, 171, 167, 163],
"flag_id": 123,
"timestamp": {},
"tx_flag_bits": ["RESERVED"],
"rx_status_bits": ["TX_MSG_TYPE"]
}
j2534__PassThruMsg_Input
Fields
| Input Field | Description |
|---|---|
protocol_id - j2534__Protocol
|
|
rx_status - UnsignedInt
|
|
tx_flags - UnsignedInt
|
The Tx flags used when transmitting messages. |
data_size - UnsignedInt
|
The size of the message data. |
extra_data_index - UnsignedInt
|
|
data - Byte
|
The message data. |
flag_id - UnsignedInt
|
|
timestamp - BigInt
|
|
tx_flag_bits - [j2534__TxFlagBit]
|
Example
{
"protocol_id": "UNKNOWN_PROTOCOL",
"rx_status": 123,
"tx_flags": 123,
"data_size": 123,
"extra_data_index": 123,
"data": [196, 189, 173, 171, 167, 163],
"flag_id": 123,
"timestamp": {},
"tx_flag_bits": ["RESERVED"]
}
j2534__PassThruReadMsgsRequest
Description
READ
Fields
| Field Name | Description |
|---|---|
channel_id - UnsignedInt
|
|
timeout - UnsignedInt
|
|
p_num_msgs - UnsignedInt
|
Example
{"channel_id": 123, "timeout": 123, "p_num_msgs": 123}
j2534__PassThruReadMsgsRequest_Input
Description
READ
Fields
| Input Field | Description |
|---|---|
channel_id - UnsignedInt
|
|
timeout - UnsignedInt
|
|
p_num_msgs - UnsignedInt
|
Example
{"channel_id": 123, "timeout": 123, "p_num_msgs": 123}
j2534__PassThruReadMsgsResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
|
p_num_msgs - UnsignedInt
|
|
p_msg - [j2534__PassThruMsg]
|
Example
{
"status": "NOERROR",
"p_num_msgs": 123,
"p_msg": [j2534__PassThruMsg]
}
j2534__PassThruReadMsgsResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
|
p_num_msgs - UnsignedInt
|
|
p_msg - [j2534__PassThruMsg_Input]
|
Example
{
"status": "NOERROR",
"p_num_msgs": 123,
"p_msg": [j2534__PassThruMsg_Input]
}
j2534__PassThruReadVersionRequest
Example
j2534__PassThruReadVersionRequest
j2534__PassThruReadVersionRequest_Input
Example
j2534__PassThruReadVersionRequest_Input
j2534__PassThruReadVersionResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
|
p_firmware_version - String
|
|
p_dll_version - String
|
|
p_api_version - String
|
Example
{
"status": "NOERROR",
"p_firmware_version": "abc123",
"p_dll_version": "abc123",
"p_api_version": "abc123"
}
j2534__PassThruReadVersionResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
|
p_firmware_version - String
|
|
p_dll_version - String
|
|
p_api_version - String
|
Example
{
"status": "NOERROR",
"p_firmware_version": "xyz789",
"p_dll_version": "abc123",
"p_api_version": "abc123"
}
j2534__PassThruSetProgrammingVoltageRequest
Fields
| Field Name | Description |
|---|---|
pin_number - UnsignedInt
|
|
voltage - UnsignedInt
|
Example
{"pin_number": 123, "voltage": 123}
j2534__PassThruSetProgrammingVoltageRequest_Input
Fields
| Input Field | Description |
|---|---|
pin_number - UnsignedInt
|
|
voltage - UnsignedInt
|
Example
{"pin_number": 123, "voltage": 123}
j2534__PassThruSetProgrammingVoltageResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
Example
{"status": "NOERROR"}
j2534__PassThruSetProgrammingVoltageResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
Example
{"status": "NOERROR"}
j2534__PassThruStartMsgFilterRequest
Fields
| Field Name | Description |
|---|---|
channel_id - UnsignedInt
|
|
filter_type - j2534__FilterType
|
|
p_mask_msg - j2534__PassThruMsg
|
|
p_pattern_msg - j2534__PassThruMsg
|
|
p_flow_control_msg - j2534__PassThruMsg
|
|
p_msg_id - UnsignedInt
|
Example
{
"channel_id": 123,
"filter_type": "UNKNOWN_FILTER",
"p_mask_msg": j2534__PassThruMsg,
"p_pattern_msg": j2534__PassThruMsg,
"p_flow_control_msg": j2534__PassThruMsg,
"p_msg_id": 123
}
j2534__PassThruStartMsgFilterRequest_Input
Fields
| Input Field | Description |
|---|---|
channel_id - UnsignedInt
|
|
filter_type - j2534__FilterType
|
|
p_mask_msg - j2534__PassThruMsg_Input
|
|
p_pattern_msg - j2534__PassThruMsg_Input
|
|
p_flow_control_msg - j2534__PassThruMsg_Input
|
|
p_msg_id - UnsignedInt
|
Example
{
"channel_id": 123,
"filter_type": "UNKNOWN_FILTER",
"p_mask_msg": j2534__PassThruMsg_Input,
"p_pattern_msg": j2534__PassThruMsg_Input,
"p_flow_control_msg": j2534__PassThruMsg_Input,
"p_msg_id": 123
}
j2534__PassThruStartMsgFilterResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
|
p_msg_id - UnsignedInt
|
Example
{"status": "NOERROR", "p_msg_id": 123}
j2534__PassThruStartMsgFilterResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
|
p_msg_id - UnsignedInt
|
Example
{"status": "NOERROR", "p_msg_id": 123}
j2534__PassThruStartPeriodicMsgRequest
Fields
| Field Name | Description |
|---|---|
channel_id - UnsignedInt
|
|
p_msg - j2534__PassThruMsg
|
|
time_interval - UnsignedInt
|
|
p_msg_id - UnsignedInt
|
Example
{
"channel_id": 123,
"p_msg": j2534__PassThruMsg,
"time_interval": 123,
"p_msg_id": 123
}
j2534__PassThruStartPeriodicMsgRequest_Input
Fields
| Input Field | Description |
|---|---|
channel_id - UnsignedInt
|
|
p_msg - j2534__PassThruMsg_Input
|
|
time_interval - UnsignedInt
|
|
p_msg_id - UnsignedInt
|
Example
{
"channel_id": 123,
"p_msg": j2534__PassThruMsg_Input,
"time_interval": 123,
"p_msg_id": 123
}
j2534__PassThruStartPeriodicMsgResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
|
p_msg_id - UnsignedInt
|
Example
{"status": "NOERROR", "p_msg_id": 123}
j2534__PassThruStartPeriodicMsgResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
|
p_msg_id - UnsignedInt
|
Example
{"status": "NOERROR", "p_msg_id": 123}
j2534__PassThruStartPeriodicReadMsgRequest
Fields
| Field Name | Description |
|---|---|
channel_id - UnsignedInt
|
|
data_filter - [j2534__DataFilter]
|
|
time_interval - UnsignedInt
|
|
p_msg_id - UnsignedInt
|
|
flag_id - UnsignedInt
|
Example
{
"channel_id": 123,
"data_filter": [j2534__DataFilter],
"time_interval": 123,
"p_msg_id": 123,
"flag_id": 123
}
j2534__PassThruStartPeriodicReadMsgRequest_Input
Fields
| Input Field | Description |
|---|---|
channel_id - UnsignedInt
|
|
data_filter - [j2534__DataFilter_Input]
|
|
time_interval - UnsignedInt
|
|
p_msg_id - UnsignedInt
|
|
flag_id - UnsignedInt
|
Example
{
"channel_id": 123,
"data_filter": [j2534__DataFilter_Input],
"time_interval": 123,
"p_msg_id": 123,
"flag_id": 123
}
j2534__PassThruStartPeriodicReadMsgResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
|
p_msg_id - UnsignedInt
|
Example
{"status": "NOERROR", "p_msg_id": 123}
j2534__PassThruStartPeriodicReadMsgResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
|
p_msg_id - UnsignedInt
|
Example
{"status": "NOERROR", "p_msg_id": 123}
j2534__PassThruStopMsgFilterRequest
Fields
| Field Name | Description |
|---|---|
channel_id - UnsignedInt
|
|
msg_id - UnsignedInt
|
Example
{"channel_id": 123, "msg_id": 123}
j2534__PassThruStopMsgFilterRequest_Input
Fields
| Input Field | Description |
|---|---|
channel_id - UnsignedInt
|
|
msg_id - UnsignedInt
|
Example
{"channel_id": 123, "msg_id": 123}
j2534__PassThruStopMsgFilterResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
Example
{"status": "NOERROR"}
j2534__PassThruStopMsgFilterResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
Example
{"status": "NOERROR"}
j2534__PassThruStopPeriodicMsgRequest
Fields
| Field Name | Description |
|---|---|
channel_id - UnsignedInt
|
|
msg_id - UnsignedInt
|
Example
{"channel_id": 123, "msg_id": 123}
j2534__PassThruStopPeriodicMsgRequest_Input
Fields
| Input Field | Description |
|---|---|
channel_id - UnsignedInt
|
|
msg_id - UnsignedInt
|
Example
{"channel_id": 123, "msg_id": 123}
j2534__PassThruStopPeriodicMsgResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
Example
{"status": "NOERROR"}
j2534__PassThruStopPeriodicMsgResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
Example
{"status": "NOERROR"}
j2534__PassThruStopPeriodicReadMsgRequest
Fields
| Field Name | Description |
|---|---|
channel_id - UnsignedInt
|
|
msg_id - UnsignedInt
|
Example
{"channel_id": 123, "msg_id": 123}
j2534__PassThruStopPeriodicReadMsgRequest_Input
Fields
| Input Field | Description |
|---|---|
channel_id - UnsignedInt
|
|
msg_id - UnsignedInt
|
Example
{"channel_id": 123, "msg_id": 123}
j2534__PassThruStopPeriodicReadMsgResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
Example
{"status": "NOERROR"}
j2534__PassThruStopPeriodicReadMsgResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
Example
{"status": "NOERROR"}
j2534__PassThruUnsupported
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
Example
{"status": "NOERROR"}
j2534__PassThruUnsupported_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
Example
{"status": "NOERROR"}
j2534__PassThruWriteMsgsRequest
Description
WRITE
Fields
| Field Name | Description |
|---|---|
channel_id - UnsignedInt
|
|
timeout - UnsignedInt
|
|
p_num_msgs - UnsignedInt
|
|
p_msg - [j2534__PassThruMsg]
|
Example
{
"channel_id": 123,
"timeout": 123,
"p_num_msgs": 123,
"p_msg": [j2534__PassThruMsg]
}
j2534__PassThruWriteMsgsRequest_Input
Description
WRITE
Fields
| Input Field | Description |
|---|---|
channel_id - UnsignedInt
|
|
timeout - UnsignedInt
|
|
p_num_msgs - UnsignedInt
|
|
p_msg - [j2534__PassThruMsg_Input]
|
Example
{
"channel_id": 123,
"timeout": 123,
"p_num_msgs": 123,
"p_msg": [j2534__PassThruMsg_Input]
}
j2534__PassThruWriteMsgsResponse
Fields
| Field Name | Description |
|---|---|
status - j2534__Status
|
|
p_num_msgs - UnsignedInt
|
Example
{"status": "NOERROR", "p_num_msgs": 123}
j2534__PassThruWriteMsgsResponse_Input
Fields
| Input Field | Description |
|---|---|
status - j2534__Status
|
|
p_num_msgs - UnsignedInt
|
Example
{"status": "NOERROR", "p_num_msgs": 123}
j2534__Protocol
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Reserved for SAE use: 0x0b-0xffff For the following definitions see J2534-2 section 22.2 ProtocolID Values |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN_PROTOCOL"
j2534__RxStatusBit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
7-3 reserved for SAE CAN_29BIT_ID = 8; allready define 23-9 reserved for SAE 31-24 Tool Manufacturer specific |
|
|
|
|
|
|
|
|
Example
"TX_MSG_TYPE"
j2534__SConfigParameter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Unused = 2; |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unused = 0x19; |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Reserved for SAE: 0x20-0xffff See J2534-2 Section 22.5 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Reserved: 0x8002-0x800f |
|
|
|
|
|
|
|
|
Reserved: 0x8013-0x801f |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Reserved for Tool manufacturer: 0x10000-0xffffffff |
|
|
DOIP related |
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN_SCONFIG_PARAMETER"
j2534__Sconfig
Fields
| Field Name | Description |
|---|---|
sconfig_parameter - j2534__SConfigParameter
|
|
value - UnsignedInt
|
Example
{"sconfig_parameter": "UNKNOWN_SCONFIG_PARAMETER", "value": 123}
j2534__SconfigList
Fields
| Field Name | Description |
|---|---|
list - [j2534__Sconfig]
|
Example
{"list": [j2534__Sconfig]}
j2534__SconfigList_Input
Fields
| Input Field | Description |
|---|---|
list - [j2534__Sconfig_Input]
|
Example
{"list": [j2534__Sconfig_Input]}
j2534__Sconfig_Input
Fields
| Input Field | Description |
|---|---|
sconfig_parameter - j2534__SConfigParameter
|
|
value - UnsignedInt
|
Example
{"sconfig_parameter": "UNKNOWN_SCONFIG_PARAMETER", "value": 123}
j2534__Status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
COULD NOT READ ANY MESSAGES FROM THE VEHICLE NETWORK |
|
|
|
|
|
RECEIVE BUFFER OVERFLOWED AND MESSAGES WERE LOST |
|
|
|
|
|
|
|
|
|
|
|
Only old J2524-2004 |
|
|
Only old J2524-2004 |
|
|
Only old J2524-2004 |
|
|
Only old J2524-2004 |
|
|
Only old J2524-2004 |
|
|
Munic specific |
|
|
Munic specific |
|
|
Munic specific |
|
|
Munic specific |
|
|
Munic specific |
Example
"NOERROR"
j2534__TxFlagBit
Values
| Enum Value | Description |
|---|---|
|
|
0-5 reserved for SAE The first enum value must be zero in proto3 |
|
|
|
|
|
|
|
|
|
|
|
15-9 reserved for SAE |
|
|
17-22 reserved for SAE |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RESERVED"
join__FieldSet
Example
join__FieldSet
join__Graph
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSET_MANAGER"
journey_associated_device
Fields
| Field Name | Description |
|---|---|
type - devices_const!
|
|
id - ID!
|
Example
{"type": "devices", "id": "4"}
journey_device_paginated
Fields
| Field Name | Description |
|---|---|
data - [journey_associated_device]!
|
|
meta - meta!
|
Example
{
"data": [journey_associated_device],
"meta": meta
}
journey_query_device_trips_included_items
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - metadata_const!
|
|
attributes - metadata_attributes
|
Example
{
"id": "4",
"type": "metadata",
"attributes": metadata_attributes
}
journey_report
Fields
| Field Name | Description |
|---|---|
type - reports_const!
|
|
id - ID!
|
|
attributes - report_attributes!
|
Example
{
"type": "reports",
"id": "4",
"attributes": report_attributes
}
journey_summary
Fields
| Field Name | Description |
|---|---|
data - query_device_summary_data!
|
Example
{"data": query_device_summary_data}
journey_trip
Fields
| Field Name | Description |
|---|---|
type - trips_const!
|
|
id - ID!
|
|
attributes - trip_attributes!
|
|
relationships - query_get_trip_oneOf_0_data_relationships
|
|
cleaned_positions - map_matching_position_paginated
|
|
journey_harshes - journey_trip_harsh_paginated
|
|
journey_overspeeds - trip_overspeeds_response
|
|
journey_idlings - trip_idlings_response
|
|
Example
{
"type": "trips",
"id": "4",
"attributes": trip_attributes,
"relationships": query_get_trip_oneOf_0_data_relationships,
"cleaned_positions": map_matching_position_paginated,
"journey_harshes": journey_trip_harsh_paginated,
"journey_overspeeds": journey_trip_overspeed_paginated,
"journey_idlings": journey_trip_idling_paginated
}
journey_trip_encapsulated
Fields
| Field Name | Description |
|---|---|
data - journey_trip!
|
|
included - [query_get_trip_oneOf_0_included_items]
|
Example
{
"data": journey_trip,
"included": [query_get_trip_oneOf_0_included_items]
}
journey_trip_harsh
Fields
| Field Name | Description |
|---|---|
type - harshes_const!
|
|
id - ID!
|
|
attributes - journey_trip_harsh_attributes!
|
Example
{
"type": "harshes",
"id": 4,
"attributes": journey_trip_harsh_attributes
}
journey_trip_harsh_attributes
Fields
| Field Name | Description |
|---|---|
kind - query_trip_harshes_data_items_attributes_kind
|
|
mean_acceleration - Float
|
|
peak_acceleration - Float
|
|
start_speed - Float
|
|
end_speed - Float
|
|
start_latitude - Float
|
|
start_longitude - Float
|
|
start_time - DateTime
|
|
end_latitude - Float
|
|
end_longitude - Float
|
|
end_time - DateTime
|
|
duration_in_seconds - Int
|
|
duration - String
|
Example
{
"kind": "left_cornering",
"mean_acceleration": 123.45,
"peak_acceleration": 123.45,
"start_speed": 123.45,
"end_speed": 123.45,
"start_latitude": 987.65,
"start_longitude": 123.45,
"start_time": "2007-12-03T10:15:30Z",
"end_latitude": 987.65,
"end_longitude": 987.65,
"end_time": "2007-12-03T10:15:30Z",
"duration_in_seconds": 123,
"duration": "abc123"
}
journey_trip_harsh_paginated
Fields
| Field Name | Description |
|---|---|
data - [journey_trip_harsh]!
|
|
meta - meta
|
Example
{
"data": [journey_trip_harsh],
"meta": meta
}
journey_trip_idling
Fields
| Field Name | Description |
|---|---|
type - idlings_const!
|
|
id - ID!
|
|
attributes - journey_trip_idling_attributes!
|
Example
{
"type": "idlings",
"id": 4,
"attributes": journey_trip_idling_attributes
}
journey_trip_idling_attributes
Example
{
"open": true,
"start_latitude": 987.65,
"start_longitude": 123.45,
"start_time": "2007-12-03T10:15:30Z",
"end_latitude": 987.65,
"end_longitude": 123.45,
"end_time": "2007-12-03T10:15:30Z",
"duration_in_seconds": 987,
"duration": "xyz789"
}
journey_trip_idling_paginated
Fields
| Field Name | Description |
|---|---|
data - [journey_trip_idling]!
|
|
meta - meta
|
Example
{
"data": [journey_trip_idling],
"meta": meta
}
journey_trip_overspeed
Fields
| Field Name | Description |
|---|---|
type - overspeeds_const!
|
|
id - ID!
|
|
attributes - journey_trip_overspeed_attributes!
|
Example
{
"type": "overspeeds",
"id": "4",
"attributes": journey_trip_overspeed_attributes
}
journey_trip_overspeed_attributes
Fields
| Field Name | Description |
|---|---|
mean_overspeed - Float
|
|
mean_speed - Float
|
|
peak_overspeed - Float
|
|
peak_speed - Float
|
|
speed_threshold - Float
|
|
start_latitude - Float
|
|
start_longitude - Float
|
|
start_time - DateTime
|
|
end_latitude - Float
|
|
end_longitude - Float
|
|
end_time - DateTime
|
|
duration_in_seconds - Int
|
|
duration - String
|
Example
{
"mean_overspeed": 987.65,
"mean_speed": 987.65,
"peak_overspeed": 123.45,
"peak_speed": 123.45,
"speed_threshold": 123.45,
"start_latitude": 123.45,
"start_longitude": 123.45,
"start_time": "2007-12-03T10:15:30Z",
"end_latitude": 987.65,
"end_longitude": 123.45,
"end_time": "2007-12-03T10:15:30Z",
"duration_in_seconds": 123,
"duration": "xyz789"
}
journey_trip_overspeed_paginated
Fields
| Field Name | Description |
|---|---|
data - [journey_trip_overspeed]!
|
|
meta - meta
|
Example
{
"data": [journey_trip_overspeed],
"meta": meta
}
journey_trip_paginated
Fields
| Field Name | Description |
|---|---|
data - [journey_trip]!
|
|
meta - meta!
|
|
included - [journey_query_device_trips_included_items]
|
Example
{
"data": [journey_trip],
"meta": meta,
"included": [journey_query_device_trips_included_items]
}
journey_trip_tag_schedule
Fields
| Field Name | Description |
|---|---|
type - trip_tag_schedules_const!
|
|
id - ID!
|
|
attributes - trip_tag_schedule_attributes!
|
|
devices - journey_device_paginated
|
|
Example
{
"type": "trip_tag_schedules",
"id": 4,
"attributes": trip_tag_schedule_attributes,
"devices": journey_device_paginated
}
link__Import
Example
link__Import
link__Purpose
Values
| Enum Value | Description |
|---|---|
|
|
SECURITY features provide metadata necessary to securely resolve fields.
|
|
|
EXECUTION features provide metadata necessary for operation execution.
|
Example
"SECURITY"
links_for_paginated
links_for_resource
Fields
| Field Name | Description |
|---|---|
self - String!
|
Example
{"self": "xyz789"}
map_matching_position
Fields
| Field Name | Description |
|---|---|
type - positions_const!
|
|
id - ID!
|
|
attributes - map_matching_position_attributes!
|
Example
{
"type": "positions",
"id": "4",
"attributes": map_matching_position_attributes
}
map_matching_position_attributes
map_matching_position_paginated
Fields
| Field Name | Description |
|---|---|
data - [map_matching_position]!
|
|
meta - meta
|
Example
{
"data": [map_matching_position],
"meta": meta
}
meta
meta_j2534__CmdType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DEFAULT_CMD"
meta_j2534__MetaJ2534
Fields
| Field Name | Description |
|---|---|
monitor - Boolean
|
If true the response of this request will be decode and send to main api |
type - meta_j2534__CmdType
|
Define commande type |
parameter_id - BigInt
|
Define cmd ID in case on INIT_CMD id of the command, in case of PARAM_CMD the id of the dependence |
byte_id - [UnsignedInt]
|
in cases of INIT_CMD bytes to keep in response, in case of PARAM_CMD bytes to replace in request |
start_offset - UnsignedInt
|
|
pattern_length - UnsignedInt
|
|
pattern_offset - UnsignedInt
|
|
j2534 - j2534__J2534Msg
|
Example
{
"monitor": true,
"type": "DEFAULT_CMD",
"parameter_id": {},
"byte_id": [123],
"start_offset": 123,
"pattern_length": 123,
"pattern_offset": 123,
"j2534": j2534__J2534Msg
}
meta_j2534__MetaJ2534_Input
Fields
| Input Field | Description |
|---|---|
monitor - Boolean
|
If true the response of this request will be decode and send to main api |
type - meta_j2534__CmdType
|
Define commande type |
parameter_id - BigInt
|
Define cmd ID in case on INIT_CMD id of the command, in case of PARAM_CMD the id of the dependence |
byte_id - [UnsignedInt]
|
in cases of INIT_CMD bytes to keep in response, in case of PARAM_CMD bytes to replace in request |
start_offset - UnsignedInt
|
|
pattern_length - UnsignedInt
|
|
pattern_offset - UnsignedInt
|
|
j2534 - j2534__J2534Msg_Input
|
Example
{
"monitor": false,
"type": "DEFAULT_CMD",
"parameter_id": {},
"byte_id": [123],
"start_offset": 123,
"pattern_length": 123,
"pattern_offset": 123,
"j2534": j2534__J2534Msg_Input
}
meta_j2534__Task
Fields
| Field Name | Description |
|---|---|
version - UnsignedInt
|
|
last_task - Boolean
|
If true: finish the current Action |
loop - Boolean
|
If true start a loop with this task (all the meta_j2534) |
loop_timeout_s - UnsignedInt
|
Loop timeout , the loop stop after this duration |
loop_count_max - UnsignedInt
|
Loop Max count, the loop stop if the count is reached |
loop_expected_period_us - UnsignedInt
|
Loop expected period in micro second |
meta_j2534_list - [meta_j2534__MetaJ2534]
|
Meta j2534 array |
Example
{
"version": 123,
"last_task": false,
"loop": false,
"loop_timeout_s": 123,
"loop_count_max": 123,
"loop_expected_period_us": 123,
"meta_j2534_list": [meta_j2534__MetaJ2534]
}
meta_j2534__Task_Input
Fields
| Input Field | Description |
|---|---|
version - UnsignedInt
|
|
last_task - Boolean
|
If true: finish the current Action |
loop - Boolean
|
If true start a loop with this task (all the meta_j2534) |
loop_timeout_s - UnsignedInt
|
Loop timeout , the loop stop after this duration |
loop_count_max - UnsignedInt
|
Loop Max count, the loop stop if the count is reached |
loop_expected_period_us - UnsignedInt
|
Loop expected period in micro second |
meta_j2534_list - [meta_j2534__MetaJ2534_Input]
|
Meta j2534 array |
Example
{
"version": 123,
"last_task": true,
"loop": false,
"loop_timeout_s": 123,
"loop_count_max": 123,
"loop_expected_period_us": 123,
"meta_j2534_list": [meta_j2534__MetaJ2534_Input]
}
metadata_attributes
metadata_attributes_Input
metadata_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"metadata"
munic__remote_diagnostic__interactive__Action_Input
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
munic__remote_diagnostic__interactive__MetaTask
Fields
| Field Name | Description |
|---|---|
action_id - String
|
|
tasks - [meta_j2534__Task]
|
string session_id = 2; |
Example
{
"action_id": "abc123",
"tasks": [meta_j2534__Task]
}
munic__remote_diagnostic__interactive__MetaTask_Input
Fields
| Input Field | Description |
|---|---|
action_id - String
|
|
tasks - [meta_j2534__Task_Input]
|
string session_id = 2; |
Example
{
"action_id": "abc123",
"tasks": [meta_j2534__Task_Input]
}
munic__remote_diagnostic__interactive__Response
Fields
| Field Name | Description |
|---|---|
j2534_msgs - [j2534__J2534Msg]
|
Example
{"j2534_msgs": [j2534__J2534Msg]}
munic__remote_diagnostic__main__exposedTypes_Input
Fields
| Input Field | Description |
|---|---|
tx_flag_bits - j2534__TxFlagBit
|
|
rx_status_bits - j2534__RxStatusBit
|
Example
{"tx_flag_bits": "RESERVED", "rx_status_bits": "TX_MSG_TYPE"}
mutationInput_post_alerts_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
imei - String!
|
|
geofence_id - String!
|
|
state - mutationInput_post_alerts_input_data_attributes_state!
|
|
event_type - mutationInput_post_alerts_input_data_attributes_event_type!
|
|
position - point_Input!
|
|
started_at - DateTime
|
|
ended_at - DateTime
|
Example
{
"imei": "xyz789",
"geofence_id": "abc123",
"state": "UNKNOWN",
"event_type": "ENTRY",
"position": point_Input,
"started_at": "2007-12-03T10:15:30Z",
"ended_at": "2007-12-03T10:15:30Z"
}
mutationInput_post_alerts_input_data_attributes_event_type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ENTRY"
mutationInput_post_alerts_input_data_attributes_state
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
mutationInput_post_client_identifications_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
label - String!
|
|
client_reference_type - mutationInput_post_client_identifications_input_data_attributes_client_reference_type!
|
|
client_reference - ID!
|
|
number_of_onboardings - Int!
|
|
distributor_id - ID
|
|
default_user - ID
|
|
default_privacy_whitelisted_data - [mutationInput_post_client_identifications_input_data_attributes_default_privacy_whitelisted_data_items]!
|
Example
{
"label": "abc123",
"client_reference_type": "group",
"client_reference": 4,
"number_of_onboardings": 123,
"distributor_id": "4",
"default_user": 4,
"default_privacy_whitelisted_data": ["position"]
}
mutationInput_post_client_identifications_input_data_attributes_client_reference_type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"group"
mutationInput_post_client_identifications_input_data_attributes_default_privacy_whitelisted_data_items
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"position"
mutationInput_post_device_configs_input_data_attributes_Input
mutationInput_post_doors_toggle_requests_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
imei - String!
|
|
account - String
|
|
action - mutationInput_post_doors_toggle_requests_input_data_attributes_action!
|
|
request_custom_id - String
|
|
process_kind - process_kind
|
Example
{
"imei": "abc123",
"account": "xyz789",
"action": "lock",
"request_custom_id": "abc123",
"process_kind": "default_process"
}
mutationInput_post_doors_toggle_requests_input_data_attributes_action
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"lock"
mutationInput_post_driver_auxiliary_devices_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
id_key - String
|
device identifier, mendatory phore rfid, nfc, Tag |
label - String
|
|
tags - [String]
|
Driver tags |
kind - auxiliary_device_kind
|
|
connection_type - auxiliary_device_connection_type
|
|
sensor_functions - [auxiliary_device_sensor_function]
|
|
color - String
|
|
serial_number - String
|
Device serial number |
mac_address_hash - String
|
required for sensors: the SHA-1 hash of the MAC address in uppercase, formatted as ^([0-9A-F]{2}[:-]){5}([0-9A-F]{2})$ |
settings - auxiliary_device_settings_Input
|
Example
{
"id_key": "xyz789",
"label": "abc123",
"tags": ["abc123"],
"kind": "phone",
"connection_type": "unknown",
"sensor_functions": ["temperature"],
"color": "abc123",
"serial_number": "abc123",
"mac_address_hash": "xyz789",
"settings": auxiliary_device_settings_Input
}
mutationInput_post_drop_data_requests_input_data_Input
Fields
| Input Field | Description |
|---|---|
type - drop_data_requests_const!
|
|
id - String
|
|
attributes - mutationInput_post_drop_data_requests_input_data_attributes_Input!
|
Example
{
"type": "drop_data_requests",
"id": "abc123",
"attributes": mutationInput_post_drop_data_requests_input_data_attributes_Input
}
mutationInput_post_drop_data_requests_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
user_id - Int
|
|
status - mutationInput_post_drop_data_requests_input_data_attributes_status
|
|
imei - String!
|
Example
{
"user_id": 987,
"status": "created",
"imei": "abc123"
}
mutationInput_post_drop_data_requests_input_data_attributes_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"created"
mutationInput_post_engine_immobilizer_requests_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
imei - String!
|
|
account - String
|
|
action - mutationInput_post_engine_immobilizer_requests_input_data_attributes_action!
|
|
request_custom_id - String
|
|
process_kind - process_kind
|
Example
{
"imei": "abc123",
"account": "xyz789",
"action": "enable_immobilizer",
"request_custom_id": "abc123",
"process_kind": "default_process"
}
mutationInput_post_engine_immobilizer_requests_input_data_attributes_action
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"enable_immobilizer"
mutationInput_post_geofences_input_data_attributes_Input
mutationInput_post_geofences_relationships_devices_input_data_items_Input
Fields
| Input Field | Description |
|---|---|
type - devices_const!
|
|
id - String!
|
Example
{"type": "devices", "id": "abc123"}
mutationInput_post_geofences_relationships_groups_input_data_items_Input
Fields
| Input Field | Description |
|---|---|
type - groups_const!
|
|
id - String!
|
Example
{"type": "groups", "id": "xyz789"}
mutationInput_post_metadata_input_data_Input
Fields
| Input Field | Description |
|---|---|
type - metadata_const!
|
|
attributes - metadata_attributes_Input!
|
Example
{
"type": "metadata",
"attributes": metadata_attributes_Input
}
mutationInput_post_schedules_input_data_attributes_Input
Example
{
"week_days": mutationInput_post_schedules_input_data_attributes_week_days_Input,
"geofence_id": "xyz789",
"time_zone": "Africa_Abidjan",
"outside_of_slots": true,
"start_at": "2007-12-03T10:15:30Z",
"end_at": "2007-12-03T10:15:30Z"
}
mutationInput_post_schedules_input_data_attributes_week_days_Input
Fields
| Input Field | Description |
|---|---|
monday - [time_slot_Input]
|
|
tuesday - [time_slot_Input]
|
|
wednesday - [time_slot_Input]
|
|
thursday - [time_slot_Input]
|
|
friday - [time_slot_Input]
|
|
saturday - [time_slot_Input]
|
|
sunday - [time_slot_Input]
|
Example
{
"monday": [time_slot_Input],
"tuesday": [time_slot_Input],
"wednesday": [time_slot_Input],
"thursday": [time_slot_Input],
"friday": [time_slot_Input],
"saturday": [time_slot_Input],
"sunday": [time_slot_Input]
}
mutationInput_post_shapes_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
geofence_id - String!
|
|
geometry_type - CIRCLE_const!
|
|
definition - circle_Input!
|
Example
{
"geofence_id": "abc123",
"geometry_type": "CIRCLE",
"definition": circle_Input
}
mutationInput_post_trip_tag_schedules_input_data_attributes_week_days_Input
Fields
| Input Field | Description |
|---|---|
monday - [time_slot_Input]
|
|
tuesday - [time_slot_Input]
|
|
wednesday - [time_slot_Input]
|
|
thursday - [time_slot_Input]
|
|
friday - [time_slot_Input]
|
|
saturday - [time_slot_Input]
|
|
sunday - [time_slot_Input]
|
Example
{
"monday": [time_slot_Input],
"tuesday": [time_slot_Input],
"wednesday": [time_slot_Input],
"thursday": [time_slot_Input],
"friday": [time_slot_Input],
"saturday": [time_slot_Input],
"sunday": [time_slot_Input]
}
mutationInput_post_trip_tag_schedules_input_data_relationships_Input
Fields
| Input Field | Description |
|---|---|
devices - associated_devices_Input!
|
Example
{"devices": associated_devices_Input}
mutationInput_post_user_unlock_requests_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
identifier - user_unlock_request_identifier!
|
|
identifier_value - String!
|
Example
{
"identifier": "email",
"identifier_value": "abc123"
}
mutationInput_post_user_unlocks_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
unlock_token - String!
|
Example
{"unlock_token": "abc123"}
mutationInput_post_v1_user_alert_notifications_input_data_Input
Fields
| Input Field | Description |
|---|---|
type - user_alert_notifications_const!
|
|
attributes - mutationInput_post_v1_user_alert_notifications_input_data_attributes_Input!
|
Example
{
"type": "user_alert_notifications",
"attributes": mutationInput_post_v1_user_alert_notifications_input_data_attributes_Input
}
mutationInput_post_v1_user_alert_notifications_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
uid - ID!
|
|
user_name - String!
|
|
type_of_alert - geofencing_const!
|
|
event_type - geofence_event_type!
|
|
geofence_id - ID!
|
|
should_verify_stay - Boolean
|
|
duration_in_seconds - Int
|
duration in seconds |
Example
{
"uid": 4,
"user_name": "abc123",
"type_of_alert": "geofencing",
"event_type": "ENTRY",
"geofence_id": "4",
"should_verify_stay": false,
"duration_in_seconds": 987
}
mutationInput_post_video_segments_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
imei - String!
|
|
referenced_event_id - String
|
|
name - String!
|
|
description - String
|
|
start_time - DateTime!
|
|
end_time - DateTime!
|
|
referenced_event_kind - video_segment_referenced_event_kind
|
|
action - video_segment_action_Input
|
Example
{
"imei": "xyz789",
"referenced_event_id": "xyz789",
"name": "abc123",
"description": "abc123",
"start_time": "2007-12-03T10:15:30Z",
"end_time": "2007-12-03T10:15:30Z",
"referenced_event_kind": "Overspeed",
"action": video_segment_action_Input
}
mutationInput_put_action_input_data_Input
Fields
| Input Field | Description |
|---|---|
type - actions_const!
|
|
id - ID!
|
|
attributes - mutationInput_put_action_input_data_attributes_Input!
|
Example
{
"type": "actions",
"id": 4,
"attributes": mutationInput_put_action_input_data_attributes_Input
}
mutationInput_put_action_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
stack - mutationInput_put_action_input_data_attributes_stack_Input
|
Example
{
"stack": mutationInput_put_action_input_data_attributes_stack_Input
}
mutationInput_put_action_input_data_attributes_stack_Input
Fields
| Input Field | Description |
|---|---|
Stack_Input - Stack_Input
|
|
EndOfProcess_Input - EndOfProcess_Input
|
Example
{
"Stack_Input": Stack_Input,
"EndOfProcess_Input": EndOfProcess_Input
}
mutationInput_put_action_input_data_attributes_stack_oneOf_0_buses_items_Input
Fields
| Input Field | Description |
|---|---|
bus_id - String!
|
|
pin_h - Int!
|
|
pin_l - Int!
|
|
baudrate - Int!
|
|
protocol - mutationInput_put_action_input_data_attributes_stack_oneOf_0_buses_items_protocol!
|
Example
{
"bus_id": "abc123",
"pin_h": 123,
"pin_l": 123,
"baudrate": 987,
"protocol": "isoTP"
}
mutationInput_put_action_input_data_attributes_stack_oneOf_0_buses_items_protocol
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"isoTP"
mutationInput_put_action_input_data_attributes_stack_oneOf_0_commands_items_Input
mutationInput_put_action_input_data_attributes_stack_oneOf_0_ecus_items_Input
mutationInput_put_action_input_data_attributes_stack_oneOf_0_operations_items_Input
mutationInput_put_action_input_data_attributes_stack_oneOf_1_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SUCCESS"
mutationInput_put_alert_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
imei - String!
|
|
geofence_id - String!
|
|
state - mutationInput_put_alert_input_data_attributes_state!
|
|
event_type - mutationInput_put_alert_input_data_attributes_event_type!
|
|
position - point_Input!
|
|
started_at - DateTime
|
|
ended_at - DateTime
|
Example
{
"imei": "abc123",
"geofence_id": "xyz789",
"state": "UNKNOWN",
"event_type": "ENTRY",
"position": point_Input,
"started_at": "2007-12-03T10:15:30Z",
"ended_at": "2007-12-03T10:15:30Z"
}
mutationInput_put_alert_input_data_attributes_event_type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ENTRY"
mutationInput_put_alert_input_data_attributes_state
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
mutationInput_put_dashcam_file_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
action - dashcam_file_action_Input
|
Example
{"action": dashcam_file_action_Input}
mutationInput_put_dashcam_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
action - dashcam_action_Input!
|
Example
{"action": dashcam_action_Input}
mutationInput_put_dashcam_input_data_attributes_action_configure_Input
Description
Configure dashcam settings
Fields
| Input Field | Description |
|---|---|
resolution - mutationInput_put_dashcam_input_data_attributes_action_configure_resolution
|
|
fps - PositiveInt
|
|
microphone - Boolean
|
|
stamp - mutationInput_put_dashcam_input_data_attributes_action_configure_stamp
|
|
parking_mode - Boolean
|
|
movement_detection_sensitivity - mutationInput_put_dashcam_input_data_attributes_action_configure_movement_detection_sensitivity
|
Example
{
"resolution": "_720p",
"fps": 123,
"microphone": false,
"stamp": "none",
"parking_mode": true,
"movement_detection_sensitivity": "low"
}
mutationInput_put_dashcam_input_data_attributes_action_configure_movement_detection_sensitivity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"low"
mutationInput_put_dashcam_input_data_attributes_action_configure_resolution
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"_720p"
mutationInput_put_dashcam_input_data_attributes_action_configure_stamp
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"none"
mutationInput_put_dashcam_input_data_attributes_action_list_Input
Fields
| Input Field | Description |
|---|---|
date_from - String
|
|
date_to - String
|
|
video_only - Boolean
|
|
events_only - Boolean
|
|
lens - mutationInput_put_dashcam_input_data_attributes_action_list_lens
|
Example
{
"date_from": "abc123",
"date_to": "xyz789",
"video_only": true,
"events_only": true,
"lens": "front"
}
mutationInput_put_dashcam_input_data_attributes_action_list_lens
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"front"
mutationInput_put_dashcam_input_data_attributes_action_live_stream_Input
Fields
| Input Field | Description |
|---|---|
start - Boolean
|
|
lens - mutationInput_put_dashcam_input_data_attributes_action_live_stream_lens
|
|
duration - PositiveInt
|
|
microphone - Boolean
|
|
server - mutationInput_put_dashcam_input_data_attributes_action_live_stream_server_Input
|
Example
{
"start": true,
"lens": "front",
"duration": 123,
"microphone": false,
"server": mutationInput_put_dashcam_input_data_attributes_action_live_stream_server_Input
}
mutationInput_put_dashcam_input_data_attributes_action_live_stream_lens
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"front"
mutationInput_put_dashcam_input_data_attributes_action_live_stream_server_Input
Fields
| Input Field | Description |
|---|---|
url - String!
|
Example
{"url": "abc123"}
mutationInput_put_driver_auxiliary_device_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
id_key - String
|
custom identifier used as a reference |
label - String
|
|
tags - [String]
|
Driver tags |
kind - auxiliary_device_kind
|
|
connection_type - auxiliary_device_connection_type
|
|
sensor_functions - [auxiliary_device_sensor_function]
|
|
color - String
|
|
serial_number - String
|
Device serial number |
settings - auxiliary_device_settings_Input
|
|
mac_address_hash - String
|
required for sensors: the SHA-1 hash of the MAC address in uppercase, formatted as ^([0-9A-F]{2}[:-]){5}([0-9A-F]{2})$ |
action - renewToken_const
|
|
token_max_ttl - Int
|
The number of seconds the token remains valid. The actual token TTL may be shorter than the requested TTL if the driver's authorization on one of the authorized vehicles is set to expire earlier. This ensures that the token does not outlast the driver's access permissions. This field should only be used when action = renewToken |
token_targeted_vehicle_ids - [ID]
|
A list of vehicle IDs that restrict the token's usage to a specific set of the driver authorized vehicles. If provided, the token will only be valid for the specified vehicles. This field should only be used when action = renewToken |
token_targeted_device_ids - [ID]
|
A list of device IDs (dongle IMEIs) that restrict the token's usage to specific devices that are onboarded on authorized vehicles. If provided, the token will only be valid for the specified devices. This field should only be used when action = renewToken. |
Example
{
"id_key": "abc123",
"label": "xyz789",
"tags": ["abc123"],
"kind": "phone",
"connection_type": "unknown",
"sensor_functions": ["temperature"],
"color": "xyz789",
"serial_number": "xyz789",
"settings": auxiliary_device_settings_Input,
"mac_address_hash": "abc123",
"action": "renewToken",
"token_max_ttl": 123,
"token_targeted_vehicle_ids": [4],
"token_targeted_device_ids": [4]
}
mutationInput_put_geofence_input_data_attributes_Input
mutationInput_put_schedule_input_data_attributes_Input
Example
{
"week_days": mutationInput_put_schedule_input_data_attributes_week_days_Input,
"geofence_id": "xyz789",
"time_zone": "Africa_Abidjan",
"outside_of_slots": false,
"start_at": "2007-12-03T10:15:30Z",
"end_at": "2007-12-03T10:15:30Z"
}
mutationInput_put_schedule_input_data_attributes_week_days_Input
Fields
| Input Field | Description |
|---|---|
monday - [time_slot_Input]
|
|
tuesday - [time_slot_Input]
|
|
wednesday - [time_slot_Input]
|
|
thursday - [time_slot_Input]
|
|
friday - [time_slot_Input]
|
|
saturday - [time_slot_Input]
|
|
sunday - [time_slot_Input]
|
Example
{
"monday": [time_slot_Input],
"tuesday": [time_slot_Input],
"wednesday": [time_slot_Input],
"thursday": [time_slot_Input],
"friday": [time_slot_Input],
"saturday": [time_slot_Input],
"sunday": [time_slot_Input]
}
mutationInput_put_shape_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
geofence_id - String!
|
|
geometry_type - CIRCLE_const!
|
|
definition - circle_Input!
|
Example
{
"geofence_id": "abc123",
"geometry_type": "CIRCLE",
"definition": circle_Input
}
mutationInput_put_v1_user_alert_notifications_by_id_input_data_Input
Fields
| Input Field | Description |
|---|---|
type - user_alert_notifications_const
|
|
id - ID!
|
|
attributes - mutationInput_put_v1_user_alert_notifications_by_id_input_data_attributes_Input
|
Example
{
"type": "user_alert_notifications",
"id": 4,
"attributes": mutationInput_put_v1_user_alert_notifications_by_id_input_data_attributes_Input
}
mutationInput_put_v1_user_alert_notifications_by_id_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
event_type - geofence_event_type
|
|
geofence_id - ID!
|
|
should_verify_stay - Boolean
|
|
duration_in_seconds - Int
|
duration in seconds |
Example
{
"event_type": "ENTRY",
"geofence_id": "4",
"should_verify_stay": true,
"duration_in_seconds": 123
}
mutationInput_put_video_segment_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
action - video_segment_action_Input!
|
Example
{"action": video_segment_action_Input}
mutationInput_update_trip_tag_schedule_input_data_attributes_week_days_Input
Fields
| Input Field | Description |
|---|---|
monday - [time_slot_Input]
|
|
tuesday - [time_slot_Input]
|
|
wednesday - [time_slot_Input]
|
|
thursday - [time_slot_Input]
|
|
friday - [time_slot_Input]
|
|
saturday - [time_slot_Input]
|
|
sunday - [time_slot_Input]
|
Example
{
"monday": [time_slot_Input],
"tuesday": [time_slot_Input],
"wednesday": [time_slot_Input],
"thursday": [time_slot_Input],
"friday": [time_slot_Input],
"saturday": [time_slot_Input],
"sunday": [time_slot_Input]
}
mutation_create_device_token_oneOf_0_data_attributes
Fields
| Field Name | Description |
|---|---|
device_ids - [ID]!
|
A list of device IDs (dongle IMEIs) that restrict the token's usage to specific devices. If provided, the token will only be valid for the specified devices. |
start_at - DateTime
|
|
end_at - DateTime
|
|
token - String
|
|
created_at - DateTime
|
|
updated_at - DateTime
|
Example
{
"device_ids": [4],
"start_at": "2007-12-03T10:15:30Z",
"end_at": "2007-12-03T10:15:30Z",
"token": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
mutation_post_device_configs_oneOf_0_data_attributes
mutation_post_metadata_data
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - metadata_const!
|
|
attributes - metadata_attributes!
|
Example
{
"id": "4",
"type": "metadata",
"attributes": metadata_attributes
}
mutation_post_trip_tag_schedules_oneOf_0_data_attributes_week_days
Fields
| Field Name | Description |
|---|---|
monday - [time_slot]
|
|
tuesday - [time_slot]
|
|
wednesday - [time_slot]
|
|
thursday - [time_slot]
|
|
friday - [time_slot]
|
|
saturday - [time_slot]
|
|
sunday - [time_slot]
|
Example
{
"monday": [time_slot],
"tuesday": [time_slot],
"wednesday": [time_slot],
"thursday": [time_slot],
"friday": [time_slot],
"saturday": [time_slot],
"sunday": [time_slot]
}
mutation_put_action_data_attributes
Fields
| Field Name | Description |
|---|---|
action_type - mutation_put_action_data_attributes_action_type!
|
|
status - mutation_put_action_data_attributes_status!
|
|
failure_reason - String
|
|
progress - Float
|
|
ecus - [Int]
|
|
pids - [String]
|
Example
{
"action_type": "READ_ALL",
"status": "PENDING",
"failure_reason": "abc123",
"progress": 123.45,
"ecus": [987],
"pids": ["abc123"]
}
mutation_put_action_data_attributes_action_type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"READ_ALL"
mutation_put_action_data_attributes_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
onboarding_query_client_identifications_data_items_attributes
Fields
| Field Name | Description |
|---|---|
label - String
|
|
client_reference_type - query_client_identifications_data_items_attributes_client_reference_type!
|
|
client_reference - ID!
|
|
number_of_onboardings - Int!
|
|
number_of_started_onboardings - Int
|
|
code - String
|
|
distributor_id - ID
|
|
default_user - ID
|
|
default_privacy_whitelisted_data - [query_client_identifications_data_items_attributes_default_privacy_whitelisted_data_items]
|
Example
{
"label": "xyz789",
"client_reference_type": "group",
"client_reference": 4,
"number_of_onboardings": 123,
"number_of_started_onboardings": 123,
"code": "xyz789",
"distributor_id": 4,
"default_user": 4,
"default_privacy_whitelisted_data": ["position"]
}
organization_attributes
organization_attributes_Input
organization_encapsulated
Fields
| Field Name | Description |
|---|---|
data - sso_organization!
|
Example
{"data": sso_organization}
organization_encapsulated_post_Input
Fields
| Input Field | Description |
|---|---|
data - organization_post_Input!
|
Example
{"data": organization_post_Input}
organization_paginated
Fields
| Field Name | Description |
|---|---|
data - [sso_organization]!
|
|
meta - meta
|
Example
{
"data": [sso_organization],
"meta": meta
}
organization_post_Input
Fields
| Input Field | Description |
|---|---|
type - organizations_const!
|
|
id - ID
|
|
attributes - organization_attributes_Input!
|
Example
{
"type": "organizations",
"id": "4",
"attributes": organization_attributes_Input
}
organization_response
Types
| Union Types |
|---|
Example
organization_encapsulated
organizations_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"organizations"
overspeed_response
Types
| Union Types |
|---|
Example
trip_overspeed_encapsulated
overspeeds_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"overspeeds"
point
point_Input
positions_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"positions"
post_device_configs_response
Types
| Union Types |
|---|
Example
device_config_show
post_driver_auxiliary_devices_response
Types
| Union Types |
|---|
Example
auxiliary_device_show
post_metadata_request_Input
Fields
| Input Field | Description |
|---|---|
data - mutationInput_post_metadata_input_data_Input!
|
Example
{"data": mutationInput_post_metadata_input_data_Input}
post_metadata_response
Fields
| Field Name | Description |
|---|---|
data - mutation_post_metadata_data!
|
Example
{"data": mutation_post_metadata_data}
post_organization_response
Types
| Union Types |
|---|
Example
organization_encapsulated
post_reports_response
Types
| Union Types |
|---|
Example
report_encapsulated
post_trip_tag_schedules_response
Types
| Union Types |
|---|
Example
trip_tag_schedule_encapsulated
post_user_alert_notification_Input
Fields
| Input Field | Description |
|---|---|
data - mutationInput_post_v1_user_alert_notifications_input_data_Input
|
Example
{
"data": mutationInput_post_v1_user_alert_notifications_input_data_Input
}
post_user_unlock_requests_response
Types
| Union Types |
|---|
Example
user_unlock_request_show
post_user_unlocks_response
Types
| Union Types |
|---|
Example
user_unlock_show
post_v1_fleet_summaries_response
Types
| Union Types |
|---|
Example
fleet_summary
post_v1_user_alert_notifications_response
Types
| Union Types |
|---|
Example
fetch_user_alert_notification_encapsulated
post_vehicle_auxiliary_devices_response
Types
| Union Types |
|---|
Example
auxiliary_device_show
postal_address
Example
{
"country_code": "abc123",
"country": "abc123",
"state": "abc123",
"county": "xyz789",
"city": "abc123",
"postal_code": "abc123",
"street": "abc123",
"street_number": "abc123"
}
process_kind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"default_process"
process_status
Description
The status field is only applicable if process_kind is 'default', 'workflow', or 'optimized_workflow'. For other process kinds, the status value will be 'unknown'.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"unknown"
put_driver_auxiliary_device_response
Types
| Union Types |
|---|
Example
auxiliary_device_show
put_user_alert_notification_Input
Fields
| Input Field | Description |
|---|---|
data - mutationInput_put_v1_user_alert_notifications_by_id_input_data_Input
|
Example
{
"data": mutationInput_put_v1_user_alert_notifications_by_id_input_data_Input
}
put_v1_user_alert_notifications_by_id_response
Types
| Union Types |
|---|
Example
fetch_user_alert_notification_encapsulated
put_vehicle_auxiliary_device_response
Types
| Union Types |
|---|
Example
auxiliary_device_show
queryInput_alerts_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_autocompletes_input_data_attributes_Input
queryInput_dashcams_dashcam_files_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_devices_alerts_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_devices_dashcams_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_devices_device_config_fields_LEFT_SQUARE_BRACE_device_configs_RIGHT_SQUARE_BRACE__items
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"imei"
queryInput_devices_geofences_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_devices_video_segments_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_geocodes_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
addresses - [queryInput_geocodes_input_data_attributes_addresses_items_Input]!
|
Example
{
"addresses": [
queryInput_geocodes_input_data_attributes_addresses_items_Input
]
}
queryInput_geocodes_input_data_attributes_addresses_items_Input
Example
{
"country_code": "xyz789",
"country": "abc123",
"state": "abc123",
"county": "abc123",
"city": "xyz789",
"postal_code": "abc123",
"road_number": "abc123",
"street": "xyz789",
"street_number": "xyz789",
"district": "abc123"
}
queryInput_geofences_alerts_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_geofences_devices_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_geofences_relationships_devices_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_geofences_schedules_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_geofences_shapes_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_geofences_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_revcodes_input_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
locations - [queryInput_revcodes_input_data_attributes_locations_items_Input]!
|
Example
{
"locations": [
queryInput_revcodes_input_data_attributes_locations_items_Input
]
}
queryInput_revcodes_input_data_attributes_locations_items_Input
queryInput_schedules_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_shapes_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_users_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_vehicles_refills_fields_LEFT_SQUARE_BRACE_refills_RIGHT_SQUARE_BRACE__items
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"product"
queryInput_vehicles_refills_sort_items
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
queryInput_vehicles_summary_fields_LEFT_SQUARE_BRACE_vehicle_summaries_RIGHT_SQUARE_BRACE__items
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"quantity"
queryInput_video_segments_video_files_sort
Description
sort results by field
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
query_alerts_data_items_attributes_event_type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ENTRY"
query_alerts_data_items_attributes_state
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
query_autocompletes_oneOf_0_data_attributes
Fields
| Field Name | Description |
|---|---|
addresses - [query_autocompletes_oneOf_0_data_attributes_addresses_items]!
|
Example
{
"addresses": [
query_autocompletes_oneOf_0_data_attributes_addresses_items
]
}
query_autocompletes_oneOf_0_data_attributes_addresses_items
Example
{
"country_code": "xyz789",
"country": "xyz789",
"state": "xyz789",
"county": "xyz789",
"district": "abc123",
"city": "abc123",
"postal_code": "abc123",
"road_number": "xyz789",
"street": "xyz789",
"street_number": "xyz789",
"lon": 123.45,
"lat": 987.65
}
query_client_identifications_data_items_attributes_client_reference_type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"group"
query_client_identifications_data_items_attributes_default_privacy_whitelisted_data_items
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"position"
query_dashcam_file_data_attributes
Fields
| Field Name | Description |
|---|---|
filename - String!
|
|
recorded_at - String!
|
|
size_bytes - Int
|
|
kind - query_dashcam_file_data_attributes_kind!
|
|
duration_seconds - Int
|
|
file_url - String
|
|
thumbnail_url - String
|
|
file_size_bytes - Int
|
|
created_at - String
|
|
updated_at - String
|
|
storage_status - dashcam_file_storage_status
|
|
failure_reason - String
|
|
lens - dashcam_lens
|
|
recording_type - dashcam_file_recording_type
|
Example
{
"filename": "xyz789",
"recorded_at": "abc123",
"size_bytes": 987,
"kind": "video",
"duration_seconds": 123,
"file_url": "abc123",
"thumbnail_url": "abc123",
"file_size_bytes": 123,
"created_at": "xyz789",
"updated_at": "abc123",
"storage_status": "not_stored",
"failure_reason": "abc123",
"lens": "front",
"recording_type": "continuous"
}
query_dashcam_file_data_attributes_kind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"video"
query_dashcam_files_dashcam_data_attributes
Fields
| Field Name | Description |
|---|---|
dashcam_uid - String!
|
|
make - String
|
|
model - String
|
|
sn - String
|
|
hw - String
|
|
fw - String
|
|
available_lenses - [String]
|
Array of available lenses on the dashcam |
supported_resolutions - JSON
|
|
current_lens - String
|
|
unplugged - Boolean
|
|
unplugged_last_reported_at - String
|
|
status - dashcam_status
|
|
status_last_reported_at - String
|
|
settings - dashcam_settings
|
|
settings_last_reported_at - String
|
|
data_usage - dashcam_data_usage
|
|
data_usage_last_reported_at - String
|
|
sd_card - dashcam_sd_card
|
|
sd_card_last_reported_at - String
|
|
oldest_file_date - String
|
Example
{
"dashcam_uid": "abc123",
"make": "xyz789",
"model": "xyz789",
"sn": "xyz789",
"hw": "xyz789",
"fw": "abc123",
"available_lenses": ["abc123"],
"supported_resolutions": {},
"current_lens": "abc123",
"unplugged": false,
"unplugged_last_reported_at": "abc123",
"status": dashcam_status,
"status_last_reported_at": "abc123",
"settings": dashcam_settings,
"settings_last_reported_at": "abc123",
"data_usage": dashcam_data_usage,
"data_usage_last_reported_at": "abc123",
"sd_card": dashcam_sd_card,
"sd_card_last_reported_at": "xyz789",
"oldest_file_date": "xyz789"
}
query_dashcam_files_dashcam_data_attributes_settings_movement_detection_sensitivity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"low"
query_dashcam_files_dashcam_data_attributes_settings_resolution
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"_720p"
query_dashcam_files_dashcam_data_attributes_settings_stamp
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"none"
query_device_data_attributes
query_device_data_attributes_Input
query_device_summary_data
Fields
| Field Name | Description |
|---|---|
attributes - summary_attributes!
|
Example
{"attributes": summary_attributes}
query_doors_toggle_requests_data_items_attributes
Fields
| Field Name | Description |
|---|---|
imei - String!
|
|
account - String
|
|
created_at - String
|
|
action - query_doors_toggle_requests_data_items_attributes_action!
|
|
request_custom_id - String
|
|
process_kind - process_kind
|
|
status - process_status
|
|
origin - request_origin
|
|
failed_reason - String
|
Example
{
"imei": "xyz789",
"account": "xyz789",
"created_at": "abc123",
"action": "lock",
"request_custom_id": "abc123",
"process_kind": "default_process",
"status": "unknown",
"origin": "api",
"failed_reason": "abc123"
}
query_doors_toggle_requests_data_items_attributes_action
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"lock"
query_driver_auxiliary_devices_oneOf_0_data_items_attributes
Fields
| Field Name | Description |
|---|---|
id_key - String
|
custom identifier used as a reference |
label - String!
|
|
tags - [String]
|
Driver tags |
kind - auxiliary_device_kind!
|
|
connection_type - auxiliary_device_connection_type
|
|
sensor_functions - [auxiliary_device_sensor_function]
|
|
color - String
|
|
serial_number - String
|
Device serial number |
mac_address_hash - String
|
required for sensors: the SHA-1 hash of the MAC address in uppercase, formatted as ^([0-9A-F]{2}[:-]){5}([0-9A-F]{2})$ |
first_connection_at - DateTime
|
|
last_connection_at - DateTime
|
|
settings - auxiliary_device_settings
|
|
created_at - DateTime
|
|
updated_at - String
|
Current paired device IMEI |
bluetooth_token - String
|
Token used for bluetooth pairing, only returned when renewToken action has been called |
Example
{
"id_key": "xyz789",
"label": "xyz789",
"tags": ["xyz789"],
"kind": "phone",
"connection_type": "unknown",
"sensor_functions": ["temperature"],
"color": "xyz789",
"serial_number": "xyz789",
"mac_address_hash": "abc123",
"first_connection_at": "2007-12-03T10:15:30Z",
"last_connection_at": "2007-12-03T10:15:30Z",
"settings": auxiliary_device_settings,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "abc123",
"bluetooth_token": "abc123"
}
query_engine_immobilizer_requests_data_items_attributes
Fields
| Field Name | Description |
|---|---|
imei - String!
|
|
account - String
|
|
created_at - String
|
|
action - query_engine_immobilizer_requests_data_items_attributes_action!
|
|
request_custom_id - String
|
|
process_kind - process_kind
|
|
status - process_status
|
|
origin - request_origin
|
|
failed_reason - String
|
Example
{
"imei": "xyz789",
"account": "abc123",
"created_at": "abc123",
"action": "enable_immobilizer",
"request_custom_id": "abc123",
"process_kind": "default_process",
"status": "unknown",
"origin": "api",
"failed_reason": "abc123"
}
query_engine_immobilizer_requests_data_items_attributes_action
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"enable_immobilizer"
query_geocodes_oneOf_0_data_attributes
Fields
| Field Name | Description |
|---|---|
locations - [query_geocodes_oneOf_0_data_attributes_locations_items]!
|
|
addresses - [query_geocodes_oneOf_0_data_attributes_addresses_items]!
|
Example
{
"locations": [
query_geocodes_oneOf_0_data_attributes_locations_items
],
"addresses": [
query_geocodes_oneOf_0_data_attributes_addresses_items
]
}
query_geocodes_oneOf_0_data_attributes_addresses_items
Example
{
"country_code": "abc123",
"country": "abc123",
"state": "xyz789",
"county": "abc123",
"city": "abc123",
"postal_code": "abc123",
"road_number": "xyz789",
"street": "xyz789",
"street_number": "abc123",
"district": "xyz789"
}
query_geocodes_oneOf_0_data_attributes_locations_items
query_get_trip_oneOf_0_data_attributes_statistics
Fields
| Field Name | Description |
|---|---|
distance_in_m - Int
|
|
max_speed - Float
|
|
average_speed - Float
|
|
tow_away - Boolean
|
|
driver_badge_id - String
|
|
overspeed_distance_in_m - Int
|
|
overspeed_duration_in_s - Int
|
|
driving_duration_in_s - Int
|
|
idling_duration_in_s - Int
|
|
daytime_duration_in_s - Int
|
|
nb_harsh_acceleration - Int
|
|
nb_harsh_braking - Int
|
|
nb_harsh_cornering - Int
|
|
nb_overspeed - Int
|
|
nb_postprocessed_overspeed - Int
|
|
overconsumption_gap_percentage - Int
|
|
overemission_gap_percentage - Int
|
|
safety_score - Float
|
|
eco_driving_score - Float
|
|
overspeed_score - Float
|
|
fuel_efficiency_in_l_per_100_km - Float
|
|
fuel_estimation_in_ml - Int
|
|
co2_estimation_in_g - Int
|
|
start_weather_description - String
|
|
end_weather_description - String
|
|
start_weather_temperature - Float
|
|
end_weather_temperature - Float
|
|
start_weather_type_id - Int
|
|
end_weather_type_id - Int
|
|
end_mileage - Float
|
|
end_fuel_level_percent - Float
|
|
end_charge_level_percent - Float
|
|
electric_energy_consumption_in_kwh - Float
|
|
electric_energy_consumption_in_percent - Float
|
Example
{
"distance_in_m": 987,
"max_speed": 123.45,
"average_speed": 987.65,
"tow_away": false,
"driver_badge_id": "abc123",
"overspeed_distance_in_m": 123,
"overspeed_duration_in_s": 123,
"driving_duration_in_s": 987,
"idling_duration_in_s": 123,
"daytime_duration_in_s": 987,
"nb_harsh_acceleration": 123,
"nb_harsh_braking": 123,
"nb_harsh_cornering": 987,
"nb_overspeed": 987,
"nb_postprocessed_overspeed": 123,
"overconsumption_gap_percentage": 987,
"overemission_gap_percentage": 987,
"safety_score": 987.65,
"eco_driving_score": 123.45,
"overspeed_score": 987.65,
"fuel_efficiency_in_l_per_100_km": 987.65,
"fuel_estimation_in_ml": 123,
"co2_estimation_in_g": 123,
"start_weather_description": "xyz789",
"end_weather_description": "xyz789",
"start_weather_temperature": 123.45,
"end_weather_temperature": 987.65,
"start_weather_type_id": 987,
"end_weather_type_id": 987,
"end_mileage": 987.65,
"end_fuel_level_percent": 123.45,
"end_charge_level_percent": 987.65,
"electric_energy_consumption_in_kwh": 987.65,
"electric_energy_consumption_in_percent": 123.45
}
query_get_trip_oneOf_0_data_relationships
Fields
| Field Name | Description |
|---|---|
metadata - query_get_trip_oneOf_0_data_relationships_metadata
|
Example
{
"metadata": query_get_trip_oneOf_0_data_relationships_metadata
}
query_get_trip_oneOf_0_data_relationships_metadata
Fields
| Field Name | Description |
|---|---|
data - [query_get_trip_oneOf_0_data_relationships_metadata_data_items]
|
Example
{
"data": [
query_get_trip_oneOf_0_data_relationships_metadata_data_items
]
}
query_get_trip_oneOf_0_data_relationships_metadata_data_items
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
type - metadata_const
|
|
attributes - metadata_attributes
|
Example
{
"id": 4,
"type": "metadata",
"attributes": metadata_attributes
}
query_get_trip_oneOf_0_included_items
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - metadata_const!
|
|
attributes - metadata_attributes
|
Example
{
"id": "4",
"type": "metadata",
"attributes": metadata_attributes
}
query_post_v1_fleet_summaries_oneOf_0_data
Fields
| Field Name | Description |
|---|---|
type - fleet_summaries_const!
|
|
id - ID!
|
|
attributes - query_post_v1_fleet_summaries_oneOf_0_data_attributes!
|
Example
{
"type": "fleet_summaries",
"id": "4",
"attributes": query_post_v1_fleet_summaries_oneOf_0_data_attributes
}
query_post_v1_fleet_summaries_oneOf_0_data_Input
Fields
| Input Field | Description |
|---|---|
type - fleet_summaries_const!
|
|
id - ID!
|
|
attributes - query_post_v1_fleet_summaries_oneOf_0_data_attributes_Input!
|
Example
{
"type": "fleet_summaries",
"id": "4",
"attributes": query_post_v1_fleet_summaries_oneOf_0_data_attributes_Input
}
query_post_v1_fleet_summaries_oneOf_0_data_attributes
Fields
| Field Name | Description |
|---|---|
fleets - [va_query_post_v1_fleet_summaries_oneOf_0_data_attributes_fleets_items]!
|
Example
{
"fleets": [
va_query_post_v1_fleet_summaries_oneOf_0_data_attributes_fleets_items
]
}
query_post_v1_fleet_summaries_oneOf_0_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
fleets - [query_post_v1_fleet_summaries_oneOf_0_data_attributes_fleets_items_Input]!
|
Example
{
"fleets": [
query_post_v1_fleet_summaries_oneOf_0_data_attributes_fleets_items_Input
]
}
query_post_v1_fleet_summaries_oneOf_0_data_attributes_fleets_items_Input
Fields
| Input Field | Description |
|---|---|
from_date - DateTime
|
|
to_date - DateTime
|
|
group_id - ID!
|
|
stats - query_post_v1_fleet_summaries_oneOf_0_data_attributes_fleets_items_stats_Input
|
Example
{
"from_date": "2007-12-03T10:15:30Z",
"to_date": "2007-12-03T10:15:30Z",
"group_id": "4",
"stats": query_post_v1_fleet_summaries_oneOf_0_data_attributes_fleets_items_stats_Input
}
query_post_v1_fleet_summaries_oneOf_0_data_attributes_fleets_items_stats
query_post_v1_fleet_summaries_oneOf_0_data_attributes_fleets_items_stats_Input
query_request_setup_status_data_attributes
Fields
| Field Name | Description |
|---|---|
cloud_connection - setup_status!
|
|
configuration - setup_status!
|
|
gnss - setup_status!
|
|
stable_power_supply - setup_status!
|
|
multistacks - setup_status!
|
|
multistacks_data - setup_status!
|
Example
{
"cloud_connection": "UNKNOWN",
"configuration": "UNKNOWN",
"gnss": "UNKNOWN",
"stable_power_supply": "UNKNOWN",
"multistacks": "UNKNOWN",
"multistacks_data": "UNKNOWN"
}
query_revcodes_oneOf_0_data_attributes
Fields
| Field Name | Description |
|---|---|
addresses - [query_revcodes_oneOf_0_data_attributes_addresses_items]!
|
Example
{
"addresses": [
query_revcodes_oneOf_0_data_attributes_addresses_items
]
}
query_revcodes_oneOf_0_data_attributes_addresses_items
Example
{
"country_code": "abc123",
"country": "abc123",
"state": "xyz789",
"county": "abc123",
"city": "abc123",
"postal_code": "xyz789",
"road_number": "xyz789",
"street": "abc123",
"street_number": "abc123",
"district": "xyz789"
}
query_schedules_data_items_attributes_week_days
Fields
| Field Name | Description |
|---|---|
monday - [time_slot]
|
|
tuesday - [time_slot]
|
|
wednesday - [time_slot]
|
|
thursday - [time_slot]
|
|
friday - [time_slot]
|
|
saturday - [time_slot]
|
|
sunday - [time_slot]
|
Example
{
"monday": [time_slot],
"tuesday": [time_slot],
"wednesday": [time_slot],
"thursday": [time_slot],
"friday": [time_slot],
"saturday": [time_slot],
"sunday": [time_slot]
}
query_sso_user_oneOf_0_data
Fields
| Field Name | Description |
|---|---|
type - users_const!
|
|
id - ID
|
|
attributes - query_sso_user_oneOf_0_data_attributes!
|
Example
{
"type": "users",
"id": "4",
"attributes": query_sso_user_oneOf_0_data_attributes
}
query_sso_user_oneOf_0_data_attributes
query_trip_harshes_data_items_attributes_kind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"left_cornering"
query_user_data_Input
Fields
| Input Field | Description |
|---|---|
type - users_const!
|
|
id - String
|
|
attributes - query_user_data_attributes_Input!
|
Example
{
"type": "users",
"id": "xyz789",
"attributes": query_user_data_attributes_Input
}
query_user_data_attributes_Input
Fields
| Input Field | Description |
|---|---|
uid - String!
|
|
full_name - String
|
|
role - query_user_data_attributes_role!
|
Example
{
"uid": "abc123",
"full_name": "abc123",
"role": "user"
}
query_user_data_attributes_role
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"user"
query_vehicles_refills_oneOf_0_data_items_attributes
Example
{
"product": "abc123",
"quantity": 987.65,
"amount_net": 987.65,
"amount_gross": 987.65,
"mileage": 123.45,
"currency": "xyz789",
"event_time": "abc123"
}
query_vehicles_refills_oneOf_0_data_items_relationships_additionalProperties
Fields
| Field Name | Description |
|---|---|
links - query_vehicles_refills_oneOf_0_data_items_relationships_additionalProperties_links!
|
Example
{
"links": query_vehicles_refills_oneOf_0_data_items_relationships_additionalProperties_links
}
query_vehicles_refills_oneOf_0_data_items_relationships_additionalProperties_entry
Fields
| Field Name | Description |
|---|---|
key - ID!
|
|
value - query_vehicles_refills_oneOf_0_data_items_relationships_additionalProperties
|
Example
{
"key": 4,
"value": query_vehicles_refills_oneOf_0_data_items_relationships_additionalProperties
}
query_vehicles_refills_oneOf_0_data_items_relationships_additionalProperties_links
Fields
| Field Name | Description |
|---|---|
related - String!
|
Example
{"related": "xyz789"}
query_vehicles_summary_oneOf_0_data_attributes
Example
{
"quantity": 987.65,
"amount_gross": 987.65,
"amount_net": 123.45,
"products": ["xyz789"],
"per_product_quantity": [123.45],
"per_product_amount_net": [987.65],
"per_product_amount_gross": [123.45]
}
query_video_segment_data_attributes
Fields
| Field Name | Description |
|---|---|
imei - String!
|
|
referenced_event_id - String
|
|
name - String!
|
|
description - String
|
|
start_time - DateTime!
|
|
end_time - DateTime!
|
|
storage_status - video_segment_storage_status
|
|
referenced_event_kind - video_segment_referenced_event_kind
|
|
thumbnail_url - String
|
|
available_lenses - [dashcam_lens]
|
|
download_progress - Int
|
Example
{
"imei": "abc123",
"referenced_event_id": "xyz789",
"name": "abc123",
"description": "abc123",
"start_time": "2007-12-03T10:15:30Z",
"end_time": "2007-12-03T10:15:30Z",
"storage_status": "pending",
"referenced_event_kind": "Overspeed",
"thumbnail_url": "xyz789",
"available_lenses": ["front"],
"download_progress": 123
}
refill_paged
Fields
| Field Name | Description |
|---|---|
data - [data_fusion_refill]!
|
|
meta - meta!
|
|
links - links_for_paginated
|
Example
{
"data": [data_fusion_refill],
"meta": meta,
"links": links_for_paginated
}
refills_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"refills"
relationships
Fields
| Field Name | Description |
|---|---|
additionalProperties - [query_vehicles_refills_oneOf_0_data_items_relationships_additionalProperties_entry]
|
Example
{
"additionalProperties": [
query_vehicles_refills_oneOf_0_data_items_relationships_additionalProperties_entry
]
}
renewToken_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"renewToken"
report_attributes
Fields
| Field Name | Description |
|---|---|
group_id - ID
|
|
imei - ID
|
|
label - String
|
|
start_time - DateTime!
|
|
end_time - DateTime!
|
|
timezone - timezone
|
|
kind - report_kind!
|
|
status - report_status!
|
|
url - URL
|
|
xlsx_url - URL
|
|
progress - NonNegativeInt
|
Example
{
"group_id": 4,
"imei": "4",
"label": "abc123",
"start_time": "2007-12-03T10:15:30Z",
"end_time": "2007-12-03T10:15:30Z",
"timezone": "Africa_Abidjan",
"kind": "trips",
"status": "pending",
"url": "http://www.test.com/",
"xlsx_url": "http://www.test.com/",
"progress": 123
}
report_attributes_post_Input
report_encapsulated
Fields
| Field Name | Description |
|---|---|
data - journey_report!
|
Example
{"data": journey_report}
report_encapsulated_post_Input
Fields
| Input Field | Description |
|---|---|
data - report_post_Input!
|
Example
{"data": report_post_Input}
report_kind
Description
Report kind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"trips"
report_paginated
Fields
| Field Name | Description |
|---|---|
data - [journey_report]!
|
|
meta - meta!
|
Example
{
"data": [journey_report],
"meta": meta
}
report_post_Input
Fields
| Input Field | Description |
|---|---|
type - reports_const!
|
|
attributes - report_attributes_post_Input!
|
Example
{
"type": "reports",
"attributes": report_attributes_post_Input
}
report_response
Types
| Union Types |
|---|
Example
report_encapsulated
report_status
Description
Report status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"pending"
reports_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"reports"
reports_response
Types
| Union Types |
|---|
Example
report_paginated
request_origin
Description
Indicates the origin of the request, such as whether it was initiated by a api, bluetooth or system.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"api"
request_setup_status
Fields
| Field Name | Description |
|---|---|
type - setup_statuses_const!
|
|
id - ID!
|
|
attributes - query_request_setup_status_data_attributes!
|
Example
{
"type": "setup_statuses",
"id": "4",
"attributes": query_request_setup_status_data_attributes
}
request_setup_status_show
Fields
| Field Name | Description |
|---|---|
data - request_setup_status
|
Example
{"data": request_setup_status}
revcode_create_Input
Fields
| Input Field | Description |
|---|---|
data - revcode_post_Input!
|
Example
{"data": revcode_post_Input}
revcode_get
Fields
| Field Name | Description |
|---|---|
type - revcodes_const!
|
|
id - ID!
|
|
attributes - query_revcodes_oneOf_0_data_attributes!
|
|
links - links_for_resource
|
Example
{
"type": "revcodes",
"id": 4,
"attributes": query_revcodes_oneOf_0_data_attributes,
"links": links_for_resource
}
revcode_post_Input
Fields
| Input Field | Description |
|---|---|
type - revcodes_const!
|
|
attributes - queryInput_revcodes_input_data_attributes_Input!
|
Example
{
"type": "revcodes",
"attributes": queryInput_revcodes_input_data_attributes_Input
}
revcode_show
Fields
| Field Name | Description |
|---|---|
data - revcode_get!
|
Example
{"data": revcode_get}
revcodes_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"revcodes"
revcodes_response
Types
| Union Types |
|---|
Example
revcode_show
schedule_create_Input
Fields
| Input Field | Description |
|---|---|
data - schedule_input_Input!
|
Example
{"data": schedule_input_Input}
schedule_input_Input
Fields
| Input Field | Description |
|---|---|
type - schedules_const!
|
|
attributes - mutationInput_post_schedules_input_data_attributes_Input!
|
Example
{
"type": "schedules",
"attributes": mutationInput_post_schedules_input_data_attributes_Input
}
schedule_input_with_id_Input
Fields
| Input Field | Description |
|---|---|
type - schedules_const!
|
|
id - String!
|
|
attributes - mutationInput_put_schedule_input_data_attributes_Input!
|
Example
{
"type": "schedules",
"id": "xyz789",
"attributes": mutationInput_put_schedule_input_data_attributes_Input
}
schedule_paginated
Fields
| Field Name | Description |
|---|---|
data - [geofence_schedule]!
|
|
meta - meta!
|
Example
{
"data": [geofence_schedule],
"meta": meta
}
schedule_show
Fields
| Field Name | Description |
|---|---|
data - geofence_schedule!
|
Example
{"data": geofence_schedule}
schedule_update_Input
Fields
| Input Field | Description |
|---|---|
data - schedule_input_with_id_Input!
|
Example
{"data": schedule_input_with_id_Input}
schedules_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"schedules"
setup_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
setup_statuses_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"setup_statuses"
shape_create_Input
Fields
| Input Field | Description |
|---|---|
data - shape_input_Input!
|
Example
{"data": shape_input_Input}
shape_input_Input
Fields
| Input Field | Description |
|---|---|
type - shapes_const!
|
|
attributes - mutationInput_post_shapes_input_data_attributes_Input!
|
Example
{
"type": "shapes",
"attributes": mutationInput_post_shapes_input_data_attributes_Input
}
shape_input_with_id_Input
Fields
| Input Field | Description |
|---|---|
type - shapes_const!
|
|
id - String!
|
|
attributes - mutationInput_put_shape_input_data_attributes_Input!
|
Example
{
"type": "shapes",
"id": "xyz789",
"attributes": mutationInput_put_shape_input_data_attributes_Input
}
shape_paginated
Fields
| Field Name | Description |
|---|---|
data - [geofence_shape]!
|
|
meta - meta!
|
Example
{
"data": [geofence_shape],
"meta": meta
}
shape_show
Fields
| Field Name | Description |
|---|---|
data - geofence_shape!
|
Example
{"data": geofence_shape}
shape_update_Input
Fields
| Input Field | Description |
|---|---|
data - shape_input_with_id_Input!
|
Example
{"data": shape_input_with_id_Input}
shapes_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"shapes"
sso_organization
Fields
| Field Name | Description |
|---|---|
type - organizations_const!
|
|
id - ID!
|
|
attributes - organization_attributes!
|
Example
{
"type": "organizations",
"id": "4",
"attributes": organization_attributes
}
sso_user_response
summary_attributes
Fields
| Field Name | Description |
|---|---|
distance_in_m - Int
|
|
driving_duration_in_s - Int
|
|
idling_duration_in_s - Int
|
|
daytime_duration_in_s - Int
|
|
safety_score - Float
|
|
eco_driving_score - Float
|
|
overspeed_score - Float
|
|
fuel_efficiency_in_l_per_100_km - Float
|
|
fuel_estimation_in_ml - Int
|
|
nb_device_active - Int
|
|
nb_journeys - Int
|
|
nb_driving_days - Int
|
|
co2_estimation_in_g - Int
|
|
electric_energy_consumption_in_kwh - Float
|
|
electric_energy_consumption_in_percent - Float
|
|
end_mileage - Float
|
|
end_mileage_date - DateTime
|
|
end_fuel_level_percent - Float
|
|
end_fuel_level_percent_date - DateTime
|
|
end_charge_level_percent - Float
|
|
end_charge_level_percent_date - DateTime
|
Example
{
"distance_in_m": 123,
"driving_duration_in_s": 123,
"idling_duration_in_s": 987,
"daytime_duration_in_s": 987,
"safety_score": 987.65,
"eco_driving_score": 987.65,
"overspeed_score": 987.65,
"fuel_efficiency_in_l_per_100_km": 123.45,
"fuel_estimation_in_ml": 123,
"nb_device_active": 987,
"nb_journeys": 123,
"nb_driving_days": 123,
"co2_estimation_in_g": 987,
"electric_energy_consumption_in_kwh": 123.45,
"electric_energy_consumption_in_percent": 987.65,
"end_mileage": 987.65,
"end_mileage_date": "2007-12-03T10:15:30Z",
"end_fuel_level_percent": 987.65,
"end_fuel_level_percent_date": "2007-12-03T10:15:30Z",
"end_charge_level_percent": 987.65,
"end_charge_level_percent_date": "2007-12-03T10:15:30Z"
}
time_slot
time_slot_Input
timezone
Description
Timezone in tz database format
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Africa_Abidjan"
toggles_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"toggles"
trip_attributes
Fields
| Field Name | Description |
|---|---|
imei - ID!
|
|
start_latitude - Float
|
|
start_longitude - Float
|
|
end_latitude - Float
|
|
end_longitude - Float
|
|
driving_duration_in_seconds - Float
|
|
idling_duration_in_seconds - Float
|
|
max_idling_duration_in_seconds - Float
|
|
driving_percentage - Float
|
|
idling_percentage - Float
|
|
state - trip_state
|
|
start_time - DateTime!
|
|
end_time - DateTime!
|
|
duration_in_seconds - Int
|
|
start_postal_address - postal_address
|
|
end_postal_address - postal_address
|
|
statistics - query_get_trip_oneOf_0_data_attributes_statistics
|
Example
{
"imei": "4",
"start_latitude": 123.45,
"start_longitude": 987.65,
"end_latitude": 987.65,
"end_longitude": 123.45,
"driving_duration_in_seconds": 987.65,
"idling_duration_in_seconds": 987.65,
"max_idling_duration_in_seconds": 123.45,
"driving_percentage": 987.65,
"idling_percentage": 123.45,
"state": "closed",
"start_time": "2007-12-03T10:15:30Z",
"end_time": "2007-12-03T10:15:30Z",
"duration_in_seconds": 987,
"start_postal_address": postal_address,
"end_postal_address": postal_address,
"statistics": query_get_trip_oneOf_0_data_attributes_statistics
}
trip_harsh_encapsulated
Fields
| Field Name | Description |
|---|---|
data - journey_trip_harsh!
|
Example
{"data": journey_trip_harsh}
trip_idling_encapsulated
Fields
| Field Name | Description |
|---|---|
data - journey_trip_idling!
|
Example
{"data": journey_trip_idling}
trip_idlings_response
Types
| Union Types |
|---|
Example
journey_trip_idling_paginated
trip_overspeed_encapsulated
Fields
| Field Name | Description |
|---|---|
data - journey_trip_overspeed!
|
Example
{"data": journey_trip_overspeed}
trip_overspeeds_response
Types
| Union Types |
|---|
Example
journey_trip_overspeed_paginated
trip_state
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"closed"
trip_tag
Values
| Enum Value | Description |
|---|---|
|
|
Example
"user_private"
trip_tag_schedule_attributes
Fields
| Field Name | Description |
|---|---|
week_days - mutation_post_trip_tag_schedules_oneOf_0_data_attributes_week_days
|
|
name - String!
|
|
tags - [trip_tag]!
|
|
timezone - timezone
|
|
outside_of_slots - Boolean
|
|
start_at - DateTime
|
|
end_at - DateTime
|
|
active - Boolean
|
|
created_at - DateTime
|
|
updated_at - DateTime
|
Example
{
"week_days": mutation_post_trip_tag_schedules_oneOf_0_data_attributes_week_days,
"name": "abc123",
"tags": ["user_private"],
"timezone": "Africa_Abidjan",
"outside_of_slots": false,
"start_at": "2007-12-03T10:15:30Z",
"end_at": "2007-12-03T10:15:30Z",
"active": true,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
trip_tag_schedule_attributes_post_Input
Fields
| Input Field | Description |
|---|---|
week_days - mutationInput_post_trip_tag_schedules_input_data_attributes_week_days_Input
|
|
name - String!
|
|
tags - [trip_tag]!
|
|
timezone - timezone
|
|
outside_of_slots - Boolean
|
|
start_at - DateTime
|
|
end_at - DateTime
|
|
active - Boolean
|
Example
{
"week_days": mutationInput_post_trip_tag_schedules_input_data_attributes_week_days_Input,
"name": "abc123",
"tags": ["user_private"],
"timezone": "Africa_Abidjan",
"outside_of_slots": true,
"start_at": "2007-12-03T10:15:30Z",
"end_at": "2007-12-03T10:15:30Z",
"active": true
}
trip_tag_schedule_encapsulated
Fields
| Field Name | Description |
|---|---|
data - journey_trip_tag_schedule!
|
Example
{"data": journey_trip_tag_schedule}
trip_tag_schedule_encapsulated_post_Input
Fields
| Input Field | Description |
|---|---|
data - trip_tag_schedule_post_Input!
|
Example
{"data": trip_tag_schedule_post_Input}
trip_tag_schedule_encapsulated_put_Input
Fields
| Input Field | Description |
|---|---|
data - trip_tag_schedule_put_Input!
|
Example
{"data": trip_tag_schedule_put_Input}
trip_tag_schedule_paginated
Fields
| Field Name | Description |
|---|---|
data - [journey_trip_tag_schedule]!
|
|
meta - meta!
|
Example
{
"data": [journey_trip_tag_schedule],
"meta": meta
}
trip_tag_schedule_post_Input
Fields
| Input Field | Description |
|---|---|
type - trip_tag_schedules_const!
|
|
attributes - trip_tag_schedule_attributes_post_Input!
|
|
relationships - mutationInput_post_trip_tag_schedules_input_data_relationships_Input!
|
Example
{
"type": "trip_tag_schedules",
"attributes": trip_tag_schedule_attributes_post_Input,
"relationships": mutationInput_post_trip_tag_schedules_input_data_relationships_Input
}
trip_tag_schedule_put_Input
Fields
| Input Field | Description |
|---|---|
type - trip_tag_schedules_const!
|
|
id - ID
|
|
attributes - trip_tag_schedule_put_attributes_Input!
|
Example
{
"type": "trip_tag_schedules",
"id": 4,
"attributes": trip_tag_schedule_put_attributes_Input
}
trip_tag_schedule_put_attributes_Input
Example
{
"outside_of_slots": false,
"active": false,
"timezone": "Africa_Abidjan",
"start_at": "2007-12-03T10:15:30Z",
"end_at": "2007-12-03T10:15:30Z",
"week_days": mutationInput_update_trip_tag_schedule_input_data_attributes_week_days_Input
}
trip_tag_schedules_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"trip_tag_schedules"
trips_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"trips"
user
Fields
| Field Name | Description |
|---|---|
data - query_sso_user_oneOf_0_data!
|
Example
{"data": query_sso_user_oneOf_0_data}
user_Input
Fields
| Input Field | Description |
|---|---|
data - query_user_data_Input
|
Example
{"data": query_user_data_Input}
user_alert_notifications_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"user_alert_notifications"
user_role_paginated
Fields
| Field Name | Description |
|---|---|
data - [am_user_role]!
|
|
meta - meta
|
Example
{
"data": [am_user_role],
"meta": meta
}
user_roles_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"user_roles"
user_unlock_create_Input
Fields
| Input Field | Description |
|---|---|
data - user_unlock_input_Input!
|
Example
{"data": user_unlock_input_Input}
user_unlock_input_Input
Fields
| Input Field | Description |
|---|---|
type - user_unlocks_const!
|
|
id - ID
|
|
attributes - mutationInput_post_user_unlocks_input_data_attributes_Input!
|
Example
{
"type": "user_unlocks",
"id": 4,
"attributes": mutationInput_post_user_unlocks_input_data_attributes_Input
}
user_unlock_request
Fields
| Field Name | Description |
|---|---|
type - user_unlocks_const!
|
|
id - ID!
|
Example
{"type": "user_unlocks", "id": 4}
user_unlock_request_create_Input
Fields
| Input Field | Description |
|---|---|
data - user_unlock_request_input_Input!
|
Example
{"data": user_unlock_request_input_Input}
user_unlock_request_identifier
Description
email or phone
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"email"
user_unlock_request_input_Input
Fields
| Input Field | Description |
|---|---|
type - user_unlock_requests_const!
|
|
id - ID
|
|
attributes - mutationInput_post_user_unlock_requests_input_data_attributes_Input!
|
Example
{
"type": "user_unlock_requests",
"id": 4,
"attributes": mutationInput_post_user_unlock_requests_input_data_attributes_Input
}
user_unlock_request_show
Fields
| Field Name | Description |
|---|---|
data - user_unlock_request!
|
Example
{"data": user_unlock_request}
user_unlock_requests_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"user_unlock_requests"
user_unlock_show
Fields
| Field Name | Description |
|---|---|
data - String
|
Example
{"data": "abc123"}
user_unlocks_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"user_unlocks"
users_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"users"
va_fetch_user_alert_notification
Fields
| Field Name | Description |
|---|---|
type - user_alert_notifications_const
|
|
id - ID!
|
|
attributes - va_query_v1_user_alert_notifications_data_items_attributes
|
Example
{
"type": "user_alert_notifications",
"id": 4,
"attributes": va_query_v1_user_alert_notifications_data_items_attributes
}
va_query_post_v1_fleet_summaries_oneOf_0_data_attributes_fleets_items
Fields
| Field Name | Description |
|---|---|
from_date - DateTime
|
|
to_date - DateTime
|
|
group_id - ID!
|
|
stats - query_post_v1_fleet_summaries_oneOf_0_data_attributes_fleets_items_stats!
|
Example
{
"from_date": "2007-12-03T10:15:30Z",
"to_date": "2007-12-03T10:15:30Z",
"group_id": 4,
"stats": query_post_v1_fleet_summaries_oneOf_0_data_attributes_fleets_items_stats
}
va_query_v1_user_alert_notifications_data_items_attributes
Fields
| Field Name | Description |
|---|---|
uid - ID!
|
|
type_of_alert - geofencing_const!
|
|
geofencing - va_query_v1_user_alert_notifications_data_items_attributes_geofencing
|
Example
{
"uid": 4,
"type_of_alert": "geofencing",
"geofencing": va_query_v1_user_alert_notifications_data_items_attributes_geofencing
}
va_query_v1_user_alert_notifications_data_items_attributes_geofencing
Fields
| Field Name | Description |
|---|---|
event_type - geofence_event_type
|
|
geofence_id - ID!
|
|
should_verify_stay - Boolean
|
|
duration_in_seconds - Int
|
duration in seconds |
Example
{
"event_type": "ENTRY",
"geofence_id": "4",
"should_verify_stay": false,
"duration_in_seconds": 987
}
vehicle_auxiliary_devices_response
Types
| Union Types |
|---|
Example
auxiliary_device_paginated
vehicle_driver_paginated
Fields
| Field Name | Description |
|---|---|
data - [am_vehicle_driver]!
|
|
meta - meta!
|
Example
{
"data": [am_vehicle_driver],
"meta": meta
}
vehicle_driver_relationship_Input
Fields
| Input Field | Description |
|---|---|
data - [mutationInput_add_vehicle_authorized_drivers_input_data_items_Input]
|
Example
{
"data": [
mutationInput_add_vehicle_authorized_drivers_input_data_items_Input
]
}
vehicle_relationship_Input
Fields
| Input Field | Description |
|---|---|
data - [mutationInput_add_driver_authorized_vehicles_input_data_items_Input]
|
Example
{
"data": [
mutationInput_add_driver_authorized_vehicles_input_data_items_Input
]
}
vehicle_summaries_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"vehicle_summaries"
vehicle_summary
Fields
| Field Name | Description |
|---|---|
type - vehicle_summaries_const!
|
|
id - ID!
|
|
attributes - query_vehicles_summary_oneOf_0_data_attributes!
|
|
links - links_for_resource
|
|
relationships - relationships
|
Example
{
"type": "vehicle_summaries",
"id": "4",
"attributes": query_vehicles_summary_oneOf_0_data_attributes,
"links": links_for_resource,
"relationships": relationships
}
vehicle_summary_show
Fields
| Field Name | Description |
|---|---|
data - vehicle_summary!
|
Example
{"data": vehicle_summary}
vehicles_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"vehicles"
vehicles_refills_response
Types
| Union Types |
|---|
Example
refill_paged
vehicles_summary_response
Types
| Union Types |
|---|
Example
vehicle_summary_show
video_segment
Fields
| Field Name | Description |
|---|---|
type - video_segments_const!
|
|
id - String!
|
|
attributes - query_video_segment_data_attributes!
|
|
links - JSON
|
|
relationships - JSON
|
|
video_files - dashcam_file_paged
|
|
Arguments
|
|
Example
{
"type": "video_segments",
"id": "xyz789",
"attributes": query_video_segment_data_attributes,
"links": {},
"relationships": {},
"video_files": dashcam_file_paged
}
video_segment_action_Input
Fields
| Input Field | Description |
|---|---|
download - Boolean
|
Whether to download the video segment |
Example
{"download": false}
video_segment_create_Input
Fields
| Input Field | Description |
|---|---|
data - video_segment_post_input_Input!
|
Example
{"data": video_segment_post_input_Input}
video_segment_paged
Fields
| Field Name | Description |
|---|---|
data - [video_segment]!
|
|
meta - meta!
|
|
links - JSON
|
Example
{
"data": [video_segment],
"meta": meta,
"links": {}
}
video_segment_post_input_Input
Fields
| Input Field | Description |
|---|---|
type - video_segments_const!
|
|
attributes - mutationInput_post_video_segments_input_data_attributes_Input!
|
Example
{
"type": "video_segments",
"attributes": mutationInput_post_video_segments_input_data_attributes_Input
}
video_segment_put_input_Input
Fields
| Input Field | Description |
|---|---|
type - video_segments_const!
|
|
id - String!
|
|
attributes - mutationInput_put_video_segment_input_data_attributes_Input!
|
Example
{
"type": "video_segments",
"id": "xyz789",
"attributes": mutationInput_put_video_segment_input_data_attributes_Input
}
video_segment_referenced_event_kind
Description
Filter by referenced_event_kind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Overspeed"
video_segment_show
Fields
| Field Name | Description |
|---|---|
data - video_segment!
|
Example
{"data": video_segment}
video_segment_storage_status
Description
Filter by storage_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"pending"
video_segment_update_Input
Fields
| Input Field | Description |
|---|---|
data - video_segment_put_input_Input!
|
Example
{"data": video_segment_put_input_Input}
video_segments_const
Values
| Enum Value | Description |
|---|---|
|
|
Example
"video_segments"