VehicleProfileService Resource

A set of services related to vehicle profiles.

GET /v1/vehicle/profile/list

Request Parameters
name type description default constraints
auth-token header The authentication token.    
limit query 25 int
name query    
offset query 0 int
Response Body
media type data type description
application/json VehicleProfileResult (JSON)

Example

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

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

                
{
  "count" : 10,
  "offset" : 0,
  "limit" : 25
}

GET /v1/vehicle/profile/{id}

Look up the VehicleProfile for the provided vehicle profile id.

Request Parameters
name type description constraints
auth-token header The authentication token.  
id path required int
Response Body
media type data type description
application/json VehicleProfile (JSON)

Example

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

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

                
{
  "id" : 12345,
  "name" : "...",
  "diagnosticReferenceID" : 12345
}

GET /v1/vehicle/profile/description-files/a2l

Get available A2L files with the option to filter files of a specific name.

Request Parameters
name type description default constraints
auth-token header The authentication token.    
limit query 25 int
name query Any name of interest. Treated as a regular expression.    
offset query 0 int
Response Body
media type data type description
application/json VehicleDescriptionFileResultOfA2LDescriptionFile (JSON)

Example

Request
GET /v1/vehicle/profile/description-files/a2l
Content-Type: */*
Accept: application/json
auth-token: ...

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

                
{
  "results" : {
    "name" : "...",
    "id" : 12345,
    "type" : "A2L",
    "comment" : "...",
    "enabled" : true,
    "version" : "..."
  },
  "count" : 10,
  "offset" : 0,
  "limit" : 25
}

POST /v1/vehicle/profile/description-files/a2l

Upload a new A2L file. Properties for the file are provided via the 'attributes' parameter.
It is also possible to upload multiple a2l files via a zip archive. In this case, the 'name' attribute will be replaced by the file name for each a2l file in the archive.

Request Parameters
name type description
attributes formdata Attributes for the uploaded file. Required attributes are 'ecu-name' and 'name'. See A2LDescriptionFile.
file formdata The A2L file to upload.
auth-token header The authentication token.
Request Body
media type data type
multipart/form-data (custom)
Response Codes
code condition
400 If 'ecu-name' or 'name' is empty.
400 If no a2l file is provided.
Response Body
media type data type description
application/json array of A2LDescriptionFile (JSON) An array of A2LDescriptionFile which shows the current metadata for the uploaded a2l file(s).

Example

Request
POST /v1/vehicle/profile/description-files/a2l
Content-Type: multipart/form-data
Accept: application/json
auth-token: ...

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

                
[ {
  "ecu-name" : "...",
  "name" : "...",
  "id" : 12345,
  "type" : "A2L",
  "comment" : "...",
  "enabled" : true,
  "version" : "..."
} ]

GET /v1/vehicle/profile/seedkey/list

Get all available SeedKeys.

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

Example

Request
GET /v1/vehicle/profile/seedkey/list
Content-Type: */*
Accept: application/json
auth-token: ...

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

                
[ {
  "id" : 12345,
  "name" : "seedKey1",
  "enabled" : true
} ]

GET /v1/vehicle/profile/seedkey/{id}

Request Parameters
name type description constraints
auth-token header The authentication token.  
id path required int
Response Body
media type data type description
application/json SeedKey (JSON)

Example

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

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

                
{
  "id" : 12345,
  "name" : "seedKey1",
  "enabled" : true
}

GET /v1/vehicle/profile/version/{version-id}

Request Parameters
name type description constraints
auth-token header The authentication token.  
version-id path required int
Response Body
media type data type description
application/json VehicleProfileVersion (JSON)

Example

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

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

                
{
  "vehicleProfileID" : 12345,
  "id" : 12345,
  "name" : "...",
  "diagnosticReferenceID" : 12345
}

PUT /v1/vehicle/profile/description-files/a2l/{id}

Replace an existing A2L file and optionally any metadata for the file.

Request Parameters
name type description constraints
attributes formdata Attributes to replace. Any attribute in this json will replace the attribute for the current version of the file.  
file formdata The new version of the A2L file which will replace the existing file identified by the provided id.  
auth-token header The authentication token.  
id path The id of the a2l file to replace. required int
Request Body
media type data type
multipart/form-data (custom)
Response Codes
code condition
400 If the provided id does not match an existing A2L file.
400 If no a2l file is provided.
Response Body
media type data type description
application/json A2LDescriptionFile (JSON) The current attributes for the file after the replacement has been done.

Example

Request
PUT /v1/vehicle/profile/description-files/a2l/{id}
Content-Type: multipart/form-data
Accept: application/json
auth-token: ...

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

                
{
  "ecu-name" : "...",
  "name" : "...",
  "id" : 12345,
  "type" : "A2L",
  "comment" : "...",
  "enabled" : true,
  "version" : "..."
}

GET /v1/vehicle/profile/{id}/ecu/a2l

Get the A2L file assocations for the provided vehicle profile and ECU.

Request Parameters
name type description constraints
auth-token header The authentication token.  
id path required int
name query  
Response Body
media type data type description
application/json array of EcuA2lAssociationResult (JSON)

Example

Request
GET /v1/vehicle/profile/{id}/ecu/a2l
Content-Type: */*
Accept: application/json
auth-token: ...

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

                
[ {
  "association-id" : 123,
  "type" : "A2L",
  "a2l-file-id" : 13,
  "ecu-name" : "CEM",
  "can-bus-number" : 1,
  "seedkey-id" : 0
} ]

PUT /v1/vehicle/profile/{id}/ecu/a2l

Add a new A2L association for the provided vehicle profile and ECU. See EcuA2lAssociation. The field "ecu-name" is not required in the provided json. See example below.

Request Parameters
name type description constraints
auth-token header The authentication token.  
id path required int
Request Body
media type data type
application/json EcuA2lAssociation (JSON)
Response Body
media type data type description
application/json EcuA2lAssociationResult (JSON)

Example

Request
PUT /v1/vehicle/profile/{id}/ecu/a2l
Content-Type: application/json
Accept: application/json
auth-token: ...

                
{
  "a2l-file-id" : 13,
  "can-bus-number" : 1,
  "seedkey-id" : 0
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "association-id" : 123,
  "type" : "A2L",
  "a2l-file-id" : 13,
  "ecu-name" : "CEM",
  "can-bus-number" : 1,
  "seedkey-id" : 0
}

GET /v1/vehicle/profile/{id}/ecu/a2l/list

Get the ECUs and the number of associated A2L files for each ECU for the provided vehicle profile.

Request Parameters
name type description constraints
auth-token header The authentication token.  
id path required int
Response Body
media type data type description
application/json array of EcuA2lAssociationSummary (JSON)

Example

Request
GET /v1/vehicle/profile/{id}/ecu/a2l/list
Content-Type: */*
Accept: application/json
auth-token: ...

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

                
[ {
  "nr-of-a2l-files" : 10,
  "ecu-name" : "CEM",
  "can-bus-number" : 1,
  "seedkey-id" : 0
} ]