Skip to content

Installations

Install product into car

PUT /installations
Request parameters
Name Type Location Description
flinkey-API-Key string header Required. API key which provides access to this API.
Authorization string header Required. The bearer token.
Customer-ID integer header Required. The database ID of the customer.
Content-Type string header Required. The content type of the request. Value: application/json
Request body
{
  "type": "object",
  "properties": {
    "carId": {
      "type": "number",
      "format": "int32"
    },
    "uniqueId": {
      "type": [
        "string",
        "null"
      ]
    },
    "serialNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "productId": {
      "type": [
        "number",
        "null"
      ],
      "format": "int32"
    }
  },
  "required": [
    "carId"
  ]
}
Response
204 NO CONTENT
Response
400 BAD REQUEST

Couldn't install product into car. No valid carId provided.

Couldn't install product into car. No valid productId, serialNumber or uniqueId provided.
Response
401 UNAUTHORIZED



{
  "statusCode": 401,
  "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}

{
  "statusCode": 401,
  "message": "Unauthorized. Access token is missing or invalid."
}
Response
404 NOT FOUND

Unable to find a manager for the given OAuth ID claim data.

Unable to find a car for the given carId which is assigned to the given customerId.

Unable to find a product for the given productId, serialNumber or uniqueId.
Response
409 CONFLICT

The product is already installed into a car.

The product has no service assigned.

There is already installed a product of the same type in the car.
Response
415 UNSUPPORTED MEDIA TYPE

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.13",
  "title": "Unsupported Media Type",
  "status": "415",
  "traceId": "<traceId>"
}
Response
500 INTERNAL SERVER ERROR

Internal server error.

Uninstall product from car

DELETE /installations

Warning

If you uninstall a flinkey Box, this operation also removes all assignments of the car. The assignments are deleted asynchronously. You will receive the response of the assignment deletion operations via webhook. More detailed information could be found here.

Request parameters
Name Type Location Description
flinkey-API-Key string header Required. API key which provides access to this API.
Authorization string header Required. The bearer token.
Customer-ID integer header Required. The database ID of the customer.
Content-Type string header Required. The content type of the request. Value: application/json
Request body
{
  "type": "object",
  "properties": {
    "carId": {
      "type": "number",
      "format": "int32"
    },
    "uniqueId": {
      "type": [
        "string",
        "null"
      ]
    },
    "serialNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "productId": {
      "type": [
        "number",
        "null"
      ],
      "format": "int32"
    }
  },
  "required": [
    "carId"
  ]
}
Response
204 NO CONTENT
Response
400 BAD REQUEST

Couldn't uninstall product from car. No valid carId provided.

Couldn't uninstall product from car. No valid productId, serialNumber or uniqueId provided.
Response
401 UNAUTHORIZED



{
  "statusCode": 401,
  "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}

{
  "statusCode": 401,
  "message": "Unauthorized. Access token is missing or invalid."
}
Response
404 NOT FOUND

Unable to find a manager for the given OAuth ID claim data.

Unable to find a car for the given carId which is assigned to the given customerId.

Unable to find a product for the given productId, serialNumber or uniqueId.
Response
409 CONFLICT

The product is already uninstalled.

The given product is not assigned to the given car.
Response
415 UNSUPPORTED MEDIA TYPE

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.13",
  "title": "Unsupported Media Type",
  "status": "415",
  "traceId": "<traceId>"
}
Response
500 INTERNAL SERVER ERROR

Internal server error.