Munic GraphQL API
Exploring the API
- Learn about GraphQL itself.
- Use the web client for quick API experiments.
- View the schema as a visual graph.
- Connect your app to this API endpoint
- Download the schema definition
- Check the API version and status
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.
Pagination
Data that is potentially to big for a single reply gets split into pages, that can be queried one at a time.
Paginated data is an object with count, next, and list fields:
listcontains the actual elements.countis the total number of elements over all pages. It may be unknown (null).nextis an opaque id to fetch the next page of data in another query. It is null for the last page.- Some simple-but-large paginated data like battery readings use multiple
foo: [SimpleType]fields instead a singlelist: [ComplexType]field, to reduce network/parsing overhead.
Queries returning paginated data take one of these arguments:
page_size, the default and max value depends on the queried data.page_id, copied from thenextfield of a previous query.
Support
Queries
account
Description
Get account info
Response
Returns an Account
Arguments
| Name | Description |
|---|---|
id - ID
|
Account id. Defaults to logged-in user. |
Example
Query
query account($id: ID) {
account(id: $id) {
id
organizationId
email
phone
fullName
shortName
companyName
countryCode
language
timeZone
createdAt
updatedAt
lastSignInAt
confirmedAt
descriptions {
...DescriptionPagedFragment
}
roles {
...AccountRoleFragment
}
groups {
...GroupPagedFragment
}
devices {
...DevicePagedFragment
}
vehicles {
...VehiclePagedFragment
}
drivers {
...DriverPagedFragment
}
driverProfiles {
...DriverPagedFragment
}
driverContacts {
...DriverPagedFragment
}
workshops {
...WorkshopPagedFragment
}
distributors {
...OnboardingDistributorPagedFragment
}
alertPreference {
...AlertPreferenceFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"account": {
"id": "4",
"organizationId": "4",
"email": "xyz789",
"phone": "abc123",
"fullName": "xyz789",
"shortName": "abc123",
"companyName": "xyz789",
"countryCode": "abc123",
"language": Language,
"timeZone": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"lastSignInAt": "2007-12-03T10:15:30Z",
"confirmedAt": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"roles": [AccountRole],
"groups": GroupPaged,
"devices": DevicePaged,
"vehicles": VehiclePaged,
"drivers": DriverPaged,
"driverProfiles": DriverPaged,
"driverContacts": DriverPaged,
"workshops": WorkshopPaged,
"distributors": OnboardingDistributorPaged,
"alertPreference": AlertPreference
}
}
}
accounts
Description
List accounts
Response
Returns an AccountPaged
Example
Query
query accounts(
$pageSize: Int,
$pageId: ID,
$ids: [ID!],
$email: String,
$fullName: String,
$shortName: String,
$phone: String
) {
accounts(
pageSize: $pageSize,
pageId: $pageId,
ids: $ids,
email: $email,
fullName: $fullName,
shortName: $shortName,
phone: $phone
) {
next
count
list {
...AccountFragment
}
}
}
Variables
{
"pageSize": 987,
"pageId": "4",
"ids": ["4"],
"email": "abc123",
"fullName": "abc123",
"shortName": "abc123",
"phone": "xyz789"
}
Response
{
"data": {
"accounts": {
"next": "4",
"count": 987,
"list": [Account]
}
}
}
alertFeedbacks
Description
List alert feedbacks
Response
Returns a VehicleAlertFeedbackPaged
Arguments
| Name | Description |
|---|---|
pageSize - Int
|
Results per page (initial query) |
pageId - ID
|
Request page id (followup queries) |
alertIds - [ID!]
|
Filter by alert ids |
language - LangArg
|
Filter by feedback language |
status - VehicleAlertFeedbackStatusArg
|
Filter by feedback status |
Example
Query
query alertFeedbacks(
$pageSize: Int,
$pageId: ID,
$alertIds: [ID!],
$language: LangArg,
$status: VehicleAlertFeedbackStatusArg
) {
alertFeedbacks(
pageSize: $pageSize,
pageId: $pageId,
alertIds: $alertIds,
language: $language,
status: $status
) {
next
count
list {
...VehicleAlertFeedbackFragment
}
}
}
Variables
{
"pageSize": 987,
"pageId": 4,
"alertIds": ["4"],
"language": "EN",
"status": "NO"
}
Response
{
"data": {
"alertFeedbacks": {
"next": 4,
"count": 987,
"list": [VehicleAlertFeedback]
}
}
}
alertTemplate
Description
Get template
Response
Returns an AlertTemplate
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query alertTemplate($id: ID!) {
alertTemplate(id: $id) {
id
name
version
contentType
defaultContext
locked
channelName
createdAt
updatedAt
definition
attachments {
...AlertAttachmentPagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"alertTemplate": {
"id": "4",
"name": "xyz789",
"version": "xyz789",
"contentType": "TEXT",
"defaultContext": Json,
"locked": false,
"channelName": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"definition": "xyz789",
"attachments": AlertAttachmentPaged
}
}
}
alertTemplates
Description
List templates
Response
Returns an AlertTemplatePaged
Example
Query
query alertTemplates(
$pageSize: Int,
$pageId: ID
) {
alertTemplates(
pageSize: $pageSize,
pageId: $pageId
) {
next
count
list {
...AlertTemplateFragment
}
}
}
Variables
{"pageSize": 123, "pageId": 4}
Response
{
"data": {
"alertTemplates": {
"next": "4",
"count": 123,
"list": [AlertTemplate]
}
}
}
alpr
Description
Recognize plate from image
Response
Returns an Alpr
Arguments
| Name | Description |
|---|---|
vehiclePicture - String!
|
vehicle picture type String and required / value in 64b and supports jpg,jpeg,png ... except GIF |
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 … |
year - Int
|
vehicle manufacturing year type integer and optional / supported value are a valid year such as 1990,2001,2009 ... |
Example
Query
query alpr(
$vehiclePicture: String!,
$country: String!,
$region: String,
$year: Int
) {
alpr(
vehiclePicture: $vehiclePicture,
country: $country,
region: $region,
year: $year
) {
vehicle {
...VehicleInfoFragment
}
plate {
...PlateFragment
}
}
}
Variables
{
"vehiclePicture": "xyz789",
"country": "abc123",
"region": "abc123",
"year": 987
}
Response
{
"data": {
"alpr": {
"vehicle": VehicleInfo,
"plate": Plate
}
}
}
booking
Description
Get booking by ID
Example
Query
query booking($id: ID!) {
booking(id: $id) {
id
plateNumber
bookingDate
status
quotationIds
workshop {
...WorkshopFragment
}
vehicleMake
vehicleModel
vehicleYear
vin
city
country
additionalInformation
preferredLanguage
contactMethod
userEmail
userName
userPhoneNumber
}
}
Variables
{"id": "4"}
Response
{
"data": {
"booking": {
"id": "4",
"plateNumber": "abc123",
"bookingDate": "2007-12-03T10:15:30Z",
"status": "PENDING",
"quotationIds": [4],
"workshop": Workshop,
"vehicleMake": "abc123",
"vehicleModel": "xyz789",
"vehicleYear": "xyz789",
"vin": "xyz789",
"city": "abc123",
"country": "xyz789",
"additionalInformation": "xyz789",
"preferredLanguage": Language,
"contactMethod": "SMS",
"userEmail": "abc123",
"userName": "xyz789",
"userPhoneNumber": "abc123"
}
}
}
bookings
Description
List Bookings
Response
Returns a BookingPaged
Example
Query
query bookings(
$pageSize: Int,
$pageId: ID
) {
bookings(
pageSize: $pageSize,
pageId: $pageId
) {
next
count
list {
...BookingFragment
}
}
}
Variables
{"pageSize": 123, "pageId": "4"}
Response
{
"data": {
"bookings": {
"next": 4,
"count": 123,
"list": [Booking]
}
}
}
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 |
|---|---|
scope - CacheScope
|
Cache scope (default LOGIN) |
ttl - Int
|
Time to live of future entries (default 5 seconds) |
extendTtl - Boolean
|
Wether cache hits extend the time to live (default false) |
saveSettings - Boolean
|
Wether settings should be applied for the duration of the SSO login (default true) |
softFlush - Boolean
|
Ignore old cache entries in the scope |
flush - Boolean
|
Remove all cache entries from the scope |
Example
Query
query cache(
$scope: CacheScope,
$ttl: Int,
$extendTtl: Boolean,
$saveSettings: Boolean,
$softFlush: Boolean,
$flush: Boolean
) {
cache(
scope: $scope,
ttl: $ttl,
extendTtl: $extendTtl,
saveSettings: $saveSettings,
softFlush: $softFlush,
flush: $flush
) {
scope
ttl
extendTtl
softFlush
}
}
Variables
{
"scope": "REQUEST",
"ttl": 123,
"extendTtl": false,
"saveSettings": false,
"softFlush": true,
"flush": true
}
Response
{
"data": {
"cache": {
"scope": "REQUEST",
"ttl": 987,
"extendTtl": false,
"softFlush": "abc123"
}
}
}
campaign
Temporary internal API
Example
Query
query campaign($id: ID!) {
campaign(id: $id) {
id
name
status
createdAt
devicesStatus {
...CampaignDeviceFragment
}
configurations
}
}
Variables
{"id": "4"}
Response
{
"data": {
"campaign": {
"id": 4,
"name": "abc123",
"status": "AVAILABLE_UPDATE",
"createdAt": "2007-12-03T10:15:30Z",
"devicesStatus": [CampaignDevice],
"configurations": [4]
}
}
}
campaigns
Temporary internal API
Response
Returns a CampaignPaged
Example
Query
query campaigns(
$pageSize: Int,
$pageId: ID,
$archived: Boolean
) {
campaigns(
pageSize: $pageSize,
pageId: $pageId,
archived: $archived
) {
next
count
list {
...CampaignFragment
}
}
}
Variables
{"pageSize": 123, "pageId": 4, "archived": true}
Response
{
"data": {
"campaigns": {
"next": 4,
"count": 987,
"list": [Campaign]
}
}
}
clientIdentifications
Description
List client identifications
Response
Returns a ClientIdentificationPaged
Example
Query
query clientIdentifications(
$pageSize: Int,
$pageId: ID,
$code: String,
$label: String,
$distributorId: ID,
$clientReference: ID,
$defaultAccountId: ID,
$usable: Boolean,
$revoked: Boolean
) {
clientIdentifications(
pageSize: $pageSize,
pageId: $pageId,
code: $code,
label: $label,
distributorId: $distributorId,
clientReference: $clientReference,
defaultAccountId: $defaultAccountId,
usable: $usable,
revoked: $revoked
) {
next
count
list {
...ClientIdentificationFragment
}
}
}
Variables
{
"pageSize": 987,
"pageId": "4",
"code": "xyz789",
"label": "xyz789",
"distributorId": "4",
"clientReference": 4,
"defaultAccountId": "4",
"usable": false,
"revoked": false
}
Response
{
"data": {
"clientIdentifications": {
"next": "4",
"count": 123,
"list": [ClientIdentification]
}
}
}
coverageBlacklists
Description
Parameter coverage info for a given type of vehicle
Response
Returns a CoverageBlacklistPaged
Example
Query
query coverageBlacklists(
$pageSize: Int,
$pageId: ID,
$ids: [ID!],
$makes: [String!],
$models: [String!],
$years: [Int!]
) {
coverageBlacklists(
pageSize: $pageSize,
pageId: $pageId,
ids: $ids,
makes: $makes,
models: $models,
years: $years
) {
next
count
list {
...CoverageBlacklistFragment
}
}
}
Variables
{
"pageSize": 123,
"pageId": "4",
"ids": [4],
"makes": ["xyz789"],
"models": ["abc123"],
"years": [123]
}
Response
{
"data": {
"coverageBlacklists": {
"next": "4",
"count": 987,
"list": [CoverageBlacklist]
}
}
}
coverageMakes
Response
Returns a CoverageMakePaged
Example
Query
query coverageMakes(
$pageSize: Int,
$pageId: ID,
$name: String
) {
coverageMakes(
pageSize: $pageSize,
pageId: $pageId,
name: $name
) {
next
count
list {
...CoverageMakeFragment
}
}
}
Variables
{
"pageSize": 123,
"pageId": "4",
"name": "xyz789"
}
Response
{
"data": {
"coverageMakes": {
"next": 4,
"count": 987,
"list": [CoverageMake]
}
}
}
coverageModels
Response
Returns a CoverageModelPaged
Example
Query
query coverageModels(
$pageSize: Int,
$pageId: ID,
$makes: [String!]
) {
coverageModels(
pageSize: $pageSize,
pageId: $pageId,
makes: $makes
) {
next
count
list {
...CoverageModelFragment
}
}
}
Variables
{
"pageSize": 123,
"pageId": "4",
"makes": ["abc123"]
}
Response
{
"data": {
"coverageModels": {
"next": "4",
"count": 987,
"list": [CoverageModel]
}
}
}
coverageVehicles
Description
Parameter coverage info for a given type of vehicle
Response
Returns a CoverageVehiclePaged
Arguments
| Name | Description |
|---|---|
pageSize - Int
|
Results per page (initial query) |
pageId - ID
|
Request page id (followup queries) |
ids - [ID!]
|
Filter by ids |
makes - [String!]
|
Filter by vehicle make |
models - [String!]
|
Filter by vehicle model |
years - [Int!]
|
Filter by vehicle year |
energyTypes - [CoverageEnergyTypeArg!]
|
Filter by vehicle energy type |
regions - [CoverageRegionArg!]
|
Filter by world region |
powertrain - CoveragePowertrainArg
|
Filter by powertrain |
vin - [String!]
|
Filter by VIN |
parameters - [String!]
|
Filter by covered parameters |
blacklisted - Boolean
|
Filter by blacklist status |
Example
Query
query coverageVehicles(
$pageSize: Int,
$pageId: ID,
$ids: [ID!],
$makes: [String!],
$models: [String!],
$years: [Int!],
$energyTypes: [CoverageEnergyTypeArg!],
$regions: [CoverageRegionArg!],
$powertrain: CoveragePowertrainArg,
$vin: [String!],
$parameters: [String!],
$blacklisted: Boolean
) {
coverageVehicles(
pageSize: $pageSize,
pageId: $pageId,
ids: $ids,
makes: $makes,
models: $models,
years: $years,
energyTypes: $energyTypes,
regions: $regions,
powertrain: $powertrain,
vin: $vin,
parameters: $parameters,
blacklisted: $blacklisted
) {
next
count
list {
...CoverageVehicleFragment
}
}
}
Variables
{
"pageSize": 987,
"pageId": "4",
"ids": [4],
"makes": ["abc123"],
"models": ["xyz789"],
"years": [987],
"energyTypes": ["DIESEL"],
"regions": ["EUROPE"],
"powertrain": "ICE",
"vin": ["xyz789"],
"parameters": ["xyz789"],
"blacklisted": true
}
Response
{
"data": {
"coverageVehicles": {
"next": "4",
"count": 123,
"list": [CoverageVehicle]
}
}
}
decodeDtcs
Description
Get list of dtc codes description & related informations
Response
Returns [Dtc]
Arguments
| Name | Description |
|---|---|
vin - String!
|
VIN of vehicle related to the codes |
codes - [String]!
|
List of DTC codes to be decoded |
protocol - DtcProtocol!
|
Protocol used for communicating with the vehicle |
region - DtcRegion!
|
Decoding region |
make - String
|
Vehicle's make |
language - Language
|
Decoded information display language |
oem - Boolean
|
Should be set to True, if codes are known to be oem specific. |
Example
Query
query decodeDtcs(
$vin: String!,
$codes: [String]!,
$protocol: DtcProtocol!,
$region: DtcRegion!,
$make: String,
$language: Language,
$oem: Boolean
) {
decodeDtcs(
vin: $vin,
codes: $codes,
protocol: $protocol,
region: $region,
make: $make,
language: $language,
oem: $oem
) {
id
code
description
subdescription
information
cause
effect
recommendation
warning
classification
mdiDtc
protocol
warningImg
systemCategory
riskSafety
riskDamage
riskAvailability
riskEmissions
}
}
Variables
{
"vin": "abc123",
"codes": ["abc123"],
"protocol": "OBD2",
"region": "EU",
"make": "xyz789",
"language": Language,
"oem": false
}
Response
{
"data": {
"decodeDtcs": [
{
"id": 4,
"code": "abc123",
"description": "xyz789",
"subdescription": "abc123",
"information": "abc123",
"cause": "xyz789",
"effect": "xyz789",
"recommendation": "xyz789",
"warning": "xyz789",
"classification": "abc123",
"mdiDtc": "xyz789",
"protocol": "xyz789",
"warningImg": "xyz789",
"systemCategory": "xyz789",
"riskSafety": "NO",
"riskDamage": "NO",
"riskAvailability": "NO",
"riskEmissions": "NO"
}
]
}
}
decodePlate
Description
Get list of vehicle descriptions by Plate & Country
Response
Returns [DecodeVinResult!]
Example
Query
query decodePlate(
$plate: String!,
$country: String!
) {
decodePlate(
plate: $plate,
country: $country
) {
id
vin
kba
kType
decodingRegion
dayOfFirstCirculation
dayOfSale
monthOfFirstCirculation
monthOfSale
yearOfFirstCirculation
yearOfSale
acceleration
advancedModel
bodyType
bodyTypeCode
brakesAbs
brakesFrontType
brakesRearType
brakesSystem
cargoCapacity
co2Emission
coEmission
color
companyId
country
critair
curbWeight
doors
driveType
electricVehicleBatteryCapacity
electricVehicleBatteryVoltage
emissionStandard
engineAspiration
engineBore
engineCode
engineConfiguration
engineCylinderHeadType
engineCylinders
engineDisplacement
engineExtra
engineFiscalPower
engineFuelType
engineFuelTypeSecondary
engineFuelTypeTertiary
engineIgnitionSystem
engineManufacturer
engineOutputPower
engineOutputPowerPs
engineRpmIdleMax
engineRpmIdleMin
engineRpmMax
engineStroke
engineValves
engineVersion
engineWithTurbo
extraInfo {
...VinExtraInfoFragment
}
frontOverhang
frontTrack
fuelEfficiencyCity
fuelEfficiencyCombined
fuelEfficiencyHighway
fuelInjectionControlType
fuelInjectionSubtype
fuelInjectionSystemDesign
fuelInjectionType
gearboxSpeed
gearboxType
grossWeight
hcEmission
hcNoxEmission
height
hipRoomFront
hipRoomRear
length
manufacturer
make
maxRoofLoad
maxTowBarDownload
maxTrailerLoadBLicense
maxTrailerLoadBraked12
maxTrailerLoadUnbraked
model
modelCode
modelVersionCode
noxEmission
oilTemperatureEmission
options {
...DescriptionOptionFragment
}
plate
price
rearOverhang
rearTrack
seats
sliBatteryCapacity
springsFrontType
springsRearType
steeringSystem
steeringType
tankVolume
topSpeed
transmissionElectronicControl
transmissionManufacturerCode
transmissionType
trunkVolume
urlVehicleImage
vehicleType
verified
wheelBase
wheelsDimension
width
}
}
Variables
{
"plate": "abc123",
"country": "xyz789"
}
Response
{
"data": {
"decodePlate": [
{
"id": "4",
"vin": "abc123",
"kba": 4,
"kType": "abc123",
"decodingRegion": "abc123",
"dayOfFirstCirculation": 123,
"dayOfSale": 987,
"monthOfFirstCirculation": 123,
"monthOfSale": 987,
"yearOfFirstCirculation": 123,
"yearOfSale": 987,
"acceleration": 987.65,
"advancedModel": "abc123",
"bodyType": "xyz789",
"bodyTypeCode": "xyz789",
"brakesAbs": "abc123",
"brakesFrontType": "xyz789",
"brakesRearType": "abc123",
"brakesSystem": "xyz789",
"cargoCapacity": 987,
"co2Emission": 123,
"coEmission": 987.65,
"color": "abc123",
"companyId": "4",
"country": "xyz789",
"critair": "xyz789",
"curbWeight": 987,
"doors": 987,
"driveType": "abc123",
"electricVehicleBatteryCapacity": 123.45,
"electricVehicleBatteryVoltage": 123.45,
"emissionStandard": "abc123",
"engineAspiration": "xyz789",
"engineBore": 123.45,
"engineCode": "xyz789",
"engineConfiguration": "abc123",
"engineCylinderHeadType": "abc123",
"engineCylinders": 987,
"engineDisplacement": 987,
"engineExtra": "abc123",
"engineFiscalPower": 987,
"engineFuelType": "OTHER",
"engineFuelTypeSecondary": "OTHER",
"engineFuelTypeTertiary": "OTHER",
"engineIgnitionSystem": "xyz789",
"engineManufacturer": "xyz789",
"engineOutputPower": 123,
"engineOutputPowerPs": 123,
"engineRpmIdleMax": 987,
"engineRpmIdleMin": 123,
"engineRpmMax": 987,
"engineStroke": 987.65,
"engineValves": 123,
"engineVersion": "abc123",
"engineWithTurbo": true,
"extraInfo": VinExtraInfo,
"frontOverhang": 123,
"frontTrack": 123,
"fuelEfficiencyCity": 987.65,
"fuelEfficiencyCombined": 123.45,
"fuelEfficiencyHighway": 987.65,
"fuelInjectionControlType": "xyz789",
"fuelInjectionSubtype": "abc123",
"fuelInjectionSystemDesign": "xyz789",
"fuelInjectionType": "xyz789",
"gearboxSpeed": 987,
"gearboxType": "xyz789",
"grossWeight": 987,
"hcEmission": 987.65,
"hcNoxEmission": 123.45,
"height": 987,
"hipRoomFront": 123,
"hipRoomRear": 123,
"length": 987,
"manufacturer": "xyz789",
"make": "abc123",
"maxRoofLoad": 987,
"maxTowBarDownload": 987,
"maxTrailerLoadBLicense": 987,
"maxTrailerLoadBraked12": 123,
"maxTrailerLoadUnbraked": 987,
"model": "abc123",
"modelCode": "xyz789",
"modelVersionCode": "abc123",
"noxEmission": 123.45,
"oilTemperatureEmission": 987.65,
"options": [DescriptionOption],
"plate": "abc123",
"price": 123,
"rearOverhang": 987,
"rearTrack": 987,
"seats": 987,
"sliBatteryCapacity": 987.65,
"springsFrontType": "xyz789",
"springsRearType": "xyz789",
"steeringSystem": "abc123",
"steeringType": "abc123",
"tankVolume": 123,
"topSpeed": 987,
"transmissionElectronicControl": "abc123",
"transmissionManufacturerCode": "abc123",
"transmissionType": "xyz789",
"trunkVolume": 123,
"urlVehicleImage": "abc123",
"vehicleType": "abc123",
"verified": true,
"wheelBase": 987,
"wheelsDimension": "xyz789",
"width": 123
}
]
}
}
decodeVin
Description
Get list of vehicle descriptions by VIN and region (optional)
Response
Returns [DecodeVinResult!]
Arguments
| Name | Description |
|---|---|
vin - String!
|
Vehicle Identification Number to decode |
deviceId - ID
|
Device imei |
region - String
|
Decode region (africa, asia, europe, north america, south america, oceania) |
kba - ID
|
Kraftfahrbundesamt (Germany and Austria) |
kType - ID
|
k_type number (also known as techdoc number) |
Example
Query
query decodeVin(
$vin: String!,
$deviceId: ID,
$region: String,
$kba: ID,
$kType: ID
) {
decodeVin(
vin: $vin,
deviceId: $deviceId,
region: $region,
kba: $kba,
kType: $kType
) {
id
vin
kba
kType
decodingRegion
dayOfFirstCirculation
dayOfSale
monthOfFirstCirculation
monthOfSale
yearOfFirstCirculation
yearOfSale
acceleration
advancedModel
bodyType
bodyTypeCode
brakesAbs
brakesFrontType
brakesRearType
brakesSystem
cargoCapacity
co2Emission
coEmission
color
companyId
country
critair
curbWeight
doors
driveType
electricVehicleBatteryCapacity
electricVehicleBatteryVoltage
emissionStandard
engineAspiration
engineBore
engineCode
engineConfiguration
engineCylinderHeadType
engineCylinders
engineDisplacement
engineExtra
engineFiscalPower
engineFuelType
engineFuelTypeSecondary
engineFuelTypeTertiary
engineIgnitionSystem
engineManufacturer
engineOutputPower
engineOutputPowerPs
engineRpmIdleMax
engineRpmIdleMin
engineRpmMax
engineStroke
engineValves
engineVersion
engineWithTurbo
extraInfo {
...VinExtraInfoFragment
}
frontOverhang
frontTrack
fuelEfficiencyCity
fuelEfficiencyCombined
fuelEfficiencyHighway
fuelInjectionControlType
fuelInjectionSubtype
fuelInjectionSystemDesign
fuelInjectionType
gearboxSpeed
gearboxType
grossWeight
hcEmission
hcNoxEmission
height
hipRoomFront
hipRoomRear
length
manufacturer
make
maxRoofLoad
maxTowBarDownload
maxTrailerLoadBLicense
maxTrailerLoadBraked12
maxTrailerLoadUnbraked
model
modelCode
modelVersionCode
noxEmission
oilTemperatureEmission
options {
...DescriptionOptionFragment
}
plate
price
rearOverhang
rearTrack
seats
sliBatteryCapacity
springsFrontType
springsRearType
steeringSystem
steeringType
tankVolume
topSpeed
transmissionElectronicControl
transmissionManufacturerCode
transmissionType
trunkVolume
urlVehicleImage
vehicleType
verified
wheelBase
wheelsDimension
width
}
}
Variables
{
"vin": "abc123",
"deviceId": "4",
"region": "abc123",
"kba": "4",
"kType": 4
}
Response
{
"data": {
"decodeVin": [
{
"id": 4,
"vin": "abc123",
"kba": "4",
"kType": "abc123",
"decodingRegion": "abc123",
"dayOfFirstCirculation": 987,
"dayOfSale": 123,
"monthOfFirstCirculation": 123,
"monthOfSale": 123,
"yearOfFirstCirculation": 123,
"yearOfSale": 123,
"acceleration": 123.45,
"advancedModel": "abc123",
"bodyType": "abc123",
"bodyTypeCode": "abc123",
"brakesAbs": "abc123",
"brakesFrontType": "xyz789",
"brakesRearType": "xyz789",
"brakesSystem": "xyz789",
"cargoCapacity": 987,
"co2Emission": 123,
"coEmission": 123.45,
"color": "abc123",
"companyId": 4,
"country": "abc123",
"critair": "abc123",
"curbWeight": 123,
"doors": 987,
"driveType": "xyz789",
"electricVehicleBatteryCapacity": 987.65,
"electricVehicleBatteryVoltage": 987.65,
"emissionStandard": "xyz789",
"engineAspiration": "abc123",
"engineBore": 123.45,
"engineCode": "abc123",
"engineConfiguration": "abc123",
"engineCylinderHeadType": "xyz789",
"engineCylinders": 987,
"engineDisplacement": 987,
"engineExtra": "xyz789",
"engineFiscalPower": 123,
"engineFuelType": "OTHER",
"engineFuelTypeSecondary": "OTHER",
"engineFuelTypeTertiary": "OTHER",
"engineIgnitionSystem": "abc123",
"engineManufacturer": "abc123",
"engineOutputPower": 987,
"engineOutputPowerPs": 987,
"engineRpmIdleMax": 123,
"engineRpmIdleMin": 987,
"engineRpmMax": 987,
"engineStroke": 123.45,
"engineValves": 123,
"engineVersion": "abc123",
"engineWithTurbo": true,
"extraInfo": VinExtraInfo,
"frontOverhang": 987,
"frontTrack": 987,
"fuelEfficiencyCity": 987.65,
"fuelEfficiencyCombined": 123.45,
"fuelEfficiencyHighway": 987.65,
"fuelInjectionControlType": "abc123",
"fuelInjectionSubtype": "abc123",
"fuelInjectionSystemDesign": "xyz789",
"fuelInjectionType": "xyz789",
"gearboxSpeed": 987,
"gearboxType": "abc123",
"grossWeight": 123,
"hcEmission": 123.45,
"hcNoxEmission": 123.45,
"height": 987,
"hipRoomFront": 987,
"hipRoomRear": 987,
"length": 987,
"manufacturer": "abc123",
"make": "abc123",
"maxRoofLoad": 987,
"maxTowBarDownload": 987,
"maxTrailerLoadBLicense": 987,
"maxTrailerLoadBraked12": 123,
"maxTrailerLoadUnbraked": 987,
"model": "xyz789",
"modelCode": "xyz789",
"modelVersionCode": "xyz789",
"noxEmission": 987.65,
"oilTemperatureEmission": 987.65,
"options": [DescriptionOption],
"plate": "abc123",
"price": 123,
"rearOverhang": 123,
"rearTrack": 987,
"seats": 123,
"sliBatteryCapacity": 123.45,
"springsFrontType": "abc123",
"springsRearType": "abc123",
"steeringSystem": "abc123",
"steeringType": "xyz789",
"tankVolume": 123,
"topSpeed": 123,
"transmissionElectronicControl": "xyz789",
"transmissionManufacturerCode": "abc123",
"transmissionType": "abc123",
"trunkVolume": 123,
"urlVehicleImage": "abc123",
"vehicleType": "abc123",
"verified": false,
"wheelBase": 987,
"wheelsDimension": "xyz789",
"width": 987
}
]
}
}
description
Response
Returns a Description
Arguments
| Name | Description |
|---|---|
subject - DescriptionSubject!
|
|
id - ID!
|
Example
Query
query description(
$subject: DescriptionSubject!,
$id: ID!
) {
description(
subject: $subject,
id: $id
) {
id
label
value
source
createdAt
updatedAt
}
}
Variables
{
"subject": DescriptionSubject,
"id": "4"
}
Response
{
"data": {
"description": {
"id": 4,
"label": "abc123",
"value": "abc123",
"source": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
device
Example
Query
query device($id: ID!) {
device(id: $id) {
id
activeAccount
deviceType
serialNumber
onboarded
createdAt
updatedAt
owner {
...AccountFragment
}
firstConnectionAt
lastConnectionAt
lastConnectionReason
lastDisconnectionAt
lastDisconnectionReason
lastActivityAt
status
history {
...DeviceHistoryPagedFragment
}
aggregatedData {
...AggregatedDataFragment
}
lastTrip {
...TripFragment
}
trips {
...TripPagedFragment
}
tripSummary {
...TripSummaryFragment
}
harshes {
...TripHarshPagedFragment
}
overspeeds {
...TripOverspeedPagedFragment
}
currentVehicle {
...VehicleFragment
}
vehicles {
...VehiclePagedFragment
}
fields {
...FieldPagedFragment
}
readings {
...ReadingPagedFragment
}
readingsAnon {
...ReadingAnonPagedFragment
}
lastPosition {
...CoordinatesFragment
}
vehicleSessions {
...DeviceVehicleSessionPagedFragment
}
groups {
...GroupPagedFragment
}
alerts {
...VehicleAlertPagedFragment
}
alertsState {
...VehicleAlertsStateFragment
}
batteryAnnotations {
...BatteryAnnotationPagedFragment
}
remoteDiags {
...RemoteDiagPagedFragment
}
logFetches {
...LogfetchPagedFragment
}
profilePrivacies {
...ProfilePrivacyPagedFragment
}
profilePrivacy {
...ProfilePrivacyFragment
}
profileModes {
...ProfileDeviceModePagedFragment
}
profileMode {
...ProfileDeviceModeFragment
}
product {
...ProductFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"device": {
"id": 4,
"activeAccount": "abc123",
"deviceType": "xyz789",
"serialNumber": "abc123",
"onboarded": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"owner": Account,
"firstConnectionAt": "2007-12-03T10:15:30Z",
"lastConnectionAt": "2007-12-03T10:15:30Z",
"lastConnectionReason": "COLD_BOOT",
"lastDisconnectionAt": "2007-12-03T10:15:30Z",
"lastDisconnectionReason": "UNKNOWN_SERVER_REASON",
"lastActivityAt": "2007-12-03T10:15:30Z",
"status": "CONNECTED",
"history": DeviceHistoryPaged,
"aggregatedData": AggregatedData,
"lastTrip": Trip,
"trips": TripPaged,
"tripSummary": TripSummary,
"harshes": TripHarshPaged,
"overspeeds": TripOverspeedPaged,
"currentVehicle": Vehicle,
"vehicles": VehiclePaged,
"fields": FieldPaged,
"readings": ReadingPaged,
"readingsAnon": ReadingAnonPaged,
"lastPosition": Coordinates,
"vehicleSessions": DeviceVehicleSessionPaged,
"groups": GroupPaged,
"alerts": VehicleAlertPaged,
"alertsState": VehicleAlertsState,
"batteryAnnotations": BatteryAnnotationPaged,
"remoteDiags": RemoteDiagPaged,
"logFetches": LogfetchPaged,
"profilePrivacies": ProfilePrivacyPaged,
"profilePrivacy": ProfilePrivacy,
"profileModes": ProfileDeviceModePaged,
"profileMode": ProfileDeviceMode,
"product": Product
}
}
}
devices
Response
Returns a DevicePaged
Arguments
| Name | Description |
|---|---|
pageSize - Int
|
Results per page (initial query) |
pageId - ID
|
Request page id (followup queries) |
ids - [ID]
|
|
onboarded - Boolean
|
|
statuses - [DeviceStatus!]
|
|
deviceTypes - [String]
|
|
hasWifi - Boolean
|
|
hasBluetooth - Boolean
|
|
productNames - [String!]
|
|
productNetworks - [ProductNetwork!]
|
|
productMarkets - [ProductMarket!]
|
Example
Query
query devices(
$pageSize: Int,
$pageId: ID,
$ids: [ID],
$onboarded: Boolean,
$statuses: [DeviceStatus!],
$deviceTypes: [String],
$hasWifi: Boolean,
$hasBluetooth: Boolean,
$productNames: [String!],
$productNetworks: [ProductNetwork!],
$productMarkets: [ProductMarket!]
) {
devices(
pageSize: $pageSize,
pageId: $pageId,
ids: $ids,
onboarded: $onboarded,
statuses: $statuses,
deviceTypes: $deviceTypes,
hasWifi: $hasWifi,
hasBluetooth: $hasBluetooth,
productNames: $productNames,
productNetworks: $productNetworks,
productMarkets: $productMarkets
) {
next
count
list {
...DeviceFragment
}
}
}
Variables
{
"pageSize": 123,
"pageId": "4",
"ids": ["4"],
"onboarded": true,
"statuses": ["CONNECTED"],
"deviceTypes": ["abc123"],
"hasWifi": true,
"hasBluetooth": false,
"productNames": ["xyz789"],
"productNetworks": ["_2G"],
"productMarkets": ["EU"]
}
Response
{
"data": {
"devices": {"next": 4, "count": 987, "list": [Device]}
}
}
distributor
Description
Get distributor
Response
Returns an OnboardingDistributor
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query distributor($id: ID!) {
distributor(id: $id) {
id
organizationId
label
provider {
...OnboardingProviderFragment
}
isActive
workshop {
...WorkshopFragment
}
providerWorkshopId
staff {
...OnboardingStaffPagedFragment
}
requests {
...OnboardingRequestPagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"distributor": {
"id": "4",
"organizationId": 4,
"label": "abc123",
"provider": OnboardingProvider,
"isActive": false,
"workshop": Workshop,
"providerWorkshopId": "4",
"staff": OnboardingStaffPaged,
"requests": OnboardingRequestPaged
}
}
}
distributors
Description
List distributors
Response
Returns an OnboardingDistributorPaged
Example
Query
query distributors(
$pageSize: Int,
$pageId: ID,
$isActive: Boolean
) {
distributors(
pageSize: $pageSize,
pageId: $pageId,
isActive: $isActive
) {
next
count
list {
...OnboardingDistributorFragment
}
}
}
Variables
{"pageSize": 123, "pageId": 4, "isActive": false}
Response
{
"data": {
"distributors": {
"next": 4,
"count": 987,
"list": [OnboardingDistributor]
}
}
}
driver
Example
Query
query driver($id: ID) {
driver(id: $id) {
id
label
idKey
createdAt
updatedAt
userProfile {
...AccountFragment
}
userContact {
...AccountFragment
}
currentVehicle {
...VehicleFragment
}
defaultVehicle {
...VehicleFragment
}
active
vehicles {
...VehiclePagedFragment
}
currentVehicles {
...VehiclePagedFragment
}
groups {
...GroupPagedFragment
}
lastTrip {
...TripFragment
}
trips {
...TripPagedFragment
}
vehicleSessions {
...DriverVehicleSessionPagedFragment
}
descriptions {
...DescriptionPagedFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"driver": {
"id": 4,
"label": "xyz789",
"idKey": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"userProfile": Account,
"userContact": Account,
"currentVehicle": Vehicle,
"defaultVehicle": Vehicle,
"active": true,
"vehicles": VehiclePaged,
"currentVehicles": VehiclePaged,
"groups": GroupPaged,
"lastTrip": Trip,
"trips": TripPaged,
"vehicleSessions": DriverVehicleSessionPaged,
"descriptions": DescriptionPaged
}
}
}
driverService
Description
Get Driver service by ID
Response
Returns a DriverService
Arguments
| Name | Description |
|---|---|
id - ID!
|
Driver service ID |
Example
Query
query driverService($id: ID!) {
driverService(id: $id) {
id
label
description
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"driverService": {
"id": 4,
"label": "xyz789",
"description": "xyz789",
"workshops": WorkshopPaged
}
}
}
driverServices
Description
List Driver services
Response
Returns a DriverServicePaged
Example
Query
query driverServices(
$pageSize: Int,
$pageId: ID,
$label: String
) {
driverServices(
pageSize: $pageSize,
pageId: $pageId,
label: $label
) {
next
count
list {
...DriverServiceFragment
}
}
}
Variables
{
"pageSize": 123,
"pageId": "4",
"label": "xyz789"
}
Response
{
"data": {
"driverServices": {
"next": "4",
"count": 123,
"list": [DriverService]
}
}
}
drivers
Response
Returns a DriverPaged
Arguments
| Name | Description |
|---|---|
pageSize - Int
|
Results per page (initial query) |
pageId - ID
|
Request page id (followup queries) |
ids - [ID!]
|
Filter by ids |
idKeys - [ID!]
|
Filter by id_keys |
labels - [String!]
|
Filter by labels |
auxiliaryDeviceSerialNumbers - [String!]
|
Filter by driver auxiliary devices serial number |
auxiliaryDeviceMacAddressHashs - [String!]
|
Filter by driver auxiliary devices mac address hash |
auxiliaryDeviceIdKeys - [String!]
|
Filter by driver auxiliary devices id_key |
hasVehicle - Boolean
|
|
active - Boolean
|
Example
Query
query drivers(
$pageSize: Int,
$pageId: ID,
$ids: [ID!],
$idKeys: [ID!],
$labels: [String!],
$auxiliaryDeviceSerialNumbers: [String!],
$auxiliaryDeviceMacAddressHashs: [String!],
$auxiliaryDeviceIdKeys: [String!],
$hasVehicle: Boolean,
$active: Boolean
) {
drivers(
pageSize: $pageSize,
pageId: $pageId,
ids: $ids,
idKeys: $idKeys,
labels: $labels,
auxiliaryDeviceSerialNumbers: $auxiliaryDeviceSerialNumbers,
auxiliaryDeviceMacAddressHashs: $auxiliaryDeviceMacAddressHashs,
auxiliaryDeviceIdKeys: $auxiliaryDeviceIdKeys,
hasVehicle: $hasVehicle,
active: $active
) {
next
count
list {
...DriverFragment
}
}
}
Variables
{
"pageSize": 987,
"pageId": 4,
"ids": [4],
"idKeys": [4],
"labels": ["abc123"],
"auxiliaryDeviceSerialNumbers": [
"abc123"
],
"auxiliaryDeviceMacAddressHashs": [
"xyz789"
],
"auxiliaryDeviceIdKeys": ["xyz789"],
"hasVehicle": true,
"active": false
}
Response
{
"data": {
"drivers": {
"next": "4",
"count": 123,
"list": [Driver]
}
}
}
geodecode
Description
Get the geodecoding of a coordinate
Response
Returns a Geodecode
Arguments
| Name | Description |
|---|---|
lat - Float
|
Coordinate latitude |
lng - Float
|
Coordinate longitude |
radius - Int
|
Search radius around lat/lon (meters), default 100 |
skipEmptyStreetname - Boolean
|
Skip results with empty streetnames |
maxResult - Int
|
Max Results, default 1 |
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" |
Example
Query
query geodecode(
$lat: Float,
$lng: Float,
$radius: Int,
$skipEmptyStreetname: Boolean,
$maxResult: Int,
$lang: String
) {
geodecode(
lat: $lat,
lng: $lng,
radius: $radius,
skipEmptyStreetname: $skipEmptyStreetname,
maxResult: $maxResult,
lang: $lang
) {
extent {
...GeodecodeExtentFragment
}
elements {
...GeodecodeElementsFragment
}
}
}
Variables
{
"lat": 987.65,
"lng": 987.65,
"radius": 123,
"skipEmptyStreetname": false,
"maxResult": 123,
"lang": "abc123"
}
Response
{
"data": {
"geodecode": {
"extent": GeodecodeExtent,
"elements": GeodecodeElements
}
}
}
getMetadatum
Description
Get trip metdatum
Response
Returns a TripMetadatum
Arguments
| Name | Description |
|---|---|
id - ID!
|
Metadatum id |
Example
Query
query getMetadatum($id: ID!) {
getMetadatum(id: $id) {
id
key
value
tripId
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getMetadatum": {
"id": 4,
"key": "xyz789",
"value": "abc123",
"tripId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
group
Example
Query
query group($id: ID!) {
group(id: $id) {
id
label
tags
hierarchyLevel
owner {
...AccountFragment
}
descriptions {
...DescriptionPagedFragment
}
devices {
...DevicePagedFragment
}
vehicles {
...VehiclePagedFragment
}
alerts {
...VehicleAlertPagedFragment
}
drivers {
...DriverPagedFragment
}
parents {
...GroupPagedFragment
}
children {
...GroupPagedFragment
}
users {
...AccountPagedFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"group": {
"id": "4",
"label": "abc123",
"tags": ["abc123"],
"hierarchyLevel": "UNASSIGNED",
"owner": Account,
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"vehicles": VehiclePaged,
"alerts": VehicleAlertPaged,
"drivers": DriverPaged,
"parents": GroupPaged,
"children": GroupPaged,
"users": AccountPaged
}
}
}
groups
Response
Returns a GroupPaged
Arguments
| Name | Description |
|---|---|
pageSize - Int
|
Results per page (initial query) |
pageId - ID
|
Request page id (followup queries) |
ids - [ID!]
|
|
labels - [String!]
|
|
hierarchyLevels - [GroupHierarchyLevel!]
|
Example
Query
query groups(
$pageSize: Int,
$pageId: ID,
$ids: [ID!],
$labels: [String!],
$hierarchyLevels: [GroupHierarchyLevel!]
) {
groups(
pageSize: $pageSize,
pageId: $pageId,
ids: $ids,
labels: $labels,
hierarchyLevels: $hierarchyLevels
) {
next
count
list {
...GroupFragment
}
}
}
Variables
{
"pageSize": 123,
"pageId": 4,
"ids": [4],
"labels": ["xyz789"],
"hierarchyLevels": ["UNASSIGNED"]
}
Response
{
"data": {
"groups": {
"next": "4",
"count": 987,
"list": [Group]
}
}
}
logfetchActions
Description
List standard log fetch actions
Response
Returns a LogfetchActionPaged
Example
Query
query logfetchActions(
$pageSize: Int,
$pageId: ID
) {
logfetchActions(
pageSize: $pageSize,
pageId: $pageId
) {
next
count
list {
...LogfetchActionFragment
}
}
}
Variables
{"pageSize": 123, "pageId": 4}
Response
{
"data": {
"logfetchActions": {
"next": 4,
"count": 123,
"list": [LogfetchAction]
}
}
}
lpa
Description
Local profile assistance
Response
Returns a Lpa
Arguments
| Name | Description |
|---|---|
imei - ID!
|
IMEI of the dongle |
functionName - FunctionNameType!
|
The name of the function to call |
parameters - ParametersType!
|
Parameters needed for the called function |
Example
Query
query lpa(
$imei: ID!,
$functionName: FunctionNameType!,
$parameters: ParametersType!
) {
lpa(
imei: $imei,
functionName: $functionName,
parameters: $parameters
) {
id
imei
functionName
status
parameters {
...ParametersFragment
}
}
}
Variables
{
"imei": 4,
"functionName": "DOWNLOAD_AND_ENABLE_PROFILE",
"parameters": ParametersType
}
Response
{
"data": {
"lpa": {
"id": "4",
"imei": "4",
"functionName": "xyz789",
"status": "xyz789",
"parameters": Parameters
}
}
}
maintenanceCriticalityThreshold
Response
Returns a MaintenanceCriticalityThreshold
Example
Query
query maintenanceCriticalityThreshold {
maintenanceCriticalityThreshold {
id
remainingDistance
remainingDuration
criticality
description
}
}
Response
{
"data": {
"maintenanceCriticalityThreshold": {
"id": 4,
"remainingDistance": 123,
"remainingDuration": 123,
"criticality": 123,
"description": "xyz789"
}
}
}
maintenanceCriticalityThresholds
Description
Maintenance criticality ID
Response
Returns a MaintenanceCriticalityThresholdPaged
Example
Query
query maintenanceCriticalityThresholds(
$pageSize: Int,
$pageId: ID
) {
maintenanceCriticalityThresholds(
pageSize: $pageSize,
pageId: $pageId
) {
next
count
list {
...MaintenanceCriticalityThresholdFragment
}
}
}
Variables
{"pageSize": 987, "pageId": "4"}
Response
{
"data": {
"maintenanceCriticalityThresholds": {
"next": 4,
"count": 987,
"list": [MaintenanceCriticalityThreshold]
}
}
}
maintenanceHistorical
Response
Returns a MaintenanceHistorical
Arguments
| Name | Description |
|---|---|
id - ID!
|
Historical maintenance ID |
Example
Query
query maintenanceHistorical($id: ID!) {
maintenanceHistorical(id: $id) {
id
vehicle {
...VehicleFragment
}
template {
...MaintenanceTemplateFragment
}
mileage
date
}
}
Variables
{"id": 4}
Response
{
"data": {
"maintenanceHistorical": {
"id": 4,
"vehicle": Vehicle,
"template": MaintenanceTemplate,
"mileage": 987,
"date": "2007-12-03T10:15:30Z"
}
}
}
maintenanceTemplate
Response
Returns a MaintenanceTemplate
Arguments
| Name | Description |
|---|---|
id - ID!
|
Maintenance template ID |
Example
Query
query maintenanceTemplate($id: ID!) {
maintenanceTemplate(id: $id) {
id
description
system {
...MaintenanceSystemFragment
}
fromExternalService
}
}
Variables
{"id": "4"}
Response
{
"data": {
"maintenanceTemplate": {
"id": "4",
"description": "xyz789",
"system": MaintenanceSystem,
"fromExternalService": false
}
}
}
maintenanceUpcoming
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 maintenanceUpcoming($id: ID!) {
maintenanceUpcoming(id: $id) {
id
template {
...MaintenanceTemplateFragment
}
vehicle {
...VehicleFragment
}
criticality {
...MaintenanceCriticalityThresholdFragment
}
mileageDeadline
remainingDistanceToDrive
dateDeadline
remainingDaysToDrive
}
}
Variables
{"id": "4"}
Response
{
"data": {
"maintenanceUpcoming": {
"id": "4",
"template": MaintenanceTemplate,
"vehicle": Vehicle,
"criticality": MaintenanceCriticalityThreshold,
"mileageDeadline": 123,
"remainingDistanceToDrive": 987,
"dateDeadline": "2007-12-03T10:15:30Z",
"remainingDaysToDrive": 987
}
}
}
metrics
Response
Returns a MetricPaged
Example
Query
query metrics(
$pageSize: Int,
$pageId: ID,
$ids: [ID!],
$names: [String!],
$nameContains: String,
$rawUnit: Boolean
) {
metrics(
pageSize: $pageSize,
pageId: $pageId,
ids: $ids,
names: $names,
nameContains: $nameContains,
rawUnit: $rawUnit
) {
next
count
list {
...MetricFragment
}
}
}
Variables
{
"pageSize": 987,
"pageId": "4",
"ids": [4],
"names": ["xyz789"],
"nameContains": "xyz789",
"rawUnit": false
}
Response
{
"data": {
"metrics": {
"next": "4",
"count": 987,
"list": [Metric]
}
}
}
onboardings
Description
List onboarding requests
Response
Returns an OnboardingRequestPaged
Arguments
| Name | Description |
|---|---|
pageSize - Int
|
Results per page (initial query) |
pageId - ID
|
Request page id (followup queries) |
sort - [OnboardingRequestSort!]
|
Sort criteria |
ids - [ID!]
|
Filter by request id |
status - [OnboardingStatus!]
|
Filter by request status |
deviceIds - [ID!]
|
Filter by linked device id |
plates - [String!]
|
Filter by linked vehicle plate |
vins - [String!]
|
Filter by linked vehicle VIN |
clientIdentificationIds - [ID!]
|
Filter by client identification ids |
distributorIds - [ID!]
|
Filter by distributor ids |
vehicleTypes - [VehicleTypeName!]
|
Filter by vehicle type |
modes - [OnboardingMode!]
|
Filter by onboarding mode |
clientReferences - [ID!]
|
Filter by client identification reference |
vehicleEnrichments - [String!]
|
Filter by any vehicle enrichment values |
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. |
Example
Query
query onboardings(
$pageSize: Int,
$pageId: ID,
$sort: [OnboardingRequestSort!],
$ids: [ID!],
$status: [OnboardingStatus!],
$deviceIds: [ID!],
$plates: [String!],
$vins: [String!],
$clientIdentificationIds: [ID!],
$distributorIds: [ID!],
$vehicleTypes: [VehicleTypeName!],
$modes: [OnboardingMode!],
$clientReferences: [ID!],
$vehicleEnrichments: [String!],
$multi: [String]
) {
onboardings(
pageSize: $pageSize,
pageId: $pageId,
sort: $sort,
ids: $ids,
status: $status,
deviceIds: $deviceIds,
plates: $plates,
vins: $vins,
clientIdentificationIds: $clientIdentificationIds,
distributorIds: $distributorIds,
vehicleTypes: $vehicleTypes,
modes: $modes,
clientReferences: $clientReferences,
vehicleEnrichments: $vehicleEnrichments,
multi: $multi
) {
next
count
list {
...OnboardingRequestFragment
}
}
}
Variables
{
"pageSize": 123,
"pageId": "4",
"sort": [OnboardingRequestSort],
"ids": ["4"],
"status": ["OPEN"],
"deviceIds": ["4"],
"plates": ["abc123"],
"vins": ["abc123"],
"clientIdentificationIds": ["4"],
"distributorIds": ["4"],
"vehicleTypes": ["CAR"],
"modes": ["MANUAL"],
"clientReferences": ["4"],
"vehicleEnrichments": ["xyz789"],
"multi": ["xyz789"]
}
Response
{
"data": {
"onboardings": {
"next": "4",
"count": 987,
"list": [OnboardingRequest]
}
}
}
parkings
Description
Get parkings for vehicles
Response
Returns a ParkingPaged
Example
Query
query parkings(
$pageSize: Int,
$pageId: ID,
$latitude: Float!,
$longitude: Float!,
$radius: Int!
) {
parkings(
pageSize: $pageSize,
pageId: $pageId,
latitude: $latitude,
longitude: $longitude,
radius: $radius
) {
next
count
list {
...ParkingFragment
}
}
}
Variables
{
"pageSize": 123,
"pageId": "4",
"latitude": 123.45,
"longitude": 987.65,
"radius": 123
}
Response
{
"data": {
"parkings": {
"next": 4,
"count": 987,
"list": [Parking]
}
}
}
partners
Description
List partners
Response
Returns an OnboardingPartnerPaged
Example
Query
query partners(
$pageSize: Int,
$pageId: ID,
$ids: [ID!]
) {
partners(
pageSize: $pageSize,
pageId: $pageId,
ids: $ids
) {
next
count
list {
...OnboardingPartnerFragment
}
}
}
Variables
{"pageSize": 987, "pageId": 4, "ids": [4]}
Response
{
"data": {
"partners": {
"next": 4,
"count": 123,
"list": [OnboardingPartner]
}
}
}
passwordCheckToken
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 passwordCheckToken(
$channel: PasswordResetChannel!,
$id: ID!,
$token: String!
) {
passwordCheckToken(
channel: $channel,
id: $id,
token: $token
)
}
Variables
{
"channel": "PHONE",
"id": "4",
"token": "xyz789"
}
Response
{"data": {"passwordCheckToken": false}}
perf
Experimental/unstable API
Description
Get performance info
project
Example
Query
query project($id: ID!) {
project(id: $id) {
id
label
owner {
...AccountFragment
}
vehicles {
...VehiclePagedFragment
}
groups {
...GroupPagedFragment
}
drivers {
...DriverPagedFragment
}
devices {
...DevicePagedFragment
}
users {
...AccountPagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"project": {
"id": "4",
"label": "abc123",
"owner": Account,
"vehicles": VehiclePaged,
"groups": GroupPaged,
"drivers": DriverPaged,
"devices": DevicePaged,
"users": AccountPaged
}
}
}
projects
Description
Get the logged-in user project list
Response
Returns a ProjectPaged
Example
Query
query projects(
$pageSize: Int,
$pageId: ID
) {
projects(
pageSize: $pageSize,
pageId: $pageId
) {
next
count
list {
...ProjectFragment
}
}
}
Variables
{"pageSize": 123, "pageId": "4"}
Response
{
"data": {
"projects": {
"next": 4,
"count": 987,
"list": [Project]
}
}
}
providers
Description
List providers
Response
Returns an OnboardingProviderPaged
Example
Query
query providers(
$pageSize: Int,
$pageId: ID,
$ids: [ID!]
) {
providers(
pageSize: $pageSize,
pageId: $pageId,
ids: $ids
) {
next
count
list {
...OnboardingProviderFragment
}
}
}
Variables
{"pageSize": 123, "pageId": 4, "ids": ["4"]}
Response
{
"data": {
"providers": {
"next": 4,
"count": 987,
"list": [OnboardingProvider]
}
}
}
quotation
Description
Get Quotation by ID
Example
Query
query quotation($id: ID!) {
quotation(id: $id) {
id
plateNumber
workshop {
...WorkshopFragment
}
currency
price
maintenanceCode
bookingId
taxes
taxesPrice
providerQuotationId
}
}
Variables
{"id": 4}
Response
{
"data": {
"quotation": {
"id": "4",
"plateNumber": "xyz789",
"workshop": Workshop,
"currency": "xyz789",
"price": 987,
"maintenanceCode": "xyz789",
"bookingId": "4",
"taxes": 123,
"taxesPrice": 123,
"providerQuotationId": "4"
}
}
}
quotations
Description
List Quotations
Response
Returns a QuotationPaged
Example
Query
query quotations(
$pageSize: Int,
$pageId: ID
) {
quotations(
pageSize: $pageSize,
pageId: $pageId
) {
next
count
list {
...QuotationFragment
}
}
}
Variables
{"pageSize": 123, "pageId": 4}
Response
{
"data": {
"quotations": {
"next": "4",
"count": 987,
"list": [Quotation]
}
}
}
rating
Description
Get Rating by ID
Example
Query
query rating($id: ID!) {
rating(id: $id) {
id
createdAt
message
stars
response
responseDate
status
workshop {
...WorkshopFragment
}
booking {
...BookingFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"rating": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"message": "abc123",
"stars": 987,
"response": "xyz789",
"responseDate": "2007-12-03T10:15:30Z",
"status": "VERIFIED",
"workshop": Workshop,
"booking": Booking
}
}
}
rdcLog
Description
Get log of sent RemoteDeviceCommands
Response
Returns [RdcAsyncAck]
Arguments
| Name | Description |
|---|---|
endpoint - RdcEndpoint!
|
Type of logs |
Example
Query
query rdcLog($endpoint: RdcEndpoint!) {
rdcLog(endpoint: $endpoint) {
id
type
attributes
}
}
Variables
{"endpoint": "DISPLACEMENT_SET"}
Response
{
"data": {
"rdcLog": [
{
"id": 4,
"type": "abc123",
"attributes": Json
}
]
}
}
remoteDiag
Description
Get a remote diagnostic session
Response
Returns a RemoteDiag
Arguments
| Name | Description |
|---|---|
id - ID!
|
Remote diagnostic session id |
Example
Query
query remoteDiag($id: ID!) {
remoteDiag(id: $id) {
id
createdAt
updatedAt
status
vud {
...RemoteDiagEndpointFragment
}
vci {
...RemoteDiagEndpointFragment
}
currentStep
language
providerName
actions {
...RemoteDiagActionPagedFragment
}
result {
...RemoteDiagResultFragment
}
steps {
...RemoteDiagStepPagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"remoteDiag": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "abc123",
"vud": RemoteDiagEndpoint,
"vci": RemoteDiagEndpoint,
"currentStep": "SETUP_ONGOING",
"language": Language,
"providerName": "abc123",
"actions": RemoteDiagActionPaged,
"result": RemoteDiagResult,
"steps": RemoteDiagStepPaged
}
}
}
stations
Description
Get stations for vehicles
Response
Returns a StationPaged
Arguments
| Name | Description |
|---|---|
pageSize - Int
|
Results per page (initial query) |
pageId - ID
|
Request page id (followup queries) |
energyTypes - [EnergyType]
|
Energy type filter |
connectorTypes - [ConnectorType]
|
Electric connector type filter |
latitude - Float!
|
Latitude |
longitude - Float!
|
Longitude |
radius - Int!
|
Search radius (meters) |
Example
Query
query stations(
$pageSize: Int,
$pageId: ID,
$energyTypes: [EnergyType],
$connectorTypes: [ConnectorType],
$latitude: Float!,
$longitude: Float!,
$radius: Int!
) {
stations(
pageSize: $pageSize,
pageId: $pageId,
energyTypes: $energyTypes,
connectorTypes: $connectorTypes,
latitude: $latitude,
longitude: $longitude,
radius: $radius
) {
next
count
list {
...StationFragment
}
}
}
Variables
{
"pageSize": 123,
"pageId": 4,
"energyTypes": ["OTHER"],
"connectorTypes": ["OTHER"],
"latitude": 123.45,
"longitude": 123.45,
"radius": 987
}
Response
{
"data": {
"stations": {
"next": 4,
"count": 987,
"list": [Station]
}
}
}
systemInfo
Description
Get system information
Response
Returns a SystemInfo
Example
Query
query systemInfo(
$service: String,
$extra: [String!]
) {
systemInfo(
service: $service,
extra: $extra
) {
software
hash
schema
services {
...SystemServiceFragment
}
extra
}
}
Variables
{
"service": "xyz789",
"extra": ["xyz789"]
}
Response
{
"data": {
"systemInfo": {
"software": "abc123",
"hash": "xyz789",
"schema": "abc123",
"services": [SystemService],
"extra": Json
}
}
}
tickets
Description
List support tickets
Response
Returns a TicketPaged
Example
Query
query tickets(
$pageSize: Int,
$pageId: ID
) {
tickets(
pageSize: $pageSize,
pageId: $pageId
) {
next
count
list {
...TicketFragment
}
}
}
Variables
{"pageSize": 987, "pageId": "4"}
Response
{
"data": {
"tickets": {"next": 4, "count": 123, "list": [Ticket]}
}
}
trip
Description
Get trip
Example
Query
query trip($id: ID!) {
trip(id: $id) {
id
drivingPercentage
duration
endEvent {
...IdcoordinatesFragment
}
idlingPercentage
maxIdlingDuration
startEvent {
...IdcoordinatesFragment
}
status
averageSpeed
co2Estimation
distance
distanceInDay
drivingDuration
ecoDrivingScore
endPostalAddress {
...AddressAttributesFragment
}
endWeather {
...WeatherFragment
}
fuelEfficiency
fuelEstimation
idlingDuration
maxSpeed
nbHarshAcceleration
nbHarshBraking
nbHarshCornering
overconsumptionGap
overemissionGap
safetyScore
startPostalAddress {
...AddressAttributesFragment
}
startWeather {
...WeatherFragment
}
towAway
nbOverspeed
nbPostprocessedOverspeed
overspeedDistance
overspeedDuration
overspeedScore
locations {
...IdcoordinatesPagedFragment
}
activities {
...TripActivityPagedFragment
}
movements {
...TripMovementPagedFragment
}
stops {
...TripStopPagedFragment
}
harshes {
...TripHarshPagedFragment
}
overspeeds {
...TripOverspeedPagedFragment
}
metadata {
...TripMetadatumPagedFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"trip": {
"id": "4",
"drivingPercentage": Percent,
"duration": 123,
"endEvent": Idcoordinates,
"idlingPercentage": Percent,
"maxIdlingDuration": 123,
"startEvent": Idcoordinates,
"status": "OPEN",
"averageSpeed": 987.65,
"co2Estimation": 987,
"distance": 987,
"distanceInDay": Percent,
"drivingDuration": 123,
"ecoDrivingScore": Percent,
"endPostalAddress": AddressAttributes,
"endWeather": Weather,
"fuelEfficiency": 123.45,
"fuelEstimation": 123,
"idlingDuration": 987,
"maxSpeed": 123.45,
"nbHarshAcceleration": 123,
"nbHarshBraking": 123,
"nbHarshCornering": 123,
"overconsumptionGap": AnyPercent,
"overemissionGap": AnyPercent,
"safetyScore": Percent,
"startPostalAddress": AddressAttributes,
"startWeather": Weather,
"towAway": true,
"nbOverspeed": 123,
"nbPostprocessedOverspeed": 123,
"overspeedDistance": 987,
"overspeedDuration": 987,
"overspeedScore": Percent,
"locations": IdcoordinatesPaged,
"activities": TripActivityPaged,
"movements": TripMovementPaged,
"stops": TripStopPaged,
"harshes": TripHarshPaged,
"overspeeds": TripOverspeedPaged,
"metadata": TripMetadatumPaged
}
}
}
vehicle
Example
Query
query vehicle($id: ID!) {
vehicle(id: $id) {
id
plate
label
vin
onboarded
modelId
ktype
hasDriver
make
model
year
fuelType
fuelTypeSecondary
kba
tags
hybrid
vehicleType
canTow
canBeTowed
immobilizerStatus
immobilizerStatusUpdatedAt
doorsLockStatus
doorsLockStatusUpdatedAt
garageModeStatus
garageModeStatusUpdatedAt
archived
descriptions {
...DescriptionPagedFragment
}
vinDescriptions {
...DecodeVinResultFragment
}
owner {
...AccountFragment
}
currentDevice {
...DeviceFragment
}
currentDriver {
...DriverFragment
}
groups {
...GroupPagedFragment
}
lastTrip {
...TripFragment
}
trips {
...TripPagedFragment
}
maintenancesUpcoming {
...MaintenanceUpcomingPagedFragment
}
maintenancesHistorical {
...MaintenanceHistoricalPagedFragment
}
maintenanceTemplates {
...MaintenanceTemplatePagedFragment
}
maintenanceSchedules {
...MaintenanceSchedulePagedFragment
}
alerts {
...VehicleAlertPagedFragment
}
alertsState {
...VehicleAlertsStateFragment
}
currentDevices {
...DevicePagedFragment
}
towingSessionsAsTowingVehicle {
...TowingSessionPagedFragment
}
towingSessionsAsTrailerVehicle {
...TowingSessionPagedFragment
}
currentTowingSessionAsTowingVehicle {
...TowingSessionFragment
}
currentTowingSessionAsTrailerVehicle {
...TowingSessionFragment
}
currentTrailerVehicle {
...VehicleFragment
}
currentTowingVehicle {
...VehicleFragment
}
driverSessions {
...DriverVehicleSessionPagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"vehicle": {
"id": "4",
"plate": "abc123",
"label": "abc123",
"vin": "abc123",
"onboarded": false,
"modelId": "4",
"ktype": "abc123",
"hasDriver": true,
"make": "xyz789",
"model": "abc123",
"year": "xyz789",
"fuelType": "abc123",
"fuelTypeSecondary": "xyz789",
"kba": "abc123",
"tags": ["abc123"],
"hybrid": false,
"vehicleType": "CAR",
"canTow": true,
"canBeTowed": true,
"immobilizerStatus": "UNKNOWN",
"immobilizerStatusUpdatedAt": "2007-12-03T10:15:30Z",
"doorsLockStatus": "UNKNOWN",
"doorsLockStatusUpdatedAt": "2007-12-03T10:15:30Z",
"garageModeStatus": "UNKNOWN",
"garageModeStatusUpdatedAt": "2007-12-03T10:15:30Z",
"archived": true,
"descriptions": DescriptionPaged,
"vinDescriptions": DecodeVinResult,
"owner": Account,
"currentDevice": Device,
"currentDriver": Driver,
"groups": GroupPaged,
"lastTrip": Trip,
"trips": TripPaged,
"maintenancesUpcoming": MaintenanceUpcomingPaged,
"maintenancesHistorical": MaintenanceHistoricalPaged,
"maintenanceTemplates": MaintenanceTemplatePaged,
"maintenanceSchedules": MaintenanceSchedulePaged,
"alerts": VehicleAlertPaged,
"alertsState": VehicleAlertsState,
"currentDevices": DevicePaged,
"towingSessionsAsTowingVehicle": TowingSessionPaged,
"towingSessionsAsTrailerVehicle": TowingSessionPaged,
"currentTowingSessionAsTowingVehicle": TowingSession,
"currentTowingSessionAsTrailerVehicle": TowingSession,
"currentTrailerVehicle": Vehicle,
"currentTowingVehicle": Vehicle,
"driverSessions": DriverVehicleSessionPaged
}
}
}
vehicleAlert
Description
Get vehicle alert
Response
Returns a VehicleAlert
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query vehicleAlert($id: ID!) {
vehicleAlert(id: $id) {
id
type
device {
...DeviceFragment
}
vehicle {
...VehicleFragment
}
icon
lastReceived
lastReported
source
createdAt
updatedAt
status
language
feedbackStatus
feedbacks {
...VehicleAlertFeedbackPagedFragment
}
aggregatedData {
...AggregatedDataFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"vehicleAlert": {
"id": 4,
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "abc123",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData
}
}
}
vehicleAlerts
Description
List vehicle alerts
Response
Returns a VehicleAlertPaged
Arguments
| Name | Description |
|---|---|
pageSize - Int
|
Results per page (initial query) |
pageId - ID
|
Request page id (followup queries) |
sort - [VehicleAlertSort!]
|
Sort criteria |
groups - [ID!]
|
Filter by groups |
ids - [ID!]
|
Filter by ids |
isActive - Boolean
|
Filter by activity |
language - LangArg
|
Filter by language |
source - VehicleAlertSourceArg
|
Filter by source |
status - VehicleAlertStatusArg
|
Filter by status |
types - [VehicleAlertTypeArg!]
|
Filter by alert types |
batteryTypes - [VehicleAlertBatteryType!]
|
Filter battery alerts by type |
dtcCode - String
|
Filter DTC alerts by code |
dtcClassification - DtcClassification
|
Filter DTC alerts by classification |
dtcMode - DtcMode
|
Filter DTC alerts by mode |
maintenanceFromVehicle - Boolean
|
Filter maintenance alerts by source |
maintenanceCriticalities - [MaintenanceCriticalityArg!]
|
Filter maintenance alerts by criticality |
warningLightLevel - AlertWarningLightLevelArg
|
Filter by warning light level |
warningLightCode - String
|
Filter by warning lignt code |
Example
Query
query vehicleAlerts(
$pageSize: Int,
$pageId: ID,
$sort: [VehicleAlertSort!],
$groups: [ID!],
$ids: [ID!],
$isActive: Boolean,
$language: LangArg,
$source: VehicleAlertSourceArg,
$status: VehicleAlertStatusArg,
$types: [VehicleAlertTypeArg!],
$batteryTypes: [VehicleAlertBatteryType!],
$dtcCode: String,
$dtcClassification: DtcClassification,
$dtcMode: DtcMode,
$maintenanceFromVehicle: Boolean,
$maintenanceCriticalities: [MaintenanceCriticalityArg!],
$warningLightLevel: AlertWarningLightLevelArg,
$warningLightCode: String
) {
vehicleAlerts(
pageSize: $pageSize,
pageId: $pageId,
sort: $sort,
groups: $groups,
ids: $ids,
isActive: $isActive,
language: $language,
source: $source,
status: $status,
types: $types,
batteryTypes: $batteryTypes,
dtcCode: $dtcCode,
dtcClassification: $dtcClassification,
dtcMode: $dtcMode,
maintenanceFromVehicle: $maintenanceFromVehicle,
maintenanceCriticalities: $maintenanceCriticalities,
warningLightLevel: $warningLightLevel,
warningLightCode: $warningLightCode
) {
next
count
list {
...VehicleAlertFragment
}
}
}
Variables
{
"pageSize": 123,
"pageId": "4",
"sort": [VehicleAlertSort],
"groups": ["4"],
"ids": ["4"],
"isActive": true,
"language": "EN",
"source": "DEVICE",
"status": "ONGOING",
"types": ["BAD_INSTALLATION"],
"batteryTypes": ["STATE_OF_HEALTH_LOW_VOLTAGE"],
"dtcCode": "xyz789",
"dtcClassification": "ADVISORY",
"dtcMode": "UNKNOWN",
"maintenanceFromVehicle": true,
"maintenanceCriticalities": ["LOW"],
"warningLightLevel": "ADVISORY",
"warningLightCode": "abc123"
}
Response
{
"data": {
"vehicleAlerts": {
"next": 4,
"count": 123,
"list": [VehicleAlert]
}
}
}
vehicleDesc
Description
Get vehicle description by id
Response
Returns a DecodeVinResult
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query vehicleDesc($id: ID!) {
vehicleDesc(id: $id) {
id
vin
kba
kType
decodingRegion
dayOfFirstCirculation
dayOfSale
monthOfFirstCirculation
monthOfSale
yearOfFirstCirculation
yearOfSale
acceleration
advancedModel
bodyType
bodyTypeCode
brakesAbs
brakesFrontType
brakesRearType
brakesSystem
cargoCapacity
co2Emission
coEmission
color
companyId
country
critair
curbWeight
doors
driveType
electricVehicleBatteryCapacity
electricVehicleBatteryVoltage
emissionStandard
engineAspiration
engineBore
engineCode
engineConfiguration
engineCylinderHeadType
engineCylinders
engineDisplacement
engineExtra
engineFiscalPower
engineFuelType
engineFuelTypeSecondary
engineFuelTypeTertiary
engineIgnitionSystem
engineManufacturer
engineOutputPower
engineOutputPowerPs
engineRpmIdleMax
engineRpmIdleMin
engineRpmMax
engineStroke
engineValves
engineVersion
engineWithTurbo
extraInfo {
...VinExtraInfoFragment
}
frontOverhang
frontTrack
fuelEfficiencyCity
fuelEfficiencyCombined
fuelEfficiencyHighway
fuelInjectionControlType
fuelInjectionSubtype
fuelInjectionSystemDesign
fuelInjectionType
gearboxSpeed
gearboxType
grossWeight
hcEmission
hcNoxEmission
height
hipRoomFront
hipRoomRear
length
manufacturer
make
maxRoofLoad
maxTowBarDownload
maxTrailerLoadBLicense
maxTrailerLoadBraked12
maxTrailerLoadUnbraked
model
modelCode
modelVersionCode
noxEmission
oilTemperatureEmission
options {
...DescriptionOptionFragment
}
plate
price
rearOverhang
rearTrack
seats
sliBatteryCapacity
springsFrontType
springsRearType
steeringSystem
steeringType
tankVolume
topSpeed
transmissionElectronicControl
transmissionManufacturerCode
transmissionType
trunkVolume
urlVehicleImage
vehicleType
verified
wheelBase
wheelsDimension
width
}
}
Variables
{"id": "4"}
Response
{
"data": {
"vehicleDesc": {
"id": 4,
"vin": "abc123",
"kba": "4",
"kType": "abc123",
"decodingRegion": "abc123",
"dayOfFirstCirculation": 987,
"dayOfSale": 123,
"monthOfFirstCirculation": 123,
"monthOfSale": 123,
"yearOfFirstCirculation": 123,
"yearOfSale": 987,
"acceleration": 123.45,
"advancedModel": "abc123",
"bodyType": "abc123",
"bodyTypeCode": "abc123",
"brakesAbs": "xyz789",
"brakesFrontType": "abc123",
"brakesRearType": "abc123",
"brakesSystem": "abc123",
"cargoCapacity": 123,
"co2Emission": 123,
"coEmission": 123.45,
"color": "abc123",
"companyId": 4,
"country": "xyz789",
"critair": "xyz789",
"curbWeight": 123,
"doors": 123,
"driveType": "abc123",
"electricVehicleBatteryCapacity": 987.65,
"electricVehicleBatteryVoltage": 987.65,
"emissionStandard": "abc123",
"engineAspiration": "abc123",
"engineBore": 987.65,
"engineCode": "abc123",
"engineConfiguration": "xyz789",
"engineCylinderHeadType": "xyz789",
"engineCylinders": 123,
"engineDisplacement": 123,
"engineExtra": "xyz789",
"engineFiscalPower": 987,
"engineFuelType": "OTHER",
"engineFuelTypeSecondary": "OTHER",
"engineFuelTypeTertiary": "OTHER",
"engineIgnitionSystem": "xyz789",
"engineManufacturer": "abc123",
"engineOutputPower": 123,
"engineOutputPowerPs": 987,
"engineRpmIdleMax": 987,
"engineRpmIdleMin": 123,
"engineRpmMax": 123,
"engineStroke": 987.65,
"engineValves": 123,
"engineVersion": "xyz789",
"engineWithTurbo": true,
"extraInfo": VinExtraInfo,
"frontOverhang": 123,
"frontTrack": 987,
"fuelEfficiencyCity": 123.45,
"fuelEfficiencyCombined": 123.45,
"fuelEfficiencyHighway": 987.65,
"fuelInjectionControlType": "abc123",
"fuelInjectionSubtype": "xyz789",
"fuelInjectionSystemDesign": "xyz789",
"fuelInjectionType": "xyz789",
"gearboxSpeed": 123,
"gearboxType": "xyz789",
"grossWeight": 123,
"hcEmission": 987.65,
"hcNoxEmission": 987.65,
"height": 987,
"hipRoomFront": 987,
"hipRoomRear": 123,
"length": 123,
"manufacturer": "xyz789",
"make": "xyz789",
"maxRoofLoad": 123,
"maxTowBarDownload": 987,
"maxTrailerLoadBLicense": 987,
"maxTrailerLoadBraked12": 123,
"maxTrailerLoadUnbraked": 123,
"model": "xyz789",
"modelCode": "xyz789",
"modelVersionCode": "xyz789",
"noxEmission": 987.65,
"oilTemperatureEmission": 123.45,
"options": [DescriptionOption],
"plate": "xyz789",
"price": 123,
"rearOverhang": 123,
"rearTrack": 123,
"seats": 987,
"sliBatteryCapacity": 123.45,
"springsFrontType": "abc123",
"springsRearType": "abc123",
"steeringSystem": "xyz789",
"steeringType": "abc123",
"tankVolume": 987,
"topSpeed": 123,
"transmissionElectronicControl": "xyz789",
"transmissionManufacturerCode": "xyz789",
"transmissionType": "abc123",
"trunkVolume": 123,
"urlVehicleImage": "abc123",
"vehicleType": "xyz789",
"verified": true,
"wheelBase": 123,
"wheelsDimension": "xyz789",
"width": 987
}
}
}
vehicleService
Description
Get Vehicle service by ID
Response
Returns a VehicleService
Arguments
| Name | Description |
|---|---|
id - ID!
|
Vehicle service ID |
Example
Query
query vehicleService($id: ID!) {
vehicleService(id: $id) {
id
label
description
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"vehicleService": {
"id": 4,
"label": "abc123",
"description": "xyz789",
"workshops": WorkshopPaged
}
}
}
vehicleServices
Description
List Vehicle services
Response
Returns a VehicleServicePaged
Example
Query
query vehicleServices(
$pageSize: Int,
$pageId: ID,
$label: String
) {
vehicleServices(
pageSize: $pageSize,
pageId: $pageId,
label: $label
) {
next
count
list {
...VehicleServiceFragment
}
}
}
Variables
{
"pageSize": 987,
"pageId": 4,
"label": "abc123"
}
Response
{
"data": {
"vehicleServices": {
"next": "4",
"count": 987,
"list": [VehicleService]
}
}
}
vehicleType
Description
Get Vehicle type by ID
Response
Returns a VehicleType
Arguments
| Name | Description |
|---|---|
id - ID!
|
Vehicle type ID |
Example
Query
query vehicleType($id: ID!) {
vehicleType(id: $id) {
id
label
description
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"vehicleType": {
"id": 4,
"label": "xyz789",
"description": "xyz789",
"workshops": WorkshopPaged
}
}
}
vehicleTypes
Description
List Vehicle types
Response
Returns a VehicleTypePaged
Example
Query
query vehicleTypes(
$pageSize: Int,
$pageId: ID,
$label: String
) {
vehicleTypes(
pageSize: $pageSize,
pageId: $pageId,
label: $label
) {
next
count
list {
...VehicleTypeFragment
}
}
}
Variables
{
"pageSize": 123,
"pageId": "4",
"label": "abc123"
}
Response
{
"data": {
"vehicleTypes": {
"next": 4,
"count": 987,
"list": [VehicleType]
}
}
}
vehicles
Description
Get the logged-in user vehicle list
Response
Returns a VehiclePaged
Arguments
| Name | Description |
|---|---|
pageSize - Int
|
Results per page (initial query) |
pageId - ID
|
Request page id (followup queries) |
ids - [ID]
|
Filter by ids |
plates - [String]
|
Filter by plates |
labels - [String]
|
Filter by labels |
vins - [String]
|
Filter by VINs |
modelIds - [ID]
|
Model ID |
ktypes - [String]
|
KType |
makes - [String]
|
Model make |
models - [String]
|
Model |
years - [String]
|
Model Year |
fuelTypes - [String]
|
Primary fuel type |
fuelTypeSecondaries - [String]
|
Secondary fuel type |
kba - [String]
|
KBA |
onboarded - Boolean
|
onboarded |
hasDriver - Boolean
|
has_driver |
hybrid - Boolean
|
hybrid |
anyFuelTypes - [String]
|
Primary or secondary fuel type |
vehicleTypes - [VehicleTypeName]
|
Vehicle type |
canTow - Boolean
|
can be used as towing vehicle |
canBeTowed - Boolean
|
can be used as trailer vehicle |
immobilizerStatuses - [ImmobilizerStatus]
|
Filter by immobilizer status. |
doorsLockStatuses - [DoorsLockStatus]
|
Filter by doors lock status. |
garageModeStatuses - [GarageModeStatus]
|
Filter by garage mode status. |
archived - Boolean
|
Filter by archived |
multi - [String]
|
Filter by Vehicle plate, vin, make and model, by Driver label and by Device imei. |
Example
Query
query vehicles(
$pageSize: Int,
$pageId: ID,
$ids: [ID],
$plates: [String],
$labels: [String],
$vins: [String],
$modelIds: [ID],
$ktypes: [String],
$makes: [String],
$models: [String],
$years: [String],
$fuelTypes: [String],
$fuelTypeSecondaries: [String],
$kba: [String],
$onboarded: Boolean,
$hasDriver: Boolean,
$hybrid: Boolean,
$anyFuelTypes: [String],
$vehicleTypes: [VehicleTypeName],
$canTow: Boolean,
$canBeTowed: Boolean,
$immobilizerStatuses: [ImmobilizerStatus],
$doorsLockStatuses: [DoorsLockStatus],
$garageModeStatuses: [GarageModeStatus],
$archived: Boolean,
$multi: [String]
) {
vehicles(
pageSize: $pageSize,
pageId: $pageId,
ids: $ids,
plates: $plates,
labels: $labels,
vins: $vins,
modelIds: $modelIds,
ktypes: $ktypes,
makes: $makes,
models: $models,
years: $years,
fuelTypes: $fuelTypes,
fuelTypeSecondaries: $fuelTypeSecondaries,
kba: $kba,
onboarded: $onboarded,
hasDriver: $hasDriver,
hybrid: $hybrid,
anyFuelTypes: $anyFuelTypes,
vehicleTypes: $vehicleTypes,
canTow: $canTow,
canBeTowed: $canBeTowed,
immobilizerStatuses: $immobilizerStatuses,
doorsLockStatuses: $doorsLockStatuses,
garageModeStatuses: $garageModeStatuses,
archived: $archived,
multi: $multi
) {
next
count
list {
...VehicleFragment
}
}
}
Variables
{
"pageSize": 123,
"pageId": 4,
"ids": [4],
"plates": ["xyz789"],
"labels": ["abc123"],
"vins": ["abc123"],
"modelIds": [4],
"ktypes": ["abc123"],
"makes": ["abc123"],
"models": ["xyz789"],
"years": ["abc123"],
"fuelTypes": ["abc123"],
"fuelTypeSecondaries": ["abc123"],
"kba": ["xyz789"],
"onboarded": true,
"hasDriver": true,
"hybrid": false,
"anyFuelTypes": ["xyz789"],
"vehicleTypes": ["CAR"],
"canTow": true,
"canBeTowed": false,
"immobilizerStatuses": ["UNKNOWN"],
"doorsLockStatuses": ["UNKNOWN"],
"garageModeStatuses": ["UNKNOWN"],
"archived": true,
"multi": ["xyz789"]
}
Response
{
"data": {
"vehicles": {
"next": 4,
"count": 987,
"list": [Vehicle]
}
}
}
warningIcons
Description
List warning icons
Response
Returns a WarningIconPaged
Example
Query
query warningIcons(
$pageSize: Int,
$pageId: ID,
$codes: [String!],
$names: [String!]
) {
warningIcons(
pageSize: $pageSize,
pageId: $pageId,
codes: $codes,
names: $names
) {
next
count
list {
...WarningIconFragment
}
}
}
Variables
{
"pageSize": 987,
"pageId": 4,
"codes": ["abc123"],
"names": ["abc123"]
}
Response
{
"data": {
"warningIcons": {
"next": 4,
"count": 987,
"list": [WarningIcon]
}
}
}
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
weatherId
weather
}
}
Variables
{
"latitude": 123.45,
"longitude": 987.65,
"time": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"weather": {
"latitude": 987.65,
"longitude": 987.65,
"temperature": 987.65,
"time": "2007-12-03T10:15:30Z",
"weatherId": 987,
"weather": "abc123"
}
}
}
wifiStatus
Description
Get wifi status
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
deviceId - ID!
|
Device id |
Example
Query
query wifiStatus($deviceId: ID!) {
wifiStatus(deviceId: $deviceId) {
id
type
attributes
}
}
Variables
{"deviceId": 4}
Response
{
"data": {
"wifiStatus": {
"id": "4",
"type": "abc123",
"attributes": Json
}
}
}
workday
Description
Get Workday by ID
Example
Query
query workday($id: ID!) {
workday(id: $id) {
id
day
openingHour1
closingHour1
openingHour2
closingHour2
workshop {
...WorkshopFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"workday": {
"id": 4,
"day": "MONDAY",
"openingHour1": "abc123",
"closingHour1": "abc123",
"openingHour2": "abc123",
"closingHour2": "xyz789",
"workshop": Workshop
}
}
}
workshop
Description
Get Workshop by ID
Example
Query
query workshop($id: ID!) {
workshop(id: $id) {
id
name
code
provider
providerWorkshopId
lat
lon
address
postalCode
province
brand
city
country
phone
internationalPhone
fax
email
web
language
timeZone
icon
averageStars
ratings {
...RatingPagedFragment
}
workdays {
...WorkdayPagedFragment
}
vehicleTypes {
...VehicleTypePagedFragment
}
vehicleServices {
...VehicleServicePagedFragment
}
driverServices {
...DriverServicePagedFragment
}
bookings {
...BookingPagedFragment
}
quotations {
...QuotationPagedFragment
}
managers {
...WorkshopManagerPagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"workshop": {
"id": "4",
"name": "xyz789",
"code": "xyz789",
"provider": "abc123",
"providerWorkshopId": "4",
"lat": 123.45,
"lon": 123.45,
"address": "xyz789",
"postalCode": "xyz789",
"province": "abc123",
"brand": "xyz789",
"city": "xyz789",
"country": "abc123",
"phone": "xyz789",
"internationalPhone": "xyz789",
"fax": "abc123",
"email": "xyz789",
"web": "xyz789",
"language": Language,
"timeZone": "abc123",
"icon": "abc123",
"averageStars": 987.65,
"ratings": RatingPaged,
"workdays": WorkdayPaged,
"vehicleTypes": VehicleTypePaged,
"vehicleServices": VehicleServicePaged,
"driverServices": DriverServicePaged,
"bookings": BookingPaged,
"quotations": QuotationPaged,
"managers": WorkshopManagerPaged
}
}
}
workshops
Description
List Workshops
Response
Returns a WorkshopPaged
Arguments
| Name | Description |
|---|---|
pageSize - Int
|
Results per page (initial query) |
pageId - ID
|
Request page id (followup queries) |
name - String
|
Workshop name |
brand - String
|
Workshop brand |
code - String
|
Workshop code |
country - String
|
Workshop country |
city - String
|
Workshop city |
address - String
|
Workshop address |
postalCode - String
|
Workshop postal code |
province - String
|
Workshop province |
phone - String
|
Workshop phone |
internationalPhone - String
|
Workshop international phone |
provider - String
|
Workshop provider |
timeZone - String
|
Workshop time_zone |
language - Language
|
Workshop language |
averageStars - Float
|
Workshop with average rating stars above value |
available - String
|
Workshop open on the specified DAY,HH:MM or DAY |
lat - Float
|
Workshop latitude |
lon - Float
|
Workshop longitude |
distance - Int
|
Max distance (km) from lat/lon |
Example
Query
query workshops(
$pageSize: Int,
$pageId: ID,
$name: String,
$brand: String,
$code: String,
$country: String,
$city: String,
$address: String,
$postalCode: String,
$province: String,
$phone: String,
$internationalPhone: String,
$provider: String,
$timeZone: String,
$language: Language,
$averageStars: Float,
$available: String,
$lat: Float,
$lon: Float,
$distance: Int
) {
workshops(
pageSize: $pageSize,
pageId: $pageId,
name: $name,
brand: $brand,
code: $code,
country: $country,
city: $city,
address: $address,
postalCode: $postalCode,
province: $province,
phone: $phone,
internationalPhone: $internationalPhone,
provider: $provider,
timeZone: $timeZone,
language: $language,
averageStars: $averageStars,
available: $available,
lat: $lat,
lon: $lon,
distance: $distance
) {
next
count
list {
...WorkshopFragment
}
}
}
Variables
{
"pageSize": 987,
"pageId": 4,
"name": "xyz789",
"brand": "abc123",
"code": "xyz789",
"country": "xyz789",
"city": "xyz789",
"address": "abc123",
"postalCode": "xyz789",
"province": "xyz789",
"phone": "xyz789",
"internationalPhone": "abc123",
"provider": "xyz789",
"timeZone": "xyz789",
"language": Language,
"averageStars": 987.65,
"available": "xyz789",
"lat": 123.45,
"lon": 123.45,
"distance": 123
}
Response
{
"data": {
"workshops": {
"next": "4",
"count": 987,
"list": [Workshop]
}
}
}
Mutations
accountConfirm
Description
Confirm account using side-channel code
Response
Returns an AccountConfirmation
Arguments
| Name | Description |
|---|---|
code - String!
|
Confirmation code |
Example
Query
mutation accountConfirm($code: String!) {
accountConfirm(code: $code) {
id
updatedAt
forceResetAtConfirmation
forceResetPassword
}
}
Variables
{"code": "xyz789"}
Response
{
"data": {
"accountConfirm": {
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"forceResetAtConfirmation": true,
"forceResetPassword": false
}
}
}
accountCreate
Description
Create a new user account
Response
Returns an Account
Arguments
| Name | Description |
|---|---|
email - String
|
|
fullName - String
|
Full name |
shortName - String
|
Short name |
phone - String
|
Phone number (including international code) |
password - String
|
Account password (see also passwordResetToken) |
countryCode - String
|
Country code (ISO 639) |
language - Language
|
Language |
timeZone - String
|
Time zone |
organizationId - ID
|
Organization id |
groupId - ID
|
Group id |
Example
Query
mutation accountCreate(
$email: String,
$fullName: String,
$shortName: String,
$phone: String,
$password: String,
$countryCode: String,
$language: Language,
$timeZone: String,
$organizationId: ID,
$groupId: ID
) {
accountCreate(
email: $email,
fullName: $fullName,
shortName: $shortName,
phone: $phone,
password: $password,
countryCode: $countryCode,
language: $language,
timeZone: $timeZone,
organizationId: $organizationId,
groupId: $groupId
) {
id
organizationId
email
phone
fullName
shortName
companyName
countryCode
language
timeZone
createdAt
updatedAt
lastSignInAt
confirmedAt
descriptions {
...DescriptionPagedFragment
}
roles {
...AccountRoleFragment
}
groups {
...GroupPagedFragment
}
devices {
...DevicePagedFragment
}
vehicles {
...VehiclePagedFragment
}
drivers {
...DriverPagedFragment
}
driverProfiles {
...DriverPagedFragment
}
driverContacts {
...DriverPagedFragment
}
workshops {
...WorkshopPagedFragment
}
distributors {
...OnboardingDistributorPagedFragment
}
alertPreference {
...AlertPreferenceFragment
}
}
}
Variables
{
"email": "xyz789",
"fullName": "xyz789",
"shortName": "xyz789",
"phone": "abc123",
"password": "abc123",
"countryCode": "xyz789",
"language": Language,
"timeZone": "xyz789",
"organizationId": 4,
"groupId": 4
}
Response
{
"data": {
"accountCreate": {
"id": "4",
"organizationId": "4",
"email": "abc123",
"phone": "xyz789",
"fullName": "xyz789",
"shortName": "abc123",
"companyName": "abc123",
"countryCode": "abc123",
"language": Language,
"timeZone": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"lastSignInAt": "2007-12-03T10:15:30Z",
"confirmedAt": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"roles": [AccountRole],
"groups": GroupPaged,
"devices": DevicePaged,
"vehicles": VehiclePaged,
"drivers": DriverPaged,
"driverProfiles": DriverPaged,
"driverContacts": DriverPaged,
"workshops": WorkshopPaged,
"distributors": OnboardingDistributorPaged,
"alertPreference": AlertPreference
}
}
}
accountDelete
Currently not supported, contact customer support for account deletion
accountUpdate
Description
Update Logged in user account
Response
Returns an Account
Arguments
| Name | Description |
|---|---|
id - ID
|
Account to update |
fullName - String
|
Full name |
shortName - String
|
Short name |
email - String
|
|
phone - String
|
Phone number (including international code) |
password - String
|
Account password (see also passwordResetToken) |
countryCode - String
|
Country code (ISO 639) |
language - Language
|
Language |
timeZone - String
|
Time zone |
roles - [RoleInput]
|
Role- and target-based permissions |
Example
Query
mutation accountUpdate(
$id: ID,
$fullName: String,
$shortName: String,
$email: String,
$phone: String,
$password: String,
$countryCode: String,
$language: Language,
$timeZone: String,
$roles: [RoleInput]
) {
accountUpdate(
id: $id,
fullName: $fullName,
shortName: $shortName,
email: $email,
phone: $phone,
password: $password,
countryCode: $countryCode,
language: $language,
timeZone: $timeZone,
roles: $roles
) {
id
organizationId
email
phone
fullName
shortName
companyName
countryCode
language
timeZone
createdAt
updatedAt
lastSignInAt
confirmedAt
descriptions {
...DescriptionPagedFragment
}
roles {
...AccountRoleFragment
}
groups {
...GroupPagedFragment
}
devices {
...DevicePagedFragment
}
vehicles {
...VehiclePagedFragment
}
drivers {
...DriverPagedFragment
}
driverProfiles {
...DriverPagedFragment
}
driverContacts {
...DriverPagedFragment
}
workshops {
...WorkshopPagedFragment
}
distributors {
...OnboardingDistributorPagedFragment
}
alertPreference {
...AlertPreferenceFragment
}
}
}
Variables
{
"id": "4",
"fullName": "xyz789",
"shortName": "abc123",
"email": "xyz789",
"phone": "xyz789",
"password": "abc123",
"countryCode": "xyz789",
"language": Language,
"timeZone": "xyz789",
"roles": [RoleInput]
}
Response
{
"data": {
"accountUpdate": {
"id": 4,
"organizationId": 4,
"email": "abc123",
"phone": "xyz789",
"fullName": "xyz789",
"shortName": "xyz789",
"companyName": "abc123",
"countryCode": "xyz789",
"language": Language,
"timeZone": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"lastSignInAt": "2007-12-03T10:15:30Z",
"confirmedAt": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"roles": [AccountRole],
"groups": GroupPaged,
"devices": DevicePaged,
"vehicles": VehiclePaged,
"drivers": DriverPaged,
"driverProfiles": DriverPaged,
"driverContacts": DriverPaged,
"workshops": WorkshopPaged,
"distributors": OnboardingDistributorPaged,
"alertPreference": AlertPreference
}
}
}
alertNotificationCreate
Description
Create notification
Response
Returns an AlertNotification
Example
Query
mutation alertNotificationCreate(
$receiver: ID,
$context: Json,
$queueName: String,
$queueVersion: String
) {
alertNotificationCreate(
receiver: $receiver,
context: $context,
queueName: $queueName,
queueVersion: $queueVersion
) {
id
templateContext
forceChannel
sentAt
failedAt
createdAt
updatedAt
status
queue {
...AlertQueueFragment
}
template {
...AlertTemplateFragment
}
sender {
...AccountFragment
}
receiver {
...AccountFragment
}
jobs {
...AlertJobPagedFragment
}
}
}
Variables
{
"receiver": "4",
"context": Json,
"queueName": "xyz789",
"queueVersion": "xyz789"
}
Response
{
"data": {
"alertNotificationCreate": {
"id": 4,
"templateContext": Json,
"forceChannel": true,
"sentAt": "2007-12-03T10:15:30Z",
"failedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "CREATED",
"queue": AlertQueue,
"template": AlertTemplate,
"sender": Account,
"receiver": Account,
"jobs": AlertJobPaged
}
}
}
alertNotificationUpdate
Description
Update notification
Response
Returns an AlertNotification
Example
Query
mutation alertNotificationUpdate(
$id: ID!,
$receiver: ID,
$context: Json,
$queueName: String,
$queueVersion: String,
$status: AlertNotificationStatus
) {
alertNotificationUpdate(
id: $id,
receiver: $receiver,
context: $context,
queueName: $queueName,
queueVersion: $queueVersion,
status: $status
) {
id
templateContext
forceChannel
sentAt
failedAt
createdAt
updatedAt
status
queue {
...AlertQueueFragment
}
template {
...AlertTemplateFragment
}
sender {
...AccountFragment
}
receiver {
...AccountFragment
}
jobs {
...AlertJobPagedFragment
}
}
}
Variables
{
"id": "4",
"receiver": 4,
"context": Json,
"queueName": "abc123",
"queueVersion": "xyz789",
"status": "CREATED"
}
Response
{
"data": {
"alertNotificationUpdate": {
"id": "4",
"templateContext": Json,
"forceChannel": true,
"sentAt": "2007-12-03T10:15:30Z",
"failedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "CREATED",
"queue": AlertQueue,
"template": AlertTemplate,
"sender": Account,
"receiver": Account,
"jobs": AlertJobPaged
}
}
}
alertPreferenceUpdate
Response
Returns an AlertPreference
Arguments
| Name | Description |
|---|---|
id - ID
|
Account id |
firebaseMessagingToken - String
|
|
stopNotifications - Boolean
|
|
preferredChannels - [AlertPreferredChannel]
|
Example
Query
mutation alertPreferenceUpdate(
$id: ID,
$firebaseMessagingToken: String,
$stopNotifications: Boolean,
$preferredChannels: [AlertPreferredChannel]
) {
alertPreferenceUpdate(
id: $id,
firebaseMessagingToken: $firebaseMessagingToken,
stopNotifications: $stopNotifications,
preferredChannels: $preferredChannels
) {
id
firebaseMessagingToken
stopNotifications
preferredChannels
}
}
Variables
{
"id": 4,
"firebaseMessagingToken": "xyz789",
"stopNotifications": false,
"preferredChannels": ["IN_APP"]
}
Response
{
"data": {
"alertPreferenceUpdate": {
"id": "4",
"firebaseMessagingToken": "xyz789",
"stopNotifications": true,
"preferredChannels": ["IN_APP"]
}
}
}
bookingCreate
Description
Create booking
Response
Returns a Booking
Arguments
| Name | Description |
|---|---|
workshopId - ID!
|
Workshop ID |
plateNumber - String!
|
Vehichle plate number |
userEmail - String!
|
|
userName - String!
|
|
userPhoneNumber - String!
|
|
contactMethod - WorkshopContactMethod!
|
|
vehicleMake - String
|
|
vehicleModel - String
|
|
vehicleYear - String
|
|
vin - String
|
|
city - String
|
|
country - String
|
|
additionalInformation - String
|
|
preferredLanguage - Language
|
|
bookingDate - DateTime
|
|
quotationIds - [ID]
|
|
uid - ID
|
Example
Query
mutation bookingCreate(
$workshopId: ID!,
$plateNumber: String!,
$userEmail: String!,
$userName: String!,
$userPhoneNumber: String!,
$contactMethod: WorkshopContactMethod!,
$vehicleMake: String,
$vehicleModel: String,
$vehicleYear: String,
$vin: String,
$city: String,
$country: String,
$additionalInformation: String,
$preferredLanguage: Language,
$bookingDate: DateTime,
$quotationIds: [ID],
$uid: ID
) {
bookingCreate(
workshopId: $workshopId,
plateNumber: $plateNumber,
userEmail: $userEmail,
userName: $userName,
userPhoneNumber: $userPhoneNumber,
contactMethod: $contactMethod,
vehicleMake: $vehicleMake,
vehicleModel: $vehicleModel,
vehicleYear: $vehicleYear,
vin: $vin,
city: $city,
country: $country,
additionalInformation: $additionalInformation,
preferredLanguage: $preferredLanguage,
bookingDate: $bookingDate,
quotationIds: $quotationIds,
uid: $uid
) {
id
plateNumber
bookingDate
status
quotationIds
workshop {
...WorkshopFragment
}
vehicleMake
vehicleModel
vehicleYear
vin
city
country
additionalInformation
preferredLanguage
contactMethod
userEmail
userName
userPhoneNumber
}
}
Variables
{
"workshopId": "4",
"plateNumber": "abc123",
"userEmail": "xyz789",
"userName": "xyz789",
"userPhoneNumber": "xyz789",
"contactMethod": "SMS",
"vehicleMake": "xyz789",
"vehicleModel": "abc123",
"vehicleYear": "abc123",
"vin": "xyz789",
"city": "xyz789",
"country": "xyz789",
"additionalInformation": "xyz789",
"preferredLanguage": Language,
"bookingDate": "2007-12-03T10:15:30Z",
"quotationIds": ["4"],
"uid": 4
}
Response
{
"data": {
"bookingCreate": {
"id": 4,
"plateNumber": "xyz789",
"bookingDate": "2007-12-03T10:15:30Z",
"status": "PENDING",
"quotationIds": ["4"],
"workshop": Workshop,
"vehicleMake": "xyz789",
"vehicleModel": "abc123",
"vehicleYear": "abc123",
"vin": "xyz789",
"city": "abc123",
"country": "abc123",
"additionalInformation": "abc123",
"preferredLanguage": Language,
"contactMethod": "SMS",
"userEmail": "abc123",
"userName": "abc123",
"userPhoneNumber": "xyz789"
}
}
}
bookingDelete
Description
Cancel booking
bookingUpdate
Description
Update booking
Response
Returns a Booking
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
workshopId - ID
|
Workshop ID |
plateNumber - String
|
Vehichle plate number |
userEmail - String
|
|
userName - String
|
|
userPhoneNumber - String
|
|
contactMethod - WorkshopContactMethod
|
|
vehicleMake - String
|
|
vehicleModel - String
|
|
vehicleYear - String
|
|
vin - String
|
|
city - String
|
|
country - String
|
|
additionalInformation - String
|
|
preferredLanguage - Language
|
|
bookingDate - DateTime
|
|
quotationIds - [ID]
|
|
uid - ID
|
Example
Query
mutation bookingUpdate(
$id: ID!,
$workshopId: ID,
$plateNumber: String,
$userEmail: String,
$userName: String,
$userPhoneNumber: String,
$contactMethod: WorkshopContactMethod,
$vehicleMake: String,
$vehicleModel: String,
$vehicleYear: String,
$vin: String,
$city: String,
$country: String,
$additionalInformation: String,
$preferredLanguage: Language,
$bookingDate: DateTime,
$quotationIds: [ID],
$uid: ID
) {
bookingUpdate(
id: $id,
workshopId: $workshopId,
plateNumber: $plateNumber,
userEmail: $userEmail,
userName: $userName,
userPhoneNumber: $userPhoneNumber,
contactMethod: $contactMethod,
vehicleMake: $vehicleMake,
vehicleModel: $vehicleModel,
vehicleYear: $vehicleYear,
vin: $vin,
city: $city,
country: $country,
additionalInformation: $additionalInformation,
preferredLanguage: $preferredLanguage,
bookingDate: $bookingDate,
quotationIds: $quotationIds,
uid: $uid
) {
id
plateNumber
bookingDate
status
quotationIds
workshop {
...WorkshopFragment
}
vehicleMake
vehicleModel
vehicleYear
vin
city
country
additionalInformation
preferredLanguage
contactMethod
userEmail
userName
userPhoneNumber
}
}
Variables
{
"id": "4",
"workshopId": "4",
"plateNumber": "abc123",
"userEmail": "abc123",
"userName": "xyz789",
"userPhoneNumber": "abc123",
"contactMethod": "SMS",
"vehicleMake": "abc123",
"vehicleModel": "xyz789",
"vehicleYear": "abc123",
"vin": "abc123",
"city": "abc123",
"country": "xyz789",
"additionalInformation": "abc123",
"preferredLanguage": Language,
"bookingDate": "2007-12-03T10:15:30Z",
"quotationIds": ["4"],
"uid": 4
}
Response
{
"data": {
"bookingUpdate": {
"id": "4",
"plateNumber": "abc123",
"bookingDate": "2007-12-03T10:15:30Z",
"status": "PENDING",
"quotationIds": ["4"],
"workshop": Workshop,
"vehicleMake": "abc123",
"vehicleModel": "abc123",
"vehicleYear": "xyz789",
"vin": "abc123",
"city": "xyz789",
"country": "xyz789",
"additionalInformation": "xyz789",
"preferredLanguage": Language,
"contactMethod": "SMS",
"userEmail": "xyz789",
"userName": "abc123",
"userPhoneNumber": "xyz789"
}
}
}
clientIdentificationCreate
Response
Returns a ClientIdentification
Arguments
| Name | Description |
|---|---|
numberOfOnboardings - Int
|
|
distributorId - ID
|
Distributor id (if user has access to more than one) |
clientReference - ID
|
|
clientReferenceType - ClientReferenceType
|
|
defaultAccountId - ID
|
Default account to use with these onboardings |
label - String
|
|
defaultWhitelistedData - [OnboardingWhitelistedDataArg!]
|
Example
Query
mutation clientIdentificationCreate(
$numberOfOnboardings: Int,
$distributorId: ID,
$clientReference: ID,
$clientReferenceType: ClientReferenceType,
$defaultAccountId: ID,
$label: String,
$defaultWhitelistedData: [OnboardingWhitelistedDataArg!]
) {
clientIdentificationCreate(
numberOfOnboardings: $numberOfOnboardings,
distributorId: $distributorId,
clientReference: $clientReference,
clientReferenceType: $clientReferenceType,
defaultAccountId: $defaultAccountId,
label: $label,
defaultWhitelistedData: $defaultWhitelistedData
) {
id
clientReference
clientReferenceType
numberOfOnboardings
numberOfStartedOnboardings
code
label
revoked
distributor {
...OnboardingDistributorFragment
}
createdBy {
...AccountFragment
}
defaultAccount {
...AccountFragment
}
defaultWhitelistedData
}
}
Variables
{
"numberOfOnboardings": 123,
"distributorId": "4",
"clientReference": 4,
"clientReferenceType": "GROUP",
"defaultAccountId": "4",
"label": "xyz789",
"defaultWhitelistedData": ["POSITION"]
}
Response
{
"data": {
"clientIdentificationCreate": {
"id": 4,
"clientReference": "4",
"clientReferenceType": "GROUP",
"numberOfOnboardings": 123,
"numberOfStartedOnboardings": 123,
"code": "abc123",
"label": "abc123",
"revoked": false,
"distributor": OnboardingDistributor,
"createdBy": Account,
"defaultAccount": Account,
"defaultWhitelistedData": ["POSITION"]
}
}
}
clientIdentificationRevoke
cloudEventsCreate
Description
Notify events from the cloud to the subscribed clients
Response
Returns a CloudEventStatus
Arguments
| Name | Description |
|---|---|
pokes - [EventPokeArg!]
|
List of pokes to notify |
tracks - [EventTrackArg!]
|
List of tracks to notify |
presences - [EventPresenceArg!]
|
|
positions - [EventPositionArg!]
|
|
remotediags - [EventRemotediagArg!]
|
Example
Query
mutation cloudEventsCreate(
$pokes: [EventPokeArg!],
$tracks: [EventTrackArg!],
$presences: [EventPresenceArg!],
$positions: [EventPositionArg!],
$remotediags: [EventRemotediagArg!]
) {
cloudEventsCreate(
pokes: $pokes,
tracks: $tracks,
presences: $presences,
positions: $positions,
remotediags: $remotediags
) {
node
peers
}
}
Variables
{
"pokes": [EventPokeArg],
"tracks": [EventTrackArg],
"presences": [EventPresenceArg],
"positions": [EventPositionArg],
"remotediags": [EventRemotediagArg]
}
Response
{
"data": {
"cloudEventsCreate": {
"node": "xyz789",
"peers": ["abc123"]
}
}
}
createMetadatum
Description
Create metadatum
Response
Returns a TripMetadatum
Example
Query
mutation createMetadatum(
$key: String!,
$value: String!,
$tripId: ID!
) {
createMetadatum(
key: $key,
value: $value,
tripId: $tripId
) {
id
key
value
tripId
createdAt
updatedAt
}
}
Variables
{
"key": "abc123",
"value": "abc123",
"tripId": 4
}
Response
{
"data": {
"createMetadatum": {
"id": 4,
"key": "abc123",
"value": "xyz789",
"tripId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
deleteMetadatum
Description
Delete metdatum
descriptionCreate
Response
Returns a Description
Arguments
| Name | Description |
|---|---|
subject - DescriptionSubject!
|
|
description - DescriptionCreate!
|
Example
Query
mutation descriptionCreate(
$subject: DescriptionSubject!,
$description: DescriptionCreate!
) {
descriptionCreate(
subject: $subject,
description: $description
) {
id
label
value
source
createdAt
updatedAt
}
}
Variables
{
"subject": DescriptionSubject,
"description": DescriptionCreate
}
Response
{
"data": {
"descriptionCreate": {
"id": 4,
"label": "xyz789",
"value": "xyz789",
"source": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
descriptionDelete
Response
Returns an ID
Arguments
| Name | Description |
|---|---|
subject - DescriptionSubject!
|
|
id - ID!
|
Example
Query
mutation descriptionDelete(
$subject: DescriptionSubject!,
$id: ID!
) {
descriptionDelete(
subject: $subject,
id: $id
)
}
Variables
{
"subject": DescriptionSubject,
"id": "4"
}
Response
{"data": {"descriptionDelete": "4"}}
descriptionSet
Response
Returns a Description
Arguments
| Name | Description |
|---|---|
subject - DescriptionSubject!
|
|
description - DescriptionUpdate!
|
Example
Query
mutation descriptionSet(
$subject: DescriptionSubject!,
$description: DescriptionUpdate!
) {
descriptionSet(
subject: $subject,
description: $description
) {
id
label
value
source
createdAt
updatedAt
}
}
Variables
{
"subject": DescriptionSubject,
"description": DescriptionUpdate
}
Response
{
"data": {
"descriptionSet": {
"id": 4,
"label": "xyz789",
"value": "xyz789",
"source": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
deviceCreate
Description
Create a new device
Response
Returns a Device
Arguments
| Name | Description |
|---|---|
input - DeviceInput!
|
Device Input |
Example
Query
mutation deviceCreate($input: DeviceInput!) {
deviceCreate(input: $input) {
id
activeAccount
deviceType
serialNumber
onboarded
createdAt
updatedAt
owner {
...AccountFragment
}
firstConnectionAt
lastConnectionAt
lastConnectionReason
lastDisconnectionAt
lastDisconnectionReason
lastActivityAt
status
history {
...DeviceHistoryPagedFragment
}
aggregatedData {
...AggregatedDataFragment
}
lastTrip {
...TripFragment
}
trips {
...TripPagedFragment
}
tripSummary {
...TripSummaryFragment
}
harshes {
...TripHarshPagedFragment
}
overspeeds {
...TripOverspeedPagedFragment
}
currentVehicle {
...VehicleFragment
}
vehicles {
...VehiclePagedFragment
}
fields {
...FieldPagedFragment
}
readings {
...ReadingPagedFragment
}
readingsAnon {
...ReadingAnonPagedFragment
}
lastPosition {
...CoordinatesFragment
}
vehicleSessions {
...DeviceVehicleSessionPagedFragment
}
groups {
...GroupPagedFragment
}
alerts {
...VehicleAlertPagedFragment
}
alertsState {
...VehicleAlertsStateFragment
}
batteryAnnotations {
...BatteryAnnotationPagedFragment
}
remoteDiags {
...RemoteDiagPagedFragment
}
logFetches {
...LogfetchPagedFragment
}
profilePrivacies {
...ProfilePrivacyPagedFragment
}
profilePrivacy {
...ProfilePrivacyFragment
}
profileModes {
...ProfileDeviceModePagedFragment
}
profileMode {
...ProfileDeviceModeFragment
}
product {
...ProductFragment
}
}
}
Variables
{"input": DeviceInput}
Response
{
"data": {
"deviceCreate": {
"id": "4",
"activeAccount": "xyz789",
"deviceType": "xyz789",
"serialNumber": "xyz789",
"onboarded": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"owner": Account,
"firstConnectionAt": "2007-12-03T10:15:30Z",
"lastConnectionAt": "2007-12-03T10:15:30Z",
"lastConnectionReason": "COLD_BOOT",
"lastDisconnectionAt": "2007-12-03T10:15:30Z",
"lastDisconnectionReason": "UNKNOWN_SERVER_REASON",
"lastActivityAt": "2007-12-03T10:15:30Z",
"status": "CONNECTED",
"history": DeviceHistoryPaged,
"aggregatedData": AggregatedData,
"lastTrip": Trip,
"trips": TripPaged,
"tripSummary": TripSummary,
"harshes": TripHarshPaged,
"overspeeds": TripOverspeedPaged,
"currentVehicle": Vehicle,
"vehicles": VehiclePaged,
"fields": FieldPaged,
"readings": ReadingPaged,
"readingsAnon": ReadingAnonPaged,
"lastPosition": Coordinates,
"vehicleSessions": DeviceVehicleSessionPaged,
"groups": GroupPaged,
"alerts": VehicleAlertPaged,
"alertsState": VehicleAlertsState,
"batteryAnnotations": BatteryAnnotationPaged,
"remoteDiags": RemoteDiagPaged,
"logFetches": LogfetchPaged,
"profilePrivacies": ProfilePrivacyPaged,
"profilePrivacy": ProfilePrivacy,
"profileModes": ProfileDeviceModePaged,
"profileMode": ProfileDeviceMode,
"product": Product
}
}
}
deviceDelete
Description
Delete a user device
Example
Query
mutation deviceDelete($id: ID!) {
deviceDelete(id: $id) {
id
activeAccount
deviceType
serialNumber
onboarded
createdAt
updatedAt
owner {
...AccountFragment
}
firstConnectionAt
lastConnectionAt
lastConnectionReason
lastDisconnectionAt
lastDisconnectionReason
lastActivityAt
status
history {
...DeviceHistoryPagedFragment
}
aggregatedData {
...AggregatedDataFragment
}
lastTrip {
...TripFragment
}
trips {
...TripPagedFragment
}
tripSummary {
...TripSummaryFragment
}
harshes {
...TripHarshPagedFragment
}
overspeeds {
...TripOverspeedPagedFragment
}
currentVehicle {
...VehicleFragment
}
vehicles {
...VehiclePagedFragment
}
fields {
...FieldPagedFragment
}
readings {
...ReadingPagedFragment
}
readingsAnon {
...ReadingAnonPagedFragment
}
lastPosition {
...CoordinatesFragment
}
vehicleSessions {
...DeviceVehicleSessionPagedFragment
}
groups {
...GroupPagedFragment
}
alerts {
...VehicleAlertPagedFragment
}
alertsState {
...VehicleAlertsStateFragment
}
batteryAnnotations {
...BatteryAnnotationPagedFragment
}
remoteDiags {
...RemoteDiagPagedFragment
}
logFetches {
...LogfetchPagedFragment
}
profilePrivacies {
...ProfilePrivacyPagedFragment
}
profilePrivacy {
...ProfilePrivacyFragment
}
profileModes {
...ProfileDeviceModePagedFragment
}
profileMode {
...ProfileDeviceModeFragment
}
product {
...ProductFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deviceDelete": {
"id": 4,
"activeAccount": "xyz789",
"deviceType": "abc123",
"serialNumber": "abc123",
"onboarded": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"owner": Account,
"firstConnectionAt": "2007-12-03T10:15:30Z",
"lastConnectionAt": "2007-12-03T10:15:30Z",
"lastConnectionReason": "COLD_BOOT",
"lastDisconnectionAt": "2007-12-03T10:15:30Z",
"lastDisconnectionReason": "UNKNOWN_SERVER_REASON",
"lastActivityAt": "2007-12-03T10:15:30Z",
"status": "CONNECTED",
"history": DeviceHistoryPaged,
"aggregatedData": AggregatedData,
"lastTrip": Trip,
"trips": TripPaged,
"tripSummary": TripSummary,
"harshes": TripHarshPaged,
"overspeeds": TripOverspeedPaged,
"currentVehicle": Vehicle,
"vehicles": VehiclePaged,
"fields": FieldPaged,
"readings": ReadingPaged,
"readingsAnon": ReadingAnonPaged,
"lastPosition": Coordinates,
"vehicleSessions": DeviceVehicleSessionPaged,
"groups": GroupPaged,
"alerts": VehicleAlertPaged,
"alertsState": VehicleAlertsState,
"batteryAnnotations": BatteryAnnotationPaged,
"remoteDiags": RemoteDiagPaged,
"logFetches": LogfetchPaged,
"profilePrivacies": ProfilePrivacyPaged,
"profilePrivacy": ProfilePrivacy,
"profileModes": ProfileDeviceModePaged,
"profileMode": ProfileDeviceMode,
"product": Product
}
}
}
deviceModeCreate
Response
Returns a ProfileDeviceMode
Arguments
| Name | Description |
|---|---|
id - ID!
|
Device id |
mode - ProfileDeviceModeClassArg!
|
Example
Query
mutation deviceModeCreate(
$id: ID!,
$mode: ProfileDeviceModeClassArg!
) {
deviceModeCreate(
id: $id,
mode: $mode
) {
id
mode
status
startedAt
endedAt
restoreDefault {
...ProfileRestoreDefaultFragment
}
}
}
Variables
{"id": "4", "mode": "WORKSHOP"}
Response
{
"data": {
"deviceModeCreate": {
"id": "4",
"mode": "WORKSHOP",
"status": "PENDING",
"startedAt": "2007-12-03T10:15:30Z",
"endedAt": "2007-12-03T10:15:30Z",
"restoreDefault": ProfileRestoreDefault
}
}
}
devicePrivacyCreate
Response
Returns a ProfilePrivacy
Arguments
| Name | Description |
|---|---|
id - ID!
|
Device id |
whitelistedData - [OnboardingWhitelistedData!]
|
Example
Query
mutation devicePrivacyCreate(
$id: ID!,
$whitelistedData: [OnboardingWhitelistedData!]
) {
devicePrivacyCreate(
id: $id,
whitelistedData: $whitelistedData
) {
id
createdAt
startedAt
endedAt
status
whitelistedData
restoreDefault {
...ProfileRestoreDefaultFragment
}
}
}
Variables
{"id": "4", "whitelistedData": ["POSITION"]}
Response
{
"data": {
"devicePrivacyCreate": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"startedAt": "2007-12-03T10:15:30Z",
"endedAt": "2007-12-03T10:15:30Z",
"status": "PENDING",
"whitelistedData": ["POSITION"],
"restoreDefault": ProfileRestoreDefault
}
}
}
deviceSet
Description
Set the user's device fields
Response
Returns a Device
Arguments
| Name | Description |
|---|---|
id - ID!
|
Identifier |
input - DeviceInput!
|
Device Input |
Example
Query
mutation deviceSet(
$id: ID!,
$input: DeviceInput!
) {
deviceSet(
id: $id,
input: $input
) {
id
activeAccount
deviceType
serialNumber
onboarded
createdAt
updatedAt
owner {
...AccountFragment
}
firstConnectionAt
lastConnectionAt
lastConnectionReason
lastDisconnectionAt
lastDisconnectionReason
lastActivityAt
status
history {
...DeviceHistoryPagedFragment
}
aggregatedData {
...AggregatedDataFragment
}
lastTrip {
...TripFragment
}
trips {
...TripPagedFragment
}
tripSummary {
...TripSummaryFragment
}
harshes {
...TripHarshPagedFragment
}
overspeeds {
...TripOverspeedPagedFragment
}
currentVehicle {
...VehicleFragment
}
vehicles {
...VehiclePagedFragment
}
fields {
...FieldPagedFragment
}
readings {
...ReadingPagedFragment
}
readingsAnon {
...ReadingAnonPagedFragment
}
lastPosition {
...CoordinatesFragment
}
vehicleSessions {
...DeviceVehicleSessionPagedFragment
}
groups {
...GroupPagedFragment
}
alerts {
...VehicleAlertPagedFragment
}
alertsState {
...VehicleAlertsStateFragment
}
batteryAnnotations {
...BatteryAnnotationPagedFragment
}
remoteDiags {
...RemoteDiagPagedFragment
}
logFetches {
...LogfetchPagedFragment
}
profilePrivacies {
...ProfilePrivacyPagedFragment
}
profilePrivacy {
...ProfilePrivacyFragment
}
profileModes {
...ProfileDeviceModePagedFragment
}
profileMode {
...ProfileDeviceModeFragment
}
product {
...ProductFragment
}
}
}
Variables
{"id": 4, "input": DeviceInput}
Response
{
"data": {
"deviceSet": {
"id": 4,
"activeAccount": "xyz789",
"deviceType": "xyz789",
"serialNumber": "abc123",
"onboarded": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"owner": Account,
"firstConnectionAt": "2007-12-03T10:15:30Z",
"lastConnectionAt": "2007-12-03T10:15:30Z",
"lastConnectionReason": "COLD_BOOT",
"lastDisconnectionAt": "2007-12-03T10:15:30Z",
"lastDisconnectionReason": "UNKNOWN_SERVER_REASON",
"lastActivityAt": "2007-12-03T10:15:30Z",
"status": "CONNECTED",
"history": DeviceHistoryPaged,
"aggregatedData": AggregatedData,
"lastTrip": Trip,
"trips": TripPaged,
"tripSummary": TripSummary,
"harshes": TripHarshPaged,
"overspeeds": TripOverspeedPaged,
"currentVehicle": Vehicle,
"vehicles": VehiclePaged,
"fields": FieldPaged,
"readings": ReadingPaged,
"readingsAnon": ReadingAnonPaged,
"lastPosition": Coordinates,
"vehicleSessions": DeviceVehicleSessionPaged,
"groups": GroupPaged,
"alerts": VehicleAlertPaged,
"alertsState": VehicleAlertsState,
"batteryAnnotations": BatteryAnnotationPaged,
"remoteDiags": RemoteDiagPaged,
"logFetches": LogfetchPaged,
"profilePrivacies": ProfilePrivacyPaged,
"profilePrivacy": ProfilePrivacy,
"profileModes": ProfileDeviceModePaged,
"profileMode": ProfileDeviceMode,
"product": Product
}
}
}
deviceVehicleSessionStart
Description
Start a device vehicle session
Response
Returns a DeviceVehicleSession
Arguments
| Name | Description |
|---|---|
deviceId - ID!
|
Device Identifier |
vehicleId - ID!
|
Vehicle Identifier |
kmAtInstallation - Int!
|
km_at_installation |
installationDate - DateTime!
|
Installation Date |
connectionType - DeviceConnectionType
|
Connection type |
Example
Query
mutation deviceVehicleSessionStart(
$deviceId: ID!,
$vehicleId: ID!,
$kmAtInstallation: Int!,
$installationDate: DateTime!,
$connectionType: DeviceConnectionType
) {
deviceVehicleSessionStart(
deviceId: $deviceId,
vehicleId: $vehicleId,
kmAtInstallation: $kmAtInstallation,
installationDate: $installationDate,
connectionType: $connectionType
) {
id
kmAtInstallation
connectionType
installationDate
removalDate
active
vehicle {
...VehicleFragment
}
device {
...DeviceFragment
}
owner {
...AccountFragment
}
}
}
Variables
{
"deviceId": 4,
"vehicleId": 4,
"kmAtInstallation": 987,
"installationDate": "2007-12-03T10:15:30Z",
"connectionType": "CABLE"
}
Response
{
"data": {
"deviceVehicleSessionStart": {
"id": 4,
"kmAtInstallation": 123,
"connectionType": "CABLE",
"installationDate": "2007-12-03T10:15:30Z",
"removalDate": "2007-12-03T10:15:30Z",
"active": false,
"vehicle": Vehicle,
"device": Device,
"owner": Account
}
}
}
deviceVehicleSessionStop
Description
Stop a device vehicle session
Response
Returns a DeviceVehicleSession
Example
Query
mutation deviceVehicleSessionStop(
$deviceId: ID,
$vehicleId: ID,
$id: ID!,
$removalDate: DateTime
) {
deviceVehicleSessionStop(
deviceId: $deviceId,
vehicleId: $vehicleId,
id: $id,
removalDate: $removalDate
) {
id
kmAtInstallation
connectionType
installationDate
removalDate
active
vehicle {
...VehicleFragment
}
device {
...DeviceFragment
}
owner {
...AccountFragment
}
}
}
Variables
{
"deviceId": "4",
"vehicleId": 4,
"id": 4,
"removalDate": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"deviceVehicleSessionStop": {
"id": 4,
"kmAtInstallation": 123,
"connectionType": "CABLE",
"installationDate": "2007-12-03T10:15:30Z",
"removalDate": "2007-12-03T10:15:30Z",
"active": true,
"vehicle": Vehicle,
"device": Device,
"owner": Account
}
}
}
deviceVehicleSessionUpdate
Description
Start a device vehicle session
Response
Returns a DeviceVehicleSession
Example
Query
mutation deviceVehicleSessionUpdate(
$deviceId: ID,
$vehicleId: ID,
$id: ID!,
$kmAtInstallation: Int,
$installationDate: DateTime,
$connectionType: DeviceConnectionType
) {
deviceVehicleSessionUpdate(
deviceId: $deviceId,
vehicleId: $vehicleId,
id: $id,
kmAtInstallation: $kmAtInstallation,
installationDate: $installationDate,
connectionType: $connectionType
) {
id
kmAtInstallation
connectionType
installationDate
removalDate
active
vehicle {
...VehicleFragment
}
device {
...DeviceFragment
}
owner {
...AccountFragment
}
}
}
Variables
{
"deviceId": "4",
"vehicleId": 4,
"id": "4",
"kmAtInstallation": 123,
"installationDate": "2007-12-03T10:15:30Z",
"connectionType": "CABLE"
}
Response
{
"data": {
"deviceVehicleSessionUpdate": {
"id": "4",
"kmAtInstallation": 123,
"connectionType": "CABLE",
"installationDate": "2007-12-03T10:15:30Z",
"removalDate": "2007-12-03T10:15:30Z",
"active": true,
"vehicle": Vehicle,
"device": Device,
"owner": Account
}
}
}
displacementSet
Description
Set displacement value parameter
Response
Returns a RdcAsyncAck
Example
Query
mutation displacementSet(
$deviceId: ID!,
$value: Int!
) {
displacementSet(
deviceId: $deviceId,
value: $value
) {
id
type
attributes
}
}
Variables
{"deviceId": 4, "value": 987}
Response
{
"data": {
"displacementSet": {
"id": "4",
"type": "xyz789",
"attributes": Json
}
}
}
distributorCreate
Description
Create onboarding distributor
Response
Returns an OnboardingDistributor
Example
Query
mutation distributorCreate(
$providerId: ID,
$workshopId: ID,
$organizationId: ID,
$label: String,
$managerId: ID,
$sendEmailToMunic: Boolean,
$sendEmailToProvider: Boolean
) {
distributorCreate(
providerId: $providerId,
workshopId: $workshopId,
organizationId: $organizationId,
label: $label,
managerId: $managerId,
sendEmailToMunic: $sendEmailToMunic,
sendEmailToProvider: $sendEmailToProvider
) {
id
organizationId
label
provider {
...OnboardingProviderFragment
}
isActive
workshop {
...WorkshopFragment
}
providerWorkshopId
staff {
...OnboardingStaffPagedFragment
}
requests {
...OnboardingRequestPagedFragment
}
}
}
Variables
{
"providerId": "4",
"workshopId": 4,
"organizationId": "4",
"label": "abc123",
"managerId": "4",
"sendEmailToMunic": false,
"sendEmailToProvider": true
}
Response
{
"data": {
"distributorCreate": {
"id": "4",
"organizationId": "4",
"label": "xyz789",
"provider": OnboardingProvider,
"isActive": true,
"workshop": Workshop,
"providerWorkshopId": "4",
"staff": OnboardingStaffPaged,
"requests": OnboardingRequestPaged
}
}
}
distributorUpdate
Description
Update onboarding distributor
Response
Returns an OnboardingDistributor
Example
Query
mutation distributorUpdate(
$id: ID!,
$organizationId: ID,
$isActive: Boolean,
$label: String
) {
distributorUpdate(
id: $id,
organizationId: $organizationId,
isActive: $isActive,
label: $label
) {
id
organizationId
label
provider {
...OnboardingProviderFragment
}
isActive
workshop {
...WorkshopFragment
}
providerWorkshopId
staff {
...OnboardingStaffPagedFragment
}
requests {
...OnboardingRequestPagedFragment
}
}
}
Variables
{
"id": "4",
"organizationId": "4",
"isActive": false,
"label": "xyz789"
}
Response
{
"data": {
"distributorUpdate": {
"id": "4",
"organizationId": 4,
"label": "xyz789",
"provider": OnboardingProvider,
"isActive": true,
"workshop": Workshop,
"providerWorkshopId": "4",
"staff": OnboardingStaffPaged,
"requests": OnboardingRequestPaged
}
}
}
doorToggle
Description
Toggle door action parameter
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
deviceId - ID!
|
Device id |
action - DoorAction!
|
Action |
Example
Query
mutation doorToggle(
$deviceId: ID!,
$action: DoorAction!
) {
doorToggle(
deviceId: $deviceId,
action: $action
) {
id
type
attributes
}
}
Variables
{"deviceId": "4", "action": "LOCK"}
Response
{
"data": {
"doorToggle": {
"id": "4",
"type": "xyz789",
"attributes": Json
}
}
}
driverCreate
Description
Create a new driver
Response
Returns a Driver
Example
Query
mutation driverCreate(
$label: String!,
$idKey: String,
$userProfileId: ID,
$userContactId: ID,
$defaultVehicleId: ID,
$active: Boolean,
$groupId: ID
) {
driverCreate(
label: $label,
idKey: $idKey,
userProfileId: $userProfileId,
userContactId: $userContactId,
defaultVehicleId: $defaultVehicleId,
active: $active,
groupId: $groupId
) {
id
label
idKey
createdAt
updatedAt
userProfile {
...AccountFragment
}
userContact {
...AccountFragment
}
currentVehicle {
...VehicleFragment
}
defaultVehicle {
...VehicleFragment
}
active
vehicles {
...VehiclePagedFragment
}
currentVehicles {
...VehiclePagedFragment
}
groups {
...GroupPagedFragment
}
lastTrip {
...TripFragment
}
trips {
...TripPagedFragment
}
vehicleSessions {
...DriverVehicleSessionPagedFragment
}
descriptions {
...DescriptionPagedFragment
}
}
}
Variables
{
"label": "abc123",
"idKey": "abc123",
"userProfileId": 4,
"userContactId": 4,
"defaultVehicleId": "4",
"active": false,
"groupId": "4"
}
Response
{
"data": {
"driverCreate": {
"id": "4",
"label": "xyz789",
"idKey": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"userProfile": Account,
"userContact": Account,
"currentVehicle": Vehicle,
"defaultVehicle": Vehicle,
"active": false,
"vehicles": VehiclePaged,
"currentVehicles": VehiclePaged,
"groups": GroupPaged,
"lastTrip": Trip,
"trips": TripPaged,
"vehicleSessions": DriverVehicleSessionPaged,
"descriptions": DescriptionPaged
}
}
}
driverDelete
Description
Delete a user vehicle
driverServiceCreate
Description
Create driver service
Response
Returns a DriverService
Example
Query
mutation driverServiceCreate(
$workshopIds: [ID],
$label: String,
$description: String
) {
driverServiceCreate(
workshopIds: $workshopIds,
label: $label,
description: $description
) {
id
label
description
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{
"workshopIds": ["4"],
"label": "xyz789",
"description": "xyz789"
}
Response
{
"data": {
"driverServiceCreate": {
"id": "4",
"label": "abc123",
"description": "xyz789",
"workshops": WorkshopPaged
}
}
}
driverServiceDelete
Description
Delete Driver service
driverServiceUpdate
Description
Update driver service
Response
Returns a DriverService
Example
Query
mutation driverServiceUpdate(
$id: ID!,
$workshopIds: [ID],
$label: String,
$description: String
) {
driverServiceUpdate(
id: $id,
workshopIds: $workshopIds,
label: $label,
description: $description
) {
id
label
description
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{
"id": "4",
"workshopIds": [4],
"label": "xyz789",
"description": "abc123"
}
Response
{
"data": {
"driverServiceUpdate": {
"id": 4,
"label": "xyz789",
"description": "abc123",
"workshops": WorkshopPaged
}
}
}
driverUpdate
Description
Update an existing driver
Response
Returns a Driver
Example
Query
mutation driverUpdate(
$id: ID!,
$label: String,
$idKey: String,
$userProfileId: ID,
$userContactId: ID,
$defaultVehicleId: ID,
$active: Boolean
) {
driverUpdate(
id: $id,
label: $label,
idKey: $idKey,
userProfileId: $userProfileId,
userContactId: $userContactId,
defaultVehicleId: $defaultVehicleId,
active: $active
) {
id
label
idKey
createdAt
updatedAt
userProfile {
...AccountFragment
}
userContact {
...AccountFragment
}
currentVehicle {
...VehicleFragment
}
defaultVehicle {
...VehicleFragment
}
active
vehicles {
...VehiclePagedFragment
}
currentVehicles {
...VehiclePagedFragment
}
groups {
...GroupPagedFragment
}
lastTrip {
...TripFragment
}
trips {
...TripPagedFragment
}
vehicleSessions {
...DriverVehicleSessionPagedFragment
}
descriptions {
...DescriptionPagedFragment
}
}
}
Variables
{
"id": 4,
"label": "xyz789",
"idKey": "abc123",
"userProfileId": "4",
"userContactId": 4,
"defaultVehicleId": "4",
"active": true
}
Response
{
"data": {
"driverUpdate": {
"id": "4",
"label": "xyz789",
"idKey": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"userProfile": Account,
"userContact": Account,
"currentVehicle": Vehicle,
"defaultVehicle": Vehicle,
"active": true,
"vehicles": VehiclePaged,
"currentVehicles": VehiclePaged,
"groups": GroupPaged,
"lastTrip": Trip,
"trips": TripPaged,
"vehicleSessions": DriverVehicleSessionPaged,
"descriptions": DescriptionPaged
}
}
}
driverVehicleSessionStart
Description
Start a driver vehicle session
Response
Returns a DriverVehicleSession
Example
Query
mutation driverVehicleSessionStart(
$driverId: ID!,
$vehicleId: ID!,
$startAt: DateTime
) {
driverVehicleSessionStart(
driverId: $driverId,
vehicleId: $vehicleId,
startAt: $startAt
) {
id
startAt
endAt
active
vehicle {
...VehicleFragment
}
driver {
...DriverFragment
}
owner {
...AccountFragment
}
}
}
Variables
{
"driverId": "4",
"vehicleId": "4",
"startAt": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"driverVehicleSessionStart": {
"id": 4,
"startAt": "2007-12-03T10:15:30Z",
"endAt": "2007-12-03T10:15:30Z",
"active": false,
"vehicle": Vehicle,
"driver": Driver,
"owner": Account
}
}
}
driverVehicleSessionStop
Description
Stop a driver vehicle session
Response
Returns a DriverVehicleSession
Example
Query
mutation driverVehicleSessionStop(
$driverId: ID,
$vehicleId: ID,
$id: ID!,
$endAt: DateTime
) {
driverVehicleSessionStop(
driverId: $driverId,
vehicleId: $vehicleId,
id: $id,
endAt: $endAt
) {
id
startAt
endAt
active
vehicle {
...VehicleFragment
}
driver {
...DriverFragment
}
owner {
...AccountFragment
}
}
}
Variables
{
"driverId": 4,
"vehicleId": 4,
"id": 4,
"endAt": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"driverVehicleSessionStop": {
"id": "4",
"startAt": "2007-12-03T10:15:30Z",
"endAt": "2007-12-03T10:15:30Z",
"active": true,
"vehicle": Vehicle,
"driver": Driver,
"owner": Account
}
}
}
dtcClean
Description
Clean DTC
Response
Returns a RdcAsyncAck
Example
Query
mutation dtcClean(
$deviceId: ID!,
$type: String!
) {
dtcClean(
deviceId: $deviceId,
type: $type
) {
id
type
attributes
}
}
Variables
{"deviceId": 4, "type": "xyz789"}
Response
{
"data": {
"dtcClean": {
"id": "4",
"type": "xyz789",
"attributes": Json
}
}
}
engineToggle
Description
Toggle engine action parameter
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
deviceId - ID!
|
Device id |
action - ToggleAction!
|
On/Off |
Example
Query
mutation engineToggle(
$deviceId: ID!,
$action: ToggleAction!
) {
engineToggle(
deviceId: $deviceId,
action: $action
) {
id
type
attributes
}
}
Variables
{"deviceId": "4", "action": "START"}
Response
{
"data": {
"engineToggle": {
"id": 4,
"type": "abc123",
"attributes": Json
}
}
}
groupCreate
Response
Returns a Group
Arguments
| Name | Description |
|---|---|
label - String!
|
Label |
tags - [String]
|
Tags |
hierarchyLevel - GroupHierarchyLevel
|
Hierarchy level |
owner - ID
|
Owner account |
Example
Query
mutation groupCreate(
$label: String!,
$tags: [String],
$hierarchyLevel: GroupHierarchyLevel,
$owner: ID
) {
groupCreate(
label: $label,
tags: $tags,
hierarchyLevel: $hierarchyLevel,
owner: $owner
) {
id
label
tags
hierarchyLevel
owner {
...AccountFragment
}
descriptions {
...DescriptionPagedFragment
}
devices {
...DevicePagedFragment
}
vehicles {
...VehiclePagedFragment
}
alerts {
...VehicleAlertPagedFragment
}
drivers {
...DriverPagedFragment
}
parents {
...GroupPagedFragment
}
children {
...GroupPagedFragment
}
users {
...AccountPagedFragment
}
}
}
Variables
{
"label": "abc123",
"tags": ["abc123"],
"hierarchyLevel": "UNASSIGNED",
"owner": 4
}
Response
{
"data": {
"groupCreate": {
"id": 4,
"label": "xyz789",
"tags": ["xyz789"],
"hierarchyLevel": "UNASSIGNED",
"owner": Account,
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"vehicles": VehiclePaged,
"alerts": VehicleAlertPaged,
"drivers": DriverPaged,
"parents": GroupPaged,
"children": GroupPaged,
"users": AccountPaged
}
}
}
groupDelete
groupUpdate
Response
Returns a Group
Arguments
| Name | Description |
|---|---|
id - ID!
|
Identifier |
label - String
|
Label |
tags - [String]
|
Tags |
hierarchyLevel - GroupHierarchyLevel
|
Hierarchy level |
owner - ID
|
Owner account |
Example
Query
mutation groupUpdate(
$id: ID!,
$label: String,
$tags: [String],
$hierarchyLevel: GroupHierarchyLevel,
$owner: ID
) {
groupUpdate(
id: $id,
label: $label,
tags: $tags,
hierarchyLevel: $hierarchyLevel,
owner: $owner
) {
id
label
tags
hierarchyLevel
owner {
...AccountFragment
}
descriptions {
...DescriptionPagedFragment
}
devices {
...DevicePagedFragment
}
vehicles {
...VehiclePagedFragment
}
alerts {
...VehicleAlertPagedFragment
}
drivers {
...DriverPagedFragment
}
parents {
...GroupPagedFragment
}
children {
...GroupPagedFragment
}
users {
...AccountPagedFragment
}
}
}
Variables
{
"id": "4",
"label": "xyz789",
"tags": ["abc123"],
"hierarchyLevel": "UNASSIGNED",
"owner": "4"
}
Response
{
"data": {
"groupUpdate": {
"id": "4",
"label": "xyz789",
"tags": ["abc123"],
"hierarchyLevel": "UNASSIGNED",
"owner": Account,
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"vehicles": VehiclePaged,
"alerts": VehicleAlertPaged,
"drivers": DriverPaged,
"parents": GroupPaged,
"children": GroupPaged,
"users": AccountPaged
}
}
}
groupUpdateMembers
Response
Returns an ID
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of group being modified |
op - MemberOperation!
|
Add or remove |
type - GroupMember!
|
Member type |
ids - [ID]!
|
Ids of members being add/remove to/from group |
Example
Query
mutation groupUpdateMembers(
$id: ID!,
$op: MemberOperation!,
$type: GroupMember!,
$ids: [ID]!
) {
groupUpdateMembers(
id: $id,
op: $op,
type: $type,
ids: $ids
)
}
Variables
{
"id": 4,
"op": "ADD",
"type": "DEVICE",
"ids": ["4"]
}
Response
{"data": {"groupUpdateMembers": "4"}}
lighthornTrigger
Description
Trigger lighthorn
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
deviceId - ID!
|
Device id |
Example
Query
mutation lighthornTrigger($deviceId: ID!) {
lighthornTrigger(deviceId: $deviceId) {
id
type
attributes
}
}
Variables
{"deviceId": "4"}
Response
{
"data": {
"lighthornTrigger": {
"id": 4,
"type": "abc123",
"attributes": Json
}
}
}
logfetchCreate
Description
Request a log fetch
Response
Returns a Logfetch
Example
Query
mutation logfetchCreate(
$deviceId: ID!,
$action: String!,
$reason: String
) {
logfetchCreate(
deviceId: $deviceId,
action: $action,
reason: $reason
) {
id
status
reason
account
actionName
createdAt
updatedAt
}
}
Variables
{
"deviceId": "4",
"action": "abc123",
"reason": "xyz789"
}
Response
{
"data": {
"logfetchCreate": {
"id": "4",
"status": "ABORTED",
"reason": "xyz789",
"account": "xyz789",
"actionName": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
maintenanceHistoricalDelete
Description
Delete historical maintenance
A corresponding upcoming might get regenerated sooner.
maintenanceHistoricalUpdate
Description
Update historical maintenance
Response
Returns a MaintenanceHistorical
Example
Query
mutation maintenanceHistoricalUpdate(
$id: ID!,
$mileage: Int,
$date: DateTime
) {
maintenanceHistoricalUpdate(
id: $id,
mileage: $mileage,
date: $date
) {
id
vehicle {
...VehicleFragment
}
template {
...MaintenanceTemplateFragment
}
mileage
date
}
}
Variables
{
"id": 4,
"mileage": 123,
"date": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"maintenanceHistoricalUpdate": {
"id": 4,
"vehicle": Vehicle,
"template": MaintenanceTemplate,
"mileage": 123,
"date": "2007-12-03T10:15:30Z"
}
}
}
maintenanceUpcomingUpdate
Description
Mark upcoming maintenance as done
This will create a corresponding historical maintenance.
Response
Returns a MaintenanceHistorical
Example
Query
mutation maintenanceUpcomingUpdate(
$id: ID!,
$mileage: Int,
$date: DateTime
) {
maintenanceUpcomingUpdate(
id: $id,
mileage: $mileage,
date: $date
) {
id
vehicle {
...VehicleFragment
}
template {
...MaintenanceTemplateFragment
}
mileage
date
}
}
Variables
{
"id": "4",
"mileage": 987,
"date": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"maintenanceUpcomingUpdate": {
"id": 4,
"vehicle": Vehicle,
"template": MaintenanceTemplate,
"mileage": 987,
"date": "2007-12-03T10:15:30Z"
}
}
}
odometerSet
Description
Set odometer value parameter
Response
Returns a RdcAsyncAck
Example
Query
mutation odometerSet(
$deviceId: ID!,
$value: Int!
) {
odometerSet(
deviceId: $deviceId,
value: $value
) {
id
type
attributes
}
}
Variables
{"deviceId": "4", "value": 987}
Response
{
"data": {
"odometerSet": {
"id": 4,
"type": "xyz789",
"attributes": Json
}
}
}
onboardingAuxiliaryDeviceAdd
Description
Add an auxiliary device
Response
Returns an OnboardingAuxiliaryDevice
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing onboarding request |
label - String
|
|
kind - OnboardingAuxiliaryDeviceKind!
|
|
connectionType - OnboardingAuxiliaryDeviceConnectionType
|
|
sensorFunctions - [OnboardingAuxiliarySensorFunction!]
|
|
serialNumber - String
|
|
macAddressHash - String
|
|
wifiSsid - String
|
required if connection_type is wifi |
wifiPassword - String
|
Example
Query
mutation onboardingAuxiliaryDeviceAdd(
$id: ID!,
$label: String,
$kind: OnboardingAuxiliaryDeviceKind!,
$connectionType: OnboardingAuxiliaryDeviceConnectionType,
$sensorFunctions: [OnboardingAuxiliarySensorFunction!],
$serialNumber: String,
$macAddressHash: String,
$wifiSsid: String,
$wifiPassword: String
) {
onboardingAuxiliaryDeviceAdd(
id: $id,
label: $label,
kind: $kind,
connectionType: $connectionType,
sensorFunctions: $sensorFunctions,
serialNumber: $serialNumber,
macAddressHash: $macAddressHash,
wifiSsid: $wifiSsid,
wifiPassword: $wifiPassword
) {
id
idKey
label
kind
connectionType
sensorFunctions
serialNumber
macAddressHash
wifiSsid
wifiPassword
assetManagerId
}
}
Variables
{
"id": "4",
"label": "abc123",
"kind": "SENSOR",
"connectionType": "UNKNOWN",
"sensorFunctions": ["SENSOR"],
"serialNumber": "xyz789",
"macAddressHash": "xyz789",
"wifiSsid": "abc123",
"wifiPassword": "abc123"
}
Response
{
"data": {
"onboardingAuxiliaryDeviceAdd": {
"id": 4,
"idKey": "xyz789",
"label": "abc123",
"kind": "SENSOR",
"connectionType": "UNKNOWN",
"sensorFunctions": ["SENSOR"],
"serialNumber": "xyz789",
"macAddressHash": "xyz789",
"wifiSsid": "abc123",
"wifiPassword": "abc123",
"assetManagerId": "xyz789"
}
}
}
onboardingAuxiliaryDeviceRemove
Description
remove an auxiliary device
Response
Returns an ID
Example
Query
mutation onboardingAuxiliaryDeviceRemove(
$id: ID!,
$auxiliaryDeviceId: ID!
) {
onboardingAuxiliaryDeviceRemove(
id: $id,
auxiliaryDeviceId: $auxiliaryDeviceId
)
}
Variables
{"id": "4", "auxiliaryDeviceId": 4}
Response
{
"data": {
"onboardingAuxiliaryDeviceRemove": "4"
}
}
onboardingAuxiliaryDeviceUpdate
Description
Update an auxiliary device
Response
Returns an OnboardingAuxiliaryDevice
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing onboarding request |
auxiliaryDeviceId - ID!
|
Id of existing auxiliary device |
label - String
|
|
kind - OnboardingAuxiliaryDeviceKind!
|
|
connectionType - OnboardingAuxiliaryDeviceConnectionType
|
|
sensorFunctions - [OnboardingAuxiliarySensorFunction!]
|
|
serialNumber - String
|
|
macAddressHash - String
|
|
wifiSsid - String
|
required if connection_type is wifi |
wifiPassword - String
|
Example
Query
mutation onboardingAuxiliaryDeviceUpdate(
$id: ID!,
$auxiliaryDeviceId: ID!,
$label: String,
$kind: OnboardingAuxiliaryDeviceKind!,
$connectionType: OnboardingAuxiliaryDeviceConnectionType,
$sensorFunctions: [OnboardingAuxiliarySensorFunction!],
$serialNumber: String,
$macAddressHash: String,
$wifiSsid: String,
$wifiPassword: String
) {
onboardingAuxiliaryDeviceUpdate(
id: $id,
auxiliaryDeviceId: $auxiliaryDeviceId,
label: $label,
kind: $kind,
connectionType: $connectionType,
sensorFunctions: $sensorFunctions,
serialNumber: $serialNumber,
macAddressHash: $macAddressHash,
wifiSsid: $wifiSsid,
wifiPassword: $wifiPassword
) {
id
idKey
label
kind
connectionType
sensorFunctions
serialNumber
macAddressHash
wifiSsid
wifiPassword
assetManagerId
}
}
Variables
{
"id": 4,
"auxiliaryDeviceId": "4",
"label": "abc123",
"kind": "SENSOR",
"connectionType": "UNKNOWN",
"sensorFunctions": ["SENSOR"],
"serialNumber": "abc123",
"macAddressHash": "xyz789",
"wifiSsid": "abc123",
"wifiPassword": "abc123"
}
Response
{
"data": {
"onboardingAuxiliaryDeviceUpdate": {
"id": 4,
"idKey": "xyz789",
"label": "xyz789",
"kind": "SENSOR",
"connectionType": "UNKNOWN",
"sensorFunctions": ["SENSOR"],
"serialNumber": "xyz789",
"macAddressHash": "abc123",
"wifiSsid": "xyz789",
"wifiPassword": "abc123",
"assetManagerId": "abc123"
}
}
}
onboardingCancel
Description
Cancel onboarding request
Response
Returns an OnboardingRequest
Example
Query
mutation onboardingCancel(
$id: ID!,
$reason: String
) {
onboardingCancel(
id: $id,
reason: $reason
) {
id
status
mode
createdAt
updatedAt
warnings {
...OnboardingWarningFragment
}
clonedTo {
...OnboardingRequestFragment
}
clonedFrom {
...OnboardingRequestFragment
}
deviceCreatedBy {
...AccountFragment
}
driverCreatedBy {
...AccountFragment
}
driverValidatedBy {
...AccountFragment
}
driverAssociationId
driverAssociatedBy {
...AccountFragment
}
vehicleCreatedBy {
...AccountFragment
}
vehicleAssociatedBy {
...AccountFragment
}
vehicleEnrichedBy {
...AccountFragment
}
createdBy {
...AccountFragment
}
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
vehicle {
...VehicleFragment
}
vehicleCreationId
vehicleEnrichments {
...OnboardingVehicleFragment
}
vehicleConnection {
...OnboardingVehicleConnectionFragment
}
consent {
...OnboardingConsentFragment
}
profile {
...ProfileOnboardingFragment
}
actions {
...OnboardingActionPagedFragment
}
device {
...DeviceFragment
}
deviceMode
deviceBluetooth
plateNumber
vin
vehicleLabel
withCode
connectionType
kmAtInstallation
serialNumber
activateReadWriteInDevice
clientIdentificationId
auxiliaryDevices {
...OnboardingAuxiliaryDevicePagedFragment
}
}
}
Variables
{
"id": "4",
"reason": "xyz789"
}
Response
{
"data": {
"onboardingCancel": {
"id": "4",
"status": "OPEN",
"mode": "MANUAL",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"warnings": [OnboardingWarning],
"clonedTo": OnboardingRequest,
"clonedFrom": OnboardingRequest,
"deviceCreatedBy": Account,
"driverCreatedBy": Account,
"driverValidatedBy": Account,
"driverAssociationId": "4",
"driverAssociatedBy": Account,
"vehicleCreatedBy": Account,
"vehicleAssociatedBy": Account,
"vehicleEnrichedBy": Account,
"createdBy": Account,
"distributor": OnboardingDistributor,
"driver": Account,
"vehicle": Vehicle,
"vehicleCreationId": 4,
"vehicleEnrichments": OnboardingVehicle,
"vehicleConnection": OnboardingVehicleConnection,
"consent": OnboardingConsent,
"profile": ProfileOnboarding,
"actions": OnboardingActionPaged,
"device": Device,
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE",
"plateNumber": 4,
"vin": "xyz789",
"vehicleLabel": "xyz789",
"withCode": true,
"connectionType": "CABLE",
"kmAtInstallation": 987,
"serialNumber": "xyz789",
"activateReadWriteInDevice": false,
"clientIdentificationId": "4",
"auxiliaryDevices": OnboardingAuxiliaryDevicePaged
}
}
}
onboardingClone
Description
Clone onboarding request
Response
Returns an OnboardingRequest
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing closed onboarding request |
Example
Query
mutation onboardingClone($id: ID!) {
onboardingClone(id: $id) {
id
status
mode
createdAt
updatedAt
warnings {
...OnboardingWarningFragment
}
clonedTo {
...OnboardingRequestFragment
}
clonedFrom {
...OnboardingRequestFragment
}
deviceCreatedBy {
...AccountFragment
}
driverCreatedBy {
...AccountFragment
}
driverValidatedBy {
...AccountFragment
}
driverAssociationId
driverAssociatedBy {
...AccountFragment
}
vehicleCreatedBy {
...AccountFragment
}
vehicleAssociatedBy {
...AccountFragment
}
vehicleEnrichedBy {
...AccountFragment
}
createdBy {
...AccountFragment
}
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
vehicle {
...VehicleFragment
}
vehicleCreationId
vehicleEnrichments {
...OnboardingVehicleFragment
}
vehicleConnection {
...OnboardingVehicleConnectionFragment
}
consent {
...OnboardingConsentFragment
}
profile {
...ProfileOnboardingFragment
}
actions {
...OnboardingActionPagedFragment
}
device {
...DeviceFragment
}
deviceMode
deviceBluetooth
plateNumber
vin
vehicleLabel
withCode
connectionType
kmAtInstallation
serialNumber
activateReadWriteInDevice
clientIdentificationId
auxiliaryDevices {
...OnboardingAuxiliaryDevicePagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"onboardingClone": {
"id": 4,
"status": "OPEN",
"mode": "MANUAL",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"warnings": [OnboardingWarning],
"clonedTo": OnboardingRequest,
"clonedFrom": OnboardingRequest,
"deviceCreatedBy": Account,
"driverCreatedBy": Account,
"driverValidatedBy": Account,
"driverAssociationId": 4,
"driverAssociatedBy": Account,
"vehicleCreatedBy": Account,
"vehicleAssociatedBy": Account,
"vehicleEnrichedBy": Account,
"createdBy": Account,
"distributor": OnboardingDistributor,
"driver": Account,
"vehicle": Vehicle,
"vehicleCreationId": "4",
"vehicleEnrichments": OnboardingVehicle,
"vehicleConnection": OnboardingVehicleConnection,
"consent": OnboardingConsent,
"profile": ProfileOnboarding,
"actions": OnboardingActionPaged,
"device": Device,
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE",
"plateNumber": "4",
"vin": "abc123",
"vehicleLabel": "xyz789",
"withCode": true,
"connectionType": "CABLE",
"kmAtInstallation": 987,
"serialNumber": "abc123",
"activateReadWriteInDevice": true,
"clientIdentificationId": "4",
"auxiliaryDevices": OnboardingAuxiliaryDevicePaged
}
}
}
onboardingConsent
Description
(re)set user consent
Response
Returns an OnboardingConsent
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing onboarding request |
consentId - ID
|
Id of existing onboarding consent |
whitelistedData - [OnboardingWhitelistedDataArg!]!
|
Override whitelisted_data from client identification |
Example
Query
mutation onboardingConsent(
$id: ID!,
$consentId: ID,
$whitelistedData: [OnboardingWhitelistedDataArg!]!
) {
onboardingConsent(
id: $id,
consentId: $consentId,
whitelistedData: $whitelistedData
) {
id
whitelistedData
inherited
}
}
Variables
{
"id": 4,
"consentId": "4",
"whitelistedData": ["POSITION"]
}
Response
{
"data": {
"onboardingConsent": {
"id": 4,
"whitelistedData": ["POSITION"],
"inherited": true
}
}
}
onboardingCreate
Description
Initiate onboarding request
Response
Returns an OnboardingRequest
Arguments
| Name | Description |
|---|---|
distributorId - ID!
|
Id of existing onboarding distributor |
code - String
|
Onboarding code |
mode - OnboardingModeArg
|
Example
Query
mutation onboardingCreate(
$distributorId: ID!,
$code: String,
$mode: OnboardingModeArg
) {
onboardingCreate(
distributorId: $distributorId,
code: $code,
mode: $mode
) {
id
status
mode
createdAt
updatedAt
warnings {
...OnboardingWarningFragment
}
clonedTo {
...OnboardingRequestFragment
}
clonedFrom {
...OnboardingRequestFragment
}
deviceCreatedBy {
...AccountFragment
}
driverCreatedBy {
...AccountFragment
}
driverValidatedBy {
...AccountFragment
}
driverAssociationId
driverAssociatedBy {
...AccountFragment
}
vehicleCreatedBy {
...AccountFragment
}
vehicleAssociatedBy {
...AccountFragment
}
vehicleEnrichedBy {
...AccountFragment
}
createdBy {
...AccountFragment
}
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
vehicle {
...VehicleFragment
}
vehicleCreationId
vehicleEnrichments {
...OnboardingVehicleFragment
}
vehicleConnection {
...OnboardingVehicleConnectionFragment
}
consent {
...OnboardingConsentFragment
}
profile {
...ProfileOnboardingFragment
}
actions {
...OnboardingActionPagedFragment
}
device {
...DeviceFragment
}
deviceMode
deviceBluetooth
plateNumber
vin
vehicleLabel
withCode
connectionType
kmAtInstallation
serialNumber
activateReadWriteInDevice
clientIdentificationId
auxiliaryDevices {
...OnboardingAuxiliaryDevicePagedFragment
}
}
}
Variables
{
"distributorId": 4,
"code": "abc123",
"mode": "MANUAL"
}
Response
{
"data": {
"onboardingCreate": {
"id": 4,
"status": "OPEN",
"mode": "MANUAL",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"warnings": [OnboardingWarning],
"clonedTo": OnboardingRequest,
"clonedFrom": OnboardingRequest,
"deviceCreatedBy": Account,
"driverCreatedBy": Account,
"driverValidatedBy": Account,
"driverAssociationId": "4",
"driverAssociatedBy": Account,
"vehicleCreatedBy": Account,
"vehicleAssociatedBy": Account,
"vehicleEnrichedBy": Account,
"createdBy": Account,
"distributor": OnboardingDistributor,
"driver": Account,
"vehicle": Vehicle,
"vehicleCreationId": "4",
"vehicleEnrichments": OnboardingVehicle,
"vehicleConnection": OnboardingVehicleConnection,
"consent": OnboardingConsent,
"profile": ProfileOnboarding,
"actions": OnboardingActionPaged,
"device": Device,
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE",
"plateNumber": "4",
"vin": "xyz789",
"vehicleLabel": "abc123",
"withCode": true,
"connectionType": "CABLE",
"kmAtInstallation": 987,
"serialNumber": "xyz789",
"activateReadWriteInDevice": true,
"clientIdentificationId": "4",
"auxiliaryDevices": OnboardingAuxiliaryDevicePaged
}
}
}
onboardingDeviceReserve
Description
Reserve device for onboarding request
Response
Returns a Device
Example
Query
mutation onboardingDeviceReserve(
$id: ID!,
$deviceId: ID,
$serialNumber: String
) {
onboardingDeviceReserve(
id: $id,
deviceId: $deviceId,
serialNumber: $serialNumber
) {
id
activeAccount
deviceType
serialNumber
onboarded
createdAt
updatedAt
owner {
...AccountFragment
}
firstConnectionAt
lastConnectionAt
lastConnectionReason
lastDisconnectionAt
lastDisconnectionReason
lastActivityAt
status
history {
...DeviceHistoryPagedFragment
}
aggregatedData {
...AggregatedDataFragment
}
lastTrip {
...TripFragment
}
trips {
...TripPagedFragment
}
tripSummary {
...TripSummaryFragment
}
harshes {
...TripHarshPagedFragment
}
overspeeds {
...TripOverspeedPagedFragment
}
currentVehicle {
...VehicleFragment
}
vehicles {
...VehiclePagedFragment
}
fields {
...FieldPagedFragment
}
readings {
...ReadingPagedFragment
}
readingsAnon {
...ReadingAnonPagedFragment
}
lastPosition {
...CoordinatesFragment
}
vehicleSessions {
...DeviceVehicleSessionPagedFragment
}
groups {
...GroupPagedFragment
}
alerts {
...VehicleAlertPagedFragment
}
alertsState {
...VehicleAlertsStateFragment
}
batteryAnnotations {
...BatteryAnnotationPagedFragment
}
remoteDiags {
...RemoteDiagPagedFragment
}
logFetches {
...LogfetchPagedFragment
}
profilePrivacies {
...ProfilePrivacyPagedFragment
}
profilePrivacy {
...ProfilePrivacyFragment
}
profileModes {
...ProfileDeviceModePagedFragment
}
profileMode {
...ProfileDeviceModeFragment
}
product {
...ProductFragment
}
}
}
Variables
{
"id": 4,
"deviceId": 4,
"serialNumber": "abc123"
}
Response
{
"data": {
"onboardingDeviceReserve": {
"id": "4",
"activeAccount": "abc123",
"deviceType": "xyz789",
"serialNumber": "abc123",
"onboarded": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"owner": Account,
"firstConnectionAt": "2007-12-03T10:15:30Z",
"lastConnectionAt": "2007-12-03T10:15:30Z",
"lastConnectionReason": "COLD_BOOT",
"lastDisconnectionAt": "2007-12-03T10:15:30Z",
"lastDisconnectionReason": "UNKNOWN_SERVER_REASON",
"lastActivityAt": "2007-12-03T10:15:30Z",
"status": "CONNECTED",
"history": DeviceHistoryPaged,
"aggregatedData": AggregatedData,
"lastTrip": Trip,
"trips": TripPaged,
"tripSummary": TripSummary,
"harshes": TripHarshPaged,
"overspeeds": TripOverspeedPaged,
"currentVehicle": Vehicle,
"vehicles": VehiclePaged,
"fields": FieldPaged,
"readings": ReadingPaged,
"readingsAnon": ReadingAnonPaged,
"lastPosition": Coordinates,
"vehicleSessions": DeviceVehicleSessionPaged,
"groups": GroupPaged,
"alerts": VehicleAlertPaged,
"alertsState": VehicleAlertsState,
"batteryAnnotations": BatteryAnnotationPaged,
"remoteDiags": RemoteDiagPaged,
"logFetches": LogfetchPaged,
"profilePrivacies": ProfilePrivacyPaged,
"profilePrivacy": ProfilePrivacy,
"profileModes": ProfileDeviceModePaged,
"profileMode": ProfileDeviceMode,
"product": Product
}
}
}
onboardingDriverAssociate
Use onboarding_driver_association_create
Example
Query
mutation onboardingDriverAssociate(
$id: ID!,
$driverId: ID!
) {
onboardingDriverAssociate(
id: $id,
driverId: $driverId
) {
id
organizationId
email
phone
fullName
shortName
companyName
countryCode
language
timeZone
createdAt
updatedAt
lastSignInAt
confirmedAt
descriptions {
...DescriptionPagedFragment
}
roles {
...AccountRoleFragment
}
groups {
...GroupPagedFragment
}
devices {
...DevicePagedFragment
}
vehicles {
...VehiclePagedFragment
}
drivers {
...DriverPagedFragment
}
driverProfiles {
...DriverPagedFragment
}
driverContacts {
...DriverPagedFragment
}
workshops {
...WorkshopPagedFragment
}
distributors {
...OnboardingDistributorPagedFragment
}
alertPreference {
...AlertPreferenceFragment
}
}
}
Variables
{"id": "4", "driverId": 4}
Response
{
"data": {
"onboardingDriverAssociate": {
"id": "4",
"organizationId": 4,
"email": "abc123",
"phone": "abc123",
"fullName": "xyz789",
"shortName": "xyz789",
"companyName": "abc123",
"countryCode": "xyz789",
"language": Language,
"timeZone": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"lastSignInAt": "2007-12-03T10:15:30Z",
"confirmedAt": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"roles": [AccountRole],
"groups": GroupPaged,
"devices": DevicePaged,
"vehicles": VehiclePaged,
"drivers": DriverPaged,
"driverProfiles": DriverPaged,
"driverContacts": DriverPaged,
"workshops": WorkshopPaged,
"distributors": OnboardingDistributorPaged,
"alertPreference": AlertPreference
}
}
}
onboardingDriverAssociationCreate
Description
Associate driver to onboarding request
Response
Returns an OnboardingDriverAssociation
Example
Query
mutation onboardingDriverAssociationCreate(
$id: ID!,
$driverId: ID!
) {
onboardingDriverAssociationCreate(
id: $id,
driverId: $driverId
) {
id
driver {
...AccountFragment
}
}
}
Variables
{"id": "4", "driverId": 4}
Response
{
"data": {
"onboardingDriverAssociationCreate": {
"id": 4,
"driver": Account
}
}
}
onboardingDriverAssociationUpdate
Description
Reassociate driver to onboarding request
Response
Returns an OnboardingDriverAssociation
Example
Query
mutation onboardingDriverAssociationUpdate(
$id: ID!,
$driverAssociationId: ID!,
$driverId: ID!
) {
onboardingDriverAssociationUpdate(
id: $id,
driverAssociationId: $driverAssociationId,
driverId: $driverId
) {
id
driver {
...AccountFragment
}
}
}
Variables
{
"id": "4",
"driverAssociationId": "4",
"driverId": "4"
}
Response
{
"data": {
"onboardingDriverAssociationUpdate": {
"id": 4,
"driver": Account
}
}
}
onboardingDriverCreate
Description
Create driver for onboarding request
Response
Returns an Account
Example
Query
mutation onboardingDriverCreate(
$id: ID!,
$fullName: String,
$shortName: String,
$email: String,
$phoneNumber: String,
$countryCode: String
) {
onboardingDriverCreate(
id: $id,
fullName: $fullName,
shortName: $shortName,
email: $email,
phoneNumber: $phoneNumber,
countryCode: $countryCode
) {
id
organizationId
email
phone
fullName
shortName
companyName
countryCode
language
timeZone
createdAt
updatedAt
lastSignInAt
confirmedAt
descriptions {
...DescriptionPagedFragment
}
roles {
...AccountRoleFragment
}
groups {
...GroupPagedFragment
}
devices {
...DevicePagedFragment
}
vehicles {
...VehiclePagedFragment
}
drivers {
...DriverPagedFragment
}
driverProfiles {
...DriverPagedFragment
}
driverContacts {
...DriverPagedFragment
}
workshops {
...WorkshopPagedFragment
}
distributors {
...OnboardingDistributorPagedFragment
}
alertPreference {
...AlertPreferenceFragment
}
}
}
Variables
{
"id": 4,
"fullName": "xyz789",
"shortName": "xyz789",
"email": "abc123",
"phoneNumber": "xyz789",
"countryCode": "abc123"
}
Response
{
"data": {
"onboardingDriverCreate": {
"id": "4",
"organizationId": 4,
"email": "xyz789",
"phone": "abc123",
"fullName": "abc123",
"shortName": "xyz789",
"companyName": "xyz789",
"countryCode": "abc123",
"language": Language,
"timeZone": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"lastSignInAt": "2007-12-03T10:15:30Z",
"confirmedAt": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"roles": [AccountRole],
"groups": GroupPaged,
"devices": DevicePaged,
"vehicles": VehiclePaged,
"drivers": DriverPaged,
"driverProfiles": DriverPaged,
"driverContacts": DriverPaged,
"workshops": WorkshopPaged,
"distributors": OnboardingDistributorPaged,
"alertPreference": AlertPreference
}
}
}
onboardingDriverValidate
Description
Validate driver for onboarding request
Response
Returns an Account
Example
Query
mutation onboardingDriverValidate(
$id: ID!,
$code: String
) {
onboardingDriverValidate(
id: $id,
code: $code
) {
id
organizationId
email
phone
fullName
shortName
companyName
countryCode
language
timeZone
createdAt
updatedAt
lastSignInAt
confirmedAt
descriptions {
...DescriptionPagedFragment
}
roles {
...AccountRoleFragment
}
groups {
...GroupPagedFragment
}
devices {
...DevicePagedFragment
}
vehicles {
...VehiclePagedFragment
}
drivers {
...DriverPagedFragment
}
driverProfiles {
...DriverPagedFragment
}
driverContacts {
...DriverPagedFragment
}
workshops {
...WorkshopPagedFragment
}
distributors {
...OnboardingDistributorPagedFragment
}
alertPreference {
...AlertPreferenceFragment
}
}
}
Variables
{"id": 4, "code": "xyz789"}
Response
{
"data": {
"onboardingDriverValidate": {
"id": 4,
"organizationId": "4",
"email": "abc123",
"phone": "xyz789",
"fullName": "abc123",
"shortName": "abc123",
"companyName": "abc123",
"countryCode": "abc123",
"language": Language,
"timeZone": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"lastSignInAt": "2007-12-03T10:15:30Z",
"confirmedAt": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"roles": [AccountRole],
"groups": GroupPaged,
"devices": DevicePaged,
"vehicles": VehiclePaged,
"drivers": DriverPaged,
"driverProfiles": DriverPaged,
"driverContacts": DriverPaged,
"workshops": WorkshopPaged,
"distributors": OnboardingDistributorPaged,
"alertPreference": AlertPreference
}
}
}
onboardingFinalize
Description
Finalize onboarding request
Response
Returns an OnboardingRequest
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing onboarding request |
Example
Query
mutation onboardingFinalize($id: ID!) {
onboardingFinalize(id: $id) {
id
status
mode
createdAt
updatedAt
warnings {
...OnboardingWarningFragment
}
clonedTo {
...OnboardingRequestFragment
}
clonedFrom {
...OnboardingRequestFragment
}
deviceCreatedBy {
...AccountFragment
}
driverCreatedBy {
...AccountFragment
}
driverValidatedBy {
...AccountFragment
}
driverAssociationId
driverAssociatedBy {
...AccountFragment
}
vehicleCreatedBy {
...AccountFragment
}
vehicleAssociatedBy {
...AccountFragment
}
vehicleEnrichedBy {
...AccountFragment
}
createdBy {
...AccountFragment
}
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
vehicle {
...VehicleFragment
}
vehicleCreationId
vehicleEnrichments {
...OnboardingVehicleFragment
}
vehicleConnection {
...OnboardingVehicleConnectionFragment
}
consent {
...OnboardingConsentFragment
}
profile {
...ProfileOnboardingFragment
}
actions {
...OnboardingActionPagedFragment
}
device {
...DeviceFragment
}
deviceMode
deviceBluetooth
plateNumber
vin
vehicleLabel
withCode
connectionType
kmAtInstallation
serialNumber
activateReadWriteInDevice
clientIdentificationId
auxiliaryDevices {
...OnboardingAuxiliaryDevicePagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"onboardingFinalize": {
"id": "4",
"status": "OPEN",
"mode": "MANUAL",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"warnings": [OnboardingWarning],
"clonedTo": OnboardingRequest,
"clonedFrom": OnboardingRequest,
"deviceCreatedBy": Account,
"driverCreatedBy": Account,
"driverValidatedBy": Account,
"driverAssociationId": 4,
"driverAssociatedBy": Account,
"vehicleCreatedBy": Account,
"vehicleAssociatedBy": Account,
"vehicleEnrichedBy": Account,
"createdBy": Account,
"distributor": OnboardingDistributor,
"driver": Account,
"vehicle": Vehicle,
"vehicleCreationId": "4",
"vehicleEnrichments": OnboardingVehicle,
"vehicleConnection": OnboardingVehicleConnection,
"consent": OnboardingConsent,
"profile": ProfileOnboarding,
"actions": OnboardingActionPaged,
"device": Device,
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE",
"plateNumber": 4,
"vin": "xyz789",
"vehicleLabel": "xyz789",
"withCode": false,
"connectionType": "CABLE",
"kmAtInstallation": 123,
"serialNumber": "xyz789",
"activateReadWriteInDevice": false,
"clientIdentificationId": "4",
"auxiliaryDevices": OnboardingAuxiliaryDevicePaged
}
}
}
onboardingOffboard
Description
Unlink device and delete/reset data associated with a closed onboarding request
Response
Returns an OnboardingRequest
Example
Query
mutation onboardingOffboard(
$id: ID!,
$resetData: Boolean!
) {
onboardingOffboard(
id: $id,
resetData: $resetData
) {
id
status
mode
createdAt
updatedAt
warnings {
...OnboardingWarningFragment
}
clonedTo {
...OnboardingRequestFragment
}
clonedFrom {
...OnboardingRequestFragment
}
deviceCreatedBy {
...AccountFragment
}
driverCreatedBy {
...AccountFragment
}
driverValidatedBy {
...AccountFragment
}
driverAssociationId
driverAssociatedBy {
...AccountFragment
}
vehicleCreatedBy {
...AccountFragment
}
vehicleAssociatedBy {
...AccountFragment
}
vehicleEnrichedBy {
...AccountFragment
}
createdBy {
...AccountFragment
}
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
vehicle {
...VehicleFragment
}
vehicleCreationId
vehicleEnrichments {
...OnboardingVehicleFragment
}
vehicleConnection {
...OnboardingVehicleConnectionFragment
}
consent {
...OnboardingConsentFragment
}
profile {
...ProfileOnboardingFragment
}
actions {
...OnboardingActionPagedFragment
}
device {
...DeviceFragment
}
deviceMode
deviceBluetooth
plateNumber
vin
vehicleLabel
withCode
connectionType
kmAtInstallation
serialNumber
activateReadWriteInDevice
clientIdentificationId
auxiliaryDevices {
...OnboardingAuxiliaryDevicePagedFragment
}
}
}
Variables
{"id": "4", "resetData": false}
Response
{
"data": {
"onboardingOffboard": {
"id": "4",
"status": "OPEN",
"mode": "MANUAL",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"warnings": [OnboardingWarning],
"clonedTo": OnboardingRequest,
"clonedFrom": OnboardingRequest,
"deviceCreatedBy": Account,
"driverCreatedBy": Account,
"driverValidatedBy": Account,
"driverAssociationId": "4",
"driverAssociatedBy": Account,
"vehicleCreatedBy": Account,
"vehicleAssociatedBy": Account,
"vehicleEnrichedBy": Account,
"createdBy": Account,
"distributor": OnboardingDistributor,
"driver": Account,
"vehicle": Vehicle,
"vehicleCreationId": "4",
"vehicleEnrichments": OnboardingVehicle,
"vehicleConnection": OnboardingVehicleConnection,
"consent": OnboardingConsent,
"profile": ProfileOnboarding,
"actions": OnboardingActionPaged,
"device": Device,
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE",
"plateNumber": "4",
"vin": "abc123",
"vehicleLabel": "xyz789",
"withCode": true,
"connectionType": "CABLE",
"kmAtInstallation": 123,
"serialNumber": "abc123",
"activateReadWriteInDevice": false,
"clientIdentificationId": 4,
"auxiliaryDevices": OnboardingAuxiliaryDevicePaged
}
}
}
onboardingReconfigureDevice
Description
Reconfigure onboarded device
Response
Returns an OnboardingRequest
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing onboarding request |
Example
Query
mutation onboardingReconfigureDevice($id: ID!) {
onboardingReconfigureDevice(id: $id) {
id
status
mode
createdAt
updatedAt
warnings {
...OnboardingWarningFragment
}
clonedTo {
...OnboardingRequestFragment
}
clonedFrom {
...OnboardingRequestFragment
}
deviceCreatedBy {
...AccountFragment
}
driverCreatedBy {
...AccountFragment
}
driverValidatedBy {
...AccountFragment
}
driverAssociationId
driverAssociatedBy {
...AccountFragment
}
vehicleCreatedBy {
...AccountFragment
}
vehicleAssociatedBy {
...AccountFragment
}
vehicleEnrichedBy {
...AccountFragment
}
createdBy {
...AccountFragment
}
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
vehicle {
...VehicleFragment
}
vehicleCreationId
vehicleEnrichments {
...OnboardingVehicleFragment
}
vehicleConnection {
...OnboardingVehicleConnectionFragment
}
consent {
...OnboardingConsentFragment
}
profile {
...ProfileOnboardingFragment
}
actions {
...OnboardingActionPagedFragment
}
device {
...DeviceFragment
}
deviceMode
deviceBluetooth
plateNumber
vin
vehicleLabel
withCode
connectionType
kmAtInstallation
serialNumber
activateReadWriteInDevice
clientIdentificationId
auxiliaryDevices {
...OnboardingAuxiliaryDevicePagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"onboardingReconfigureDevice": {
"id": 4,
"status": "OPEN",
"mode": "MANUAL",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"warnings": [OnboardingWarning],
"clonedTo": OnboardingRequest,
"clonedFrom": OnboardingRequest,
"deviceCreatedBy": Account,
"driverCreatedBy": Account,
"driverValidatedBy": Account,
"driverAssociationId": "4",
"driverAssociatedBy": Account,
"vehicleCreatedBy": Account,
"vehicleAssociatedBy": Account,
"vehicleEnrichedBy": Account,
"createdBy": Account,
"distributor": OnboardingDistributor,
"driver": Account,
"vehicle": Vehicle,
"vehicleCreationId": 4,
"vehicleEnrichments": OnboardingVehicle,
"vehicleConnection": OnboardingVehicleConnection,
"consent": OnboardingConsent,
"profile": ProfileOnboarding,
"actions": OnboardingActionPaged,
"device": Device,
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE",
"plateNumber": "4",
"vin": "xyz789",
"vehicleLabel": "xyz789",
"withCode": false,
"connectionType": "CABLE",
"kmAtInstallation": 987,
"serialNumber": "abc123",
"activateReadWriteInDevice": false,
"clientIdentificationId": 4,
"auxiliaryDevices": OnboardingAuxiliaryDevicePaged
}
}
}
onboardingRegenValidation
Description
Resend onboarding driver validation code
onboardingRequireIntervention
Description
Require intervention on onboarding
Response
Returns an OnboardingRequest
Example
Query
mutation onboardingRequireIntervention(
$id: ID!,
$reason: String!
) {
onboardingRequireIntervention(
id: $id,
reason: $reason
) {
id
status
mode
createdAt
updatedAt
warnings {
...OnboardingWarningFragment
}
clonedTo {
...OnboardingRequestFragment
}
clonedFrom {
...OnboardingRequestFragment
}
deviceCreatedBy {
...AccountFragment
}
driverCreatedBy {
...AccountFragment
}
driverValidatedBy {
...AccountFragment
}
driverAssociationId
driverAssociatedBy {
...AccountFragment
}
vehicleCreatedBy {
...AccountFragment
}
vehicleAssociatedBy {
...AccountFragment
}
vehicleEnrichedBy {
...AccountFragment
}
createdBy {
...AccountFragment
}
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
vehicle {
...VehicleFragment
}
vehicleCreationId
vehicleEnrichments {
...OnboardingVehicleFragment
}
vehicleConnection {
...OnboardingVehicleConnectionFragment
}
consent {
...OnboardingConsentFragment
}
profile {
...ProfileOnboardingFragment
}
actions {
...OnboardingActionPagedFragment
}
device {
...DeviceFragment
}
deviceMode
deviceBluetooth
plateNumber
vin
vehicleLabel
withCode
connectionType
kmAtInstallation
serialNumber
activateReadWriteInDevice
clientIdentificationId
auxiliaryDevices {
...OnboardingAuxiliaryDevicePagedFragment
}
}
}
Variables
{
"id": "4",
"reason": "xyz789"
}
Response
{
"data": {
"onboardingRequireIntervention": {
"id": 4,
"status": "OPEN",
"mode": "MANUAL",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"warnings": [OnboardingWarning],
"clonedTo": OnboardingRequest,
"clonedFrom": OnboardingRequest,
"deviceCreatedBy": Account,
"driverCreatedBy": Account,
"driverValidatedBy": Account,
"driverAssociationId": "4",
"driverAssociatedBy": Account,
"vehicleCreatedBy": Account,
"vehicleAssociatedBy": Account,
"vehicleEnrichedBy": Account,
"createdBy": Account,
"distributor": OnboardingDistributor,
"driver": Account,
"vehicle": Vehicle,
"vehicleCreationId": 4,
"vehicleEnrichments": OnboardingVehicle,
"vehicleConnection": OnboardingVehicleConnection,
"consent": OnboardingConsent,
"profile": ProfileOnboarding,
"actions": OnboardingActionPaged,
"device": Device,
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE",
"plateNumber": 4,
"vin": "xyz789",
"vehicleLabel": "xyz789",
"withCode": false,
"connectionType": "CABLE",
"kmAtInstallation": 987,
"serialNumber": "xyz789",
"activateReadWriteInDevice": false,
"clientIdentificationId": "4",
"auxiliaryDevices": OnboardingAuxiliaryDevicePaged
}
}
}
onboardingRestoreDefaultSettings
Description
Require intervention on onboarding
Response
Returns an OnboardingRequest
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing onboarding request |
Example
Query
mutation onboardingRestoreDefaultSettings($id: ID!) {
onboardingRestoreDefaultSettings(id: $id) {
id
status
mode
createdAt
updatedAt
warnings {
...OnboardingWarningFragment
}
clonedTo {
...OnboardingRequestFragment
}
clonedFrom {
...OnboardingRequestFragment
}
deviceCreatedBy {
...AccountFragment
}
driverCreatedBy {
...AccountFragment
}
driverValidatedBy {
...AccountFragment
}
driverAssociationId
driverAssociatedBy {
...AccountFragment
}
vehicleCreatedBy {
...AccountFragment
}
vehicleAssociatedBy {
...AccountFragment
}
vehicleEnrichedBy {
...AccountFragment
}
createdBy {
...AccountFragment
}
distributor {
...OnboardingDistributorFragment
}
driver {
...AccountFragment
}
vehicle {
...VehicleFragment
}
vehicleCreationId
vehicleEnrichments {
...OnboardingVehicleFragment
}
vehicleConnection {
...OnboardingVehicleConnectionFragment
}
consent {
...OnboardingConsentFragment
}
profile {
...ProfileOnboardingFragment
}
actions {
...OnboardingActionPagedFragment
}
device {
...DeviceFragment
}
deviceMode
deviceBluetooth
plateNumber
vin
vehicleLabel
withCode
connectionType
kmAtInstallation
serialNumber
activateReadWriteInDevice
clientIdentificationId
auxiliaryDevices {
...OnboardingAuxiliaryDevicePagedFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"onboardingRestoreDefaultSettings": {
"id": "4",
"status": "OPEN",
"mode": "MANUAL",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"warnings": [OnboardingWarning],
"clonedTo": OnboardingRequest,
"clonedFrom": OnboardingRequest,
"deviceCreatedBy": Account,
"driverCreatedBy": Account,
"driverValidatedBy": Account,
"driverAssociationId": 4,
"driverAssociatedBy": Account,
"vehicleCreatedBy": Account,
"vehicleAssociatedBy": Account,
"vehicleEnrichedBy": Account,
"createdBy": Account,
"distributor": OnboardingDistributor,
"driver": Account,
"vehicle": Vehicle,
"vehicleCreationId": "4",
"vehicleEnrichments": OnboardingVehicle,
"vehicleConnection": OnboardingVehicleConnection,
"consent": OnboardingConsent,
"profile": ProfileOnboarding,
"actions": OnboardingActionPaged,
"device": Device,
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE",
"plateNumber": "4",
"vin": "xyz789",
"vehicleLabel": "abc123",
"withCode": true,
"connectionType": "CABLE",
"kmAtInstallation": 123,
"serialNumber": "xyz789",
"activateReadWriteInDevice": false,
"clientIdentificationId": "4",
"auxiliaryDevices": OnboardingAuxiliaryDevicePaged
}
}
}
onboardingStaffCreate
Response
Returns an OnboardingStaff
Arguments
| Name | Description |
|---|---|
distributorId - ID!
|
Distributor id |
accountId - ID!
|
Account id |
role - OnboardingStaffRole!
|
Staff role |
Example
Query
mutation onboardingStaffCreate(
$distributorId: ID!,
$accountId: ID!,
$role: OnboardingStaffRole!
) {
onboardingStaffCreate(
distributorId: $distributorId,
accountId: $accountId,
role: $role
) {
role
isActive
account {
...AccountFragment
}
}
}
Variables
{
"distributorId": "4",
"accountId": 4,
"role": "MANAGER"
}
Response
{
"data": {
"onboardingStaffCreate": {
"role": "MANAGER",
"isActive": true,
"account": Account
}
}
}
onboardingStaffUpdate
Response
Returns an OnboardingStaff
Arguments
| Name | Description |
|---|---|
distributorId - ID!
|
Distributor id |
id - ID!
|
Staff id |
role - OnboardingStaffRole
|
|
isActive - Boolean
|
Example
Query
mutation onboardingStaffUpdate(
$distributorId: ID!,
$id: ID!,
$role: OnboardingStaffRole,
$isActive: Boolean
) {
onboardingStaffUpdate(
distributorId: $distributorId,
id: $id,
role: $role,
isActive: $isActive
) {
role
isActive
account {
...AccountFragment
}
}
}
Variables
{
"distributorId": "4",
"id": 4,
"role": "MANAGER",
"isActive": false
}
Response
{
"data": {
"onboardingStaffUpdate": {
"role": "MANAGER",
"isActive": false,
"account": Account
}
}
}
onboardingVehicleConnection
Use OnboardingVehicleConnectionUpdate
Response
Returns an ID
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing onboarding request |
connectionType - DeviceConnectionType
|
Connection type |
kmAtInstallation - Int
|
Vehicle mileage (km) at installation |
activateReadWriteInDevice - Boolean
|
Enable writing or leave read-only |
deviceMode - ProfileDeviceModeClassArg
|
Specify device mode |
deviceBluetooth - OnboardingDeviceBluetoothMode
|
Specify device bluetooth mode |
Example
Query
mutation onboardingVehicleConnection(
$id: ID!,
$connectionType: DeviceConnectionType,
$kmAtInstallation: Int,
$activateReadWriteInDevice: Boolean,
$deviceMode: ProfileDeviceModeClassArg,
$deviceBluetooth: OnboardingDeviceBluetoothMode
) {
onboardingVehicleConnection(
id: $id,
connectionType: $connectionType,
kmAtInstallation: $kmAtInstallation,
activateReadWriteInDevice: $activateReadWriteInDevice,
deviceMode: $deviceMode,
deviceBluetooth: $deviceBluetooth
)
}
Variables
{
"id": "4",
"connectionType": "CABLE",
"kmAtInstallation": 123,
"activateReadWriteInDevice": true,
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE"
}
Response
{
"data": {
"onboardingVehicleConnection": "4"
}
}
onboardingVehicleConnectionUpdate
Description
Set vehicle connection of an onboarding request
Response
Returns an OnboardingVehicleConnection
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing onboarding request |
vehicleConnectionId - ID
|
|
connectionType - DeviceConnectionType
|
Connection type |
kmAtInstallation - Int
|
Vehicle mileage (km) at installation |
activateReadWriteInDevice - Boolean
|
Enable writing or leave read-only |
deviceMode - ProfileDeviceModeClassArg
|
Specify device mode |
deviceBluetooth - OnboardingDeviceBluetoothMode
|
Specify device bluetooth mode |
Example
Query
mutation onboardingVehicleConnectionUpdate(
$id: ID!,
$vehicleConnectionId: ID,
$connectionType: DeviceConnectionType,
$kmAtInstallation: Int,
$activateReadWriteInDevice: Boolean,
$deviceMode: ProfileDeviceModeClassArg,
$deviceBluetooth: OnboardingDeviceBluetoothMode
) {
onboardingVehicleConnectionUpdate(
id: $id,
vehicleConnectionId: $vehicleConnectionId,
connectionType: $connectionType,
kmAtInstallation: $kmAtInstallation,
activateReadWriteInDevice: $activateReadWriteInDevice,
deviceMode: $deviceMode,
deviceBluetooth: $deviceBluetooth
) {
id
activateReadWriteInDevice
connectionType
deviceMode
deviceBluetooth
kmAtInstallation
}
}
Variables
{
"id": "4",
"vehicleConnectionId": "4",
"connectionType": "CABLE",
"kmAtInstallation": 987,
"activateReadWriteInDevice": true,
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE"
}
Response
{
"data": {
"onboardingVehicleConnectionUpdate": {
"id": 4,
"activateReadWriteInDevice": true,
"connectionType": "CABLE",
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE",
"kmAtInstallation": 123
}
}
}
onboardingVehicleCreate
Description
Create vehicle for onboarding request
Response
Returns an ID
Example
Query
mutation onboardingVehicleCreate(
$id: ID!,
$plateNumber: String,
$vin: String,
$label: String
) {
onboardingVehicleCreate(
id: $id,
plateNumber: $plateNumber,
vin: $vin,
label: $label
)
}
Variables
{
"id": "4",
"plateNumber": "xyz789",
"vin": "xyz789",
"label": "xyz789"
}
Response
{"data": {"onboardingVehicleCreate": 4}}
onboardingVehicleEnrichment
Description
Add vehicle information to onboarding request
Response
Returns an OnboardingVehicle
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of existing onboarding request |
kba - ID
|
Kraftfahrbundesamt (Germany and Austria) |
modelId - ID
|
Vehicle model id. Fetched from AppStore api, or created if == -1 |
acIsRemoteControlled - Boolean
|
|
alarmIsPresent - Boolean
|
|
brand - String
|
The vehicle's brand |
brandModel - String
|
The vehicle's model |
color - String
|
Color of the vehicle |
connectivity - String
|
|
evPlugPosition - String
|
|
evPlugType - String
|
|
frontBrakeInstallation - String
|
Odometer (km) at last front brake change |
frontBrakeWear - String
|
|
frontTireInstallation - String
|
Odometer (km) at last front tires change |
frontTireWear - String
|
|
fuelType - OnboardingEnergyTypeArg
|
|
fuelTypeSecondary - OnboardingEnergyTypeArg
|
|
lastDateBatteryChanged - DateTime
|
Date of last battery change |
rearBrakeInstallation - String
|
Odometer (km) at last rear brake change |
rearBrakeWear - String
|
|
rearTireInstallation - String
|
Odometer (km) at last rear tires change |
rearTireWear - String
|
|
tankSize - Int
|
Tank size (l), -1 if unknown |
tyresType - TyreTypeArg
|
|
yearOfFirstCirculation - Int
|
|
vehicleType - VehicleTypeName
|
Vehicle type |
Example
Query
mutation onboardingVehicleEnrichment(
$id: ID!,
$kba: ID,
$modelId: ID,
$acIsRemoteControlled: Boolean,
$alarmIsPresent: Boolean,
$brand: String,
$brandModel: String,
$color: String,
$connectivity: String,
$evPlugPosition: String,
$evPlugType: String,
$frontBrakeInstallation: String,
$frontBrakeWear: String,
$frontTireInstallation: String,
$frontTireWear: String,
$fuelType: OnboardingEnergyTypeArg,
$fuelTypeSecondary: OnboardingEnergyTypeArg,
$lastDateBatteryChanged: DateTime,
$rearBrakeInstallation: String,
$rearBrakeWear: String,
$rearTireInstallation: String,
$rearTireWear: String,
$tankSize: Int,
$tyresType: TyreTypeArg,
$yearOfFirstCirculation: Int,
$vehicleType: VehicleTypeName
) {
onboardingVehicleEnrichment(
id: $id,
kba: $kba,
modelId: $modelId,
acIsRemoteControlled: $acIsRemoteControlled,
alarmIsPresent: $alarmIsPresent,
brand: $brand,
brandModel: $brandModel,
color: $color,
connectivity: $connectivity,
evPlugPosition: $evPlugPosition,
evPlugType: $evPlugType,
frontBrakeInstallation: $frontBrakeInstallation,
frontBrakeWear: $frontBrakeWear,
frontTireInstallation: $frontTireInstallation,
frontTireWear: $frontTireWear,
fuelType: $fuelType,
fuelTypeSecondary: $fuelTypeSecondary,
lastDateBatteryChanged: $lastDateBatteryChanged,
rearBrakeInstallation: $rearBrakeInstallation,
rearBrakeWear: $rearBrakeWear,
rearTireInstallation: $rearTireInstallation,
rearTireWear: $rearTireWear,
tankSize: $tankSize,
tyresType: $tyresType,
yearOfFirstCirculation: $yearOfFirstCirculation,
vehicleType: $vehicleType
) {
acIsRemoteControlled
alarmIsPresent
brand
brandModel
color
connectivity
evPlugPosition
evPlugType
frontBrakeInstallation
frontBrakeWear
frontTireInstallation
frontTireWear
fuelType
fuelTypeSecondary
kba
lastDateBatteryChanged
modelId
rearBrakeInstallation
rearBrakeWear
rearTireInstallation
rearTireWear
tankSize
tyresType
vinDescriptions {
...DecodeVinResultFragment
}
yearOfFirstCirculation
vehicleType
}
}
Variables
{
"id": "4",
"kba": 4,
"modelId": 4,
"acIsRemoteControlled": true,
"alarmIsPresent": true,
"brand": "abc123",
"brandModel": "abc123",
"color": "xyz789",
"connectivity": "xyz789",
"evPlugPosition": "abc123",
"evPlugType": "xyz789",
"frontBrakeInstallation": "xyz789",
"frontBrakeWear": "abc123",
"frontTireInstallation": "xyz789",
"frontTireWear": "xyz789",
"fuelType": "DIESEL",
"fuelTypeSecondary": "DIESEL",
"lastDateBatteryChanged": "2007-12-03T10:15:30Z",
"rearBrakeInstallation": "abc123",
"rearBrakeWear": "abc123",
"rearTireInstallation": "abc123",
"rearTireWear": "abc123",
"tankSize": 123,
"tyresType": "SUMMER",
"yearOfFirstCirculation": 123,
"vehicleType": "CAR"
}
Response
{
"data": {
"onboardingVehicleEnrichment": {
"acIsRemoteControlled": true,
"alarmIsPresent": true,
"brand": "abc123",
"brandModel": "xyz789",
"color": "abc123",
"connectivity": "xyz789",
"evPlugPosition": "xyz789",
"evPlugType": "abc123",
"frontBrakeInstallation": "xyz789",
"frontBrakeWear": "xyz789",
"frontTireInstallation": "abc123",
"frontTireWear": "abc123",
"fuelType": "OTHER",
"fuelTypeSecondary": "OTHER",
"kba": "4",
"lastDateBatteryChanged": "2007-12-03T10:15:30Z",
"modelId": "4",
"rearBrakeInstallation": "xyz789",
"rearBrakeWear": "abc123",
"rearTireInstallation": "xyz789",
"rearTireWear": "xyz789",
"tankSize": 123,
"tyresType": "SUMMER",
"vinDescriptions": DecodeVinResult,
"yearOfFirstCirculation": 123,
"vehicleType": "CAR"
}
}
}
onboardingVehicleUpdate
Description
Upate vehicle for onboarding request
Response
Returns an ID
Example
Query
mutation onboardingVehicleUpdate(
$id: ID!,
$vehicleCreationId: ID!,
$plateNumber: String,
$vin: String
) {
onboardingVehicleUpdate(
id: $id,
vehicleCreationId: $vehicleCreationId,
plateNumber: $plateNumber,
vin: $vin
)
}
Variables
{
"id": 4,
"vehicleCreationId": 4,
"plateNumber": "abc123",
"vin": "abc123"
}
Response
{"data": {"onboardingVehicleUpdate": 4}}
partnerCreate
Response
Returns an OnboardingPartner
Example
Query
mutation partnerCreate(
$name: String!,
$organisationId: ID!,
$projectId: ID
) {
partnerCreate(
name: $name,
organisationId: $organisationId,
projectId: $projectId
) {
id
name
organizationId
project {
...ProjectFragment
}
providers {
...OnboardingProviderPagedFragment
}
}
}
Variables
{
"name": "abc123",
"organisationId": 4,
"projectId": 4
}
Response
{
"data": {
"partnerCreate": {
"id": "4",
"name": "abc123",
"organizationId": 4,
"project": Project,
"providers": OnboardingProviderPaged
}
}
}
partnerUpdate
Response
Returns an OnboardingPartner
Example
Query
mutation partnerUpdate(
$id: ID!,
$emails: [String!]
) {
partnerUpdate(
id: $id,
emails: $emails
) {
id
name
organizationId
project {
...ProjectFragment
}
providers {
...OnboardingProviderPagedFragment
}
}
}
Variables
{
"id": "4",
"emails": ["abc123"]
}
Response
{
"data": {
"partnerUpdate": {
"id": 4,
"name": "xyz789",
"organizationId": 4,
"project": Project,
"providers": OnboardingProviderPaged
}
}
}
passwordReset
Description
Set new password using reset token
Response
Returns a Boolean
Example
Query
mutation passwordReset(
$token: String!,
$password: String!
) {
passwordReset(
token: $token,
password: $password
)
}
Variables
{
"token": "xyz789",
"password": "xyz789"
}
Response
{"data": {"passwordReset": true}}
passwordResetToken
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 passwordResetToken(
$channel: PasswordResetChannel!,
$id: ID!
) {
passwordResetToken(
channel: $channel,
id: $id
)
}
Variables
{"channel": "PHONE", "id": "4"}
Response
{"data": {"passwordResetToken": "4"}}
projectCreate
Description
Create a new project
Response
Returns a Project
Example
Query
mutation projectCreate(
$label: String!,
$ownerId: ID
) {
projectCreate(
label: $label,
ownerId: $ownerId
) {
id
label
owner {
...AccountFragment
}
vehicles {
...VehiclePagedFragment
}
groups {
...GroupPagedFragment
}
drivers {
...DriverPagedFragment
}
devices {
...DevicePagedFragment
}
users {
...AccountPagedFragment
}
}
}
Variables
{"label": "abc123", "ownerId": 4}
Response
{
"data": {
"projectCreate": {
"id": 4,
"label": "abc123",
"owner": Account,
"vehicles": VehiclePaged,
"groups": GroupPaged,
"drivers": DriverPaged,
"devices": DevicePaged,
"users": AccountPaged
}
}
}
projectDelete
Description
Delete project
projectUpdate
Description
Update project fields
Response
Returns a Project
Example
Query
mutation projectUpdate(
$id: ID!,
$label: String,
$ownerId: ID
) {
projectUpdate(
id: $id,
label: $label,
ownerId: $ownerId
) {
id
label
owner {
...AccountFragment
}
vehicles {
...VehiclePagedFragment
}
groups {
...GroupPagedFragment
}
drivers {
...DriverPagedFragment
}
devices {
...DevicePagedFragment
}
users {
...AccountPagedFragment
}
}
}
Variables
{
"id": 4,
"label": "abc123",
"ownerId": "4"
}
Response
{
"data": {
"projectUpdate": {
"id": "4",
"label": "xyz789",
"owner": Account,
"vehicles": VehiclePaged,
"groups": GroupPaged,
"drivers": DriverPaged,
"devices": DevicePaged,
"users": AccountPaged
}
}
}
projectUpdateMembers
Response
Returns an ID
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of project being modified |
op - MemberOperation!
|
Add or remove |
type - ProjectMember!
|
Member type |
ids - [ID]!
|
Ids of members being add/remove to/from project |
Example
Query
mutation projectUpdateMembers(
$id: ID!,
$op: MemberOperation!,
$type: ProjectMember!,
$ids: [ID]!
) {
projectUpdateMembers(
id: $id,
op: $op,
type: $type,
ids: $ids
)
}
Variables
{
"id": "4",
"op": "ADD",
"type": "DEVICE",
"ids": [4]
}
Response
{"data": {"projectUpdateMembers": "4"}}
providerCreate
Response
Returns an OnboardingProvider
Example
Query
mutation providerCreate(
$partnerId: ID!,
$name: String!,
$sendPoke: Boolean,
$emails: [String!]
) {
providerCreate(
partnerId: $partnerId,
name: $name,
sendPoke: $sendPoke,
emails: $emails
) {
id
name
sendPoke
municSupportEmails
emails
partner {
...OnboardingPartnerFragment
}
}
}
Variables
{
"partnerId": "4",
"name": "xyz789",
"sendPoke": true,
"emails": ["abc123"]
}
Response
{
"data": {
"providerCreate": {
"id": "4",
"name": "abc123",
"sendPoke": false,
"municSupportEmails": ["xyz789"],
"emails": ["xyz789"],
"partner": OnboardingPartner
}
}
}
providerUpdate
Response
Returns an OnboardingProvider
Example
Query
mutation providerUpdate(
$id: ID!,
$emails: [String!]
) {
providerUpdate(
id: $id,
emails: $emails
) {
id
name
sendPoke
municSupportEmails
emails
partner {
...OnboardingPartnerFragment
}
}
}
Variables
{"id": 4, "emails": ["xyz789"]}
Response
{
"data": {
"providerUpdate": {
"id": 4,
"name": "xyz789",
"sendPoke": false,
"municSupportEmails": ["xyz789"],
"emails": ["abc123"],
"partner": OnboardingPartner
}
}
}
quotationCreate
Description
Create quotation
Response
Returns a Quotation
Example
Query
mutation quotationCreate(
$plateNumber: String!,
$workshopId: ID!,
$maintenanceCode: String!
) {
quotationCreate(
plateNumber: $plateNumber,
workshopId: $workshopId,
maintenanceCode: $maintenanceCode
) {
id
plateNumber
workshop {
...WorkshopFragment
}
currency
price
maintenanceCode
bookingId
taxes
taxesPrice
providerQuotationId
}
}
Variables
{
"plateNumber": "xyz789",
"workshopId": 4,
"maintenanceCode": "abc123"
}
Response
{
"data": {
"quotationCreate": {
"id": 4,
"plateNumber": "xyz789",
"workshop": Workshop,
"currency": "xyz789",
"price": 123,
"maintenanceCode": "abc123",
"bookingId": 4,
"taxes": 987,
"taxesPrice": 123,
"providerQuotationId": "4"
}
}
}
ratingCreate
Description
Create rating
Response
Returns a Rating
Example
Query
mutation ratingCreate(
$message: String,
$stars: Int,
$workshopId: ID,
$bookingId: ID
) {
ratingCreate(
message: $message,
stars: $stars,
workshopId: $workshopId,
bookingId: $bookingId
) {
id
createdAt
message
stars
response
responseDate
status
workshop {
...WorkshopFragment
}
booking {
...BookingFragment
}
}
}
Variables
{
"message": "abc123",
"stars": 123,
"workshopId": "4",
"bookingId": 4
}
Response
{
"data": {
"ratingCreate": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"message": "abc123",
"stars": 987,
"response": "xyz789",
"responseDate": "2007-12-03T10:15:30Z",
"status": "VERIFIED",
"workshop": Workshop,
"booking": Booking
}
}
}
ratingDelete
Description
Delete rating
ratingUpdate
Description
Update rating
Response
Returns a Rating
Example
Query
mutation ratingUpdate(
$id: ID!,
$message: String,
$stars: Int,
$bookingId: ID
) {
ratingUpdate(
id: $id,
message: $message,
stars: $stars,
bookingId: $bookingId
) {
id
createdAt
message
stars
response
responseDate
status
workshop {
...WorkshopFragment
}
booking {
...BookingFragment
}
}
}
Variables
{
"id": 4,
"message": "abc123",
"stars": 123,
"bookingId": 4
}
Response
{
"data": {
"ratingUpdate": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"message": "abc123",
"stars": 987,
"response": "abc123",
"responseDate": "2007-12-03T10:15:30Z",
"status": "VERIFIED",
"workshop": Workshop,
"booking": Booking
}
}
}
rdcEkkoInitialize
Description
Initialize Ekko
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
deviceId - ID!
|
Device id |
energyType - EnergyType
|
Energy type |
odometer - Int
|
Odometer (km) |
displacement - Int
|
Displacement |
vin - String
|
Vehicle Identification Number |
Example
Query
mutation rdcEkkoInitialize(
$deviceId: ID!,
$energyType: EnergyType,
$odometer: Int,
$displacement: Int,
$vin: String
) {
rdcEkkoInitialize(
deviceId: $deviceId,
energyType: $energyType,
odometer: $odometer,
displacement: $displacement,
vin: $vin
) {
id
type
attributes
}
}
Variables
{
"deviceId": "4",
"energyType": "OTHER",
"odometer": 987,
"displacement": 123,
"vin": "abc123"
}
Response
{
"data": {
"rdcEkkoInitialize": {
"id": 4,
"type": "xyz789",
"attributes": Json
}
}
}
rdcGpsToggle
Description
Temporarily stop gps tracking
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
deviceId - ID!
|
Device id |
action - ToggleAction!
|
Start/Stop |
duration - Int!
|
Duration (minutes) |
Example
Query
mutation rdcGpsToggle(
$deviceId: ID!,
$action: ToggleAction!,
$duration: Int!
) {
rdcGpsToggle(
deviceId: $deviceId,
action: $action,
duration: $duration
) {
id
type
attributes
}
}
Variables
{
"deviceId": "4",
"action": "START",
"duration": 123
}
Response
{
"data": {
"rdcGpsToggle": {
"id": 4,
"type": "xyz789",
"attributes": Json
}
}
}
rdcSystemReboot
Description
Reboot the device
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
deviceId - ID!
|
Device id |
Example
Query
mutation rdcSystemReboot($deviceId: ID!) {
rdcSystemReboot(deviceId: $deviceId) {
id
type
attributes
}
}
Variables
{"deviceId": "4"}
Response
{
"data": {
"rdcSystemReboot": {
"id": 4,
"type": "xyz789",
"attributes": Json
}
}
}
remoteDiagActionCreate
Response
Returns a RemoteDiagAction
Arguments
| Name | Description |
|---|---|
remoteDiagId - ID!
|
Id of remote diagnostic session |
action - RemoteDiagActionTypeArg!
|
Action type |
sequenceActions - [RemoteDiagActionTypeArg]
|
List of action to execute in case of sequence |
ecus - [ID!]
|
Selected ECUs by id |
pids - [ID!]
|
Selected parameters by id |
pidsNames - [String!]
|
Selected parameters by name |
Example
Query
mutation remoteDiagActionCreate(
$remoteDiagId: ID!,
$action: RemoteDiagActionTypeArg!,
$sequenceActions: [RemoteDiagActionTypeArg],
$ecus: [ID!],
$pids: [ID!],
$pidsNames: [String!]
) {
remoteDiagActionCreate(
remoteDiagId: $remoteDiagId,
action: $action,
sequenceActions: $sequenceActions,
ecus: $ecus,
pids: $pids,
pidsNames: $pidsNames
) {
id
type
status
failureReason
progress
ecus
pids
createdAt
updatedAt
sequenceActions
dtcs {
...RemoteDiagResultDtcPagedFragment
}
snapshots {
...RemoteDiagResultSnapshotPagedFragment
}
supportedParameters {
...RemoteDiagSupportedParameterPagedFragment
}
}
}
Variables
{
"remoteDiagId": 4,
"action": "CLEAR_DTC",
"sequenceActions": ["CLEAR_DTC"],
"ecus": [4],
"pids": ["4"],
"pidsNames": ["xyz789"]
}
Response
{
"data": {
"remoteDiagActionCreate": {
"id": 4,
"type": "CLEAR_DTC",
"status": "PENDING",
"failureReason": "abc123",
"progress": 123.45,
"ecus": ["4"],
"pids": ["4"],
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"sequenceActions": ["CLEAR_DTC"],
"dtcs": RemoteDiagResultDtcPaged,
"snapshots": RemoteDiagResultSnapshotPaged,
"supportedParameters": RemoteDiagSupportedParameterPaged
}
}
}
remoteDiagActionUpdate
Response
Returns a RemoteDiagAction
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
status - RemoteDiagActionStatusArg!
|
Example
Query
mutation remoteDiagActionUpdate(
$id: ID!,
$status: RemoteDiagActionStatusArg!
) {
remoteDiagActionUpdate(
id: $id,
status: $status
) {
id
type
status
failureReason
progress
ecus
pids
createdAt
updatedAt
sequenceActions
dtcs {
...RemoteDiagResultDtcPagedFragment
}
snapshots {
...RemoteDiagResultSnapshotPagedFragment
}
supportedParameters {
...RemoteDiagSupportedParameterPagedFragment
}
}
}
Variables
{"id": "4", "status": "ABORT"}
Response
{
"data": {
"remoteDiagActionUpdate": {
"id": "4",
"type": "CLEAR_DTC",
"status": "PENDING",
"failureReason": "abc123",
"progress": 987.65,
"ecus": [4],
"pids": [4],
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"sequenceActions": ["CLEAR_DTC"],
"dtcs": RemoteDiagResultDtcPaged,
"snapshots": RemoteDiagResultSnapshotPaged,
"supportedParameters": RemoteDiagSupportedParameterPaged
}
}
}
remoteDiagCancel
Description
Close a remote diagnostic session
Response
Returns a RemoteDiag
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of remote diagnostic session |
Example
Query
mutation remoteDiagCancel($id: ID!) {
remoteDiagCancel(id: $id) {
id
createdAt
updatedAt
status
vud {
...RemoteDiagEndpointFragment
}
vci {
...RemoteDiagEndpointFragment
}
currentStep
language
providerName
actions {
...RemoteDiagActionPagedFragment
}
result {
...RemoteDiagResultFragment
}
steps {
...RemoteDiagStepPagedFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"remoteDiagCancel": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "abc123",
"vud": RemoteDiagEndpoint,
"vci": RemoteDiagEndpoint,
"currentStep": "SETUP_ONGOING",
"language": Language,
"providerName": "abc123",
"actions": RemoteDiagActionPaged,
"result": RemoteDiagResult,
"steps": RemoteDiagStepPaged
}
}
}
remoteDiagCreate
Description
Setup a remote diagnostic session
Response
Returns a RemoteDiag
Arguments
| Name | Description |
|---|---|
vudDeviceId - ID!
|
Id of device of the Vehicle Under Diagnostic |
vin - String
|
Custom VIN |
language - Language
|
|
providerName - String
|
|
initialActionType - RemoteDiagActionTypeArg
|
Type of action upon start of session |
initialSequenceActions - [RemoteDiagActionTypeArg]
|
List of action to execute in case of sequence |
Example
Query
mutation remoteDiagCreate(
$vudDeviceId: ID!,
$vin: String,
$language: Language,
$providerName: String,
$initialActionType: RemoteDiagActionTypeArg,
$initialSequenceActions: [RemoteDiagActionTypeArg]
) {
remoteDiagCreate(
vudDeviceId: $vudDeviceId,
vin: $vin,
language: $language,
providerName: $providerName,
initialActionType: $initialActionType,
initialSequenceActions: $initialSequenceActions
) {
id
createdAt
updatedAt
status
vud {
...RemoteDiagEndpointFragment
}
vci {
...RemoteDiagEndpointFragment
}
currentStep
language
providerName
actions {
...RemoteDiagActionPagedFragment
}
result {
...RemoteDiagResultFragment
}
steps {
...RemoteDiagStepPagedFragment
}
}
}
Variables
{
"vudDeviceId": 4,
"vin": "xyz789",
"language": Language,
"providerName": "abc123",
"initialActionType": "CLEAR_DTC",
"initialSequenceActions": ["CLEAR_DTC"]
}
Response
{
"data": {
"remoteDiagCreate": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "xyz789",
"vud": RemoteDiagEndpoint,
"vci": RemoteDiagEndpoint,
"currentStep": "SETUP_ONGOING",
"language": Language,
"providerName": "xyz789",
"actions": RemoteDiagActionPaged,
"result": RemoteDiagResult,
"steps": RemoteDiagStepPaged
}
}
}
remoteDiagStart
Description
Start the remote diagnostic session
Response
Returns a RemoteDiag
Arguments
| Name | Description |
|---|---|
id - ID!
|
Id of remote diagnostic session |
vin - String
|
Custom VIN |
countrySpecificId - CountrySpecificIdArg
|
Custom country-specific id |
vci - ID
|
Custom VCI (Vehicle Communication Interface device). Should only be specified at the first READ_DTC action |
shouldValidateVin - Boolean
|
|
config - Json
|
Manual configuration (stringified json) |
initialActionType - RemoteDiagActionTypeArg
|
Type of action upon start of session |
initialSequenceActions - [RemoteDiagActionTypeArg]
|
List of action to execute in case of sequence |
Example
Query
mutation remoteDiagStart(
$id: ID!,
$vin: String,
$countrySpecificId: CountrySpecificIdArg,
$vci: ID,
$shouldValidateVin: Boolean,
$config: Json,
$initialActionType: RemoteDiagActionTypeArg,
$initialSequenceActions: [RemoteDiagActionTypeArg]
) {
remoteDiagStart(
id: $id,
vin: $vin,
countrySpecificId: $countrySpecificId,
vci: $vci,
shouldValidateVin: $shouldValidateVin,
config: $config,
initialActionType: $initialActionType,
initialSequenceActions: $initialSequenceActions
) {
id
createdAt
updatedAt
status
vud {
...RemoteDiagEndpointFragment
}
vci {
...RemoteDiagEndpointFragment
}
currentStep
language
providerName
actions {
...RemoteDiagActionPagedFragment
}
result {
...RemoteDiagResultFragment
}
steps {
...RemoteDiagStepPagedFragment
}
}
}
Variables
{
"id": 4,
"vin": "abc123",
"countrySpecificId": CountrySpecificIdArg,
"vci": 4,
"shouldValidateVin": false,
"config": Json,
"initialActionType": "CLEAR_DTC",
"initialSequenceActions": ["CLEAR_DTC"]
}
Response
{
"data": {
"remoteDiagStart": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "abc123",
"vud": RemoteDiagEndpoint,
"vci": RemoteDiagEndpoint,
"currentStep": "SETUP_ONGOING",
"language": Language,
"providerName": "xyz789",
"actions": RemoteDiagActionPaged,
"result": RemoteDiagResult,
"steps": RemoteDiagStepPaged
}
}
}
ticketCreate
Description
Create support ticket
Response
Returns a Ticket
Arguments
| Name | Description |
|---|---|
title - String!
|
|
source - TicketSource!
|
|
body - String
|
Example
Query
mutation ticketCreate(
$title: String!,
$source: TicketSource!,
$body: String
) {
ticketCreate(
title: $title,
source: $source,
body: $body
) {
id
title
source
createdAt
account {
...AccountFragment
}
}
}
Variables
{
"title": "abc123",
"source": "ONBOARDING",
"body": "xyz789"
}
Response
{
"data": {
"ticketCreate": {
"id": "4",
"title": "abc123",
"source": "ONBOARDING",
"createdAt": "2007-12-03T10:15:30Z",
"account": Account
}
}
}
towingSessionStart
Description
Start a vehicle towing session
Response
Returns a TowingSession
Example
Query
mutation towingSessionStart(
$towingVehicleId: ID!,
$trailerVehicleId: ID!,
$startAt: DateTime
) {
towingSessionStart(
towingVehicleId: $towingVehicleId,
trailerVehicleId: $trailerVehicleId,
startAt: $startAt
) {
id
startAt
endAt
towingVehicle {
...VehicleFragment
}
trailerVehicle {
...VehicleFragment
}
createdBy {
...AccountFragment
}
closedBy {
...AccountFragment
}
}
}
Variables
{
"towingVehicleId": 4,
"trailerVehicleId": "4",
"startAt": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"towingSessionStart": {
"id": "4",
"startAt": "2007-12-03T10:15:30Z",
"endAt": "2007-12-03T10:15:30Z",
"towingVehicle": Vehicle,
"trailerVehicle": Vehicle,
"createdBy": Account,
"closedBy": Account
}
}
}
towingSessionStop
Description
Stop a driver vehicle session
Response
Returns a TowingSession
Example
Query
mutation towingSessionStop(
$id: ID!,
$endAt: DateTime!
) {
towingSessionStop(
id: $id,
endAt: $endAt
) {
id
startAt
endAt
towingVehicle {
...VehicleFragment
}
trailerVehicle {
...VehicleFragment
}
createdBy {
...AccountFragment
}
closedBy {
...AccountFragment
}
}
}
Variables
{"id": 4, "endAt": "2007-12-03T10:15:30Z"}
Response
{
"data": {
"towingSessionStop": {
"id": "4",
"startAt": "2007-12-03T10:15:30Z",
"endAt": "2007-12-03T10:15:30Z",
"towingVehicle": Vehicle,
"trailerVehicle": Vehicle,
"createdBy": Account,
"closedBy": Account
}
}
}
updateMetadatum
Description
Update metdatum
Response
Returns a TripMetadatum
Example
Query
mutation updateMetadatum(
$id: ID!,
$key: String,
$value: String
) {
updateMetadatum(
id: $id,
key: $key,
value: $value
) {
id
key
value
tripId
createdAt
updatedAt
}
}
Variables
{
"id": "4",
"key": "abc123",
"value": "xyz789"
}
Response
{
"data": {
"updateMetadatum": {
"id": 4,
"key": "abc123",
"value": "xyz789",
"tripId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
vehicleAlertCreate
Response
Returns a VehicleAlert
Arguments
| Name | Description |
|---|---|
deviceId - ID
|
|
vehicleId - ID
|
|
status - VehicleAlertStatusArg!
|
|
language - LangArg!
|
Content language |
content - Json
|
|
type - VehicleAlertTypeArg!
|
|
startTime - DateTime
|
|
endTime - DateTime
|
Example
Query
mutation vehicleAlertCreate(
$deviceId: ID,
$vehicleId: ID,
$status: VehicleAlertStatusArg!,
$language: LangArg!,
$content: Json,
$type: VehicleAlertTypeArg!,
$startTime: DateTime,
$endTime: DateTime
) {
vehicleAlertCreate(
deviceId: $deviceId,
vehicleId: $vehicleId,
status: $status,
language: $language,
content: $content,
type: $type,
startTime: $startTime,
endTime: $endTime
) {
id
type
device {
...DeviceFragment
}
vehicle {
...VehicleFragment
}
icon
lastReceived
lastReported
source
createdAt
updatedAt
status
language
feedbackStatus
feedbacks {
...VehicleAlertFeedbackPagedFragment
}
aggregatedData {
...AggregatedDataFragment
}
}
}
Variables
{
"deviceId": 4,
"vehicleId": "4",
"status": "ONGOING",
"language": "EN",
"content": Json,
"type": "BAD_INSTALLATION",
"startTime": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"vehicleAlertCreate": {
"id": 4,
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "abc123",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData
}
}
}
vehicleAlertFeedbackCreate
Response
Returns a VehicleAlertFeedback
Arguments
| Name | Description |
|---|---|
alertId - ID!
|
|
status - VehicleAlertFeedbackStatusArg!
|
|
description - String
|
|
language - LangArg
|
Description language |
Example
Query
mutation vehicleAlertFeedbackCreate(
$alertId: ID!,
$status: VehicleAlertFeedbackStatusArg!,
$description: String,
$language: LangArg
) {
vehicleAlertFeedbackCreate(
alertId: $alertId,
status: $status,
description: $description,
language: $language
) {
id
alert {
...VehicleAlertFragment
}
status
description
language
createdAt
updatedAt
}
}
Variables
{
"alertId": "4",
"status": "NO",
"description": "xyz789",
"language": "EN"
}
Response
{
"data": {
"vehicleAlertFeedbackCreate": {
"id": "4",
"alert": VehicleAlert,
"status": "NO",
"description": "abc123",
"language": "EN",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
vehicleCreate
Description
Create a new vehicle owned by the logged-in user
Response
Returns a Vehicle
Arguments
| Name | Description |
|---|---|
plate - String
|
Plate |
label - String
|
Label |
vin - String
|
Vin |
tags - [String]
|
Tags |
ownerId - ID
|
OwnerID |
modelId - ID
|
Model ID |
ktype - String
|
KType |
make - String
|
Model make |
model - String
|
Model |
year - String
|
Model Year |
fuelType - String
|
Primary fuel type |
fuelTypeSecondary - String
|
Secondary fuel type |
kba - String
|
KBA |
groupId - ID
|
group id to add the vehicle to |
Example
Query
mutation vehicleCreate(
$plate: String,
$label: String,
$vin: String,
$tags: [String],
$ownerId: ID,
$modelId: ID,
$ktype: String,
$make: String,
$model: String,
$year: String,
$fuelType: String,
$fuelTypeSecondary: String,
$kba: String,
$groupId: ID
) {
vehicleCreate(
plate: $plate,
label: $label,
vin: $vin,
tags: $tags,
ownerId: $ownerId,
modelId: $modelId,
ktype: $ktype,
make: $make,
model: $model,
year: $year,
fuelType: $fuelType,
fuelTypeSecondary: $fuelTypeSecondary,
kba: $kba,
groupId: $groupId
) {
id
plate
label
vin
onboarded
modelId
ktype
hasDriver
make
model
year
fuelType
fuelTypeSecondary
kba
tags
hybrid
vehicleType
canTow
canBeTowed
immobilizerStatus
immobilizerStatusUpdatedAt
doorsLockStatus
doorsLockStatusUpdatedAt
garageModeStatus
garageModeStatusUpdatedAt
archived
descriptions {
...DescriptionPagedFragment
}
vinDescriptions {
...DecodeVinResultFragment
}
owner {
...AccountFragment
}
currentDevice {
...DeviceFragment
}
currentDriver {
...DriverFragment
}
groups {
...GroupPagedFragment
}
lastTrip {
...TripFragment
}
trips {
...TripPagedFragment
}
maintenancesUpcoming {
...MaintenanceUpcomingPagedFragment
}
maintenancesHistorical {
...MaintenanceHistoricalPagedFragment
}
maintenanceTemplates {
...MaintenanceTemplatePagedFragment
}
maintenanceSchedules {
...MaintenanceSchedulePagedFragment
}
alerts {
...VehicleAlertPagedFragment
}
alertsState {
...VehicleAlertsStateFragment
}
currentDevices {
...DevicePagedFragment
}
towingSessionsAsTowingVehicle {
...TowingSessionPagedFragment
}
towingSessionsAsTrailerVehicle {
...TowingSessionPagedFragment
}
currentTowingSessionAsTowingVehicle {
...TowingSessionFragment
}
currentTowingSessionAsTrailerVehicle {
...TowingSessionFragment
}
currentTrailerVehicle {
...VehicleFragment
}
currentTowingVehicle {
...VehicleFragment
}
driverSessions {
...DriverVehicleSessionPagedFragment
}
}
}
Variables
{
"plate": "abc123",
"label": "xyz789",
"vin": "abc123",
"tags": ["abc123"],
"ownerId": 4,
"modelId": "4",
"ktype": "xyz789",
"make": "xyz789",
"model": "xyz789",
"year": "abc123",
"fuelType": "xyz789",
"fuelTypeSecondary": "abc123",
"kba": "xyz789",
"groupId": 4
}
Response
{
"data": {
"vehicleCreate": {
"id": 4,
"plate": "abc123",
"label": "abc123",
"vin": "xyz789",
"onboarded": false,
"modelId": 4,
"ktype": "xyz789",
"hasDriver": true,
"make": "xyz789",
"model": "abc123",
"year": "abc123",
"fuelType": "xyz789",
"fuelTypeSecondary": "xyz789",
"kba": "xyz789",
"tags": ["xyz789"],
"hybrid": false,
"vehicleType": "CAR",
"canTow": false,
"canBeTowed": false,
"immobilizerStatus": "UNKNOWN",
"immobilizerStatusUpdatedAt": "2007-12-03T10:15:30Z",
"doorsLockStatus": "UNKNOWN",
"doorsLockStatusUpdatedAt": "2007-12-03T10:15:30Z",
"garageModeStatus": "UNKNOWN",
"garageModeStatusUpdatedAt": "2007-12-03T10:15:30Z",
"archived": true,
"descriptions": DescriptionPaged,
"vinDescriptions": DecodeVinResult,
"owner": Account,
"currentDevice": Device,
"currentDriver": Driver,
"groups": GroupPaged,
"lastTrip": Trip,
"trips": TripPaged,
"maintenancesUpcoming": MaintenanceUpcomingPaged,
"maintenancesHistorical": MaintenanceHistoricalPaged,
"maintenanceTemplates": MaintenanceTemplatePaged,
"maintenanceSchedules": MaintenanceSchedulePaged,
"alerts": VehicleAlertPaged,
"alertsState": VehicleAlertsState,
"currentDevices": DevicePaged,
"towingSessionsAsTowingVehicle": TowingSessionPaged,
"towingSessionsAsTrailerVehicle": TowingSessionPaged,
"currentTowingSessionAsTowingVehicle": TowingSession,
"currentTowingSessionAsTrailerVehicle": TowingSession,
"currentTrailerVehicle": Vehicle,
"currentTowingVehicle": Vehicle,
"driverSessions": DriverVehicleSessionPaged
}
}
}
vehicleDelete
Description
Delete a user vehicle
vehicleServiceCreate
Description
Create vehicle service
Response
Returns a VehicleService
Example
Query
mutation vehicleServiceCreate(
$workshopIds: [ID],
$label: String,
$description: String
) {
vehicleServiceCreate(
workshopIds: $workshopIds,
label: $label,
description: $description
) {
id
label
description
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{
"workshopIds": ["4"],
"label": "xyz789",
"description": "abc123"
}
Response
{
"data": {
"vehicleServiceCreate": {
"id": "4",
"label": "xyz789",
"description": "abc123",
"workshops": WorkshopPaged
}
}
}
vehicleServiceDelete
Description
Delete Vehicle service
vehicleServiceUpdate
Description
Update Vehicle service
Response
Returns a VehicleService
Example
Query
mutation vehicleServiceUpdate(
$id: ID!,
$label: String
) {
vehicleServiceUpdate(
id: $id,
label: $label
) {
id
label
description
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{"id": 4, "label": "xyz789"}
Response
{
"data": {
"vehicleServiceUpdate": {
"id": "4",
"label": "xyz789",
"description": "xyz789",
"workshops": WorkshopPaged
}
}
}
vehicleTypeCreate
Description
Create vehicle type
Response
Returns a VehicleType
Example
Query
mutation vehicleTypeCreate(
$workshopIds: [ID],
$label: String,
$description: String
) {
vehicleTypeCreate(
workshopIds: $workshopIds,
label: $label,
description: $description
) {
id
label
description
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{
"workshopIds": [4],
"label": "xyz789",
"description": "abc123"
}
Response
{
"data": {
"vehicleTypeCreate": {
"id": 4,
"label": "abc123",
"description": "abc123",
"workshops": WorkshopPaged
}
}
}
vehicleTypeDelete
Description
Delete Vehicle type
vehicleTypeUpdate
Description
Update Vehicle type
Response
Returns a VehicleType
Example
Query
mutation vehicleTypeUpdate(
$id: ID!,
$label: String
) {
vehicleTypeUpdate(
id: $id,
label: $label
) {
id
label
description
workshops {
...WorkshopPagedFragment
}
}
}
Variables
{"id": 4, "label": "abc123"}
Response
{
"data": {
"vehicleTypeUpdate": {
"id": 4,
"label": "xyz789",
"description": "abc123",
"workshops": WorkshopPaged
}
}
}
vehicleUpdate
Description
Set the user's vehicule fields
Response
Returns a Vehicle
Arguments
| Name | Description |
|---|---|
id - ID!
|
Identifier |
tags - [String]
|
Tags |
plate - String
|
Plate |
label - String
|
Label |
vin - String
|
VIN |
ownerId - ID
|
OwnerID |
modelId - ID
|
Model ID |
ktype - String
|
KType |
make - String
|
Model make |
model - String
|
Model |
year - String
|
Model Year |
fuelType - String
|
Primary fuel type |
fuelTypeSecondary - String
|
Secondary fuel type |
kba - String
|
KBA |
archived - Boolean
|
Archived vehicle |
Example
Query
mutation vehicleUpdate(
$id: ID!,
$tags: [String],
$plate: String,
$label: String,
$vin: String,
$ownerId: ID,
$modelId: ID,
$ktype: String,
$make: String,
$model: String,
$year: String,
$fuelType: String,
$fuelTypeSecondary: String,
$kba: String,
$archived: Boolean
) {
vehicleUpdate(
id: $id,
tags: $tags,
plate: $plate,
label: $label,
vin: $vin,
ownerId: $ownerId,
modelId: $modelId,
ktype: $ktype,
make: $make,
model: $model,
year: $year,
fuelType: $fuelType,
fuelTypeSecondary: $fuelTypeSecondary,
kba: $kba,
archived: $archived
) {
id
plate
label
vin
onboarded
modelId
ktype
hasDriver
make
model
year
fuelType
fuelTypeSecondary
kba
tags
hybrid
vehicleType
canTow
canBeTowed
immobilizerStatus
immobilizerStatusUpdatedAt
doorsLockStatus
doorsLockStatusUpdatedAt
garageModeStatus
garageModeStatusUpdatedAt
archived
descriptions {
...DescriptionPagedFragment
}
vinDescriptions {
...DecodeVinResultFragment
}
owner {
...AccountFragment
}
currentDevice {
...DeviceFragment
}
currentDriver {
...DriverFragment
}
groups {
...GroupPagedFragment
}
lastTrip {
...TripFragment
}
trips {
...TripPagedFragment
}
maintenancesUpcoming {
...MaintenanceUpcomingPagedFragment
}
maintenancesHistorical {
...MaintenanceHistoricalPagedFragment
}
maintenanceTemplates {
...MaintenanceTemplatePagedFragment
}
maintenanceSchedules {
...MaintenanceSchedulePagedFragment
}
alerts {
...VehicleAlertPagedFragment
}
alertsState {
...VehicleAlertsStateFragment
}
currentDevices {
...DevicePagedFragment
}
towingSessionsAsTowingVehicle {
...TowingSessionPagedFragment
}
towingSessionsAsTrailerVehicle {
...TowingSessionPagedFragment
}
currentTowingSessionAsTowingVehicle {
...TowingSessionFragment
}
currentTowingSessionAsTrailerVehicle {
...TowingSessionFragment
}
currentTrailerVehicle {
...VehicleFragment
}
currentTowingVehicle {
...VehicleFragment
}
driverSessions {
...DriverVehicleSessionPagedFragment
}
}
}
Variables
{
"id": 4,
"tags": ["abc123"],
"plate": "abc123",
"label": "xyz789",
"vin": "xyz789",
"ownerId": "4",
"modelId": 4,
"ktype": "abc123",
"make": "xyz789",
"model": "abc123",
"year": "xyz789",
"fuelType": "abc123",
"fuelTypeSecondary": "abc123",
"kba": "xyz789",
"archived": false
}
Response
{
"data": {
"vehicleUpdate": {
"id": "4",
"plate": "abc123",
"label": "abc123",
"vin": "xyz789",
"onboarded": false,
"modelId": 4,
"ktype": "abc123",
"hasDriver": true,
"make": "abc123",
"model": "abc123",
"year": "xyz789",
"fuelType": "abc123",
"fuelTypeSecondary": "xyz789",
"kba": "abc123",
"tags": ["abc123"],
"hybrid": true,
"vehicleType": "CAR",
"canTow": false,
"canBeTowed": false,
"immobilizerStatus": "UNKNOWN",
"immobilizerStatusUpdatedAt": "2007-12-03T10:15:30Z",
"doorsLockStatus": "UNKNOWN",
"doorsLockStatusUpdatedAt": "2007-12-03T10:15:30Z",
"garageModeStatus": "UNKNOWN",
"garageModeStatusUpdatedAt": "2007-12-03T10:15:30Z",
"archived": false,
"descriptions": DescriptionPaged,
"vinDescriptions": DecodeVinResult,
"owner": Account,
"currentDevice": Device,
"currentDriver": Driver,
"groups": GroupPaged,
"lastTrip": Trip,
"trips": TripPaged,
"maintenancesUpcoming": MaintenanceUpcomingPaged,
"maintenancesHistorical": MaintenanceHistoricalPaged,
"maintenanceTemplates": MaintenanceTemplatePaged,
"maintenanceSchedules": MaintenanceSchedulePaged,
"alerts": VehicleAlertPaged,
"alertsState": VehicleAlertsState,
"currentDevices": DevicePaged,
"towingSessionsAsTowingVehicle": TowingSessionPaged,
"towingSessionsAsTrailerVehicle": TowingSessionPaged,
"currentTowingSessionAsTowingVehicle": TowingSession,
"currentTowingSessionAsTrailerVehicle": TowingSession,
"currentTrailerVehicle": Vehicle,
"currentTowingVehicle": Vehicle,
"driverSessions": DriverVehicleSessionPaged
}
}
}
wifiCredentials
Description
Set wifi ssid/password
Response
Returns a RdcAsyncAck
Example
Query
mutation wifiCredentials(
$deviceId: ID!,
$ssid: String!,
$password: String
) {
wifiCredentials(
deviceId: $deviceId,
ssid: $ssid,
password: $password
) {
id
type
attributes
}
}
Variables
{
"deviceId": 4,
"ssid": "xyz789",
"password": "xyz789"
}
Response
{
"data": {
"wifiCredentials": {
"id": "4",
"type": "xyz789",
"attributes": Json
}
}
}
wifiToggle
Description
Start or stop the wifi
Response
Returns a RdcAsyncAck
Arguments
| Name | Description |
|---|---|
deviceId - ID!
|
Device id |
action - ToggleAction!
|
Start/Stop |
Example
Query
mutation wifiToggle(
$deviceId: ID!,
$action: ToggleAction!
) {
wifiToggle(
deviceId: $deviceId,
action: $action
) {
id
type
attributes
}
}
Variables
{"deviceId": "4", "action": "START"}
Response
{
"data": {
"wifiToggle": {
"id": "4",
"type": "abc123",
"attributes": Json
}
}
}
workdayCreate
Description
Create workday
Response
Returns a Workday
Example
Query
mutation workdayCreate(
$workshopId: ID!,
$day: Weekday,
$openingHour1: String,
$closingHour1: String,
$openingHour2: String,
$closingHour2: String
) {
workdayCreate(
workshopId: $workshopId,
day: $day,
openingHour1: $openingHour1,
closingHour1: $closingHour1,
openingHour2: $openingHour2,
closingHour2: $closingHour2
) {
id
day
openingHour1
closingHour1
openingHour2
closingHour2
workshop {
...WorkshopFragment
}
}
}
Variables
{
"workshopId": "4",
"day": "MONDAY",
"openingHour1": "abc123",
"closingHour1": "xyz789",
"openingHour2": "xyz789",
"closingHour2": "abc123"
}
Response
{
"data": {
"workdayCreate": {
"id": 4,
"day": "MONDAY",
"openingHour1": "xyz789",
"closingHour1": "xyz789",
"openingHour2": "abc123",
"closingHour2": "xyz789",
"workshop": Workshop
}
}
}
workdayDelete
Description
Delete workday
workdayUpdate
Description
Update workday
Response
Returns a Workday
Example
Query
mutation workdayUpdate(
$id: ID!,
$day: Weekday,
$openingHour1: String,
$closingHour1: String,
$openingHour2: String,
$closingHour2: String
) {
workdayUpdate(
id: $id,
day: $day,
openingHour1: $openingHour1,
closingHour1: $closingHour1,
openingHour2: $openingHour2,
closingHour2: $closingHour2
) {
id
day
openingHour1
closingHour1
openingHour2
closingHour2
workshop {
...WorkshopFragment
}
}
}
Variables
{
"id": "4",
"day": "MONDAY",
"openingHour1": "xyz789",
"closingHour1": "abc123",
"openingHour2": "xyz789",
"closingHour2": "abc123"
}
Response
{
"data": {
"workdayUpdate": {
"id": 4,
"day": "MONDAY",
"openingHour1": "xyz789",
"closingHour1": "abc123",
"openingHour2": "abc123",
"closingHour2": "abc123",
"workshop": Workshop
}
}
}
workshopCreate
Description
Create workshop
Response
Returns a Workshop
Arguments
| Name | Description |
|---|---|
name - String!
|
|
code - String!
|
|
lon - Float
|
|
lat - Float
|
|
address - String
|
|
postalCode - String
|
|
province - String
|
|
brand - String
|
|
city - String
|
|
country - String
|
|
phone - String
|
|
internationalPhone - String
|
|
fax - String
|
|
email - String
|
|
web - String
|
|
provider - String
|
|
providerWorkshopId - ID
|
|
language - Language
|
|
timeZone - String
|
|
icon - String
|
Example
Query
mutation workshopCreate(
$name: String!,
$code: String!,
$lon: Float,
$lat: Float,
$address: String,
$postalCode: String,
$province: String,
$brand: String,
$city: String,
$country: String,
$phone: String,
$internationalPhone: String,
$fax: String,
$email: String,
$web: String,
$provider: String,
$providerWorkshopId: ID,
$language: Language,
$timeZone: String,
$icon: String
) {
workshopCreate(
name: $name,
code: $code,
lon: $lon,
lat: $lat,
address: $address,
postalCode: $postalCode,
province: $province,
brand: $brand,
city: $city,
country: $country,
phone: $phone,
internationalPhone: $internationalPhone,
fax: $fax,
email: $email,
web: $web,
provider: $provider,
providerWorkshopId: $providerWorkshopId,
language: $language,
timeZone: $timeZone,
icon: $icon
) {
id
name
code
provider
providerWorkshopId
lat
lon
address
postalCode
province
brand
city
country
phone
internationalPhone
fax
email
web
language
timeZone
icon
averageStars
ratings {
...RatingPagedFragment
}
workdays {
...WorkdayPagedFragment
}
vehicleTypes {
...VehicleTypePagedFragment
}
vehicleServices {
...VehicleServicePagedFragment
}
driverServices {
...DriverServicePagedFragment
}
bookings {
...BookingPagedFragment
}
quotations {
...QuotationPagedFragment
}
managers {
...WorkshopManagerPagedFragment
}
}
}
Variables
{
"name": "xyz789",
"code": "xyz789",
"lon": 123.45,
"lat": 123.45,
"address": "abc123",
"postalCode": "xyz789",
"province": "xyz789",
"brand": "abc123",
"city": "abc123",
"country": "xyz789",
"phone": "xyz789",
"internationalPhone": "abc123",
"fax": "abc123",
"email": "xyz789",
"web": "abc123",
"provider": "abc123",
"providerWorkshopId": 4,
"language": Language,
"timeZone": "xyz789",
"icon": "abc123"
}
Response
{
"data": {
"workshopCreate": {
"id": "4",
"name": "xyz789",
"code": "xyz789",
"provider": "abc123",
"providerWorkshopId": 4,
"lat": 987.65,
"lon": 123.45,
"address": "xyz789",
"postalCode": "abc123",
"province": "xyz789",
"brand": "abc123",
"city": "xyz789",
"country": "abc123",
"phone": "abc123",
"internationalPhone": "xyz789",
"fax": "abc123",
"email": "xyz789",
"web": "xyz789",
"language": Language,
"timeZone": "xyz789",
"icon": "abc123",
"averageStars": 987.65,
"ratings": RatingPaged,
"workdays": WorkdayPaged,
"vehicleTypes": VehicleTypePaged,
"vehicleServices": VehicleServicePaged,
"driverServices": DriverServicePaged,
"bookings": BookingPaged,
"quotations": QuotationPaged,
"managers": WorkshopManagerPaged
}
}
}
workshopDelete
Description
Delete Workshop
workshopUpdate
Description
Update Workshop
Response
Returns a Workshop
Arguments
| Name | Description |
|---|---|
id - ID!
|
Workshop ID |
name - String
|
|
code - String
|
|
lon - Float
|
|
lat - Float
|
|
address - String
|
|
postalCode - String
|
|
province - String
|
|
city - String
|
|
country - String
|
|
phone - String
|
|
internationalPhone - String
|
|
fax - String
|
|
email - String
|
|
web - String
|
|
provider - String
|
|
providerWorkshopId - ID
|
|
language - Language
|
|
timeZone - String
|
|
brand - String
|
|
icon - String
|
Example
Query
mutation workshopUpdate(
$id: ID!,
$name: String,
$code: String,
$lon: Float,
$lat: Float,
$address: String,
$postalCode: String,
$province: String,
$city: String,
$country: String,
$phone: String,
$internationalPhone: String,
$fax: String,
$email: String,
$web: String,
$provider: String,
$providerWorkshopId: ID,
$language: Language,
$timeZone: String,
$brand: String,
$icon: String
) {
workshopUpdate(
id: $id,
name: $name,
code: $code,
lon: $lon,
lat: $lat,
address: $address,
postalCode: $postalCode,
province: $province,
city: $city,
country: $country,
phone: $phone,
internationalPhone: $internationalPhone,
fax: $fax,
email: $email,
web: $web,
provider: $provider,
providerWorkshopId: $providerWorkshopId,
language: $language,
timeZone: $timeZone,
brand: $brand,
icon: $icon
) {
id
name
code
provider
providerWorkshopId
lat
lon
address
postalCode
province
brand
city
country
phone
internationalPhone
fax
email
web
language
timeZone
icon
averageStars
ratings {
...RatingPagedFragment
}
workdays {
...WorkdayPagedFragment
}
vehicleTypes {
...VehicleTypePagedFragment
}
vehicleServices {
...VehicleServicePagedFragment
}
driverServices {
...DriverServicePagedFragment
}
bookings {
...BookingPagedFragment
}
quotations {
...QuotationPagedFragment
}
managers {
...WorkshopManagerPagedFragment
}
}
}
Variables
{
"id": 4,
"name": "xyz789",
"code": "abc123",
"lon": 123.45,
"lat": 123.45,
"address": "xyz789",
"postalCode": "xyz789",
"province": "abc123",
"city": "abc123",
"country": "abc123",
"phone": "abc123",
"internationalPhone": "xyz789",
"fax": "abc123",
"email": "abc123",
"web": "xyz789",
"provider": "xyz789",
"providerWorkshopId": "4",
"language": Language,
"timeZone": "abc123",
"brand": "xyz789",
"icon": "abc123"
}
Response
{
"data": {
"workshopUpdate": {
"id": 4,
"name": "xyz789",
"code": "xyz789",
"provider": "abc123",
"providerWorkshopId": "4",
"lat": 123.45,
"lon": 123.45,
"address": "xyz789",
"postalCode": "xyz789",
"province": "abc123",
"brand": "abc123",
"city": "xyz789",
"country": "abc123",
"phone": "abc123",
"internationalPhone": "abc123",
"fax": "abc123",
"email": "xyz789",
"web": "xyz789",
"language": Language,
"timeZone": "xyz789",
"icon": "abc123",
"averageStars": 123.45,
"ratings": RatingPaged,
"workdays": WorkdayPaged,
"vehicleTypes": VehicleTypePaged,
"vehicleServices": VehicleServicePaged,
"driverServices": DriverServicePaged,
"bookings": BookingPaged,
"quotations": QuotationPaged,
"managers": WorkshopManagerPaged
}
}
}
Subscriptions
deviceNotifications
Description
Receive the notification linked to a device
Response
Returns [DeviceNotification!]!
Arguments
| Name | Description |
|---|---|
deviceIds - [ID!]!
|
List of Device Id (IMEI) to listen to |
Example
Query
subscription deviceNotifications($deviceIds: [ID!]!) {
deviceNotifications(deviceIds: $deviceIds) {
device {
...DeviceFragment
}
}
}
Variables
{"deviceIds": [4]}
Response
{"data": {"deviceNotifications": [{"device": Device}]}}
vehicleNotifications
Description
Receive the notification linked to a vehicle
Response
Returns [VehicleNotification!]!
Arguments
| Name | Description |
|---|---|
vehicleIds - [ID!]!
|
List of Vehicle Id to listen to |
Example
Query
subscription vehicleNotifications($vehicleIds: [ID!]!) {
vehicleNotifications(vehicleIds: $vehicleIds) {
vehicle {
...VehicleFragment
}
}
}
Variables
{"vehicleIds": ["4"]}
Response
{"data": {"vehicleNotifications": [{"vehicle": Vehicle}]}}
Types
Account
Description
Munic Connect user account
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Account id |
organizationId - ID
|
Organization id |
email - String
|
|
phone - String
|
Phone number |
fullName - String
|
Full name |
shortName - String
|
Short name |
companyName - String
|
Company name |
countryCode - String
|
Country code |
language - Language
|
Interface language |
timeZone - String
|
Time zone |
createdAt - DateTime
|
Account creation date |
updatedAt - DateTime
|
Last account update date |
lastSignInAt - DateTime
|
Last account sign-in date |
confirmedAt - DateTime
|
Account confirmation date |
descriptions - DescriptionPaged
|
Descriptions |
Arguments
|
|
roles - [AccountRole]
|
Roles |
Arguments
|
|
groups - GroupPaged
|
Groups |
Arguments
|
|
devices - DevicePaged
|
Devices |
Arguments
|
|
vehicles - VehiclePaged
|
Vehicles |
Arguments
|
|
drivers - DriverPaged
|
Use driverProfiles |
driverProfiles - DriverPaged
|
Driver profiles |
driverContacts - DriverPaged
|
Driver contacts |
workshops - WorkshopPaged
|
Workshops |
distributors - OnboardingDistributorPaged
|
Onboarding distributors |
alertPreference - AlertPreference
|
Alert preference |
Example
{
"id": "4",
"organizationId": "4",
"email": "abc123",
"phone": "abc123",
"fullName": "xyz789",
"shortName": "xyz789",
"companyName": "xyz789",
"countryCode": "abc123",
"language": Language,
"timeZone": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"lastSignInAt": "2007-12-03T10:15:30Z",
"confirmedAt": "2007-12-03T10:15:30Z",
"descriptions": DescriptionPaged,
"roles": [AccountRole],
"groups": GroupPaged,
"devices": DevicePaged,
"vehicles": VehiclePaged,
"drivers": DriverPaged,
"driverProfiles": DriverPaged,
"driverContacts": DriverPaged,
"workshops": WorkshopPaged,
"distributors": OnboardingDistributorPaged,
"alertPreference": AlertPreference
}
AccountConfirmation
Example
{
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"forceResetAtConfirmation": false,
"forceResetPassword": true
}
AccountPaged
Description
Paginated account results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Account!]!
|
Example
{"next": 4, "count": 123, "list": [Account]}
AccountRole
AddressAttributes
Description
Address model.
Fields
| Field Name | Description |
|---|---|
latitude - Float
|
Latitude |
longitude - Float
|
Longitude |
countryCode - String
|
ISO 3166 code of country |
postalCode - String
|
Postal code |
country - String
|
Country |
county - String
|
County name |
city - String
|
City |
district - String
|
District name |
state - String
|
State name |
street - String
|
Street |
streetNumber - String
|
Street_number |
Example
{
"latitude": 123.45,
"longitude": 987.65,
"countryCode": "xyz789",
"postalCode": "xyz789",
"country": "abc123",
"county": "abc123",
"city": "xyz789",
"district": "abc123",
"state": "xyz789",
"street": "xyz789",
"streetNumber": "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
{
"id": "4",
"name": "xyz789",
"version": "xyz789",
"contentType": "xyz789",
"path": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
AlertAttachmentPaged
Description
Paginated alert_attachment results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [AlertAttachment!]!
|
Example
{"next": 4, "count": 987, "list": [AlertAttachment]}
AlertJob
Example
{
"id": "4",
"retriesCount": 123,
"channelName": "xyz789",
"status": "CREATED",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
AlertJobPaged
Description
Paginated alert_job results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [AlertJob!]!
|
Example
{"next": 4, "count": 123, "list": [AlertJob]}
AlertNotification
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
templateContext - Json
|
|
forceChannel - Boolean
|
|
sentAt - DateTime
|
|
failedAt - DateTime
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
|
status - AlertNotificationStatus
|
|
queue - AlertQueue
|
|
template - AlertTemplate
|
|
sender - Account
|
|
receiver - Account
|
|
jobs - AlertJobPaged
|
|
Example
{
"id": 4,
"templateContext": Json,
"forceChannel": true,
"sentAt": "2007-12-03T10:15:30Z",
"failedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "CREATED",
"queue": AlertQueue,
"template": AlertTemplate,
"sender": Account,
"receiver": Account,
"jobs": AlertJobPaged
}
AlertNotificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
AlertPreference
Description
User alert preferences
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
firebaseMessagingToken - String
|
|
stopNotifications - Boolean
|
|
preferredChannels - [AlertPreferredChannel]
|
Example
{
"id": 4,
"firebaseMessagingToken": "xyz789",
"stopNotifications": false,
"preferredChannels": ["IN_APP"]
}
AlertPreferredChannel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"IN_APP"
AlertQueue
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
version - String
|
|
createdAt - DateTime
|
|
metadata - Json
|
|
notificationDefinitionName - String
|
|
notificationDefinitionVersion - String
|
|
preferredChannels - [AlertPreferredChannel]
|
|
priority - Int
|
|
templateContext - Json
|
|
timeout - String
|
|
updatedAt - DateTime
|
Example
{
"id": 4,
"name": "xyz789",
"version": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"metadata": Json,
"notificationDefinitionName": "abc123",
"notificationDefinitionVersion": "xyz789",
"preferredChannels": ["IN_APP"],
"priority": 987,
"templateContext": Json,
"timeout": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
AlertTemplate
Example
{
"id": 4,
"name": "xyz789",
"version": "xyz789",
"contentType": "TEXT",
"defaultContext": Json,
"locked": true,
"channelName": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"definition": "abc123",
"attachments": AlertAttachmentPaged
}
AlertTemplateContent
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"TEXT"
AlertTemplatePaged
Description
Paginated alert_template results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [AlertTemplate!]!
|
Example
{"next": 4, "count": 987, "list": [AlertTemplate]}
AlertWarningLightLevel
Description
Warning light level
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized warning light level |
Example
"ADVISORY"
AlertWarningLightLevelArg
Description
Warning light level argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVISORY"
Alpr
Description
Munic Alpr model
Fields
| Field Name | Description |
|---|---|
vehicle - VehicleInfo
|
Vehicle info |
plate - Plate
|
Vehicle plates propositions |
Example
{
"vehicle": VehicleInfo,
"plate": Plate
}
AnyPercent
Description
Percentage, as a floating point number of any value
Example
AnyPercent
BatteryAnnotation
Description
Battery annotation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Annotation id |
startTime - DateTime
|
Start time |
endTime - DateTime
|
End time |
tags - [BatteryAnnotationTag]
|
Tags |
duration - Int
|
Duration (seconds) |
times - [DateTime]
|
All timestamp readings |
electricPotentials - [Float]
|
All electric potential readings (volt) |
temperatures - [Float]
|
All temperature readings (celsius) |
readings - BatteryReadingPaged
|
Filterable battery readings |
Example
{
"id": 4,
"startTime": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"tags": ["CRANK"],
"duration": 123,
"times": ["2007-12-03T10:15:30Z"],
"electricPotentials": [987.65],
"temperatures": [987.65],
"readings": BatteryReadingPaged
}
BatteryAnnotationPaged
Description
Paginated battery_annotation results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [BatteryAnnotation!]!
|
Example
{
"next": "4",
"count": 987,
"list": [BatteryAnnotation]
}
BatteryAnnotationTag
Description
battery annotation tag
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized battery annotation tag |
Example
"CRANK"
BatteryAnnotationTagArg
Description
battery annotation tag argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CRANK"
BatteryChargeLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
BatteryDischargeLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NO_INFORMATION"
BatteryReadingPaged
Example
{
"count": 987,
"next": "4",
"id": ["4"],
"timestamp": ["2007-12-03T10:15:30Z"],
"electricPotential": [987.65],
"temperature": [987.65]
}
Booking
Description
Workshop booking
Fields
| Field Name | Description |
|---|---|
id - ID
|
Booking ID |
plateNumber - String
|
Vehicle plate number |
bookingDate - DateTime
|
Booking date |
status - BookingStatus
|
Booking status |
quotationIds - [ID]
|
Booking quotations |
workshop - Workshop
|
Workshop |
vehicleMake - String
|
|
vehicleModel - String
|
|
vehicleYear - String
|
|
vin - String
|
|
city - String
|
|
country - String
|
|
additionalInformation - String
|
|
preferredLanguage - Language
|
|
contactMethod - WorkshopContactMethod
|
|
userEmail - String
|
|
userName - String
|
|
userPhoneNumber - String
|
Example
{
"id": "4",
"plateNumber": "abc123",
"bookingDate": "2007-12-03T10:15:30Z",
"status": "PENDING",
"quotationIds": [4],
"workshop": Workshop,
"vehicleMake": "xyz789",
"vehicleModel": "abc123",
"vehicleYear": "abc123",
"vin": "abc123",
"city": "abc123",
"country": "abc123",
"additionalInformation": "xyz789",
"preferredLanguage": Language,
"contactMethod": "SMS",
"userEmail": "abc123",
"userName": "abc123",
"userPhoneNumber": "abc123"
}
BookingPaged
Description
Paginated booking results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Booking!]!
|
Example
{
"next": "4",
"count": 987,
"list": [Booking]
}
BookingStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PENDING"
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
BooleanObj
Fields
| Field Name | Description |
|---|---|
value - Boolean!
|
Example
{"value": true}
BytesObj
Fields
| Field Name | Description |
|---|---|
value - String!
|
Base64-encoded |
Example
{"value": "abc123"}
CacheInfo
Fields
| Field Name | Description |
|---|---|
scope - CacheScope!
|
|
ttl - Int!
|
Time to live (seconds) |
extendTtl - Boolean!
|
Wether cache hits extend the time to live |
softFlush - String
|
Ignore cache entries before this date |
Example
{
"scope": "REQUEST",
"ttl": 987,
"extendTtl": true,
"softFlush": "xyz789"
}
CacheScope
Description
Delimits the context in which cached results are be available
Values
| Enum Value | Description |
|---|---|
|
|
Current GraphQL query (for volatile data) |
|
|
Current SSO login / JWT token (recommended) |
|
|
Current user (for unchanging data, shared with other clients) |
Example
"REQUEST"
Campaign
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
status - CampaignStatus!
|
|
createdAt - DateTime!
|
|
devicesStatus - [CampaignDevice!]
|
|
configurations - [ID!]
|
Example
{
"id": 4,
"name": "abc123",
"status": "AVAILABLE_UPDATE",
"createdAt": "2007-12-03T10:15:30Z",
"devicesStatus": [CampaignDevice],
"configurations": [4]
}
CampaignDevice
Fields
| Field Name | Description |
|---|---|
device - Device
|
|
status - CampaignStatus
|
Example
{"device": Device, "status": "AVAILABLE_UPDATE"}
CampaignPaged
Description
Paginated campaign results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Campaign!]!
|
Example
{
"next": "4",
"count": 123,
"list": [Campaign]
}
CampaignStatus
Description
campaign status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized campaign status |
Example
"AVAILABLE_UPDATE"
ClientIdentification
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
clientReference - ID
|
|
clientReferenceType - ClientReferenceType
|
|
numberOfOnboardings - Int
|
|
numberOfStartedOnboardings - Int
|
|
code - String
|
|
label - String
|
|
revoked - Boolean
|
|
distributor - OnboardingDistributor
|
|
createdBy - Account
|
|
defaultAccount - Account
|
|
defaultWhitelistedData - [OnboardingWhitelistedData!]
|
Example
{
"id": 4,
"clientReference": 4,
"clientReferenceType": "GROUP",
"numberOfOnboardings": 123,
"numberOfStartedOnboardings": 987,
"code": "abc123",
"label": "abc123",
"revoked": true,
"distributor": OnboardingDistributor,
"createdBy": Account,
"defaultAccount": Account,
"defaultWhitelistedData": ["POSITION"]
}
ClientIdentificationPaged
Description
Paginated client_identification results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [ClientIdentification!]!
|
Example
{"next": 4, "count": 987, "list": [ClientIdentification]}
ClientReferenceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"GROUP"
CloudEventStatus
Fields
| Field Name | Description |
|---|---|
node - String!
|
|
peers - [String!]!
|
Example
{
"node": "abc123",
"peers": ["xyz789"]
}
ConnectorType
Description
The selected connector type
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized or uncategorized energy type |
|
|
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 |
|
|
Small Paddle Inductive |
|
|
Tesla Connector |
Example
"OTHER"
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 |
|---|---|
id - ID!
|
Id |
make - String
|
Make |
model - String
|
Model |
yearStart - Int
|
Starting year |
yearEnd - Int
|
Ending year |
declarationDate - DateTime!
|
Declaration date |
comment - String
|
Reason for the blacklist Always null |
errorType - String
|
Always null |
resolution - String
|
Resolution info Always null |
resolutionDate - DateTime
|
Resolution date Always null |
rootCause - CoverageBlacklistRootCause
|
Always null |
level - CoverageBlacklistLevel
|
Always null |
status - CoverageBlacklistStatus
|
Always null |
Example
{
"id": 4,
"make": "abc123",
"model": "abc123",
"yearStart": 987,
"yearEnd": 987,
"declarationDate": "2007-12-03T10:15:30Z",
"comment": "xyz789",
"errorType": "abc123",
"resolution": "xyz789",
"resolutionDate": "2007-12-03T10:15:30Z",
"rootCause": "VEHICLE_CONCEPTION",
"level": "DONGLE_UNSUPPORTED",
"status": "DECLARED"
}
CoverageBlacklistLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unknown or unrecognized blacklist level |
Example
"DONGLE_UNSUPPORTED"
CoverageBlacklistPaged
Description
Paginated coverage_blacklist results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [CoverageBlacklist!]!
|
Example
{"next": 4, "count": 987, "list": [CoverageBlacklist]}
CoverageBlacklistRootCause
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unknown or unrecognized blacklist root cause |
Example
"VEHICLE_CONCEPTION"
CoverageBlacklistStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unknown or unrecognized blacklist status |
Example
"DECLARED"
CoverageEnergyTypeArg
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DIESEL"
CoverageMake
CoverageMakePaged
Description
Paginated coverage_make results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [CoverageMake!]!
|
Example
{
"next": "4",
"count": 987,
"list": [CoverageMake]
}
CoverageModel
CoverageModelPaged
Description
Paginated coverage_model results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [CoverageModel!]!
|
Example
{"next": 4, "count": 123, "list": [CoverageModel]}
CoverageParameter
Example
{
"id": "4",
"level": "abc123",
"needMux": true,
"needCable": false,
"cloudField": "xyz789",
"deviceField": "xyz789",
"providers": ["xyz789"]
}
CoverageParameterPaged
Description
Paginated coverage_parameter results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [CoverageParameter!]!
|
Example
{"next": 4, "count": 987, "list": [CoverageParameter]}
CoveragePowertrain
Description
coverage powertrain
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Unrecognized coverage powertrain |
Example
"ICE"
CoveragePowertrainArg
Description
coverage powertrain argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ICE"
CoverageRegion
Description
coverage region
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Unrecognized coverage region |
Example
"EUROPE"
CoverageRegionArg
Description
coverage region argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EUROPE"
CoverageVehicle
Description
Vehicle coverage info
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Id |
make - String!
|
Make |
model - String!
|
Model |
year - Int!
|
Year |
energyTypes - [EnergyType!]!
|
Energy types |
powertrain - CoveragePowertrain!
|
Power train type |
regions - [CoverageRegion!]!
|
World regions |
needMux - Boolean!
|
Aggregate of parameters.need_mux |
needCable - Boolean!
|
Aggregate of parameters.need_cable |
installationInstructions - [DongleInstallationInstruction!]!
|
|
blacklistLevel - CoverageBlacklistLevel!
|
Blacklist level |
blacklists - CoverageBlacklistPaged!
|
Blacklist details |
parameters - CoverageParameterPaged
|
Covered parameters |
parameterGroups - [String!]
|
|
Example
{
"id": "4",
"make": "xyz789",
"model": "xyz789",
"year": 987,
"energyTypes": ["OTHER"],
"powertrain": "ICE",
"regions": ["EUROPE"],
"needMux": true,
"needCable": false,
"installationInstructions": ["CABLE_RECOMMENDED"],
"blacklistLevel": "DONGLE_UNSUPPORTED",
"blacklists": CoverageBlacklistPaged,
"parameters": CoverageParameterPaged,
"parameterGroups": ["abc123"]
}
CoverageVehiclePaged
Description
Paginated coverage_vehicle results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [CoverageVehicle!]!
|
Example
{"next": 4, "count": 123, "list": [CoverageVehicle]}
DateTime
Description
ISO8601 date and time with timezone
Example
"2007-12-03T10:15:30Z"
DecodeVinResult
Description
Vehicle description
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Vehicle ID |
vin - String
|
Vehicle VIN |
kba - ID
|
Kraftfahrbundesamt (Germany and Austria) |
kType - String
|
Vehicle kType |
decodingRegion - String
|
Decoding region |
dayOfFirstCirculation - Int
|
Day of first circulation |
dayOfSale - Int
|
Day of first sale |
monthOfFirstCirculation - Int
|
Month of first circulation |
monthOfSale - Int
|
Month of first sale |
yearOfFirstCirculation - Int
|
Year of first circulation |
yearOfSale - Int
|
Year of first sale |
acceleration - Float
|
Acceleration 0-100km/h (s) |
advancedModel - String
|
Vehicle model |
bodyType - String
|
Body type |
bodyTypeCode - String
|
Body type code |
brakesAbs - String
|
Brakes abs |
brakesFrontType - String
|
Brakes front type |
brakesRearType - String
|
Brakes rear type |
brakesSystem - String
|
Brakes system |
cargoCapacity - Int
|
Cargo capacity (kg) |
co2Emission - Int
|
CO2 emission (g/km) |
coEmission - Float
|
CO emission (g/km) |
color - String
|
Color |
companyId - ID
|
Company id |
country - String
|
Manufacturing country |
critair - String
|
Crit'air rating |
curbWeight - Int
|
Curb weight (kg) |
doors - Int
|
Door count |
driveType - String
|
Drive type |
electricVehicleBatteryCapacity - Float
|
Electric vehicle battery capacity (kW/h) |
electricVehicleBatteryVoltage - Float
|
Electric vehicle battery voltage (v) |
emissionStandard - String
|
Emission standard |
engineAspiration - String
|
Engine aspiration |
engineBore - Float
|
Engine bore number (mm) |
engineCode - String
|
Engine code |
engineConfiguration - String
|
Engine configuration |
engineCylinderHeadType - String
|
Engine cylinder head type |
engineCylinders - Int
|
Engine cylinder count |
engineDisplacement - Int
|
Engine displacement (ccm) |
engineExtra - String
|
Engine extra |
engineFiscalPower - Int
|
Engine fiscal power |
engineFuelType - EnergyType
|
Engine fuel type |
engineFuelTypeSecondary - EnergyType
|
Engine fuel type secondary |
engineFuelTypeTertiary - EnergyType
|
Engine fuel type tertiary |
engineIgnitionSystem - String
|
Engine ignition system |
engineManufacturer - String
|
Engine manufacturer |
engineOutputPower - Int
|
Engine ouput power (kW) |
engineOutputPowerPs - Int
|
Engine output power (PS) |
engineRpmIdleMax - Int
|
Engine rpm idle max |
engineRpmIdleMin - Int
|
Engine rpm idle min |
engineRpmMax - Int
|
Engine rpm max |
engineStroke - Float
|
Engine stroke (mm) |
engineValves - Int
|
Engine valves |
engineVersion - String
|
Engine version |
engineWithTurbo - Boolean
|
Engine with turbo |
extraInfo - VinExtraInfo
|
Extra information |
frontOverhang - Int
|
Front overhang (mm) |
frontTrack - Int
|
Front track (mm) |
fuelEfficiencyCity - Float
|
Fuel efficiency city |
fuelEfficiencyCombined - Float
|
Fuel efficiency combined |
fuelEfficiencyHighway - Float
|
Fuel efficiency highway |
fuelInjectionControlType - String
|
Fuel injection control type |
fuelInjectionSubtype - String
|
Fuel injection subtype |
fuelInjectionSystemDesign - String
|
Fuel injection system design |
fuelInjectionType - String
|
Fuel injection type |
gearboxSpeed - Int
|
Gearbox speeds count |
gearboxType - String
|
Gearbox type |
grossWeight - Int
|
Gross wieght (kg) |
hcEmission - Float
|
HC emission (g/km) |
hcNoxEmission - Float
|
HC Nox emission (g/km) |
height - Int
|
Height (mm) |
hipRoomFront - Int
|
Hip room front (mm) |
hipRoomRear - Int
|
Hip room rear (mm) |
length - Int
|
Length (mm) |
manufacturer - String
|
Manufacturer |
make - String
|
Make |
maxRoofLoad - Int
|
Max roof load (kg) |
maxTowBarDownload - Int
|
Max tow bar download (kg) |
maxTrailerLoadBLicense - Int
|
Max trailer load B license (kg) |
maxTrailerLoadBraked12 - Int
|
Max trailer load braked at 12% (kg) |
maxTrailerLoadUnbraked - Int
|
Max trailer load unbraked (kg) |
model - String
|
Model |
modelCode - String
|
Model code |
modelVersionCode - String
|
Model version code |
noxEmission - Float
|
NOX emission (g/km) |
oilTemperatureEmission - Float
|
Oil temperature emission - C° |
options - [DescriptionOption]
|
Options |
plate - String
|
Plate |
price - Int
|
Price |
rearOverhang - Int
|
Rear overhang (mm) |
rearTrack - Int
|
Rear track (mm) |
seats - Int
|
Seats |
sliBatteryCapacity - Float
|
Sli battery capacity (Ah) |
springsFrontType - String
|
Springs front type |
springsRearType - String
|
Springs rear type |
steeringSystem - String
|
Steering system |
steeringType - String
|
Steering type |
tankVolume - Int
|
Tank volume (l) |
topSpeed - Int
|
Top speed (km/h) |
transmissionElectronicControl - String
|
Transmission electronic control |
transmissionManufacturerCode - String
|
Transmission manufacturer code |
transmissionType - String
|
Transmission type |
trunkVolume - Int
|
Trunk volume |
urlVehicleImage - String
|
URL of vehicle image |
vehicleType - String
|
Vehicle type |
verified - Boolean
|
Is vehicle verified |
wheelBase - Int
|
Wheel base (mm) |
wheelsDimension - String
|
Wheels dimension |
width - Int
|
Width (mm) |
Example
{
"id": 4,
"vin": "xyz789",
"kba": "4",
"kType": "abc123",
"decodingRegion": "abc123",
"dayOfFirstCirculation": 987,
"dayOfSale": 987,
"monthOfFirstCirculation": 123,
"monthOfSale": 987,
"yearOfFirstCirculation": 123,
"yearOfSale": 987,
"acceleration": 123.45,
"advancedModel": "abc123",
"bodyType": "abc123",
"bodyTypeCode": "abc123",
"brakesAbs": "xyz789",
"brakesFrontType": "abc123",
"brakesRearType": "xyz789",
"brakesSystem": "abc123",
"cargoCapacity": 987,
"co2Emission": 123,
"coEmission": 987.65,
"color": "abc123",
"companyId": "4",
"country": "xyz789",
"critair": "xyz789",
"curbWeight": 987,
"doors": 123,
"driveType": "xyz789",
"electricVehicleBatteryCapacity": 123.45,
"electricVehicleBatteryVoltage": 987.65,
"emissionStandard": "abc123",
"engineAspiration": "xyz789",
"engineBore": 123.45,
"engineCode": "abc123",
"engineConfiguration": "xyz789",
"engineCylinderHeadType": "abc123",
"engineCylinders": 987,
"engineDisplacement": 987,
"engineExtra": "xyz789",
"engineFiscalPower": 987,
"engineFuelType": "OTHER",
"engineFuelTypeSecondary": "OTHER",
"engineFuelTypeTertiary": "OTHER",
"engineIgnitionSystem": "abc123",
"engineManufacturer": "abc123",
"engineOutputPower": 987,
"engineOutputPowerPs": 123,
"engineRpmIdleMax": 123,
"engineRpmIdleMin": 123,
"engineRpmMax": 987,
"engineStroke": 987.65,
"engineValves": 123,
"engineVersion": "abc123",
"engineWithTurbo": true,
"extraInfo": VinExtraInfo,
"frontOverhang": 987,
"frontTrack": 987,
"fuelEfficiencyCity": 123.45,
"fuelEfficiencyCombined": 987.65,
"fuelEfficiencyHighway": 987.65,
"fuelInjectionControlType": "xyz789",
"fuelInjectionSubtype": "xyz789",
"fuelInjectionSystemDesign": "abc123",
"fuelInjectionType": "abc123",
"gearboxSpeed": 123,
"gearboxType": "xyz789",
"grossWeight": 123,
"hcEmission": 123.45,
"hcNoxEmission": 123.45,
"height": 987,
"hipRoomFront": 987,
"hipRoomRear": 987,
"length": 987,
"manufacturer": "xyz789",
"make": "xyz789",
"maxRoofLoad": 123,
"maxTowBarDownload": 123,
"maxTrailerLoadBLicense": 123,
"maxTrailerLoadBraked12": 123,
"maxTrailerLoadUnbraked": 987,
"model": "xyz789",
"modelCode": "xyz789",
"modelVersionCode": "abc123",
"noxEmission": 123.45,
"oilTemperatureEmission": 987.65,
"options": [DescriptionOption],
"plate": "xyz789",
"price": 987,
"rearOverhang": 123,
"rearTrack": 123,
"seats": 987,
"sliBatteryCapacity": 123.45,
"springsFrontType": "xyz789",
"springsRearType": "xyz789",
"steeringSystem": "abc123",
"steeringType": "abc123",
"tankVolume": 987,
"topSpeed": 123,
"transmissionElectronicControl": "xyz789",
"transmissionManufacturerCode": "abc123",
"transmissionType": "xyz789",
"trunkVolume": 123,
"urlVehicleImage": "abc123",
"vehicleType": "xyz789",
"verified": false,
"wheelBase": 987,
"wheelsDimension": "abc123",
"width": 987
}
Description
Description
Description base interface. Every description_* inheritor possess a hidden type field with a different type
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier |
label - String!
|
Label |
value - String
|
Value |
source - String!
|
Source |
createdAt - DateTime
|
Creation datetime |
updatedAt - DateTime
|
Update datetime |
Possible Types
| Description Types |
|---|
Example
{
"id": "4",
"label": "xyz789",
"value": "xyz789",
"source": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
DescriptionCreate
Fields
| Input Field | Description |
|---|---|
type - DescriptionType!
|
|
label - String!
|
|
value - String
|
|
file - Upload
|
Example
{
"type": "STRING",
"label": "xyz789",
"value": "abc123",
"file": Upload
}
DescriptionFile
Description
File Description
Example
{
"id": "4",
"label": "xyz789",
"value": "abc123",
"source": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
DescriptionImage
Description
Image Description
Example
{
"id": "4",
"label": "abc123",
"value": "abc123",
"source": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"preview": "xyz789"
}
DescriptionInteger
Description
Integer Description
Example
{
"id": "4",
"label": "xyz789",
"value": "xyz789",
"source": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
DescriptionOption
DescriptionPaged
Description
Paginated description results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Description!]!
|
Example
{"next": 4, "count": 987, "list": [Description]}
DescriptionSort
Description
description sorting
Fields
| Input Field | Description |
|---|---|
by - DescriptionSortKey!
|
|
order - SortOrder!
|
Example
{"by": "CREATED_AT", "order": "ASCENDING"}
DescriptionSortKey
Description
description sorting key
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
DescriptionString
Description
String Description
Example
{
"id": 4,
"label": "abc123",
"value": "xyz789",
"source": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
DescriptionSubject
Description
Object being described
Fields
| Input Field | Description |
|---|---|
type - DescriptionSubjectType!
|
|
id - ID!
|
Example
{"type": "DRIVERS", "id": 4}
DescriptionSubjectType
Description
Description subject type Enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DRIVERS"
DescriptionType
Description
Description type Enum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"STRING"
DescriptionUpdate
Device
Description
Device Object
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier |
activeAccount - String
|
Active Account |
deviceType - String
|
Device Type |
serialNumber - String
|
Serial Number |
onboarded - Boolean
|
Onboarded |
createdAt - DateTime
|
Always null |
updatedAt - DateTime
|
Always null |
owner - Account
|
Owner |
firstConnectionAt - DateTime
|
First connection date |
lastConnectionAt - DateTime
|
Last connection date |
lastConnectionReason - DeviceConnectionReason
|
Last connection reason |
lastDisconnectionAt - DateTime
|
Last disconnection date |
lastDisconnectionReason - DeviceDisconnectionReason
|
Last disconnection reason |
lastActivityAt - DateTime
|
Last network activity date |
status - DeviceStatus
|
Use *connection_at |
history - DeviceHistoryPaged
|
Device history |
aggregatedData - AggregatedData
|
Fields aggregated from multiple sources |
Arguments
|
|
lastTrip - Trip
|
Last trip |
Arguments
|
|
trips - TripPaged
|
Trips |
Arguments
|
|
tripSummary - TripSummary
|
Aggregated trip statistics |
harshes - TripHarshPaged
|
Harsh events |
overspeeds - TripOverspeedPaged
|
Overspeed events |
currentVehicle - Vehicle
|
Current Vehicle |
vehicles - VehiclePaged
|
Vehicles |
fields - FieldPaged
|
Last value of device fields |
readings - ReadingPaged
|
|
Arguments
|
|
readingsAnon - ReadingAnonPaged
|
|
Arguments
|
|
lastPosition - Coordinates
|
Last received vehicle position |
vehicleSessions - DeviceVehicleSessionPaged
|
Vehicle Sessions |
groups - GroupPaged
|
Groups |
alerts - VehicleAlertPaged
|
|
Arguments
|
|
alertsState - VehicleAlertsState
|
|
batteryAnnotations - BatteryAnnotationPaged
|
|
remoteDiags - RemoteDiagPaged!
|
|
logFetches - LogfetchPaged
|
|
Arguments
|
|
profilePrivacies - ProfilePrivacyPaged
|
|
profilePrivacy - ProfilePrivacy
|
|
profileModes - ProfileDeviceModePaged
|
|
profileMode - ProfileDeviceMode
|
|
product - Product
|
|
Example
{
"id": "4",
"activeAccount": "abc123",
"deviceType": "abc123",
"serialNumber": "xyz789",
"onboarded": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"owner": Account,
"firstConnectionAt": "2007-12-03T10:15:30Z",
"lastConnectionAt": "2007-12-03T10:15:30Z",
"lastConnectionReason": "COLD_BOOT",
"lastDisconnectionAt": "2007-12-03T10:15:30Z",
"lastDisconnectionReason": "UNKNOWN_SERVER_REASON",
"lastActivityAt": "2007-12-03T10:15:30Z",
"status": "CONNECTED",
"history": DeviceHistoryPaged,
"aggregatedData": AggregatedData,
"lastTrip": Trip,
"trips": TripPaged,
"tripSummary": TripSummary,
"harshes": TripHarshPaged,
"overspeeds": TripOverspeedPaged,
"currentVehicle": Vehicle,
"vehicles": VehiclePaged,
"fields": FieldPaged,
"readings": ReadingPaged,
"readingsAnon": ReadingAnonPaged,
"lastPosition": Coordinates,
"vehicleSessions": DeviceVehicleSessionPaged,
"groups": GroupPaged,
"alerts": VehicleAlertPaged,
"alertsState": VehicleAlertsState,
"batteryAnnotations": BatteryAnnotationPaged,
"remoteDiags": RemoteDiagPaged,
"logFetches": LogfetchPaged,
"profilePrivacies": ProfilePrivacyPaged,
"profilePrivacy": ProfilePrivacy,
"profileModes": ProfileDeviceModePaged,
"profileMode": ProfileDeviceMode,
"product": Product
}
DeviceConnectionReason
Description
Device connection reason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COLD_BOOT"
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
"UNKNOWN_SERVER_REASON"
DeviceHistory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
action - DeviceHistoryAction
|
|
labelNew - String
|
|
labelPrevious - String
|
Example
{
"id": "4",
"action": "LINK",
"labelNew": "abc123",
"labelPrevious": "abc123"
}
DeviceHistoryAction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LINK"
DeviceHistoryPaged
Description
Paginated device_history results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [DeviceHistory!]!
|
Example
{"next": 4, "count": 123, "list": [DeviceHistory]}
DeviceInput
Description
Device Input
Example
{
"id": 4,
"activeAccount": "abc123",
"deviceType": "abc123",
"serialNumber": "abc123",
"ownerId": "4"
}
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 |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Device!]!
|
Example
{
"next": "4",
"count": 123,
"list": [Device]
}
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 |
|---|---|
id - ID!
|
Identifier |
kmAtInstallation - Int!
|
KM At Installation |
connectionType - DeviceConnectionType
|
Device connection type |
installationDate - DateTime!
|
Installation Date |
removalDate - DateTime
|
Removal Date |
active - Boolean
|
Active |
vehicle - Vehicle
|
Vehicle |
device - Device
|
Device |
owner - Account
|
Owner |
Example
{
"id": 4,
"kmAtInstallation": 987,
"connectionType": "CABLE",
"installationDate": "2007-12-03T10:15:30Z",
"removalDate": "2007-12-03T10:15:30Z",
"active": false,
"vehicle": Vehicle,
"device": Device,
"owner": Account
}
DeviceVehicleSessionPaged
Description
Paginated device_vehicle_session results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [DeviceVehicleSession!]!
|
Example
{"next": 4, "count": 123, "list": [DeviceVehicleSession]}
DongleInstallationInstruction
Description
Dongle physical installation instruction
Values
| Enum Value | Description |
|---|---|
|
|
Cable makes installation easier |
|
|
Cable is needed |
|
|
Cannot close cover after installation |
|
|
Installation requires specific knowledge |
|
|
Unrecognized dongle physical installation instruction |
Example
"CABLE_RECOMMENDED"
DoorAction
Description
Lock or unlock the door
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LOCK"
DoorsLockStatus
Values
| Enum Value | Description |
|---|---|
|
|
The doors lock state is not reported, not supported or cannot be determined. |
|
|
The vehicle doors are locked. |
|
|
The vehicle doors are unlocked. |
Example
"UNKNOWN"
Driver
Description
Driver information
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier |
label - String!
|
Label |
idKey - String
|
ID Key |
createdAt - DateTime
|
Created At Always null |
updatedAt - DateTime
|
Updated At Always null |
userProfile - Account
|
Driver User Profile |
userContact - Account
|
Driver User Contact |
currentVehicle - Vehicle
|
Current Vehicle |
defaultVehicle - Vehicle
|
Default Vehicle |
active - Boolean
|
Active |
vehicles - VehiclePaged
|
Vehicles |
currentVehicles - VehiclePaged
|
Current Vehicles |
groups - GroupPaged
|
Groups |
lastTrip - Trip
|
Last trip |
Arguments
|
|
trips - TripPaged
|
Trips |
vehicleSessions - DriverVehicleSessionPaged
|
Vehicle Sessions |
descriptions - DescriptionPaged
|
Descriptions |
Arguments
|
|
Example
{
"id": "4",
"label": "abc123",
"idKey": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"userProfile": Account,
"userContact": Account,
"currentVehicle": Vehicle,
"defaultVehicle": Vehicle,
"active": false,
"vehicles": VehiclePaged,
"currentVehicles": VehiclePaged,
"groups": GroupPaged,
"lastTrip": Trip,
"trips": TripPaged,
"vehicleSessions": DriverVehicleSessionPaged,
"descriptions": DescriptionPaged
}
DriverPaged
Description
Paginated driver results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Driver!]!
|
Example
{"next": 4, "count": 987, "list": [Driver]}
DriverService
Description
Workshop driver service
Example
{
"id": 4,
"label": "xyz789",
"description": "abc123",
"workshops": WorkshopPaged
}
DriverServicePaged
Description
Paginated driver_service results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [DriverService!]!
|
Example
{
"next": "4",
"count": 123,
"list": [DriverService]
}
DriverVehicleSession
Description
DriverVehicleSession Object
Example
{
"id": "4",
"startAt": "2007-12-03T10:15:30Z",
"endAt": "2007-12-03T10:15:30Z",
"active": false,
"vehicle": Vehicle,
"driver": Driver,
"owner": Account
}
DriverVehicleSessionPaged
Description
Paginated driver_vehicle_session results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [DriverVehicleSession!]!
|
Example
{
"next": "4",
"count": 987,
"list": [DriverVehicleSession]
}
Dtc
Description
DTC code informations
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Dtc decoded information ID |
code - String
|
Dtc code |
description - String
|
Dtc code general context and description / category of the affected function and system |
subdescription - String
|
Dtc code additional description / sub category of the affected system/function |
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 |
cause - String
|
Cause related to the dtc code. |
effect - String
|
Effect may be caused by the dtc code. |
recommendation - String
|
Code recemmendation |
warning - String
|
In case of working with the affected component which can be dangerous, certain warnings are shown, if applicable |
classification - String
|
Dtc code classification |
mdiDtc - String
|
MDI Dtc translation |
protocol - String
|
Dtc code protocol |
warningImg - String
|
Warning image URL, if applicable |
systemCategory - String
|
System category of the DTC, if applicable |
riskSafety - 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 |
riskDamage - 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 |
riskAvailability - DtcRisk
|
Assesses the potential impact of the fault on the vehicle's ability to operate reliably, if applicable; Supported values: critical, major, minor, no |
riskEmissions - DtcRisk
|
Assesses the potential impact of the fault on the vehicle's emission levels and compliance, if applicable; Supported values: critical, major, minor, no |
Example
{
"id": "4",
"code": "abc123",
"description": "abc123",
"subdescription": "xyz789",
"information": "abc123",
"cause": "abc123",
"effect": "xyz789",
"recommendation": "abc123",
"warning": "abc123",
"classification": "xyz789",
"mdiDtc": "abc123",
"protocol": "abc123",
"warningImg": "xyz789",
"systemCategory": "xyz789",
"riskSafety": "NO",
"riskDamage": "NO",
"riskAvailability": "NO",
"riskEmissions": "NO"
}
DtcClassification
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVISORY"
DtcFreezeFrameParam
DtcFreezeFrames
Fields
| Field Name | Description |
|---|---|
description - String
|
|
params - [DtcFreezeFrameParam]
|
Example
{
"description": "abc123",
"params": [DtcFreezeFrameParam]
}
DtcMode
Values
| Enum Value | Description |
|---|---|
|
|
Unkown |
|
|
Active |
|
|
Intermittent |
|
|
Historical (aka permanent) |
|
|
Absent (polled, and disappeared afterwards) |
Example
"UNKNOWN"
DtcProtocol
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"OBD2"
DtcRegion
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EU"
DtcRisk
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NO"
DtcSource
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ABS"
EnergyType
Values
| Enum Value | Description |
|---|---|
|
|
Unrecognized or uncategorized energy type |
|
|
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 |
|
|
Premium octane rating |
|
|
Regular octane rating |
|
|
Unleaded petrol |
|
|
Unleaded with ethanol |
|
|
Shell V-Power |
Example
"OTHER"
EventPokeArg
Description
Poke event arg
Example
{
"id": "4",
"sender": "abc123",
"namespace": "abc123",
"deviceId": "4",
"payload": "abc123"
}
EventPositionArg
Fields
| Input Field | Description |
|---|---|
deviceId - ID!
|
|
pos - [CoordinatesInput!]!
|
Example
{"deviceId": 4, "pos": [CoordinatesInput]}
EventPresenceArg
Fields
| Input Field | Description |
|---|---|
deviceId - ID!
|
|
status - DevicePresence!
|
|
connectionReason - DeviceConnectionReason
|
|
disconnectionReason - DeviceDisconnectionReason
|
Example
{
"deviceId": "4",
"status": "CONNECTED",
"connectionReason": "COLD_BOOT",
"disconnectionReason": "UNKNOWN_SERVER_REASON"
}
EventRemotediagArg
EventTrackArg
Description
Track event arg
Fields
| Input Field | Description |
|---|---|
deviceId - ID!
|
Device that sent the track |
fields - [FieldNotify!]!
|
fields |
Example
{
"deviceId": "4",
"fields": [FieldNotify]
}
Field
Description
Field base interface. Every field_* inheritor possess a value field with a different type
Fields
| Field Name | Description |
|---|---|
name - String
|
Field name |
coordinates - Coordinates
|
Field {lat,long,alt}itude and time coordinates |
Possible Types
| Field Types |
|---|
Example
{
"name": "xyz789",
"coordinates": Coordinates
}
FieldBoolean
Description
Boolean field
Fields
| Field Name | Description |
|---|---|
name - String
|
Field name |
coordinates - Coordinates
|
Field {lat,long,alt}itude and time coordinates |
value - Boolean
|
Field value |
Example
{
"name": "xyz789",
"coordinates": Coordinates,
"value": true
}
FieldFloat
Description
Float field
Fields
| Field Name | Description |
|---|---|
name - String
|
Field name |
coordinates - Coordinates
|
Field {lat,long,alt}itude and time coordinates |
value - Float
|
Field value |
Example
{
"name": "abc123",
"coordinates": Coordinates,
"value": 123.45
}
FieldInteger
Description
Integer field
Fields
| Field Name | Description |
|---|---|
name - String
|
Field name |
coordinates - Coordinates
|
Field {lat,long,alt}itude and time coordinates |
value - Int
|
Field value |
Example
{
"name": "abc123",
"coordinates": Coordinates,
"value": 987
}
FieldNotify
Description
Field mutation input
Example
{
"name": "abc123",
"coordinates": CoordinatesInput,
"ivalue": 123,
"fvalue": 123.45,
"bvalue": false,
"svalue": "xyz789"
}
FieldPaged
FieldString
Description
String field
Fields
| Field Name | Description |
|---|---|
name - String
|
Field name |
coordinates - Coordinates
|
Field {lat,long,alt}itude and time coordinates |
value - String
|
Field value |
Example
{
"name": "abc123",
"coordinates": Coordinates,
"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": 123.45}
FloatTensor
FunctionNameType
Description
Function name enum
Values
| Enum Value | Description |
|---|---|
|
|
Download and enable a new profile |
|
|
Download a new profile |
|
|
Enable a profile |
|
|
Delete a profile |
|
|
List all profiles |
|
|
Get eUICC information |
|
|
Set the nickname of a profile |
Example
"DOWNLOAD_AND_ENABLE_PROFILE"
GarageModeStatus
Values
| Enum Value | Description |
|---|---|
|
|
The garage mode state is not reported, not supported or cannot be determined. |
|
|
The garage mode is active. |
|
|
The garage mode is inactive. |
Example
"UNKNOWN"
Geodecode
Description
Reverse Geocoding
Fields
| Field Name | Description |
|---|---|
extent - GeodecodeExtent
|
Bounding box extent of all elements in WGS84 format |
elements - GeodecodeElements
|
Example
{
"extent": GeodecodeExtent,
"elements": GeodecodeElements
}
GeodecodeClassId
GeodecodeCoordinate
Example
{
"x": 123.45,
"y": 123.45,
"distanceFromRequest": 123.45,
"lengthUnity": "abc123"
}
GeodecodeElement
Fields
| Field Name | Description |
|---|---|
coordinate - GeodecodeCoordinate
|
Matched coordinate. |
postalAddress - GeodecodePostalAddress
|
|
angle - Float
|
Angle of matched road segment. Value is a double in degrees. |
speedLimit - Float
|
Administrative speed limit in km/h. |
relevanceScore - Float
|
Scoring of last (deepest) item found. Range value is a double between 0 to 1. the best matching is 1. |
types - [GeodecodeTypes]
|
List of type. |
Example
{
"coordinate": GeodecodeCoordinate,
"postalAddress": GeodecodePostalAddress,
"angle": 987.65,
"speedLimit": 987.65,
"relevanceScore": 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
{"minX": 987.65, "minY": 123.45, "maxX": 987.65, "maxY": 123.45}
GeodecodePostalAddress
Fields
| Field Name | Description |
|---|---|
countryCode - String
|
ISO code of country. |
country - String
|
name of country. |
state - String
|
Name of state. |
county - String
|
Nam of county. |
city - String
|
Name of city. |
district - String
|
Name of district. |
postalCode - String
|
The postal code (Zip code). |
street - String
|
Name of street. |
streetNumber - String
|
Name of street. |
oppositeStreetNumber - String
|
The opposite street number. |
classId - GeodecodeClassId
|
Example
{
"countryCode": "abc123",
"country": "xyz789",
"state": "abc123",
"county": "abc123",
"city": "abc123",
"district": "xyz789",
"postalCode": "xyz789",
"street": "abc123",
"streetNumber": "abc123",
"oppositeStreetNumber": "xyz789",
"classId": GeodecodeClassId
}
GeodecodeTypes
Fields
| Field Name | Description |
|---|---|
type - String
|
Administrative level of network. |
Example
{"type": "abc123"}
GeofencingEvent
Description
geofencing event
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized geofencing event |
Example
"ENTRY"
GeofencingState
Description
geofencing state
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized geofencing state |
Example
"UNKNOWN"
Group
Description
Group information
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier |
label - String!
|
Label |
tags - [String!]
|
Tags |
hierarchyLevel - GroupHierarchyLevel!
|
Hierarchy level |
owner - Account
|
Owner |
descriptions - DescriptionPaged
|
Descriptions |
Arguments
|
|
devices - DevicePaged
|
Devices |
Arguments
|
|
vehicles - VehiclePaged
|
Vehicles |
Arguments
|
|
alerts - VehicleAlertPaged
|
|
Arguments
|
|
drivers - DriverPaged
|
Drivers |
Arguments
|
|
parents - GroupPaged
|
Parents |
Arguments
|
|
children - GroupPaged
|
Children |
Arguments
|
|
users - AccountPaged
|
Users |
Example
{
"id": "4",
"label": "xyz789",
"tags": ["xyz789"],
"hierarchyLevel": "UNASSIGNED",
"owner": Account,
"descriptions": DescriptionPaged,
"devices": DevicePaged,
"vehicles": VehiclePaged,
"alerts": VehicleAlertPaged,
"drivers": DriverPaged,
"parents": GroupPaged,
"children": GroupPaged,
"users": AccountPaged
}
GroupHierarchyLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNASSIGNED"
GroupMember
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DEVICE"
GroupPaged
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
{
"id": 4,
"time": "2007-12-03T10:15:30Z",
"lat": 987.65,
"lng": 123.45,
"alt": 123,
"speed": 987,
"maxSpeed": 123
}
IdcoordinatesPaged
Description
Paginated idcoordinates results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Idcoordinates!]!
|
Example
{
"next": "4",
"count": 123,
"list": [Idcoordinates]
}
ImmobilizerStatus
Values
| Enum Value | Description |
|---|---|
|
|
The immobilizer state is not reported, not supported or cannot be determined. |
|
|
The immobilizer is active, preventing the vehicle from being started or moved. |
|
|
The immobilizer is inactive, allowing the vehicle to start and operate normally. |
Example
"UNKNOWN"
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
123
IntegerObj
Fields
| Field Name | Description |
|---|---|
value - Int!
|
Example
{"value": 987}
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 |
|---|---|
|
|
English |
|
|
Español - Spanish |
|
|
Français - French |
|
|
Deutch - German |
|
|
Italiano - Italian |
|
|
Unrecognized language |
Example
"EN"
LangArg
Description
Limited list of ISO 639-1 language codes argument
Values
| Enum Value | Description |
|---|---|
|
|
English |
|
|
Español - Spanish |
|
|
Français - French |
|
|
Deutch - German |
|
|
Italiano - Italian |
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
{
"id": 4,
"status": "ABORTED",
"reason": "abc123",
"account": "abc123",
"actionName": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
LogfetchAction
LogfetchActionPaged
Description
Paginated logfetch_action results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [LogfetchAction!]!
|
Example
{"next": 4, "count": 987, "list": [LogfetchAction]}
LogfetchPaged
Description
Paginated logfetch results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Logfetch!]!
|
Example
{
"next": "4",
"count": 123,
"list": [Logfetch]
}
LogfetchStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ABORTED"
Lpa
Description
Munic LPA model
Fields
| Field Name | Description |
|---|---|
id - ID
|
Request id |
imei - ID
|
Device imei |
functionName - String
|
Function name |
status - String
|
The request status, it can have the following values: CREATED/STARTED/TIMEOUT/SUCCEEDED |
parameters - Parameters
|
Associated parameters |
Example
{
"id": 4,
"imei": "4",
"functionName": "abc123",
"status": "abc123",
"parameters": Parameters
}
MaintenanceCriticality
Description
maintenance criticality
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized maintenance criticality |
Example
"LOW"
MaintenanceCriticalityArg
Description
maintenance criticality argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"LOW"
MaintenanceCriticalityThreshold
Example
{
"id": 4,
"remainingDistance": 123,
"remainingDuration": 123,
"criticality": 987,
"description": "abc123"
}
MaintenanceCriticalityThresholdPaged
Description
Paginated maintenance_criticality_threshold results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [MaintenanceCriticalityThreshold!]!
|
Example
{
"next": "4",
"count": 987,
"list": [MaintenanceCriticalityThreshold]
}
MaintenanceHistorical
Description
Historical vehicle maintenance
When an upcoming maintenance is "done'.
Fields
| Field Name | Description |
|---|---|
id - ID
|
Historical maintenance ID |
vehicle - Vehicle
|
Vehicle |
template - MaintenanceTemplate
|
Maintenance template |
mileage - Int
|
Mileage (km) |
date - DateTime
|
Maintenance date |
Example
{
"id": 4,
"vehicle": Vehicle,
"template": MaintenanceTemplate,
"mileage": 987,
"date": "2007-12-03T10:15:30Z"
}
MaintenanceHistoricalPaged
Description
Paginated maintenance_historical results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [MaintenanceHistorical!]!
|
Example
{"next": 4, "count": 123, "list": [MaintenanceHistorical]}
MaintenanceSchedule
Description
Maintenance schedule
Combined with maintenante templates to generate upcoming maintenances
Fields
| Field Name | Description |
|---|---|
id - ID
|
Schedule Id |
template - MaintenanceTemplate
|
Maintenance template |
rule - MaintenanceScheduleRule
|
Schedule rule |
modelId - Int
|
Vehicle model ID |
distance - Int
|
Distance until next maintenance (km) |
duration - Int
|
Time until next maintenance (seconds) |
Example
{
"id": "4",
"template": MaintenanceTemplate,
"rule": MaintenanceScheduleRule,
"modelId": 987,
"distance": 987,
"duration": 987
}
MaintenanceSchedulePaged
Description
Paginated maintenance_schedule results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [MaintenanceSchedule!]!
|
Example
{"next": 4, "count": 123, "list": [MaintenanceSchedule]}
MaintenanceScheduleRule
Fields
| Field Name | Description |
|---|---|
type - MaintenanceScheduleRuleType
|
|
mileage - Int
|
Trigger after distance travelled (km) |
month - Int
|
Trigger after time elapsed (months) |
Example
{"type": "AT", "mileage": 987, "month": 987}
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 |
system - MaintenanceSystem!
|
Maintenance system |
fromExternalService - Boolean
|
Example
{
"id": 4,
"description": "abc123",
"system": MaintenanceSystem,
"fromExternalService": false
}
MaintenanceTemplatePaged
Description
Paginated maintenance_template results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [MaintenanceTemplate!]!
|
Example
{"next": 4, "count": 123, "list": [MaintenanceTemplate]}
MaintenanceUpcoming
Description
Upcoming vehicle maintenance
Fields
| Field Name | Description |
|---|---|
id - ID
|
Maintenance ID |
template - MaintenanceTemplate
|
Maintenance template |
vehicle - Vehicle
|
Vehicle |
criticality - MaintenanceCriticalityThreshold
|
Maintenance criticality |
mileageDeadline - Int
|
Maintenance deadline mileage (km) |
remainingDistanceToDrive - Int
|
Maintenance remaining distance (km) |
dateDeadline - DateTime
|
Maintenance deadline date |
remainingDaysToDrive - Int
|
Maintenance remaining days |
Example
{
"id": "4",
"template": MaintenanceTemplate,
"vehicle": Vehicle,
"criticality": MaintenanceCriticalityThreshold,
"mileageDeadline": 987,
"remainingDistanceToDrive": 123,
"dateDeadline": "2007-12-03T10:15:30Z",
"remainingDaysToDrive": 123
}
MaintenanceUpcomingPaged
Description
Paginated maintenance_upcoming results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [MaintenanceUpcoming!]!
|
Example
{
"next": "4",
"count": 987,
"list": [MaintenanceUpcoming]
}
MemberOperation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ADD"
Metric
Example
{
"id": 4,
"name": "abc123",
"type": "INTEGER",
"description": "xyz789",
"tensorShape": [123],
"unitName": "xyz789",
"unitNotation": "abc123"
}
MetricPaged
Description
Paginated metric results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Metric!]!
|
Example
{
"next": "4",
"count": 123,
"list": [Metric]
}
MetricType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"INTEGER"
OnboardingAction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdAt - DateTime!
|
|
action - OnboardingActionAction!
|
|
triggeredBy - Account
|
Example
{
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"action": "CANCEL",
"triggeredBy": Account
}
OnboardingActionAction
Description
Action type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized action type |
Example
"CANCEL"
OnboardingActionPaged
Description
Paginated onboarding_action results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [OnboardingAction!]!
|
Example
{"next": 4, "count": 123, "list": [OnboardingAction]}
OnboardingAuxiliaryDevice
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
idKey - String
|
|
label - String
|
|
kind - OnboardingAuxiliaryDeviceKind!
|
|
connectionType - OnboardingAuxiliaryDeviceConnectionType
|
|
sensorFunctions - [OnboardingAuxiliarySensorFunction!]
|
|
serialNumber - String
|
|
macAddressHash - String
|
|
wifiSsid - String
|
WiFi SSID if connection type is wifi |
wifiPassword - String
|
WiFi password if connection type is wifi |
assetManagerId - String
|
Example
{
"id": "4",
"idKey": "xyz789",
"label": "xyz789",
"kind": "SENSOR",
"connectionType": "UNKNOWN",
"sensorFunctions": ["SENSOR"],
"serialNumber": "abc123",
"macAddressHash": "xyz789",
"wifiSsid": "abc123",
"wifiPassword": "abc123",
"assetManagerId": "abc123"
}
OnboardingAuxiliaryDeviceConnectionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
OnboardingAuxiliaryDeviceKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SENSOR"
OnboardingAuxiliaryDevicePaged
Description
Paginated onboarding_auxiliary_device results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [OnboardingAuxiliaryDevice!]!
|
Example
{
"next": 4,
"count": 123,
"list": [OnboardingAuxiliaryDevice]
}
OnboardingAuxiliarySensorFunction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SENSOR"
OnboardingConsent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
whitelistedData - [OnboardingWhitelistedData!]
|
|
inherited - Boolean!
|
Inherited from client identification |
Example
{"id": 4, "whitelistedData": ["POSITION"], "inherited": true}
OnboardingDeviceBluetoothMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ENABLE"
OnboardingDistributor
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Distributor id |
organizationId - ID
|
Organization id |
label - String
|
|
provider - OnboardingProvider
|
|
isActive - Boolean
|
|
workshop - Workshop
|
|
providerWorkshopId - ID
|
Workshop third-party (provider) id |
staff - OnboardingStaffPaged
|
|
requests - OnboardingRequestPaged
|
|
Arguments
|
|
Example
{
"id": 4,
"organizationId": 4,
"label": "xyz789",
"provider": OnboardingProvider,
"isActive": true,
"workshop": Workshop,
"providerWorkshopId": "4",
"staff": OnboardingStaffPaged,
"requests": OnboardingRequestPaged
}
OnboardingDistributorPaged
Description
Paginated onboarding_distributor results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [OnboardingDistributor!]!
|
Example
{
"next": "4",
"count": 987,
"list": [OnboardingDistributor]
}
OnboardingDriverAssociation
OnboardingEnergyTypeArg
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DIESEL"
OnboardingMode
Description
onboarding mode
Values
| Enum Value | Description |
|---|---|
|
|
All steps are required, and request should be finalized manually. |
|
|
Only device_reservation step is required. The request will be finalized automatically when VIN is sent if decoded successfully. |
|
|
For GPS trackers that do not need custom configuration. Only device_reservation and vehicle_creation steps are required. |
|
|
Unrecognized onboarding mode |
Example
"MANUAL"
OnboardingModeArg
Description
onboarding mode argument
Values
| Enum Value | Description |
|---|---|
|
|
All steps are required, and request should be finalized manually. |
|
|
Only device_reservation step is required. The request will be finalized automatically when VIN is sent if decoded successfully. |
|
|
For GPS trackers that do not need custom configuration. Only device_reservation and vehicle_creation steps are required. |
Example
"MANUAL"
OnboardingPartner
Example
{
"id": "4",
"name": "abc123",
"organizationId": "4",
"project": Project,
"providers": OnboardingProviderPaged
}
OnboardingPartnerPaged
Description
Paginated onboarding_partner results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [OnboardingPartner!]!
|
Example
{"next": 4, "count": 123, "list": [OnboardingPartner]}
OnboardingProvider
OnboardingProviderPaged
Description
Paginated onboarding_provider results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [OnboardingProvider!]!
|
Example
{"next": 4, "count": 123, "list": [OnboardingProvider]}
OnboardingRequest
Description
Pending onboarding request
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Request id |
status - OnboardingStatus
|
Is the request still ongoing |
mode - OnboardingMode
|
Onboarding mode |
createdAt - DateTime
|
Request creation datetime |
updatedAt - DateTime
|
Request update datetime |
warnings - [OnboardingWarning!]
|
Errors encountered |
clonedTo - OnboardingRequest
|
Child request this request was cloned to |
clonedFrom - OnboardingRequest
|
Parent request this request was cloned from |
deviceCreatedBy - Account
|
Account that created this request's device |
driverCreatedBy - Account
|
Account that created this request's driver |
driverValidatedBy - Account
|
Account that validated this request's driver |
driverAssociationId - ID
|
Driver association id |
driverAssociatedBy - Account
|
Account that associated this request's driver |
vehicleCreatedBy - Account
|
Account that created this request's vehicle |
vehicleAssociatedBy - Account
|
Account that associated this request's vehicle |
vehicleEnrichedBy - Account
|
Account that enriched this request's vehicle |
createdBy - Account
|
Account that created this request |
distributor - OnboardingDistributor
|
Request distributor |
driver - Account
|
Account created by this request |
vehicle - Vehicle
|
Vehicle created by this request |
vehicleCreationId - ID
|
Vehicle creation id |
vehicleEnrichments - OnboardingVehicle
|
Vehicle enrichments |
vehicleConnection - OnboardingVehicleConnection
|
Vehicle connection |
consent - OnboardingConsent
|
Privacy consent |
profile - ProfileOnboarding
|
Profile status |
actions - OnboardingActionPaged
|
Action history |
device - Device
|
Device IMEI |
deviceMode - ProfileDeviceModeClass
|
|
deviceBluetooth - OnboardingDeviceBluetoothMode
|
Device Bluetooth mode |
plateNumber - ID
|
Vehicle plate number |
vin - String
|
Vehicle VIN |
vehicleLabel - String
|
Vehicle label |
withCode - Boolean
|
Whether an onboarding code was used |
connectionType - DeviceConnectionType
|
Device connection type |
kmAtInstallation - Int
|
Odometer (km) at installation |
serialNumber - String
|
Device serial number |
activateReadWriteInDevice - Boolean
|
Whether read-write is enabled |
clientIdentificationId - ID
|
Client Identification id |
auxiliaryDevices - OnboardingAuxiliaryDevicePaged
|
|
Arguments
|
|
Example
{
"id": 4,
"status": "OPEN",
"mode": "MANUAL",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"warnings": [OnboardingWarning],
"clonedTo": OnboardingRequest,
"clonedFrom": OnboardingRequest,
"deviceCreatedBy": Account,
"driverCreatedBy": Account,
"driverValidatedBy": Account,
"driverAssociationId": "4",
"driverAssociatedBy": Account,
"vehicleCreatedBy": Account,
"vehicleAssociatedBy": Account,
"vehicleEnrichedBy": Account,
"createdBy": Account,
"distributor": OnboardingDistributor,
"driver": Account,
"vehicle": Vehicle,
"vehicleCreationId": 4,
"vehicleEnrichments": OnboardingVehicle,
"vehicleConnection": OnboardingVehicleConnection,
"consent": OnboardingConsent,
"profile": ProfileOnboarding,
"actions": OnboardingActionPaged,
"device": Device,
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE",
"plateNumber": "4",
"vin": "abc123",
"vehicleLabel": "xyz789",
"withCode": false,
"connectionType": "CABLE",
"kmAtInstallation": 987,
"serialNumber": "abc123",
"activateReadWriteInDevice": true,
"clientIdentificationId": "4",
"auxiliaryDevices": OnboardingAuxiliaryDevicePaged
}
OnboardingRequestPaged
Description
Paginated onboarding_request results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [OnboardingRequest!]!
|
Example
{"next": 4, "count": 123, "list": [OnboardingRequest]}
OnboardingRequestSort
Description
onboarding_request sorting
Fields
| Input Field | Description |
|---|---|
by - OnboardingRequestSortKey!
|
|
order - SortOrder!
|
Example
{"by": "ID", "order": "ASCENDING"}
OnboardingRequestSortKey
Description
onboarding_request sorting key
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
OnboardingStaff
Fields
| Field Name | Description |
|---|---|
role - OnboardingStaffRole!
|
|
isActive - Boolean!
|
|
account - Account
|
Example
{"role": "MANAGER", "isActive": true, "account": Account}
OnboardingStaffPaged
Description
Paginated onboarding_staff results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [OnboardingStaff!]!
|
Example
{
"next": "4",
"count": 123,
"list": [OnboardingStaff]
}
OnboardingStaffRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MANAGER"
OnboardingStatus
Description
onboarding status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Has been cloned and the clone has been finalized |
|
|
Unrecognized onboarding status |
Example
"OPEN"
OnboardingVehicle
Fields
| Field Name | Description |
|---|---|
acIsRemoteControlled - Boolean
|
|
alarmIsPresent - Boolean
|
|
brand - String
|
The vehicle's brand |
brandModel - String
|
The vehicle's model |
color - String
|
|
connectivity - String
|
|
evPlugPosition - String
|
|
evPlugType - String
|
|
frontBrakeInstallation - String
|
Odometer (km) at last front brake change |
frontBrakeWear - String
|
|
frontTireInstallation - String
|
Odometer (km) at last front tires change |
frontTireWear - String
|
|
fuelType - EnergyType
|
|
fuelTypeSecondary - EnergyType
|
|
kba - ID
|
Kraftfahrbundesamt (Germany and Austria) |
lastDateBatteryChanged - DateTime
|
|
modelId - ID
|
|
rearBrakeInstallation - String
|
Odometer (km) at last rear brake change |
rearBrakeWear - String
|
|
rearTireInstallation - String
|
Odometer (km) at last rear tires change |
rearTireWear - String
|
|
tankSize - Int
|
Tank size (l), -1 if unknown |
tyresType - TyreType
|
|
vinDescriptions - DecodeVinResult
|
|
yearOfFirstCirculation - Int
|
|
vehicleType - VehicleTypeName
|
Vehicle type |
Example
{
"acIsRemoteControlled": true,
"alarmIsPresent": true,
"brand": "abc123",
"brandModel": "xyz789",
"color": "xyz789",
"connectivity": "xyz789",
"evPlugPosition": "abc123",
"evPlugType": "xyz789",
"frontBrakeInstallation": "abc123",
"frontBrakeWear": "abc123",
"frontTireInstallation": "abc123",
"frontTireWear": "xyz789",
"fuelType": "OTHER",
"fuelTypeSecondary": "OTHER",
"kba": "4",
"lastDateBatteryChanged": "2007-12-03T10:15:30Z",
"modelId": "4",
"rearBrakeInstallation": "xyz789",
"rearBrakeWear": "xyz789",
"rearTireInstallation": "abc123",
"rearTireWear": "xyz789",
"tankSize": 987,
"tyresType": "SUMMER",
"vinDescriptions": DecodeVinResult,
"yearOfFirstCirculation": 123,
"vehicleType": "CAR"
}
OnboardingVehicleConnection
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Vehicle connection id |
activateReadWriteInDevice - Boolean
|
Whether read-write is enabled |
connectionType - DeviceConnectionType
|
Device connection type |
deviceMode - ProfileDeviceModeClass
|
Device mode |
deviceBluetooth - OnboardingDeviceBluetoothMode
|
Device Bluetooth mode |
kmAtInstallation - Int
|
Odometer (km) at installation |
Example
{
"id": "4",
"activateReadWriteInDevice": true,
"connectionType": "CABLE",
"deviceMode": "WORKSHOP",
"deviceBluetooth": "ENABLE",
"kmAtInstallation": 987
}
OnboardingWarning
Fields
| Field Name | Description |
|---|---|
step - String!
|
|
warnings - [String!]!
|
Example
{
"step": "xyz789",
"warnings": ["xyz789"]
}
OnboardingWhitelistedData
Description
Kind of data that can be sent
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized data type |
Example
"POSITION"
OnboardingWhitelistedDataArg
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"POSITION"
OpeningHoursAttributes
Description
Opening_hours model.
Fields
| Field Name | Description |
|---|---|
open24x7 - Boolean
|
True if the facilty doesn’t close (if True, the other attributes will be nil) |
days - [String]
|
A table of days (if the table contains all days, they will be replaced by every day) |
periods - [Period]
|
Table that contains periods when the facility will be open, it has two attributes from and to |
Example
{
"open24x7": false,
"days": ["xyz789"],
"periods": [Period]
}
Parameters
Description
Lpa parameters submodel
Fields
| Field Name | Description |
|---|---|
activationCode - String
|
Activation code. Can be prefixed with “lpa” |
enable - Int
|
Enable Set to 1 to enable the profile immediatly after the download is complete |
purpose - Int
|
Purpose (0: Telematics only, 1: Wifi Telematics, 2: Backup) |
telematicsApn - String
|
Telematics apn |
wifiApn - String
|
Wifi APN (Not checked if Purpose == 0) |
iccid - String
|
ICCID of the profile to enable |
nickname - String
|
ICCID of the profile to enable |
Example
{
"activationCode": "abc123",
"enable": 123,
"purpose": 123,
"telematicsApn": "abc123",
"wifiApn": "abc123",
"iccid": "xyz789",
"nickname": "abc123"
}
ParametersType
Description
input object parameters
Fields
| Input Field | Description |
|---|---|
activationCode - String
|
Activation code. Can be prefixed with “lpa” |
enable - Int
|
Enable Set to 1 to enable the profile immediatly after the download is complete |
purpose - Int
|
Purpose (0: Telematics only, 1: Wifi Telematics, 2: Backup) |
telematicsApn - String
|
Telematics apn |
wifiApn - String
|
Wifi APN (Not checked if Purpose == 0) |
iccid - String
|
ICCID of the profile to enable |
nickname - String
|
Nickname of the profile to set |
Example
{
"activationCode": "abc123",
"enable": 987,
"purpose": 987,
"telematicsApn": "xyz789",
"wifiApn": "xyz789",
"iccid": "xyz789",
"nickname": "abc123"
}
Parking
Description
Vehicle parking
Fields
| Field Name | Description |
|---|---|
id - ID
|
Parking ID |
type - String
|
Parking type |
address - AddressAttributes
|
The address of the facility. |
distance - Int
|
Distance (meters) between the position sent in the request and the facility. |
status - StatusAttributes
|
State of the facility (open or closed) at the time of the request. |
openingHours - [OpeningHoursAttributes]
|
Table of The opening hours of the facility. |
pricing - [PricingInfo]
|
Extra information about the station, such as connector type in the electric station case. |
brand - String
|
Parking brand |
logo - String
|
Parking logo url |
name - String
|
Parking name |
paymentInfo - PaymentInfo
|
Payment information |
Example
{
"id": "4",
"type": "xyz789",
"address": AddressAttributes,
"distance": 123,
"status": "OPEN",
"openingHours": [OpeningHoursAttributes],
"pricing": [PricingInfo],
"brand": "xyz789",
"logo": "abc123",
"name": "abc123",
"paymentInfo": PaymentInfo
}
ParkingPaged
Description
Paginated parking results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Parking!]!
|
Example
{
"next": "4",
"count": 123,
"list": [Parking]
}
PasswordResetChannel
Description
Side channel to send the reset token
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PHONE"
PaymentInfo
Fields
| Field Name | Description |
|---|---|
note - String
|
|
subscription - Boolean
|
|
methods - [PaymentMethod]
|
Example
{
"note": "xyz789",
"subscription": false,
"methods": ["CASH"]
}
PaymentMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CASH"
Percent
Description
Percentage, as a floating point number between 0 and 100
Example
Percent
Perf
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
events - [PerfEvent!]
|
Example
{"id": 4, "events": [PerfEvent]}
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 |
|---|---|
device - Device
|
Device |
coordinates - [Coordinates!]
|
Device positions (last item is also avaliable via device.last_position) |
Example
{
"device": Device,
"coordinates": [Coordinates]
}
PresenceNotification
Fields
| Field Name | Description |
|---|---|
device - Device
|
Device |
status - DevicePresence
|
|
connectionReason - DeviceConnectionReason
|
Connection reason |
disconnectionReason - DeviceDisconnectionReason
|
Disconnection reason |
Example
{
"device": Device,
"status": "CONNECTED",
"connectionReason": "COLD_BOOT",
"disconnectionReason": "UNKNOWN_SERVER_REASON"
}
PricingInfo
Description
Pricing info submodel.
Fields
| Field Name | Description |
|---|---|
price - Float
|
The price of the energy for each unit. |
currency - String
|
The currency code. ISO 4217 is used. |
minMinutes - Int
|
The min time a person should stay in the parking so this price will be used. |
maxMinutes - Int
|
The max time a person should stay in the parking so this price will be used. |
days - [String]
|
A table of days (if the table contains all days, they will be replaced by every day) |
Example
{
"price": 987.65,
"currency": "abc123",
"minMinutes": 987,
"maxMinutes": 987,
"days": ["xyz789"]
}
Product
Description
Product Object
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier |
name - String!
|
Name |
wifi - Boolean
|
Reference |
bluetooth - Boolean
|
|
network - ProductNetwork
|
|
market - ProductMarket
|
Example
{
"id": "4",
"name": "abc123",
"wifi": false,
"bluetooth": false,
"network": "_2G",
"market": "EU"
}
ProductMarket
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EU"
ProductNetwork
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"_2G"
ProfileDeviceMode
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
mode - ProfileDeviceModeClass!
|
|
status - ProfileMigrationStatus!
|
|
startedAt - DateTime!
|
|
endedAt - DateTime
|
|
restoreDefault - ProfileRestoreDefault
|
Example
{
"id": "4",
"mode": "WORKSHOP",
"status": "PENDING",
"startedAt": "2007-12-03T10:15:30Z",
"endedAt": "2007-12-03T10:15:30Z",
"restoreDefault": ProfileRestoreDefault
}
ProfileDeviceModeClass
Description
Device mode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Unrecognized device mode |
Example
"WORKSHOP"
ProfileDeviceModeClassArg
Description
Device mode argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"WORKSHOP"
ProfileDeviceModePaged
Description
Paginated profile_device_mode results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [ProfileDeviceMode!]!
|
Example
{"next": 4, "count": 987, "list": [ProfileDeviceMode]}
ProfileMigrationStatus
Description
Migration status
Values
| Enum Value | Description |
|---|---|
|
|
Migration validated, waiting for campaign to be generated |
|
|
Migration started, waiting for device to apply it |
|
|
Migration finished successfully |
|
|
Migration failed |
|
|
Migration failed because of timeout |
|
|
Migration canceled by user |
|
|
Migration is not compatible with the apps linked to the device |
|
|
Unrecognized migration status |
Example
"PENDING"
ProfileOnboarding
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdAt - DateTime!
|
|
startedAt - DateTime!
|
|
endedAt - DateTime
|
|
status - ProfileMigrationStatus!
|
|
campaignId - ID
|
|
configurationIds - [ID]
|
|
vehicleDesc - DecodeVinResult
|
|
privacy - ProfilePrivacy
|
|
restoreDefault - ProfileRestoreDefault
|
Example
{
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"startedAt": "2007-12-03T10:15:30Z",
"endedAt": "2007-12-03T10:15:30Z",
"status": "PENDING",
"campaignId": "4",
"configurationIds": [4],
"vehicleDesc": DecodeVinResult,
"privacy": ProfilePrivacy,
"restoreDefault": ProfileRestoreDefault
}
ProfilePrivacy
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdAt - DateTime!
|
|
startedAt - DateTime!
|
|
endedAt - DateTime
|
|
status - ProfileMigrationStatus!
|
|
whitelistedData - [OnboardingWhitelistedData!]
|
|
restoreDefault - ProfileRestoreDefault
|
Example
{
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"startedAt": "2007-12-03T10:15:30Z",
"endedAt": "2007-12-03T10:15:30Z",
"status": "PENDING",
"whitelistedData": ["POSITION"],
"restoreDefault": ProfileRestoreDefault
}
ProfilePrivacyPaged
Description
Paginated profile_privacy results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [ProfilePrivacy!]!
|
Example
{"next": 4, "count": 987, "list": [ProfilePrivacy]}
ProfileRestoreDefault
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
campaignId - ID
|
|
status - ProfileMigrationStatus!
|
|
mode - ProfileDeviceModeClass!
|
|
createdAt - DateTime!
|
|
startedAt - DateTime!
|
|
endedAt - DateTime
|
Example
{
"id": 4,
"campaignId": "4",
"status": "PENDING",
"mode": "WORKSHOP",
"createdAt": "2007-12-03T10:15:30Z",
"startedAt": "2007-12-03T10:15:30Z",
"endedAt": "2007-12-03T10:15:30Z"
}
Project
Description
Project Object
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier |
label - String!
|
Label |
owner - Account
|
Owner |
vehicles - VehiclePaged
|
Vehicles |
Arguments
|
|
groups - GroupPaged
|
Groups |
drivers - DriverPaged
|
Drivers |
devices - DevicePaged
|
Devices |
Arguments
|
|
users - AccountPaged
|
Users |
Example
{
"id": 4,
"label": "xyz789",
"owner": Account,
"vehicles": VehiclePaged,
"groups": GroupPaged,
"drivers": DriverPaged,
"devices": DevicePaged,
"users": AccountPaged
}
ProjectMember
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DEVICE"
ProjectPaged
Description
Paginated project results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Project!]!
|
Example
{
"next": "4",
"count": 987,
"list": [Project]
}
ProvidedEnergy
Description
Fuel/energy info
Fields
| Field Name | Description |
|---|---|
type - EnergyType
|
The standardized type of energy/fuel this station provide. |
typeFull - String
|
The full type of energy/fuel this station provide. |
price - Float
|
The price of the energy for each unit. |
unit - String
|
The unit of the energy. |
currency - String
|
The currency code. ISO 4217 is used. |
connectorType - ConnectorType
|
The standardized type of electric connector |
connectorTypeFull - String
|
The full type of electric connector |
connectorSupport - String
|
Supported electric connector |
capacity - String
|
Electric connector capacity |
connectorCount - Int
|
Number of available electric connectors |
Example
{
"type": "OTHER",
"typeFull": "abc123",
"price": 123.45,
"unit": "abc123",
"currency": "abc123",
"connectorType": "OTHER",
"connectorTypeFull": "abc123",
"connectorSupport": "xyz789",
"capacity": "xyz789",
"connectorCount": 123
}
Quotation
Description
Workshop quotation
Fields
| Field Name | Description |
|---|---|
id - ID
|
Quotation ID |
plateNumber - String
|
Plate number |
workshop - Workshop
|
Workshop |
currency - String
|
Currency |
price - Int
|
Price |
maintenanceCode - String
|
Maintenance codes |
bookingId - ID
|
Booking ID |
taxes - Int
|
Taxes |
taxesPrice - Int
|
Taxes price |
providerQuotationId - ID
|
Provider quotation ID |
Example
{
"id": "4",
"plateNumber": "xyz789",
"workshop": Workshop,
"currency": "xyz789",
"price": 123,
"maintenanceCode": "xyz789",
"bookingId": 4,
"taxes": 123,
"taxesPrice": 123,
"providerQuotationId": "4"
}
QuotationPaged
Description
Paginated quotation results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Quotation!]!
|
Example
{"next": 4, "count": 987, "list": [Quotation]}
Rating
Description
Workshop rating
Fields
| Field Name | Description |
|---|---|
id - ID
|
Rating ID |
createdAt - DateTime
|
Creation datetime |
message - String
|
Rating message |
stars - Int
|
Stars |
response - String
|
Response message |
responseDate - DateTime
|
Response datetime |
status - RatingStatus
|
Wether rating is verified |
workshop - Workshop
|
Workshop |
booking - Booking
|
Booking |
Example
{
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"message": "xyz789",
"stars": 123,
"response": "xyz789",
"responseDate": "2007-12-03T10:15:30Z",
"status": "VERIFIED",
"workshop": Workshop,
"booking": Booking
}
RatingPaged
Description
Paginated rating results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Rating!]!
|
Example
{
"next": "4",
"count": 123,
"list": [Rating]
}
RatingStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"VERIFIED"
RdcAsyncAck
Description
Asynchroneous reply
This is an aknowledgement that the command has been sent. Actual reply must be fetched using notifications.
Example
{
"id": "4",
"type": "xyz789",
"attributes": Json
}
RdcEndpoint
Description
Type of RemoteDeviceCommand query/mutation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DISPLACEMENT_SET"
Reading
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
time - DateTime!
|
|
eventId - ID
|
The cloud event this reading is extracted from |
metric - Metric!
|
|
value - ReadingValue!
|
Example
{
"id": "4",
"time": "2007-12-03T10:15:30Z",
"eventId": 4,
"metric": Metric,
"value": JsonObj
}
ReadingAggregate
Description
Aggregate readings (grouped by metric id) instead of returning the whole list
Values
| Enum Value | Description |
|---|---|
|
|
Return all readings |
|
|
Return the first reading only |
|
|
Return the last reading only |
|
|
Return only value changes |
Example
"NONE"
ReadingAnon
Fields
| Field Name | Description |
|---|---|
metric - Metric!
|
|
time - DateTime
|
|
value - ReadingValue!
|
Example
{
"metric": Metric,
"time": "2007-12-03T10:15:30Z",
"value": JsonObj
}
ReadingAnonAggregate
Values
| Enum Value | Description |
|---|---|
|
|
Return Largest Triangle Tree Buckets |
|
|
Return the number of readings |
Example
"LTTB"
ReadingAnonPaged
Description
Paginated reading_anon results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [ReadingAnon!]!
|
Example
{
"next": "4",
"count": 987,
"list": [ReadingAnon]
}
ReadingPaged
Description
Paginated reading results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Reading!]!
|
Example
{
"next": "4",
"count": 987,
"list": [Reading]
}
ReadingSort
Description
reading sorting
Fields
| Input Field | Description |
|---|---|
by - ReadingSortKey!
|
|
order - SortOrder!
|
Example
{"by": "TIME", "order": "ASCENDING"}
ReadingSortKey
Description
reading sorting key
Values
| Enum Value | Description |
|---|---|
|
|
Example
"TIME"
ReadingValue
Types
| Union Types |
|---|
Example
JsonObj
RemoteDiag
Description
Remote diagnostic session
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Remote diagnostic session id |
createdAt - DateTime!
|
Creation date |
updatedAt - DateTime!
|
Update date |
status - String
|
Current status |
vud - RemoteDiagEndpoint
|
Vehicle Under Diagnostic |
vci - RemoteDiagEndpoint
|
Vehicle Communication Interface |
currentStep - RemoteDiagCurrentStep!
|
Current session step |
language - Language!
|
Language |
providerName - String
|
|
actions - RemoteDiagActionPaged
|
List of previous actions |
result - RemoteDiagResult
|
|
steps - RemoteDiagStepPaged
|
|
Example
{
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "abc123",
"vud": RemoteDiagEndpoint,
"vci": RemoteDiagEndpoint,
"currentStep": "SETUP_ONGOING",
"language": Language,
"providerName": "abc123",
"actions": RemoteDiagActionPaged,
"result": RemoteDiagResult,
"steps": RemoteDiagStepPaged
}
RemoteDiagAction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Action id |
type - RemoteDiagActionType
|
|
status - RemoteDiagActionStatus!
|
|
failureReason - String
|
|
progress - Float
|
|
ecus - [ID!]
|
|
pids - [ID!]
|
|
createdAt - DateTime!
|
Creation date |
updatedAt - DateTime!
|
Update date |
sequenceActions - [RemoteDiagActionType]
|
|
dtcs - RemoteDiagResultDtcPaged
|
|
snapshots - RemoteDiagResultSnapshotPaged
|
|
supportedParameters - RemoteDiagSupportedParameterPaged
|
|
Example
{
"id": "4",
"type": "CLEAR_DTC",
"status": "PENDING",
"failureReason": "abc123",
"progress": 123.45,
"ecus": ["4"],
"pids": ["4"],
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"sequenceActions": ["CLEAR_DTC"],
"dtcs": RemoteDiagResultDtcPaged,
"snapshots": RemoteDiagResultSnapshotPaged,
"supportedParameters": RemoteDiagSupportedParameterPaged
}
RemoteDiagActionPaged
Description
Paginated remote_diag_action results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [RemoteDiagAction!]!
|
Example
{
"next": "4",
"count": 123,
"list": [RemoteDiagAction]
}
RemoteDiagActionStatus
Values
| Enum Value | Description |
|---|---|
|
|
Action requested |
|
|
Action in progress |
|
|
Action processed successfully |
|
|
Action failed |
|
|
|
|
|
No action started |
Example
"PENDING"
RemoteDiagActionStatusArg
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ABORT"
RemoteDiagActionType
Description
Action
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized action |
Example
"CLEAR_DTC"
RemoteDiagActionTypeArg
Description
Action argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLEAR_DTC"
RemoteDiagCurrentStep
Description
Step
Values
| Enum Value | Description |
|---|---|
|
|
Session setup in progress |
|
|
Session ready, waiting for user request |
|
|
Session processing user request |
|
|
Session closure in progress |
|
|
Session closed |
|
|
Session error |
|
|
Unrecognized step |
Example
"SETUP_ONGOING"
RemoteDiagEndpoint
Description
Remote diagnostic endpoint
Fields
| Field Name | Description |
|---|---|
device - Device
|
Diagnostic device |
failureReason - RemoteDiagFailureReason!
|
Failure reason, if any |
failureCode - Int!
|
Failure reason code, if any |
vin - String
|
Session VehicleIdentificationNumber |
vinFromVehicle - String
|
VehicleIdentificationNumber reported by vehicle |
countrySpecificId - CountrySpecificId
|
|
vehicle - Vehicle
|
Example
{
"device": Device,
"failureReason": "OK",
"failureCode": 987,
"vin": "abc123",
"vinFromVehicle": "abc123",
"countrySpecificId": CountrySpecificId,
"vehicle": Vehicle
}
RemoteDiagFailureReason
Description
Failure reason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized failure reason |
Example
"OK"
RemoteDiagFreezeFrame
RemoteDiagNotification
Fields
| Field Name | Description |
|---|---|
device - Device
|
Device |
remoteDiag - RemoteDiag!
|
Example
{
"device": Device,
"remoteDiag": RemoteDiag
}
RemoteDiagPaged
Description
Paginated remote_diag results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [RemoteDiag!]!
|
Example
{"next": 4, "count": 123, "list": [RemoteDiag]}
RemoteDiagResult
Fields
| Field Name | Description |
|---|---|
status - RemoteDiagActionStatus!
|
|
failureReason - String
|
|
progress - Float
|
|
actionsCount - Int
|
|
createdAt - DateTime!
|
Creation date |
updatedAt - DateTime!
|
Update date |
supportedParameters - RemoteDiagSupportedParameterPaged
|
|
dtcs - RemoteDiagResultDtcPaged
|
|
snapshots - RemoteDiagResultSnapshotPaged
|
|
ecus - RemoteDiagResultEcuPaged
|
|
Example
{
"status": "PENDING",
"failureReason": "xyz789",
"progress": 123.45,
"actionsCount": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"supportedParameters": RemoteDiagSupportedParameterPaged,
"dtcs": RemoteDiagResultDtcPaged,
"snapshots": RemoteDiagResultSnapshotPaged,
"ecus": RemoteDiagResultEcuPaged
}
RemoteDiagResultDtc
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
groupName - String
|
|
sourceName - String
|
|
code - String!
|
|
mode - DtcMode!
|
|
protocol - DtcProtocol!
|
|
codeDescription - String
|
|
codeSubdescription - String
|
|
cause - String
|
Cause related to the dtc code. |
effect - String
|
Effect may be caused by the dtc code. |
recommendation - String
|
|
classification - DtcClassification!
|
|
status - RemoteDiagResultDtcStatus!
|
|
dtcFreezeFrames - [RemoteDiagFreezeFrame]
|
|
createdAt - DateTime!
|
Creation date |
updatedAt - DateTime!
|
Update date |
sourceType - DtcSource
|
|
sensor - String
|
|
sensorDescription - String
|
Example
{
"id": "4",
"groupName": "abc123",
"sourceName": "xyz789",
"code": "abc123",
"mode": "UNKNOWN",
"protocol": "OBD2",
"codeDescription": "abc123",
"codeSubdescription": "xyz789",
"cause": "abc123",
"effect": "xyz789",
"recommendation": "xyz789",
"classification": "ADVISORY",
"status": "CLEARED",
"dtcFreezeFrames": [RemoteDiagFreezeFrame],
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"sourceType": "ABS",
"sensor": "xyz789",
"sensorDescription": "abc123"
}
RemoteDiagResultDtcPaged
Description
Paginated remote_diag_result_dtc results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [RemoteDiagResultDtc!]!
|
Example
{"next": 4, "count": 123, "list": [RemoteDiagResultDtc]}
RemoteDiagResultDtcStatus
Description
dtc status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized dtc status |
Example
"CLEARED"
RemoteDiagResultEcu
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
groupName - String
|
|
sourceName - String
|
|
mil - Boolean
|
|
success - Boolean!
|
|
statusCode - Int
|
|
statusDescription - String!
|
|
createdAt - DateTime!
|
Creation date |
updatedAt - DateTime!
|
Update date |
dtcs - RemoteDiagResultDtcPaged
|
|
supportedParameters - RemoteDiagSupportedParameterPaged
|
|
Example
{
"id": "4",
"groupName": "xyz789",
"sourceName": "abc123",
"mil": true,
"success": false,
"statusCode": 987,
"statusDescription": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"dtcs": RemoteDiagResultDtcPaged,
"supportedParameters": RemoteDiagSupportedParameterPaged
}
RemoteDiagResultEcuPaged
Description
Paginated remote_diag_result_ecu results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [RemoteDiagResultEcu!]!
|
Example
{"next": 4, "count": 987, "list": [RemoteDiagResultEcu]}
RemoteDiagResultSnapshot
Example
{
"id": "4",
"name": "xyz789",
"timestamp": "2007-12-03T10:15:30Z",
"value": "xyz789",
"unit": "NONE",
"unitName": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
RemoteDiagResultSnapshotPaged
Description
Paginated remote_diag_result_snapshot results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [RemoteDiagResultSnapshot!]!
|
Example
{
"next": "4",
"count": 123,
"list": [RemoteDiagResultSnapshot]
}
RemoteDiagStep
Example
{
"id": "4",
"name": "xyz789",
"description": "abc123",
"status": "CREATED",
"mandatorySuccess": true,
"instanceId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
RemoteDiagStepPaged
Description
Paginated remote_diag_step results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [RemoteDiagStep!]!
|
Example
{
"next": "4",
"count": 123,
"list": [RemoteDiagStep]
}
RemoteDiagStepStatus
Description
Step status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized step status |
Example
"CREATED"
RemoteDiagSupportedParameter
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
featureName - String
|
|
unit - Unit!
|
Standardized unit |
unitName - String!
|
Raw unit |
groupName - String
|
|
sourceName - String
|
|
preferred - Boolean!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
readings - SupportedParameterReadingsPaged!
|
|
Example
{
"id": 4,
"name": "xyz789",
"featureName": "xyz789",
"unit": "NONE",
"unitName": "xyz789",
"groupName": "xyz789",
"sourceName": "xyz789",
"preferred": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"readings": SupportedParameterReadingsPaged
}
RemoteDiagSupportedParameterPaged
Description
Paginated remote_diag_supported_parameter results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [RemoteDiagSupportedParameter!]!
|
Example
{
"next": 4,
"count": 987,
"list": [RemoteDiagSupportedParameter]
}
RoleInput
Fields
| Input Field | Description |
|---|---|
role - RoleUpdateMeta!
|
Meta role to apply |
targetId - ID
|
Apply account roles to this target only |
targetType - RoleUpdateTarget
|
Type for target_id |
Example
{"role": "ADMIN", "targetId": 4, "targetType": "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
"ASCENDING"
StateOfHealthLowVoltageLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
No voltage lower than 9 volts had been observed in the last 3 trips |
|
|
A voltage lower than 9 volts had been observed in one of the last 3 trips |
|
|
A voltage lower than 9 volts had been observed in two of the last 3 trips |
|
|
A voltage lower than 9 volts had been observed in the last three 3 trips |
Example
"UNKNOWN"
StateOfHealthUserClassification
Description
state of health user classification
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized state of health user classification |
Example
"UNKNOWN"
Station
Description
Petrol or charging station
Fields
| Field Name | Description |
|---|---|
id - ID
|
Station ID |
address - AddressAttributes
|
The address of the facility. |
distance - Int
|
Distance (meters) between the position sent in the request and the facility. |
status - StatusAttributes
|
State of the facility (open or closed) at the time of the request. |
openingHours - [OpeningHoursAttributes]
|
Table of The opening hours of the facility. |
providedEnergy - [ProvidedEnergy]
|
Extra information about the station, such as connector type in the electric station case. |
brand - String
|
Station brand |
logo - String
|
Station logo url |
name - String
|
Station name |
paymentInfo - PaymentInfo
|
Payment information |
Example
{
"id": "4",
"address": AddressAttributes,
"distance": 123,
"status": "OPEN",
"openingHours": [OpeningHoursAttributes],
"providedEnergy": [ProvidedEnergy],
"brand": "xyz789",
"logo": "abc123",
"name": "xyz789",
"paymentInfo": PaymentInfo
}
StationPaged
Description
Paginated station results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Station!]!
|
Example
{
"next": "4",
"count": 987,
"list": [Station]
}
StatusAttributes
Description
Whether a facility is currently open
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OPEN"
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
"xyz789"
StringObj
Fields
| Field Name | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SupportedParameterReadingsBoolean
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
next - ID
|
|
timestamps - [DateTime!]
|
|
relativeTimestamps - [Float!]
|
|
values - [Boolean!]
|
Example
{
"count": 123,
"next": 4,
"timestamps": ["2007-12-03T10:15:30Z"],
"relativeTimestamps": [123.45],
"values": [true]
}
SupportedParameterReadingsFloat
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
next - ID
|
|
timestamps - [DateTime!]
|
|
relativeTimestamps - [Float!]
|
|
values - [Float!]
|
Example
{
"count": 987,
"next": 4,
"timestamps": ["2007-12-03T10:15:30Z"],
"relativeTimestamps": [987.65],
"values": [987.65]
}
SupportedParameterReadingsInteger
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
next - ID
|
|
timestamps - [DateTime!]
|
|
relativeTimestamps - [Float!]
|
|
values - [Int!]
|
Example
{
"count": 987,
"next": 4,
"timestamps": ["2007-12-03T10:15:30Z"],
"relativeTimestamps": [123.45],
"values": [987]
}
SupportedParameterReadingsPaged
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
next - ID
|
|
timestamps - [DateTime!]
|
|
relativeTimestamps - [Float!]
|
Possible Types
| SupportedParameterReadingsPaged Types |
|---|
Example
{
"count": 987,
"next": 4,
"timestamps": ["2007-12-03T10:15:30Z"],
"relativeTimestamps": [987.65]
}
SupportedParameterReadingsSort
Description
supported_parameter_readings sorting
Fields
| Input Field | Description |
|---|---|
by - SupportedParameterReadingsSortKey!
|
|
order - SortOrder!
|
Example
{"by": "RELATIVE_TIMESTAMP", "order": "ASCENDING"}
SupportedParameterReadingsSortKey
Description
supported_parameter_readings sorting key
Values
| Enum Value | Description |
|---|---|
|
|
Example
"RELATIVE_TIMESTAMP"
SupportedParameterReadingsString
Example
{
"count": 123,
"next": "4",
"timestamps": ["2007-12-03T10:15:30Z"],
"relativeTimestamps": [987.65],
"values": ["abc123"],
"mixed": false
}
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 |
|---|---|
software - String!
|
Software version |
hash - String
|
Version control hash |
schema - String!
|
Graphql schema version |
services - [SystemService!]
|
List of web service hosts |
extra - Json
|
Private |
Example
{
"software": "abc123",
"hash": "abc123",
"schema": "xyz789",
"services": [SystemService],
"extra": Json
}
SystemService
Ticket
Description
Support ticket
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
title - String
|
|
source - TicketSource
|
|
createdAt - DateTime
|
|
account - Account
|
Example
{
"id": 4,
"title": "xyz789",
"source": "ONBOARDING",
"createdAt": "2007-12-03T10:15:30Z",
"account": Account
}
TicketPaged
Description
Paginated ticket results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Ticket!]!
|
Example
{
"next": "4",
"count": 123,
"list": [Ticket]
}
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
{
"id": "4",
"startAt": "2007-12-03T10:15:30Z",
"endAt": "2007-12-03T10:15:30Z",
"towingVehicle": Vehicle,
"trailerVehicle": Vehicle,
"createdBy": Account,
"closedBy": Account
}
TowingSessionPaged
Description
Paginated towing_session results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [TowingSession!]!
|
Example
{"next": 4, "count": 987, "list": [TowingSession]}
TrackNotification
Trip
Description
Trip
Fields
| Field Name | Description |
|---|---|
id - ID
|
Trip id |
drivingPercentage - Percent
|
Driving percentage (0.0 .. 100.0) |
duration - Int
|
Total duration (seconds) |
endEvent - Idcoordinates
|
End event coordinates |
idlingPercentage - Percent
|
Idling percentage (0.0 .. 100.0) |
maxIdlingDuration - Int
|
Maximum idling duration (seconds) |
startEvent - Idcoordinates
|
Start event coordinates |
status - TripStatus
|
Whether the trip is already closed or ongoing |
averageSpeed - Float
|
Average speed while moving (km/h) |
co2Estimation - Int
|
CO2 Estimation (grams) |
distance - Int
|
Total trip distance (meters) |
distanceInDay - Percent
|
Percentage of distance travelled during the day |
drivingDuration - Int
|
Driving duration, vehicle not idle (seconds) |
ecoDrivingScore - Percent
|
Eco Driving Score (0 Poor .. 100 Perfect) |
endPostalAddress - AddressAttributes
|
End postal address |
endWeather - Weather
|
End weather |
fuelEfficiency - Float
|
Fuel Efficiency / Economy (L/100Km) |
fuelEstimation - Int
|
Fuel consumption estimation (milliliters) |
idlingDuration - Int
|
Idling duration (seconds) |
maxSpeed - Float
|
Maximum speed (km/h) |
nbHarshAcceleration - Int
|
Harsh acceleration events count |
nbHarshBraking - Int
|
Harsh deceleration events count |
nbHarshCornering - Int
|
Harsh left/right turn events count |
overconsumptionGap - AnyPercent
|
Fuel overconsumption compared to fuel reference consumption |
overemissionGap - AnyPercent
|
CO2 overemission comapred to CO2 reference emission |
safetyScore - Percent
|
Safety Score (0 Poor .. 100 Perfect) |
startPostalAddress - AddressAttributes
|
Start postal address |
startWeather - Weather
|
Start weather |
towAway - Boolean
|
Is the vehicle being towed away |
nbOverspeed - Int
|
Overspeed count |
nbPostprocessedOverspeed - Int
|
Post processed Overspeed count (extracted w.r.t. road network for example) |
overspeedDistance - Int
|
Overspeed distance (m) |
overspeedDuration - Int
|
Overspeed duration (s) |
overspeedScore - Percent
|
Overspeed score |
locations - IdcoordinatesPaged
|
Trip locations |
activities - TripActivityPaged
|
Activity events |
movements - TripMovementPaged
|
Movement events |
stops - TripStopPaged
|
Stop events |
harshes - TripHarshPaged
|
Harsh events |
overspeeds - TripOverspeedPaged
|
Overspeed events |
metadata - TripMetadatumPaged
|
Metadata |
Example
{
"id": 4,
"drivingPercentage": Percent,
"duration": 123,
"endEvent": Idcoordinates,
"idlingPercentage": Percent,
"maxIdlingDuration": 123,
"startEvent": Idcoordinates,
"status": "OPEN",
"averageSpeed": 123.45,
"co2Estimation": 987,
"distance": 123,
"distanceInDay": Percent,
"drivingDuration": 123,
"ecoDrivingScore": Percent,
"endPostalAddress": AddressAttributes,
"endWeather": Weather,
"fuelEfficiency": 123.45,
"fuelEstimation": 987,
"idlingDuration": 987,
"maxSpeed": 987.65,
"nbHarshAcceleration": 987,
"nbHarshBraking": 123,
"nbHarshCornering": 123,
"overconsumptionGap": AnyPercent,
"overemissionGap": AnyPercent,
"safetyScore": Percent,
"startPostalAddress": AddressAttributes,
"startWeather": Weather,
"towAway": false,
"nbOverspeed": 123,
"nbPostprocessedOverspeed": 123,
"overspeedDistance": 987,
"overspeedDuration": 123,
"overspeedScore": Percent,
"locations": IdcoordinatesPaged,
"activities": TripActivityPaged,
"movements": TripMovementPaged,
"stops": TripStopPaged,
"harshes": TripHarshPaged,
"overspeeds": TripOverspeedPaged,
"metadata": TripMetadatumPaged
}
TripActivity
Description
Trip activity
Fields
| Field Name | Description |
|---|---|
id - ID
|
Trip id |
state - TripActivityState
|
Activity type |
imei - ID
|
Device id |
startEvent - Idcoordinates
|
Start event coordinates |
endEvent - Idcoordinates
|
End event coordinates |
createdAt - DateTime
|
Activity creation datetime |
updatedAt - DateTime
|
Activity update datetime |
duration - Int
|
Activity duration (seconds) |
Example
{
"id": "4",
"state": "MOVEMENT",
"imei": 4,
"startEvent": Idcoordinates,
"endEvent": Idcoordinates,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"duration": 987
}
TripActivityPaged
Description
Paginated trip_activity results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [TripActivity!]!
|
Example
{"next": 4, "count": 987, "list": [TripActivity]}
TripActivityState
Description
Activity type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MOVEMENT"
TripHarsh
Fields
| Field Name | Description |
|---|---|
id - ID
|
Event id |
kind - TripHarshKind
|
Event kind |
startEvent - Coordinates
|
Start event coordinates |
endEvent - Coordinates
|
End event coordinates |
duration - Int
|
Duration (seconds) |
meanAcceleration - Float
|
Mean acceleration |
peakAcceleration - Float
|
Peak acceleration |
createdAt - DateTime
|
Creation datetime |
updatedAt - DateTime
|
Update datetime |
Example
{
"id": 4,
"kind": "ACCELERATION",
"startEvent": Coordinates,
"endEvent": Coordinates,
"duration": 987,
"meanAcceleration": 123.45,
"peakAcceleration": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
TripHarshKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCELERATION"
TripHarshPaged
Description
Paginated trip_harsh results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [TripHarsh!]!
|
Example
{"next": 4, "count": 987, "list": [TripHarsh]}
TripMetadatum
Description
Trip metadatum
Example
{
"id": "4",
"key": "abc123",
"value": "abc123",
"tripId": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
TripMetadatumPaged
Description
Paginated trip_metadatum results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [TripMetadatum!]!
|
Example
{
"next": "4",
"count": 123,
"list": [TripMetadatum]
}
TripMovement
Description
Trip movement
Fields
| Field Name | Description |
|---|---|
id - ID
|
Trip id |
imei - ID
|
Device id |
startEvent - Idcoordinates
|
Start event coordinates |
endEvent - Idcoordinates
|
End event coordinates |
createdAt - DateTime
|
Activity creation datetime |
updatedAt - DateTime
|
Activity update datetime |
duration - Int
|
Activity duration (seconds) |
Example
{
"id": 4,
"imei": "4",
"startEvent": Idcoordinates,
"endEvent": Idcoordinates,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"duration": 123
}
TripMovementPaged
Description
Paginated trip_movement results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [TripMovement!]!
|
Example
{
"next": "4",
"count": 123,
"list": [TripMovement]
}
TripNotification
TripOverspeed
Fields
| Field Name | Description |
|---|---|
id - ID
|
Event id |
startEvent - Coordinates
|
Start event coordinates |
endEvent - Coordinates
|
End event coordinates |
duration - Int
|
Duration (seconds) |
distance - Float
|
Distance (m) |
meanSpeed - Float
|
Mean speed |
peakSpeed - Float
|
Peak speed |
meanOverspeed - Float
|
Mean speed over threshold |
peakOverspeed - Float
|
Peak speed over threshold |
speedThreshold - Int
|
Speed threshold |
createdAt - DateTime
|
Creation datetime |
updatedAt - DateTime
|
Update datetime |
Example
{
"id": "4",
"startEvent": Coordinates,
"endEvent": Coordinates,
"duration": 987,
"distance": 123.45,
"meanSpeed": 987.65,
"peakSpeed": 123.45,
"meanOverspeed": 987.65,
"peakOverspeed": 123.45,
"speedThreshold": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
TripOverspeedPaged
Description
Paginated trip_overspeed results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [TripOverspeed!]!
|
Example
{"next": 4, "count": 987, "list": [TripOverspeed]}
TripPaged
TripStatus
Description
Whether the trip is already closed or ongoing
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OPEN"
TripStop
Description
Trip stop
Fields
| Field Name | Description |
|---|---|
id - ID
|
Trip id |
imei - ID
|
Device id |
startEvent - Idcoordinates
|
Start event coordinates |
endEvent - Idcoordinates
|
End event coordinates |
createdAt - DateTime
|
Activity creation datetime |
updatedAt - DateTime
|
Activity update datetime |
location - Coordinates
|
Location |
radius - Float
|
Radius (meters) |
duration - Int
|
Activity duration (seconds) |
Example
{
"id": "4",
"imei": "4",
"startEvent": Idcoordinates,
"endEvent": Idcoordinates,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"location": Coordinates,
"radius": 123.45,
"duration": 987
}
TripStopPaged
Description
Paginated trip_stop results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [TripStop!]!
|
Example
{"next": 4, "count": 123, "list": [TripStop]}
TripSummary
Description
Aggregated trip statistics
Fields
| Field Name | Description |
|---|---|
distance - Int
|
Distance (m) |
drivingDuration - Int
|
Driving duration (s) |
fuelEfficiency - Float
|
Fuel efficiency (l/100km) |
ecoDrivingScore - Percent
|
Eco driving score (0 Poor .. 100 Perfect) |
idlingDuration - Int
|
Idling duration (s) |
safetyScore - Percent
|
Safety Score (0 Poor .. 100 Perfect) |
overspeedScore - Percent
|
Overspeed Score (0 Poor .. 100 Perfect) |
nbOverspeed - Int
|
Overspeed count |
overspeedDistance - Int
|
Overspeed distance (m) |
overspeedDuration - Int
|
Overspeed duration (s) |
Example
{
"distance": 123,
"drivingDuration": 987,
"fuelEfficiency": 123.45,
"ecoDrivingScore": Percent,
"idlingDuration": 987,
"safetyScore": Percent,
"overspeedScore": Percent,
"nbOverspeed": 987,
"overspeedDistance": 987,
"overspeedDuration": 123
}
TyreType
Description
Tyre type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized tyre type |
Example
"SUMMER"
TyreTypeArg
Description
Tyre type argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SUMMER"
Unit
Values
| Enum Value | Description |
|---|---|
|
|
Dimentionless value |
|
|
Unknown unit (check unit_name) |
|
|
Temperature |
|
|
Grams per second |
|
|
Distance |
|
|
Pressure |
|
|
Speed |
|
|
Duration |
|
|
Pressure |
|
|
Percentage |
|
|
Revolutions per minute |
|
|
Duration |
|
|
? per minute |
|
|
Frequency |
|
|
Electric potential |
|
|
Electric resistance |
|
|
Volume |
|
|
Light intensity |
|
|
Electric intensity |
|
|
Electric intensity |
Example
"NONE"
Upload
Description
Represents an uploaded file.
Example
Upload
Vehicle
Description
Vehicle Object
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier |
plate - String
|
Plate |
label - String
|
Label |
vin - String
|
VIN |
onboarded - Boolean
|
onboarded |
modelId - ID
|
Model ID |
ktype - String
|
KType |
hasDriver - Boolean
|
Has a driver |
make - String
|
Model make |
model - String
|
Model |
year - String
|
Model Year |
fuelType - String
|
Primary fuel type |
fuelTypeSecondary - String
|
Secondary fuel type |
kba - String
|
KBA |
tags - [String!]
|
tags |
hybrid - Boolean
|
hybrid |
vehicleType - VehicleTypeName
|
vehicle type |
canTow - Boolean
|
can be used as towing vehicle |
canBeTowed - Boolean
|
can be used as trailer vehicle |
immobilizerStatus - ImmobilizerStatus
|
Immobilizer status |
immobilizerStatusUpdatedAt - DateTime
|
Immobilizer status reported time |
doorsLockStatus - DoorsLockStatus
|
Doors lock status |
doorsLockStatusUpdatedAt - DateTime
|
Doors lock status reported time |
garageModeStatus - GarageModeStatus
|
Garage mode status |
garageModeStatusUpdatedAt - DateTime
|
Garage mode status reported time |
archived - Boolean
|
archived |
descriptions - DescriptionPaged
|
AssetManager descriptions |
Arguments
|
|
vinDescriptions - DecodeVinResult
|
VIN descriptions |
owner - Account
|
Vehicle owner |
currentDevice - Device
|
Current Device |
currentDriver - Driver
|
Current Driver |
groups - GroupPaged
|
Groups |
lastTrip - Trip
|
Last trip |
Arguments
|
|
trips - TripPaged
|
Trips |
maintenancesUpcoming - MaintenanceUpcomingPaged
|
Upcoming maintenances |
Arguments
|
|
maintenancesHistorical - MaintenanceHistoricalPaged
|
Historical maintenances |
maintenanceTemplates - MaintenanceTemplatePaged
|
Maintenance templates |
maintenanceSchedules - MaintenanceSchedulePaged
|
Maintenance schedules |
Arguments
|
|
alerts - VehicleAlertPaged
|
|
Arguments
|
|
alertsState - VehicleAlertsState
|
|
currentDevices - DevicePaged
|
Last trip |
Arguments
|
|
towingSessionsAsTowingVehicle - TowingSessionPaged
|
List towing sessions where this vehicle is the towing vehicle |
towingSessionsAsTrailerVehicle - TowingSessionPaged
|
List towing sessions where this vehicle is the trailer vehicle |
currentTowingSessionAsTowingVehicle - TowingSession
|
current towing session where this vehicle is the towing vehicle |
currentTowingSessionAsTrailerVehicle - TowingSession
|
current towing session where this vehicle is the trailer vehicle |
currentTrailerVehicle - Vehicle
|
current trailer vehicle |
currentTowingVehicle - Vehicle
|
current towing vehicle |
driverSessions - DriverVehicleSessionPaged
|
Driver Sessions |
Example
{
"id": 4,
"plate": "abc123",
"label": "abc123",
"vin": "abc123",
"onboarded": true,
"modelId": 4,
"ktype": "xyz789",
"hasDriver": true,
"make": "abc123",
"model": "abc123",
"year": "abc123",
"fuelType": "abc123",
"fuelTypeSecondary": "xyz789",
"kba": "xyz789",
"tags": ["abc123"],
"hybrid": false,
"vehicleType": "CAR",
"canTow": false,
"canBeTowed": true,
"immobilizerStatus": "UNKNOWN",
"immobilizerStatusUpdatedAt": "2007-12-03T10:15:30Z",
"doorsLockStatus": "UNKNOWN",
"doorsLockStatusUpdatedAt": "2007-12-03T10:15:30Z",
"garageModeStatus": "UNKNOWN",
"garageModeStatusUpdatedAt": "2007-12-03T10:15:30Z",
"archived": true,
"descriptions": DescriptionPaged,
"vinDescriptions": DecodeVinResult,
"owner": Account,
"currentDevice": Device,
"currentDriver": Driver,
"groups": GroupPaged,
"lastTrip": Trip,
"trips": TripPaged,
"maintenancesUpcoming": MaintenanceUpcomingPaged,
"maintenancesHistorical": MaintenanceHistoricalPaged,
"maintenanceTemplates": MaintenanceTemplatePaged,
"maintenanceSchedules": MaintenanceSchedulePaged,
"alerts": VehicleAlertPaged,
"alertsState": VehicleAlertsState,
"currentDevices": DevicePaged,
"towingSessionsAsTowingVehicle": TowingSessionPaged,
"towingSessionsAsTrailerVehicle": TowingSessionPaged,
"currentTowingSessionAsTowingVehicle": TowingSession,
"currentTowingSessionAsTrailerVehicle": TowingSession,
"currentTrailerVehicle": Vehicle,
"currentTowingVehicle": Vehicle,
"driverSessions": DriverVehicleSessionPaged
}
VehicleAlert
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
Possible Types
| VehicleAlert Types |
|---|
Example
{
"id": "4",
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "xyz789",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData
}
VehicleAlertAggregateDateArg
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"LAST_RECEIVED"
VehicleAlertBadInstallation
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
sporadicUnplug - Boolean
|
Device gets unpluged sporadically |
timestamp - DateTime
|
|
history - VehicleAlertHistoryBadInstallationPaged
|
|
Example
{
"id": 4,
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "abc123",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"sporadicUnplug": true,
"timestamp": "2007-12-03T10:15:30Z",
"history": VehicleAlertHistoryBadInstallationPaged
}
VehicleAlertBatteryDischarge
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
timestamp - DateTime!
|
|
level - BatteryDischargeLevel
|
|
history - VehicleAlertHistoryBatteryDischargePaged
|
|
Example
{
"id": 4,
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "abc123",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"timestamp": "2007-12-03T10:15:30Z",
"level": "NO_INFORMATION",
"history": VehicleAlertHistoryBatteryDischargePaged
}
VehicleAlertBatteryExcessiveCrankValley
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
timestamp - DateTime!
|
|
numberOfValleys - Int!
|
|
history - VehicleAlertHistoryBatteryExcessiveCrankValleyPaged
|
|
Example
{
"id": "4",
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "xyz789",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"timestamp": "2007-12-03T10:15:30Z",
"numberOfValleys": 987,
"history": VehicleAlertHistoryBatteryExcessiveCrankValleyPaged
}
VehicleAlertBatteryStateOfCharge
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
timestamp - DateTime!
|
|
level - BatteryChargeLevel
|
State of Charge (enum) |
value - Percent
|
State of Charge (percentage) |
ocv - Float
|
Open-Circuit Voltage (millivolt) |
history - VehicleAlertHistoryBatteryStateOfChargePaged
|
|
Example
{
"id": "4",
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "xyz789",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"timestamp": "2007-12-03T10:15:30Z",
"level": "UNKNOWN",
"value": Percent,
"ocv": 987.65,
"history": VehicleAlertHistoryBatteryStateOfChargePaged
}
VehicleAlertBatteryStateOfHealthLowVoltage
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
timestamp - DateTime!
|
|
durationInMilliseconds - Int!
|
|
firstOccurrenceTimestampStart - DateTime
|
|
lastOccurrenceTimestampEnd - DateTime
|
|
lowestValue - Float!
|
|
meanValue - Float
|
|
occurred - Boolean!
|
|
level - StateOfHealthLowVoltageLevel
|
|
history - VehicleAlertHistoryBatteryStateOfHealthLowVoltagePaged
|
|
Example
{
"id": 4,
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "xyz789",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"timestamp": "2007-12-03T10:15:30Z",
"durationInMilliseconds": 987,
"firstOccurrenceTimestampStart": "2007-12-03T10:15:30Z",
"lastOccurrenceTimestampEnd": "2007-12-03T10:15:30Z",
"lowestValue": 987.65,
"meanValue": 123.45,
"occurred": true,
"level": "UNKNOWN",
"history": VehicleAlertHistoryBatteryStateOfHealthLowVoltagePaged
}
VehicleAlertBatteryStateOfHealthUser
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
classification - StateOfHealthUserClassification
|
|
description - String
|
|
recommendation - String
|
|
calculatedDate - DateTime
|
|
history - VehicleAlertHistoryBatteryStateOfHealthUserPaged
|
|
Example
{
"id": 4,
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "xyz789",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"classification": "UNKNOWN",
"description": "abc123",
"recommendation": "xyz789",
"calculatedDate": "2007-12-03T10:15:30Z",
"history": VehicleAlertHistoryBatteryStateOfHealthUserPaged
}
VehicleAlertBatteryType
Description
Battery type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"STATE_OF_HEALTH_LOW_VOLTAGE"
VehicleAlertBatteryVoltageHighLevelGap
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
timestamp - DateTime!
|
|
durationBetweenPlateaus - Int
|
Duration between plateaus (ms) |
timestampEndFirstPlateau - DateTime
|
|
timestampEndSecondPlateau - DateTime
|
|
timestampStartFirstPlateau - DateTime
|
|
timestampStartSecondPlateau - DateTime
|
|
voltageDifference - Float
|
|
voltageFirstPlateau - Float
|
|
voltageSecondPlateau - Float
|
|
history - VehicleAlertHistoryBatteryVoltageHighLevelGapPaged
|
|
Example
{
"id": "4",
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "abc123",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"timestamp": "2007-12-03T10:15:30Z",
"durationBetweenPlateaus": 123,
"timestampEndFirstPlateau": "2007-12-03T10:15:30Z",
"timestampEndSecondPlateau": "2007-12-03T10:15:30Z",
"timestampStartFirstPlateau": "2007-12-03T10:15:30Z",
"timestampStartSecondPlateau": "2007-12-03T10:15:30Z",
"voltageDifference": 123.45,
"voltageFirstPlateau": 123.45,
"voltageSecondPlateau": 987.65,
"history": VehicleAlertHistoryBatteryVoltageHighLevelGapPaged
}
VehicleAlertCrash
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
confidence - Percent!
|
|
startTime - DateTime!
|
|
endTime - DateTime!
|
|
coordinates - Coordinates!
|
|
severity - Percent!
|
|
severityClassification - VehicleAlertCrashSeverity!
|
|
history - VehicleAlertHistoryCrashPaged
|
|
Example
{
"id": 4,
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "abc123",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"confidence": Percent,
"startTime": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"coordinates": Coordinates,
"severity": Percent,
"severityClassification": "UNKNOWN",
"history": VehicleAlertHistoryCrashPaged
}
VehicleAlertCrashSeverity
Values
| Enum Value | Description |
|---|---|
|
|
Unknown severity class |
|
|
Property damage only |
|
|
Crash with injuries |
|
|
Crash with fatalities |
|
|
Example
"UNKNOWN"
VehicleAlertDifferentVin
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
alternativeVin - String!
|
|
onboardingVin - String!
|
|
recordedAt - DateTime!
|
|
history - VehicleAlertHistoryDifferentVinPaged
|
|
Example
{
"id": "4",
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "xyz789",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"alternativeVin": "abc123",
"onboardingVin": "xyz789",
"recordedAt": "2007-12-03T10:15:30Z",
"history": VehicleAlertHistoryDifferentVinPaged
}
VehicleAlertDtc
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
dtc - VehicleAlertDtcDtc
|
|
freezeFrames - DtcFreezeFrames
|
|
dtcStatus - VehicleAlertDtcStatus
|
|
history - VehicleAlertHistoryDtcPaged
|
|
Example
{
"id": 4,
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "xyz789",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"dtc": VehicleAlertDtcDtc,
"freezeFrames": DtcFreezeFrames,
"dtcStatus": VehicleAlertDtcStatus,
"history": VehicleAlertHistoryDtcPaged
}
VehicleAlertDtcDtc
Fields
| Field Name | Description |
|---|---|
cause - String
|
|
classification - DtcClassification
|
|
code - String
|
|
codeDescription - String
|
|
codeSubdescription - String
|
|
effect - String
|
|
protocol - DtcProtocol
|
|
recommendation - String
|
|
sensor - String
|
|
sensorDescription - String
|
|
source - DtcSource
|
|
sourceId - String
|
|
sourceDescription - String
|
|
sourceName - String
|
|
warning - String
|
|
isOem - Boolean
|
|
systemCategory - String
|
|
riskSafety - DtcRisk
|
|
riskDamage - DtcRisk
|
|
riskAvailability - DtcRisk
|
|
riskEmissions - DtcRisk
|
Example
{
"cause": "abc123",
"classification": "ADVISORY",
"code": "xyz789",
"codeDescription": "abc123",
"codeSubdescription": "xyz789",
"effect": "xyz789",
"protocol": "OBD2",
"recommendation": "abc123",
"sensor": "xyz789",
"sensorDescription": "xyz789",
"source": "ABS",
"sourceId": "xyz789",
"sourceDescription": "abc123",
"sourceName": "xyz789",
"warning": "xyz789",
"isOem": true,
"systemCategory": "xyz789",
"riskSafety": "NO",
"riskDamage": "NO",
"riskAvailability": "NO",
"riskEmissions": "NO"
}
VehicleAlertDtcStatus
VehicleAlertFeedback
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
alert - VehicleAlert
|
|
status - VehicleAlertFeedbackStatus!
|
|
description - String
|
|
language - Lang
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
Example
{
"id": 4,
"alert": VehicleAlert,
"status": "NO",
"description": "xyz789",
"language": "EN",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
VehicleAlertFeedbackPaged
Description
Paginated vehicle_alert_feedback results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertFeedback!]!
|
Example
{
"next": "4",
"count": 987,
"list": [VehicleAlertFeedback]
}
VehicleAlertFeedbackStatus
Description
vehicle alert feedback status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Unrecognized vehicle alert feedback status |
Example
"NO"
VehicleAlertFeedbackStatusArg
Description
vehicle alert feedback status argument
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NO"
VehicleAlertGeofencing
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
geofenceId - ID
|
|
description - String
|
|
label - String
|
|
state - GeofencingState
|
|
event - GeofencingEvent
|
|
startTime - DateTime
|
|
endTime - DateTime
|
|
coordinates - Coordinates
|
Use StartCoordinates |
startCoordinates - Coordinates
|
|
endCoordinates - Coordinates
|
|
history - VehicleAlertHistoryGeofencingPaged
|
|
Example
{
"id": "4",
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "xyz789",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"geofenceId": "4",
"description": "abc123",
"label": "abc123",
"state": "UNKNOWN",
"event": "ENTRY",
"startTime": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"coordinates": Coordinates,
"startCoordinates": Coordinates,
"endCoordinates": Coordinates,
"history": VehicleAlertHistoryGeofencingPaged
}
VehicleAlertHistoryBadInstallation
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
sporadicUnplug - Boolean
|
Device gets unpluged sporadically |
timestamp - DateTime
|
|
Example
{
"id": "4",
"occurence": 987,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"sporadicUnplug": true,
"timestamp": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryBadInstallationPaged
Description
Paginated vehicle_alert_history_bad_installation results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryBadInstallation!]!
|
Example
{
"next": "4",
"count": 123,
"list": [VehicleAlertHistoryBadInstallation]
}
VehicleAlertHistoryBatteryDischarge
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
timestamp - DateTime!
|
|
level - BatteryDischargeLevel
|
|
Example
{
"id": 4,
"occurence": 123,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"timestamp": "2007-12-03T10:15:30Z",
"level": "NO_INFORMATION"
}
VehicleAlertHistoryBatteryDischargePaged
Description
Paginated vehicle_alert_history_battery_discharge results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryBatteryDischarge!]!
|
Example
{
"next": "4",
"count": 123,
"list": [VehicleAlertHistoryBatteryDischarge]
}
VehicleAlertHistoryBatteryExcessiveCrankValley
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
timestamp - DateTime!
|
|
numberOfValleys - Int!
|
|
Example
{
"id": "4",
"occurence": 123,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"timestamp": "2007-12-03T10:15:30Z",
"numberOfValleys": 123
}
VehicleAlertHistoryBatteryExcessiveCrankValleyPaged
Description
Paginated vehicle_alert_history_battery_excessive_crank_valley results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryBatteryExcessiveCrankValley!]!
|
Example
{
"next": "4",
"count": 123,
"list": [VehicleAlertHistoryBatteryExcessiveCrankValley]
}
VehicleAlertHistoryBatteryStateOfCharge
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
timestamp - DateTime!
|
|
level - BatteryChargeLevel
|
State of Charge (enum) |
value - Percent
|
State of Charge (percentage) |
ocv - Float
|
Open-Circuit Voltage (millivolt) |
Example
{
"id": 4,
"occurence": 123,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"timestamp": "2007-12-03T10:15:30Z",
"level": "UNKNOWN",
"value": Percent,
"ocv": 987.65
}
VehicleAlertHistoryBatteryStateOfChargePaged
Description
Paginated vehicle_alert_history_battery_state_of_charge results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryBatteryStateOfCharge!]!
|
Example
{
"next": 4,
"count": 123,
"list": [VehicleAlertHistoryBatteryStateOfCharge]
}
VehicleAlertHistoryBatteryStateOfHealthLowVoltage
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
timestamp - DateTime!
|
|
durationInMilliseconds - Int!
|
|
firstOccurrenceTimestampStart - DateTime
|
|
lastOccurrenceTimestampEnd - DateTime
|
|
lowestValue - Float!
|
|
meanValue - Float
|
|
occurred - Boolean!
|
|
level - StateOfHealthLowVoltageLevel
|
|
Example
{
"id": "4",
"occurence": 987,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"timestamp": "2007-12-03T10:15:30Z",
"durationInMilliseconds": 123,
"firstOccurrenceTimestampStart": "2007-12-03T10:15:30Z",
"lastOccurrenceTimestampEnd": "2007-12-03T10:15:30Z",
"lowestValue": 123.45,
"meanValue": 123.45,
"occurred": true,
"level": "UNKNOWN"
}
VehicleAlertHistoryBatteryStateOfHealthLowVoltagePaged
Description
Paginated vehicle_alert_history_battery_state_of_health_low_voltage results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryBatteryStateOfHealthLowVoltage!]!
|
Example
{
"next": 4,
"count": 987,
"list": [
VehicleAlertHistoryBatteryStateOfHealthLowVoltage
]
}
VehicleAlertHistoryBatteryStateOfHealthUser
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
classification - StateOfHealthUserClassification
|
|
description - String
|
|
recommendation - String
|
|
calculatedDate - DateTime
|
|
Example
{
"id": 4,
"occurence": 123,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"classification": "UNKNOWN",
"description": "abc123",
"recommendation": "abc123",
"calculatedDate": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryBatteryStateOfHealthUserPaged
Description
Paginated vehicle_alert_history_battery_state_of_health_user results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryBatteryStateOfHealthUser!]!
|
Example
{
"next": "4",
"count": 987,
"list": [VehicleAlertHistoryBatteryStateOfHealthUser]
}
VehicleAlertHistoryBatteryVoltageHighLevelGap
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
timestamp - DateTime!
|
|
durationBetweenPlateaus - Int
|
Duration between plateaus (ms) |
timestampEndFirstPlateau - DateTime
|
|
timestampEndSecondPlateau - DateTime
|
|
timestampStartFirstPlateau - DateTime
|
|
timestampStartSecondPlateau - DateTime
|
|
voltageDifference - Float
|
|
voltageFirstPlateau - Float
|
|
voltageSecondPlateau - Float
|
|
Example
{
"id": "4",
"occurence": 987,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"timestamp": "2007-12-03T10:15:30Z",
"durationBetweenPlateaus": 123,
"timestampEndFirstPlateau": "2007-12-03T10:15:30Z",
"timestampEndSecondPlateau": "2007-12-03T10:15:30Z",
"timestampStartFirstPlateau": "2007-12-03T10:15:30Z",
"timestampStartSecondPlateau": "2007-12-03T10:15:30Z",
"voltageDifference": 123.45,
"voltageFirstPlateau": 123.45,
"voltageSecondPlateau": 987.65
}
VehicleAlertHistoryBatteryVoltageHighLevelGapPaged
Description
Paginated vehicle_alert_history_battery_voltage_high_level_gap results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryBatteryVoltageHighLevelGap!]!
|
Example
{
"next": 4,
"count": 123,
"list": [VehicleAlertHistoryBatteryVoltageHighLevelGap]
}
VehicleAlertHistoryCrash
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
confidence - Percent!
|
|
startTime - DateTime!
|
|
endTime - DateTime!
|
|
coordinates - Coordinates!
|
|
severity - Percent!
|
|
severityClassification - VehicleAlertCrashSeverity!
|
|
Example
{
"id": 4,
"occurence": 123,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"confidence": Percent,
"startTime": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"coordinates": Coordinates,
"severity": Percent,
"severityClassification": "UNKNOWN"
}
VehicleAlertHistoryCrashPaged
Description
Paginated vehicle_alert_history_crash results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryCrash!]!
|
Example
{
"next": 4,
"count": 987,
"list": [VehicleAlertHistoryCrash]
}
VehicleAlertHistoryDifferentVin
Description
VIN differs between onboarding and other sources
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
alternativeVin - String!
|
|
onboardingVin - String!
|
|
recordedAt - DateTime!
|
|
Example
{
"id": 4,
"occurence": 987,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"alternativeVin": "xyz789",
"onboardingVin": "abc123",
"recordedAt": "2007-12-03T10:15:30Z"
}
VehicleAlertHistoryDifferentVinPaged
Description
Paginated vehicle_alert_history_different_vin results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryDifferentVin!]!
|
Example
{
"next": "4",
"count": 987,
"list": [VehicleAlertHistoryDifferentVin]
}
VehicleAlertHistoryDtc
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
dtc - VehicleAlertDtcDtc
|
|
freezeFrames - DtcFreezeFrames
|
|
dtcStatus - VehicleAlertDtcStatus
|
|
Example
{
"id": "4",
"occurence": 987,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"dtc": VehicleAlertDtcDtc,
"freezeFrames": DtcFreezeFrames,
"dtcStatus": VehicleAlertDtcStatus
}
VehicleAlertHistoryDtcPaged
Description
Paginated vehicle_alert_history_dtc results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryDtc!]!
|
Example
{
"next": "4",
"count": 123,
"list": [VehicleAlertHistoryDtc]
}
VehicleAlertHistoryGeofencing
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
geofenceId - ID
|
|
description - String
|
|
label - String
|
|
state - GeofencingState
|
|
event - GeofencingEvent
|
|
startTime - DateTime
|
|
endTime - DateTime
|
|
coordinates - Coordinates
|
Use StartCoordinates |
startCoordinates - Coordinates
|
|
endCoordinates - Coordinates
|
|
Example
{
"id": 4,
"occurence": 123,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"geofenceId": "4",
"description": "abc123",
"label": "abc123",
"state": "UNKNOWN",
"event": "ENTRY",
"startTime": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"coordinates": Coordinates,
"startCoordinates": Coordinates,
"endCoordinates": Coordinates
}
VehicleAlertHistoryGeofencingPaged
Description
Paginated vehicle_alert_history_geofencing results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryGeofencing!]!
|
Example
{
"next": "4",
"count": 987,
"list": [VehicleAlertHistoryGeofencing]
}
VehicleAlertHistoryPlugUnplug
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
plug - VehicleAlertPlug
|
|
unplug - VehicleAlertUnplug
|
|
Example
{
"id": 4,
"occurence": 123,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"plug": VehicleAlertPlug,
"unplug": VehicleAlertUnplug
}
VehicleAlertHistoryPlugUnplugPaged
Description
Paginated vehicle_alert_history_plug_unplug results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryPlugUnplug!]!
|
Example
{
"next": 4,
"count": 123,
"list": [VehicleAlertHistoryPlugUnplug]
}
VehicleAlertHistoryUnknown
Description
Fallback for unexpected alert types
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
typeStr - String
|
|
content - Json
|
|
Example
{
"id": 4,
"occurence": 987,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"typeStr": "abc123",
"content": Json
}
VehicleAlertHistoryUnknownPaged
Description
Paginated vehicle_alert_history_unknown results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryUnknown!]!
|
Example
{
"next": 4,
"count": 123,
"list": [VehicleAlertHistoryUnknown]
}
VehicleAlertHistoryUpcomingMaintenance
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
criticality - MaintenanceCriticality!
|
|
distanceToNext - Int
|
|
timeToNext - Int
|
|
fromVehicle - Boolean!
|
|
mileageDeadline - Int
|
Mileage deadline (km) |
dateDeadline - DateTime
|
|
description - String!
|
|
system - MaintenanceSystem!
|
|
Example
{
"id": 4,
"occurence": 987,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"criticality": "LOW",
"distanceToNext": 987,
"timeToNext": 987,
"fromVehicle": false,
"mileageDeadline": 987,
"dateDeadline": "2007-12-03T10:15:30Z",
"description": "abc123",
"system": MaintenanceSystem
}
VehicleAlertHistoryUpcomingMaintenancePaged
Description
Paginated vehicle_alert_history_upcoming_maintenance results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryUpcomingMaintenance!]!
|
Example
{
"next": "4",
"count": 123,
"list": [VehicleAlertHistoryUpcomingMaintenance]
}
VehicleAlertHistoryWarningLight
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
occurence - Int!
|
|
lastReceived - DateTime!
|
|
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
name - String
|
|
code - String
|
|
description - String
|
|
extraInformation - String
|
|
level - AlertWarningLightLevel
|
|
isActive - Boolean
|
|
Example
{
"id": "4",
"occurence": 987,
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"aggregatedData": AggregatedData,
"name": "xyz789",
"code": "abc123",
"description": "abc123",
"extraInformation": "xyz789",
"level": "ADVISORY",
"isActive": true
}
VehicleAlertHistoryWarningLightPaged
Description
Paginated vehicle_alert_history_warning_light results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlertHistoryWarningLight!]!
|
Example
{
"next": 4,
"count": 123,
"list": [VehicleAlertHistoryWarningLight]
}
VehicleAlertNotification
Fields
| Field Name | Description |
|---|---|
vehicle - Vehicle
|
Vehicle |
alerts - [VehicleAlert!]
|
Example
{
"vehicle": Vehicle,
"alerts": [VehicleAlert]
}
VehicleAlertPaged
Description
Paginated vehicle_alert results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleAlert!]!
|
Example
{
"next": "4",
"count": 987,
"list": [VehicleAlert]
}
VehicleAlertPlug
Fields
| Field Name | Description |
|---|---|
mileage - Int
|
|
potential - Float
|
|
coordinates - Coordinates
|
Example
{
"mileage": 123,
"potential": 987.65,
"coordinates": Coordinates
}
VehicleAlertPlugUnplug
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
plug - VehicleAlertPlug
|
|
unplug - VehicleAlertUnplug
|
|
history - VehicleAlertHistoryPlugUnplugPaged
|
|
Example
{
"id": 4,
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "xyz789",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"plug": VehicleAlertPlug,
"unplug": VehicleAlertUnplug,
"history": VehicleAlertHistoryPlugUnplugPaged
}
VehicleAlertSort
Description
vehicle_alert sorting
Fields
| Input Field | Description |
|---|---|
by - VehicleAlertSortKey!
|
|
order - SortOrder!
|
Example
{"by": "ID", "order": "ASCENDING"}
VehicleAlertSortKey
Description
vehicle_alert sorting key
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
VehicleAlertSource
Description
Alert source
Values
| Enum Value | Description |
|---|---|
|
|
Alerts created by the device |
|
|
Alerts created by the user |
|
|
Unrecognized alert source |
Example
"DEVICE"
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
"ONGOING"
VehicleAlertStatusArg
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ONGOING"
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 |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
typeStr - String
|
|
content - Json
|
|
history - VehicleAlertHistoryUnknownPaged
|
|
Example
{
"id": "4",
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "abc123",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"typeStr": "abc123",
"content": Json,
"history": VehicleAlertHistoryUnknownPaged
}
VehicleAlertUnplug
Fields
| Field Name | Description |
|---|---|
duration - Int
|
|
mileage - Int
|
|
potential - Float
|
|
coordinates - Coordinates
|
Example
{
"duration": 123,
"mileage": 123,
"potential": 987.65,
"coordinates": Coordinates
}
VehicleAlertUpcomingMaintenance
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
criticality - MaintenanceCriticality!
|
|
distanceToNext - Int
|
|
timeToNext - Int
|
|
fromVehicle - Boolean!
|
|
mileageDeadline - Int
|
Mileage deadline (km) |
dateDeadline - DateTime
|
|
description - String!
|
|
system - MaintenanceSystem!
|
|
history - VehicleAlertHistoryUpcomingMaintenancePaged
|
|
Example
{
"id": 4,
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "abc123",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"criticality": "LOW",
"distanceToNext": 987,
"timeToNext": 123,
"fromVehicle": true,
"mileageDeadline": 123,
"dateDeadline": "2007-12-03T10:15:30Z",
"description": "xyz789",
"system": MaintenanceSystem,
"history": VehicleAlertHistoryUpcomingMaintenancePaged
}
VehicleAlertWarningLight
Fields
| Field Name | Description |
|---|---|
id - ID
|
Alert id (null in subscriptions) |
type - VehicleAlertType!
|
|
device - Device
|
Null if no permission |
vehicle - Vehicle
|
Null if no permission or no active device_vehicle_session |
icon - String!
|
|
lastReceived - DateTime!
|
Last time the alert was received |
lastReported - DateTime
|
Last time the alert was notified (null if not yet notified or not configured for notification) |
source - VehicleAlertSource!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
status - VehicleAlertStatus!
|
|
language - Lang
|
|
feedbackStatus - VehicleAlertFeedbackStatus!
|
|
feedbacks - VehicleAlertFeedbackPaged
|
Feedbacks for this alert |
Arguments
|
|
aggregatedData - AggregatedData
|
|
Arguments
|
|
name - String
|
|
code - String
|
|
description - String
|
|
extraInformation - String
|
|
level - AlertWarningLightLevel
|
|
isActive - Boolean
|
|
history - VehicleAlertHistoryWarningLightPaged
|
|
Example
{
"id": "4",
"type": "BAD_INSTALLATION",
"device": Device,
"vehicle": Vehicle,
"icon": "xyz789",
"lastReceived": "2007-12-03T10:15:30Z",
"lastReported": "2007-12-03T10:15:30Z",
"source": "DEVICE",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "ONGOING",
"language": "EN",
"feedbackStatus": "NO",
"feedbacks": VehicleAlertFeedbackPaged,
"aggregatedData": AggregatedData,
"name": "xyz789",
"code": "xyz789",
"description": "abc123",
"extraInformation": "xyz789",
"level": "ADVISORY",
"isActive": true,
"history": VehicleAlertHistoryWarningLightPaged
}
VehicleAlertsState
Fields
| Field Name | Description |
|---|---|
isPlugged - Boolean
|
Whether device is currently plugged in (null: no plug/unplug alert was received yet) |
severityIndex - Float!
|
Device severity index |
contactWorkshop - Boolean!
|
True if MIL is true and/or a CRITICAL or a WARNING DTC is currently active |
mil - Boolean
|
True when MIL warning W0031 and/or W0006 is currently active |
stateOfHealthLowVoltageLevel - StateOfHealthLowVoltageLevel
|
Most recent received state of health low voltage battery alert level |
openCircuitVoltage - Float
|
Most recent received ocv value |
activeCriticalDtcAlerts - Int!
|
|
activeDtcAlerts - Int!
|
|
activeInformationDtcAlerts - Int!
|
|
activeWarningDtcAlerts - Int!
|
|
activeWarningLightsAlerts - Int!
|
|
badInstallationAlerts - Int!
|
|
batteryAlerts - Int!
|
|
crashAlerts - Int!
|
|
intermittentDtcAlerts - Int!
|
|
plugUnplugAlerts - Int!
|
|
totalAlerts - Int!
|
|
upcomingMaintenances - Int!
|
|
lastBatteryDischargeAlert - DateTime
|
|
lastBatteryStateOfChargeAlert - DateTime
|
|
lastCrashAlert - DateTime
|
|
lastExcessiveCrankValleysAlert - DateTime
|
|
lastPlugUnplugAlert - DateTime
|
|
lastVoltageHighLevelGapAlert - DateTime
|
|
upcomingMaintenanceDate - DateTime
|
Closest upcoming maintenance date (null: device never received upcoming maintenance alert) |
upcomingMaintenanceMileage - Int
|
Closest upcoming maintenance mileage (null: device never received upcoming maintenance alert) |
Example
{
"isPlugged": false,
"severityIndex": 123.45,
"contactWorkshop": false,
"mil": true,
"stateOfHealthLowVoltageLevel": "UNKNOWN",
"openCircuitVoltage": 123.45,
"activeCriticalDtcAlerts": 987,
"activeDtcAlerts": 987,
"activeInformationDtcAlerts": 123,
"activeWarningDtcAlerts": 987,
"activeWarningLightsAlerts": 987,
"badInstallationAlerts": 123,
"batteryAlerts": 123,
"crashAlerts": 123,
"intermittentDtcAlerts": 123,
"plugUnplugAlerts": 123,
"totalAlerts": 123,
"upcomingMaintenances": 123,
"lastBatteryDischargeAlert": "2007-12-03T10:15:30Z",
"lastBatteryStateOfChargeAlert": "2007-12-03T10:15:30Z",
"lastCrashAlert": "2007-12-03T10:15:30Z",
"lastExcessiveCrankValleysAlert": "2007-12-03T10:15:30Z",
"lastPlugUnplugAlert": "2007-12-03T10:15:30Z",
"lastVoltageHighLevelGapAlert": "2007-12-03T10:15:30Z",
"upcomingMaintenanceDate": "2007-12-03T10:15:30Z",
"upcomingMaintenanceMileage": 987
}
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 |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Vehicle!]!
|
Example
{
"next": "4",
"count": 987,
"list": [Vehicle]
}
VehicleService
Description
Workshop vehicle service
Example
{
"id": 4,
"label": "xyz789",
"description": "abc123",
"workshops": WorkshopPaged
}
VehicleServicePaged
Description
Paginated vehicle_service results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleService!]!
|
Example
{"next": 4, "count": 987, "list": [VehicleService]}
VehicleSort
Description
vehicle sorting
Fields
| Input Field | Description |
|---|---|
by - VehicleSortKey!
|
|
order - SortOrder!
|
Example
{"by": "SEVERITY_INDEX", "order": "ASCENDING"}
VehicleSortKey
Description
vehicle sorting key
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SEVERITY_INDEX"
VehicleType
Description
Workshop vehicle type
Example
{
"id": 4,
"label": "xyz789",
"description": "xyz789",
"workshops": WorkshopPaged
}
VehicleTypeName
Values
| Enum Value | Description |
|---|---|
|
|
Car |
|
|
Truck |
|
|
Other |
|
|
Trailer |
|
|
Equipment |
|
|
Unpowered |
Example
"CAR"
VehicleTypePaged
Description
Paginated vehicle_type results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [VehicleType!]!
|
Example
{
"next": "4",
"count": 123,
"list": [VehicleType]
}
VinExtraInfo
Description
Extra vehicle info from other providers
Fields
| Field Name | Description |
|---|---|
obdPortPositions - [Int]
|
Position of OBD port |
needCable - Boolean
|
Whether vehicle needs a special fiat cable |
needMux - Boolean
|
Whether vehicle needs a hardware multiplexing cable |
fuelTypes - [EnergyType]
|
Supported fuel types |
tankSizes - [Int]
|
Fuel tanks sizes (l) |
Example
{
"obdPortPositions": [987],
"needCable": true,
"needMux": false,
"fuelTypes": ["OTHER"],
"tankSizes": [123]
}
WarningIcon
Example
{
"code": "abc123",
"name": "abc123",
"icon": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
WarningIconPaged
Description
Paginated warning_icon results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [WarningIcon!]!
|
Example
{
"next": "4",
"count": 987,
"list": [WarningIcon]
}
Weather
Description
Weather
Fields
| Field Name | Description |
|---|---|
type - WeatherType!
|
Weather type |
temperature - Float
|
Temperature |
description - String
|
Description |
Example
{
"type": "THUNDERSTORM_LIGHT_RAIN",
"temperature": 987.65,
"description": "abc123"
}
WeatherCoordinates
Description
Weather with coordinates
Example
{
"latitude": 123.45,
"longitude": 123.45,
"temperature": 123.45,
"time": "2007-12-03T10:15:30Z",
"weatherId": 987,
"weather": "xyz789"
}
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
"MONDAY"
Workday
Description
Worshop workday
Example
{
"id": "4",
"day": "MONDAY",
"openingHour1": "xyz789",
"closingHour1": "abc123",
"openingHour2": "abc123",
"closingHour2": "xyz789",
"workshop": Workshop
}
WorkdayPaged
Description
Paginated workday results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Workday!]!
|
Example
{"next": 4, "count": 987, "list": [Workday]}
Workshop
Description
Workshop
Fields
| Field Name | Description |
|---|---|
id - ID
|
Workshop id |
name - String
|
Workshop name |
code - String
|
Workshop code |
provider - String
|
Workshop provider |
providerWorkshopId - ID
|
Workshop provider id |
lat - Float
|
Workshop latitude |
lon - Float
|
Workshop longitude |
address - String
|
Workshop address |
postalCode - String
|
Workshop postal code |
province - String
|
Workshop province |
brand - String
|
Workshop brand |
city - String
|
Workshop city |
country - String
|
Workshop country |
phone - String
|
Workshop phone number |
internationalPhone - String
|
Workshop international phone number |
fax - String
|
Workshop fax |
email - String
|
Workshop email |
web - String
|
Workshop web |
language - Language
|
Workshop Language |
timeZone - String
|
Workshop Time zone |
icon - String
|
Workshop public url to icon |
averageStars - Float
|
Average stars of all ratings |
ratings - RatingPaged
|
Workshop ratings |
workdays - WorkdayPaged
|
Workshop workdays |
vehicleTypes - VehicleTypePaged
|
Workshop vehicle types |
vehicleServices - VehicleServicePaged
|
Workshop vehicle services |
driverServices - DriverServicePaged
|
Workshop driver services |
bookings - BookingPaged
|
Workshop bookings |
quotations - QuotationPaged
|
Workshop quotations |
managers - WorkshopManagerPaged
|
Workshop managers |
Example
{
"id": 4,
"name": "abc123",
"code": "abc123",
"provider": "abc123",
"providerWorkshopId": 4,
"lat": 123.45,
"lon": 987.65,
"address": "xyz789",
"postalCode": "abc123",
"province": "abc123",
"brand": "xyz789",
"city": "xyz789",
"country": "abc123",
"phone": "abc123",
"internationalPhone": "abc123",
"fax": "xyz789",
"email": "xyz789",
"web": "abc123",
"language": Language,
"timeZone": "xyz789",
"icon": "xyz789",
"averageStars": 123.45,
"ratings": RatingPaged,
"workdays": WorkdayPaged,
"vehicleTypes": VehicleTypePaged,
"vehicleServices": VehicleServicePaged,
"driverServices": DriverServicePaged,
"bookings": BookingPaged,
"quotations": QuotationPaged,
"managers": WorkshopManagerPaged
}
WorkshopContactMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SMS"
WorkshopManager
WorkshopManagerPaged
Description
Paginated workshop_manager results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [WorkshopManager!]!
|
Example
{
"next": "4",
"count": 123,
"list": [WorkshopManager]
}
WorkshopPaged
Description
Paginated workshop results
Fields
| Field Name | Description |
|---|---|
next - ID
|
|
count - Int
|
|
list - [Workshop!]!
|
Example
{"next": 4, "count": 987, "list": [Workshop]}