VehicleService Resource

A set of endpoints that concerns a vehicle.

GET /v1/vehicle/info

The service returns general vehicle information (see VehicleInfo) for the provided VINs. If no VINs are provided, the service returns information for all vehicles the requesting user has access to.

Request Parameters
name type description multivalued
auth-token header The authentication token. no
vins query The VINs of interest. Can be omitted. yes
Response Body
media type data type description
application/json array of VehicleInfo (JSON) An array of VehicleInfo

Example

Request
GET /v1/vehicle/info
Content-Type: application/json
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "vin" : "...",
  "wcu-id" : "...",
  "wcu-connected" : 12345,
  "wcu-disconnected" : 12345
} ]

POST /v1/vehicle/info

The service returns general vehicle information (see VehicleInfo) for the provided VINs. If no VINs are provided, the service returns information for all vehicles the requesting user has access to.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type
application/json array of string (JSON)
Response Body
media type data type description
application/json array of VehicleInfo (JSON) An array of VehicleInfo

Example

Request
POST /v1/vehicle/info
Content-Type: application/json
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "vin" : "...",
  "wcu-id" : "...",
  "wcu-connected" : 12345,
  "wcu-disconnected" : 12345
} ]

GET /v1/vehicle/labels

This method has been deprecated. Use GET VehicleService

This service returns the labels associated with a certain vehicle identified by its VIN number.

Request Parameters
name type description constraints
auth-token header The authentication token.  
include_private_labels query Set to 'true' to include any private labels set by the current user. Defaults to false. boolean
vin query The vehicle's VIN number of interest.  
Response Body
media type data type description
application/json array of string (JSON) The labels associated with the vehicle associated with the given VIN.

Example

Request
GET /?vin=abc123
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/vehicle/plate

This service returns the plate number of the vehicle connected to the WCU with the given WCU ID.

Request Parameters
name type description
auth-token header The authentication token.
wcu_id query The WCU's ID of interest.
Response Codes
code condition
400 Parameter 'wcu_id' have to be included.
Response Body
media type data type description
application/json string (JSON) The plate number of the vehicle connected to the WCU.

Example

Request
GET /?wcu_id=00-AA-BB-CC-01
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/vehicle/vin

This service returns the VIN of the vehicle connected to the WCU with the given WCU ID.

Request Parameters
name type description
auth-token header The authentication token.
wcu_id query The WCU's ID of interest.
Response Codes
code condition
400 Parameter 'wcu_id' have to be included.
Response Body
media type data type description
application/json string (JSON) The VIN of the vehicle connected to the WCU.

Example

Request
GET /?wcu_id=00-AA-BB-CC-01
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/vehicle/wcu

The service returns the WCU ID of the WCU connected to the vehicle with the given VIN number.

Request Parameters
name type description
auth-token header The authentication token.
vin query The vehicle's VIN number of interest.
Response Codes
code condition
400 Parameter 'vin' have to be included.
Response Body
media type data type description
application/json string (JSON) The WCU ID or an empty string if no WCU is connected to the vehicle.

Example

Request
GET /?vin=abc123
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/vehicle/label/{label}

The service returns a list of Vehicles associated with the given label. The label needs to be associtated with the car. If the label is only associated with the WCU the vehicle will not be in the results.
Example call:

v1/vehicle/label/labelName
This will get you the data for all vehicles associated with the label "labelName"

Request Parameters
name type description constraints
auth-token header The authentication token.  
label path The vehicle's label of interest required
Response Body
media type data type description
application/vnd.se.alkit.wice.vehiclelabelsearch-v1+json array of Vehicle (JSON)

Example

Request
GET /v1/vehicle/label/{label}
Content-Type: */*
Accept: application/vnd.se.alkit.wice.vehiclelabelsearch-v1+json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.se.alkit.wice.vehiclelabelsearch-v1+json

                
[ {
  "description" : "...",
  "regNr" : "...",
  "vin" : "...",
  "active" : true,
  "creationDate" : "...",
  "protoNumber" : "...",
  "tsu" : "...",
  "project" : "...",
  "series" : "..."
} ]

GET /v1/vehicle/labels/{vin}

Get the current labels of the vehicle.

Request Parameters
name type description default constraints
auth-token header The authentication token.    
vin path The VIN of the vehicle.    
include_private_labels query Any private labels should be included. Default is true. true boolean
Response Body
media type data type description
application/json array of Label (JSON) The current labels on the vehicle.

Example

Request
GET /v1/vehicle/labels/{vin}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "label" : "...",
  "value" : "...",
  "global" : true
} ]

PUT /v1/vehicle/labels/{vin}

Sets (appends) the provided LabelModels to the provided vehicle. A label can be associated with a vehicle without having a value set. The value of an already associated label can be updated by setting setting the label again with a new value. To clear a value, set the label without a value. The provided labels are appended to the list of current labels of the vehicle.

Request Parameters
name type description
auth-token header The authentication token.
vin path The VIN of the vehicle.
Request Body
media type data type description
application/json array of Label (JSON) The labels to set.
Response Body
media type data type description
application/json array of Label (JSON) The current labels (including private) on the vehicle after this change.

Example

Request
PUT /v1/vehicle/labels/{vin}
Content-Type: application/json
Accept: application/json
auth-token: ...

                
[ {
  "label" : "...",
  "value" : "...",
  "global" : true
} ]
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
[ {
  "label" : "...",
  "value" : "...",
  "global" : true
} ]

GET /v1/vehicle/plate/{plate}

The service returns information associated with a certain vehicle identified by its plate number.
Example call:

v1/vehicle/plate/dys119
This will get you the data for a vehicle with plate number dys119

Request Parameters
name type description constraints
auth-token header The authentication token.  
plate path The vehicle's plate number of interest. required
Response Body
media type data type description
application/vnd.se.alkit.wice.vehiclelabelsearch-v1+json Vehicle (JSON)

Example

Request
GET /v1/vehicle/plate/{plate}
Content-Type: */*
Accept: application/vnd.se.alkit.wice.vehiclelabelsearch-v1+json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.se.alkit.wice.vehiclelabelsearch-v1+json

                
{
  "description" : "...",
  "regNr" : "...",
  "vin" : "...",
  "active" : true,
  "creationDate" : "...",
  "protoNumber" : "...",
  "tsu" : "...",
  "project" : "...",
  "series" : "..."
}

GET /v1/vehicle/position/wcu

Request Parameters
name type description constraints
auth-token header The authentication token.  
from query required int
limit query required int
page query required int
to query required int
wcu-id query  
Response Body
media type data type description
application/json PositionSearchResults (JSON)

Example

Request
GET /v1/vehicle/position/wcu
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "positions" : [ {
    "latitude" : 12345.0,
    "when" : 12345,
    "longitude" : 12345.0,
    "speed" : 12345.0
  }, {
    "latitude" : 12345.0,
    "when" : 12345,
    "longitude" : 12345.0,
    "speed" : 12345.0
  } ],
  "results" : 12345,
  "limit" : 12345,
  "offset" : 12345,
  "to" : 12345,
  "from" : 12345
}

POST /v1/vehicle/search/vins

This service returns a list of VIN numbers mathing the provided LabelSearch object.
Note! All labels in the LabelSearch objects need to exist in the system, otherwise a 404 is returned.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type description
application/json LabelSearch (JSON) The search criteria
Response Codes
code condition
404 Label does not exist.
Response Body
media type data type description
application/json array of string (JSON) The VIN numbers matching the search criteria.

Example

Request
POST /v1/vehicle/search/vins
Content-Type: application/json
Accept: application/json
auth-token: ...

                
{
  "operator" : "and",
  "criteria" : [ {
    "label" : "label1"
  }, {
    "operator" : "or",
    "criteria" : [ {
      "label" : "label2"
    }, {
      "label" : "label3"
    } ]
  } ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /v1/vehicle/vin/{vin}

The service returns information associated with a certain vehicle identified by its VIN number.
Example call:

v1/vehicle/vin/yv1uy347864kj43987hj
This will get you the data for a vehicle with VIN yv1uy347864kj43987hj

Request Parameters
name type description constraints
auth-token header The authentication token.  
vin path The vehicle's VIN number of interest. required
Request Body
media type data type description
application/json object (JSON) The service returns information associated with a certain vehicle identified by its VIN number.
Example call:
v1/vehicle/vin/yv1uy347864kj43987hj
This will get you the data for a vehicle with VIN yv1uy347864kj43987hj
Response Body
media type data type description
application/vnd.se.alkit.wice.vehiclelabelsearch-v1+json Vehicle (JSON)

Example

Request
GET /v1/vehicle/vin/{vin}
Content-Type: application/json
Accept: application/vnd.se.alkit.wice.vehiclelabelsearch-v1+json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.se.alkit.wice.vehiclelabelsearch-v1+json

                
{
  "description" : "...",
  "regNr" : "...",
  "vin" : "...",
  "active" : true,
  "creationDate" : "...",
  "protoNumber" : "...",
  "tsu" : "...",
  "project" : "...",
  "series" : "..."
}

GET /v1/vehicle/wcu/comment

This is a sevice to get the comment for a WCU provided its WCU ID

Request Parameters
name type description
auth-token header The authentication token.
wcu-id query The WCU ID of interest
Response Codes
code condition
400 Parameter 'wcu-id' have to be included
Response Body
media type data type description
text/plain string

Example

Request
GET /v1/vehicle/wcu/comment
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

CURL request

Get comment

curl --location --request GET \
--header 'Content-Type:text/plain' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
https://wice.alkit.se/m2m/v1/vehicle/wcu/comment?wcu-id=m2m_wcu_2_53_1

POST /v1/vehicle/wcu/comment

This is a sevice to add a new comment to the existing WCU comment provided its WCU ID

Request Parameters
name type description
auth-token header The authentication token.
wcu-id query The WCU ID of interest
Request Body
media type data type description
text/plain string Comment to add.
Response Codes
code condition
400 Parameter 'wcu-id' and 'comment' have to be included
Response Body
media type data type description
application/json object (JSON) An empty json

Example

Request
POST /v1/vehicle/wcu/comment
Content-Type: text/plain
Accept: application/json
auth-token: ...

                
comment to add
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

CURL request

Add comment

curl --location --request POST \
--header 'Content-Type:text/plain' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--data 'New comment' \
https://wice.alkit.se/m2m/v1/vehicle/wcu/comment?wcu-id=m2m_wcu_2_53_1

PUT /v1/vehicle/wcu/comment

Sets the comment for the provided WCU. The current comment will be replaced with the new comment. Provide an empty comment to delete the current comment for the WCU.

Request Parameters
name type description
auth-token header The authentication token.
wcu-id query The WCU ID of interest
Request Body
media type data type description
text/plain string Comment to set. May be empty to delete the current comment.

Example

Request
PUT /v1/vehicle/wcu/comment
Content-Type: text/plain
auth-token: ...

                
comment to set
Response
HTTP/1.1 204 No Content

CURL request

Add comment

curl --location --request PUT \
--header 'Content-Type:text/plain' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--data 'New comment' \
https://wice.alkit.se/m2m/v1/vehicle/wcu/comment?wcu-id=wcu-123

GET /v1/vehicle/wcu/connected

If the vehicle with the given VIN number is connected to a WCU, this service returns the number of minutes since the WCU communicated with the portal

Request Parameters
name type description
auth-token header The authentication token.
vin query The vehicle's VIN number of interest.
Response Codes
code condition
400 Parameter 'vin' have to be included.
Response Body
media type data type description
application/json number (JSON) The number of minutes since the WCU communicated with the portal.

Example

Request
GET /?vin=abc123
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/vehicle/wcu/info

The service returns general WCU information (see WCUInfo) for the provided WCU IDs. If no WCU IDs are provided, the service returns information for all WCUs the requesting user has access to.

Request Parameters
name type description default constraints multivalued
auth-token header The authentication token.     no
include_inactive query false boolean no
wcu_ids query The WCU IDs of interest. Can be omitted.     yes
Response Body
media type data type description
application/json array of WCUInfo (JSON) An array of VehicleInfo

Example

Request
GET /v1/vehicle/wcu/info
Content-Type: application/json
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "wcu-id" : "...",
  "vin" : "...",
  "vehicle-connected" : 12345,
  "vehicle-disconnected" : 12345,
  "platform-type" : "...",
  "platform-sub-type" : "...",
  "last-connected" : 12345,
  "last-uploaded" : 12345,
  "last-weeks-uptime" : 12345,
  "resource-group" : "...",
  "is-active" : true,
  "certificate-data" : {
    "expiry-date" : "2023-06-23T06:26:08Z",
    "fingerprint" : "SHA1.Fingerprint=2aae6c35c94fcfb415dbe95f408b9ce91ee846ed"
  },
  "number-of-vehicles" : 2,
  "number-of-finalized-refurbish" : 1,
  "wice-registration-date" : "2023-12-07T13:57:43Z",
  "iccdid" : "891004234814455936F"
} ]

GET /v1/vehicle/wcu/name

The service returns the 'WCU name' of the WCU connected to the vehicle with the given VIN number.

Request Parameters
name type description
auth-token header The authentication token.
vin query The vehicle's VIN number of interest.
Response Codes
code condition
400 Parameter 'vin' have to be included.
Response Body
media type data type description
application/json string (JSON) The 'WCU name' or an empty string if no WCU is connected to the vehicle.

Example

Request
GET /?vin=abc123
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /v1/vehicle/wcu/shelve

This service shelves the WCU with the provided WCU ID.

Request Parameters
name type description
auth-token header The authentication token.
label_value query Optional shelved label value
wcu-id query The WCU ID of interest
Response Codes
code condition
400 Parameter 'wcu-id"' have to be included
400 If shelving already is in progress for the provided WCU ID.
401 You are not permitted to perform shelving.
Response Body
media type data type description
application/json object (JSON)

Example

Request
POST /v1/vehicle/wcu/shelve
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /v1/vehicle/wcu/software_version

If the vehicle with the given VIN number is connected to a WCU, this service returns the software version of the WCU.

Request Parameters
name type description
auth-token header The authentication token.
vin query The vehicle's VIN number of interest.
Response Codes
code condition
400 Parameter 'vin' have to be included.
Response Body
media type data type description
application/json string (JSON) The software version of the WCU connected to the vehicle.

Example

Request
GET /?vin=abc123
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/vehicle/wcu/state

This service returns the shelving state of the WCU provided its WCU ID

Request Parameters
name type description
auth-token header The authentication token.
wcu_id query The WCU ID of interest
Response Codes
code condition
400 Parameter 'wcu_id' have to be included.
Response Body
media type data type description
application/json WcuState (JSON) The WCU state of type WcuState

Example

Request
GET /?wcu_id=00-AA-BB-CC-01
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
"IN_OPERATION"

POST /v1/vehicle/wcu/unshelve

This service unshelves the WCU with the provided WCU ID. If the provided WCU already is unshelved, nothing happens

Request Parameters
name type description
auth-token header The authentication token.
wcu-id query The WCU ID of interest
Response Codes
code condition
400 Parameter 'wcu-id"' have to be included
Response Body
media type data type description
application/json object (JSON)

Example

Request
POST /v1/vehicle/wcu/unshelve
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /v1/vehicle/{vin}/comment

This is a service to get the comment for a vehicle provided its vin

Request Parameters
name type description
auth-token header The authentication token.
vin path The VIN of interest
Response Codes
code condition
400 Parameter 'vin' have to be included
404 The vehicle with the provided VIN was not found
Response Body
media type data type description
text/plain string

Example

Request
GET /v1/vehicle/{vin}/comment
Content-Type: */*
Accept: text/plain
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...

PUT /v1/vehicle/{vin}/comment

Sets the comment for the provided VIN. The current comment will be replaced with the new comment. Provide an empty comment to delete the current comment for the vehicle.

Request Parameters
name type description constraints
auth-token header The authentication token.  
vin path The vin of interest required
Request Body
media type data type description
text/plain string Comment to set. May be empty to delete the current comment.
Response Codes
code condition
404 The vehicle with the provided VIN was not found
Response Body
media type data type description
application/json object (JSON)

Example

Request
PUT /v1/vehicle/{vin}/comment
Content-Type: text/plain
Accept: application/json
auth-token: ...

                
comment to set
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

CURL request

Add comment

curl --location --request PUT \
--header 'Content-Type:text/plain' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--data 'New comment' \
https://wice.alkit.se/m2m/v1/vehicle/{vin}/comment

PUT /v1/vehicle/{vin}/plate

This service updates the plate number of the vehicle with the given VIN.

Request Parameters
name type description constraints
auth-token header The authentication token.  
vin path The VIN ID of interest. required
Request Body
media type data type description
text/plain string The value of the new plate number.
Response Codes
code condition
400 Parameter 'wcu_id' have to be included.
400 Parameter 'plate' have to be included.
Response Body
media type data type description
application/json object (JSON)

Example

Request
PUT /v1/vehicle/{vin}/plate
Content-Type: text/plain
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /v1/vehicle/connected/car/{vin}

The service returns the time when the car last communicated with the back-end services. The response is a simple UNIX timestamp.

Request Parameters
name type description constraints
auth-token header The authentication token.  
vin path The VIN (YV1229836563) that identifies the car. required
Response Codes
code condition
404 The WCU which the car is connected to was not found.
404 The car is not connected to any WCU.
Response Body
media type data type description
application/json number (JSON) A UNIX timestamp denoting the time when the car last communicated with the back-end.

Example

Request
GET /v1/vehicle/connected/car/{vin}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /v1/vehicle/connected/now/cars

The service returns all the VINs in the provided list of VINs that satifies the "is connected" criteria. A vehicle is considered as connected if it communicated with the backend services less than 2 minutes ago.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type description
application/json array of string (JSON) The VINs of interest. If empty, all VINs (that satisfies the criteria) the current user has access to will be returned.
Response Body
media type data type description
application/json array of string (JSON) The connected VINs.

Example

Request
POST /v1/vehicle/connected/now/cars
Content-Type: application/json
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

CURL request

Two

curl --location --request POST \
--header 'Content-Type:application/json' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--data '[ "m2m_car_1", "m2m_car_2" ]' \
https://wice.alkit.se/m2m/v1/vehicle/connected/now/cars

CURL request

All

curl --location --request POST \
--header 'Content-Type:application/json' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
https://wice.alkit.se/m2m/v1/vehicle/connected/now/cars

POST /v1/vehicle/connected/value/cars

The service returns the time in minutes since the car last communicated with the backend services.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type description
application/json array of string (JSON) The VINs of interest. If empty, all VINs the current user has access to will be returned.
Response Body
media type data type description
application/json array of CarConnectedValue (JSON) The connected values for the provided VIN.

Example

Request
POST /v1/vehicle/connected/value/cars
Content-Type: application/json
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "vin" : "...",
  "connected_value" : 12345
} ]

GET /v1/vehicle/connected/wcu/{wcu_id}

The service returns the time when the WCU last communicated with the back-end services. The response is a simple UNIX timestamp.

Request Parameters
name type description constraints
auth-token header The authentication token.  
wcu_id path The WCU ID (00-00-00-00-00-00) that identifies the WCU. required
Response Codes
code condition
404 The WCU was not found.
Response Body
media type data type description
application/json number (JSON) A UNIX timestamp denoting the time when the WCU last communicated with the back-end.

Example

Request
GET /v1/vehicle/connected/wcu/{wcu_id}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/vehicle/diagnostics/{vin}/signaling-synchronous-diagnostic-session

Returns whether the vehicle identified by the VIN is signaling a synchronous diagnostic session.

The vehicle is supposed to signal a synchronous diagnostic sessions if it is configured to signal a synchronous diagnostic session (GET VehicleService returns true) and the vehicle has communicated with the WICE system after the PUT VehicleService was called.

Request Parameters
name type description constraints
auth-token header The authentication token.  
vin path The VIN that identifies the vehicle. required
Response Codes
code condition
400 VIN not supplied.
404 The vehicle could not be found.
401 No access to the vehicle.
Response Body
media type data type description
application/json boolean (JSON) true if the vehicle has an active session, false otherwise.

Example

Request
GET /v1/vehicle/diagnostics/{vin}/signaling-synchronous-diagnostic-session
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/vehicle/diagnostics/{vin}/synchronous-diagnostic-session

Returns whether the vehicle identified by the VIN is configured to signal a synchronous diagnostic session.

Request Parameters
name type description constraints
auth-token header The authentication token.  
vin path The VIN that identifies the vehicle. required
Response Codes
code condition
400 VIN not supplied.
404 The vehicle could not be found.
401 No access to the vehicle.
Response Body
media type data type description
application/json boolean (JSON) true if preparing is set, false otherwise.

Example

Request
GET /v1/vehicle/diagnostics/{vin}/synchronous-diagnostic-session
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/vehicle/history/car/{vin}

This service returns a list of resource connection events for the vehicle identified by the provided VIN number.

Request Parameters
name type description constraints
auth-token header The authentication token.  
vin path The vehicle's VIN number of interest. required
include_disconnection query Whether all disconnection events should be included in the results. If the most recent event is a disconnect event, this event will always be included. Default is false. boolean
use_plate query If the resource in the response is a car and there exists a plate no for the car, set parameter to true to get the plate no. Default is false, i.e. only respond with VIN. boolean
Response Body
media type data type description
application/json array of ResourceConnectionEvent (JSON) All resource connection events for the given VIN sorted by descending date (latest first).

Example

Request
GET /v1/vehicle/history/car/{vin}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "resource" : "...",
  "date" : 12345,
  "type" : "DISCONNECTED"
} ]

GET /v1/vehicle/history/wcu/{wcu-id}

This service returns a list of resource connection events for the WCU identified by the provided WCU ID.

Request Parameters
name type description constraints
auth-token header The authentication token.  
wcu-id path The WCU's ID of interest. required
include_disconnection query Whether all disconnection events should be included in the results. If the most recent event is a disconnect event, this event will always be included. Default is false. boolean
use_plate query If the resource in the response is a car and there exists a plate no for the car, set parameter to true to get the plate no. Default is false, i.e. only respond with VIN. boolean
Response Body
media type data type description
application/json array of ResourceConnectionEvent (JSON) All resource connection events for the given WCU ID sorted by descending date (latest first).

Example

Request
GET /v1/vehicle/history/wcu/{wcu-id}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "resource" : "...",
  "date" : 12345,
  "type" : "CONNECTED"
} ]

PUT /v1/vehicle/labels/{vin}/remove

Removes the provided labels from the vehicle. Any value set to the provided label is ignored. To only remove the value from a label associated with a vehicle, use PUT VehicleService.

Request Parameters
name type description
auth-token header The authentication token.
vin path The VIN of the vehicle.
Request Body
media type data type description
application/json array of Label (JSON) The labels to remove.
Response Body
media type data type description
application/json array of Label (JSON) The current labels (including private) on the vehicle after this change.

Example

Request
PUT /v1/vehicle/labels/{vin}/remove
Content-Type: application/json
Accept: application/json
auth-token: ...

                
[ {
  "label" : "...",
  "value" : "...",
  "global" : true
} ]
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
[ {
  "label" : "...",
  "value" : "...",
  "global" : true
} ]

GET /v1/vehicle/last_upload/car/{vin}

The service returns the time when the WCU last uploaded measurement result data. The response is a simple UNIX timestamp.

Request Parameters
name type description constraints
auth-token header The authentication token.  
vin path The VIN (YV1333399836) that identifies the car. required
Response Codes
code condition
404 The WCU which the car is connected to was not found.
404 The car is not connected to any WCU.
Response Body
media type data type description
application/json number (JSON) A UNIX timestamp denoting the time when the car last uploaded measurement result data.

Example

Request
GET /v1/vehicle/last_upload/car/{vin}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/vehicle/last_upload/wcu/{wcu_id}

The service returns the time when the WCU last uploaded measurement result data. The response is a simple UNIX timestamp.

Request Parameters
name type description constraints
auth-token header The authentication token.  
wcu_id path The WCU ID (00-00-00-00-00-00) that identifies the WCU. required
Response Codes
code condition
404 The WCU was not found.
Response Body
media type data type description
application/json number (JSON) A UNIX timestamp denoting the time when the WCU last uploaded measurement result data.

Example

Request
GET /v1/vehicle/last_upload/wcu/{wcu_id}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/vehicle/position/car/{vin}

The service returns the latest position for the vehicle identifed by the provided VIN.

Request Parameters
name type description constraints
auth-token header The authentication token.  
vin path The VIN that identifies the vehicle. required
Response Codes
code condition
404 The position was not found.
412 The vehicle needs to be connected to a WCU.
Response Body
media type data type description
application/json VehiclePosition (JSON) The position for the vehicle.

Example

Request
GET /v1/vehicle/position/car/{vin}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "lastConnected" : 12345,
  "vin" : "...",
  "wcu-id" : "...",
  "latitude" : 12345.0,
  "when" : 12345,
  "longitude" : 12345.0,
  "speed" : 12345.0
}

GET /v1/vehicle/position/wcu/{wcu-id}

This service returns the latest position for the vehicle identified by the provided WCU ID.

Request Parameters
name type description constraints
auth-token header The authentication token.  
wcu-id path The wcu ID that identifies the vehicle. required
Response Codes
code condition
404 The position was not found.
Response Body
media type data type description
application/json VehiclePosition (JSON) The position for the vehicle.

Example

Request
GET /v1/vehicle/position/wcu/{wcu-id}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "lastConnected" : 12345,
  "vin" : "...",
  "wcu-id" : "...",
  "latitude" : 12345.0,
  "when" : 12345,
  "longitude" : 12345.0,
  "speed" : 12345.0
}

POST /v1/vehicle/search/vins/matching

This service returns a list of VINs matching the given LabelMatch object. All labels included in the LabelMatch#getLabelCriteria() list need to exist. Any value provided to each LabelModel are treated as regular expression.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type description
application/json LabelMatch (JSON) The label match object.
Response Codes
code condition
400 If no labels are set to the LabelMatch object.
412 If any of the provided labels do not exist in the system.
Response Body
media type data type description
application/json array of VinLabelAssociation (JSON)

Example

Request
POST /v1/vehicle/search/vins/matching
Content-Type: application/json
Accept: application/json
auth-token: ...

                
{
  "matchOperator" : "ALL",
  "labelCriteria" : [ {
    "label" : "...",
    "value" : "...",
    "global" : true
  }, {
    "label" : "...",
    "value" : "...",
    "global" : true
  } ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "vin" : "...",
  "labels-with-values" : [ {
    "label" : "...",
    "value" : "...",
    "global" : true
  }, {
    "label" : "...",
    "value" : "...",
    "global" : true
  } ]
} ]

POST /v1/vehicle/wcu/module/gps

Enable/disable the GPS module for the specified WCU.

Request Parameters
name type description constraints
auth-token header The authentication token.  
state query Enable/disable the GPS module. required boolean
wcu-id query The WCU ID of interest  
Response Codes
code condition
400 Parameter 'wcu-id"' have to be included
401 You are not permitted to change the GPS module state.
Response Body
media type data type description
application/json object (JSON)

Example

Request
POST /v1/vehicle/wcu/module/gps
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /v1/vehicle/wcu/refurbish/finalize

This service finalizes the refurbish process for the WCU with the provided WCU ID and adds a comment, if provided. If the WCU does not meet the prerequisites for this operation and force is set to false, the operation will not go through. If force is set to true the WCU is set to meet the prerequisites and refurbish is finalized.

Request Parameters
name type description constraints
auth-token header The authentication token.  
force query Can be null, default true boolean
wcu-id query The WCU ID of interest  
Request Body
media type data type description
application/json string (JSON) Comment to add to the WCU description
Response Codes
code condition
400 Parameter 'wcu-id' have to be included
Response Body
media type data type description
application/json object (JSON)

Example

Request
POST /v1/vehicle/wcu/refurbish/finalize
Content-Type: application/json
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /v1/vehicle/wcu/refurbish/initiate

This service initiates the refurbish process for the WCU with the provided WCU ID and adds a comment, if provided. If the WCU does not meet the prerequisites for this operation and force is set to false, the operation will not go through. If force is set to true the WCU is set to meet the prerequisites and refurbish is initiated.

Request Parameters
name type description constraints
auth-token header The authentication token.  
force query Can be null, default true boolean
wcu-id query The WCU ID of interest  
Request Body
media type data type description
application/json string (JSON) Comment to add to the WCU description
Response Codes
code condition
400 Parameter 'wcu-id' have to be included
Response Body
media type data type description
application/json object (JSON)

Example

Request
POST /v1/vehicle/wcu/refurbish/initiate
Content-Type: application/json
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /v1/vehicle/wcu/{object_id}/id

The service returns the id of the wcu identified by the provided object id.
See here for more info: WCU

Request Parameters
name type description constraints
auth-token header The authentication token.  
object_id path The object id that identifies the wcu required int
Response Codes
code condition
400 The wcu object id is not valid.
404 The wcu was not found.
Response Body
media type data type description
application/json string (JSON) The wcu id

Example

Request
GET /v1/vehicle/wcu/{object_id}/id
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/vehicle/wcu/{wcu_id}/assignment

This service returns the assignments found on the WCU as a list of task IDs.
The type of the assignments can be looked up via GET TaskService

Request Parameters
name type description constraints
auth-token header The authentication token.  
wcu_id path The WCU ID (00-00-00-00-00-00) that identifies the WCU. required
status query Optional. See StatusType. Default is StatusType#running. If provided, only assignments with the provided status are returned. "error" or "pending" or "running" or "stop_pending" or "stopped" or "warning"
type query Optional. If provided, only assignments of this type are returned. "arcos" or "area5" or "audio" or "blue_pirat" or "canrecorder" or "dlt" or "etas" or "ethernet_capture" or "file_fetcher" or "idc" or "ipemotionrt" or "lpd" or "mcdhub" or "mlog" or "mqtt" or "rp" or "shub" or "signal_reader" or "smart_eye" or "soh" or "swdl" or "video"
Response Codes
code condition
400 If the WCU is not provided or type/status are provided in an incorrect format.
404 The WCU was not found.
Response Body
media type data type description
application/json array of number (JSON)

Example

Request
GET /v1/vehicle/wcu/{wcu_id}/assignment
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /v1/vehicle/diagnostics/{vin}/synchronous-diagnostic-session/disable

Tells the vehicle identified by the WCU ID to stop signal a synchronous diagnostic session. The WCU connected to the vehicles needs to run WCU software version 2.54.0 or above.

Request Parameters
name type description constraints
auth-token header The authentication token.  
vin path The WCU ID that identifies the vehicle. required
Response Codes
code condition
202 The vehicle will stop signal a synchronous diagnostic session.
400 VIN not supplied.
404 The vehicle could not be found.
401 No access to the vehicle.
412 The vehicle is not conneced to a WCU or the WCUs software version is too old.
Response Body
media type data type description
application/json object (JSON)

Example

Request
PUT /v1/vehicle/diagnostics/{vin}/synchronous-diagnostic-session/disable
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 202 Accepted
Content-Type: application/json

                
...

PUT /v1/vehicle/diagnostics/{vin}/synchronous-diagnostic-session/enable

Prepares the vehicle identified by the VIN to signal a synchronous diagnostic session. The WCU connected to the vehicles needs to run WCU software version 2.54.0 or above.

Request Parameters
name type description constraints
auth-token header The authentication token.  
vin path The VIN that identifies the vehicle. required
Response Codes
code condition
202 The vehicle will prepare for signaling a synchronous diagnostic session.
400 VIN not supplied.
404 The vehicle could not be found.
401 No access to the vehicle.
412 The vehicle is not conneced to a WCU or the WCUs software version is too old.
Response Body
media type data type description
application/json object (JSON)

Example

Request
PUT /v1/vehicle/diagnostics/{vin}/synchronous-diagnostic-session/enable
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 202 Accepted
Content-Type: application/json

                
...