Cars

Info

Car or entity represented by a car ID, which is considered to have a maximum of two different products & assignments. Several users can also be assigned to it.

Get cars

GET /cars

Tip

The returned data can be manipulated using OData.

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.

Response

200 OK

application/json

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "format": "int32"
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": [
          "string",
          "null"
        ]
      },
      "vin": {
        "type": [
          "string",
          "null"
        ]
      },
      "licensePlate": {
        "type": [
          "string",
          "null"
        ]
      },
      "brand": {
        "type": [
          "string",
          "null"
        ]
      },
      "model": {
        "type": [
          "string",
          "null"
        ]
      }
    }
  }
}

Response

401 UNAUTHORIZED

text/plain

  Access denied due to invalid subscription key. 
  Make sure to provide a valid key for an active subscription.

application/json

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

application/json

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

Response

500 INTERNAL SERVER ERROR

text/plain

  Internal server error.

Get car

GET /cars/{carId}

Tip

The returned data can be manipulated using OData.

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.
`CarId`	integer	path	Required. The database ID of the car.

Response

200 OK

application/json

{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "format": "int32"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "vin": {
      "type": [
        "string",
        "null"
      ]
    },
    "licensePlate": {
      "type": [
        "string",
        "null"
      ]
    },
    "brand": {
      "type": [
        "string",
        "null"
      ]
    },
    "model": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Response

401 UNAUTHORIZED

text/plain

  Access denied due to invalid subscription key. 
  Make sure to provide a valid key for an active subscription.

application/json

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

application/json

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

Response

404 NOT FOUND

text/plain

  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.

Response

500 INTERNAL SERVER ERROR

text/plain

  Internal server error.

Create car

PUT /cars

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

application/json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "licensePlate": {
      "type": [
        "string",
        "null"
      ]
    },
    "vin": {
      "type": [
        "string",
        "null"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "brand": {
      "type": [
        "string",
        "null"
      ]
    },
    "model": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "name"
  ]
}

Response

201 CREATED

application/json

{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "format": "int32"
    }
  }
}

Response

400 BAD REQUEST

text/plain

  Could not create car. No car name given.

Response

401 UNAUTHORIZED

text/plain

  Access denied due to invalid subscription key. 
  Make sure to provide a valid key for an active subscription.

application/json

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

application/json

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

Response

404 NOT FOUND

text/plain

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

Response

415 UNSUPPORTED MEDIA TYPE

application/json

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

Response

500 INTERNAL SERVER ERROR

text/plain

  Internal server error.

Update car

PATCH /cars/{carId}

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`
`CarId`	integer	path	Required. The database ID of the car.

Request body

application/json

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "op": {
        "type": "string",
        "enum": [
          "remove",
          "replace"
        ]
      },
      "path": {
        "type": "string",
        "enum": [
          "/description",
          "/vin",
          "/name",
          "/licensePlate",
          "/brand",
          "/model"
        ]
      },
      "value": {
        "type": [
          "string",
          "null"
        ]
      }
    }
  }
}

Response

204 NO CONTENT

Response

400 BAD REQUEST

text/plain

  Could not update car. The car name must not be null, empty or white space.

Response

401 UNAUTHORIZED

text/plain

  Access denied due to invalid subscription key. 
  Make sure to provide a valid key for an active subscription.

application/json

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

application/json

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

Response

404 NOT FOUND

text/plain

  Unable to find a manager for the given OAuth ID claim data.
  No car can be found for this carId that is assigned to this customerId.

Response

415 UNSUPPORTED MEDIA TYPE

application/json

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

Response

500 INTERNAL SERVER ERROR

text/plain

  Internal server error.

Delete car

DELETE /cars/{carId}

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.
`CarId`	integer	path	Required. The database ID of the car.

Response

204 NO CONTENT

Response

401 UNAUTHORIZED

text/plain

  Access denied due to invalid subscription key. 
  Make sure to provide a valid key for an active subscription.

application/json

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

application/json

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

Response

404 NOT FOUND

text/plain

  Unable to find a manager for the given OAuth ID claim data.
  No car can be found for this carId that is assigned to this customerId.

Response

500 INTERNAL SERVER ERROR

text/plain

  Internal server error.

Get products of car

GET /cars/{carId}/products

Tip

The returned data can be manipulated using OData.

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.
`CarId`	integer	path	Required. The database ID of the car.

Response

200 OK

application/json

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "format": "int32"
      },
      "uniqueId": {
        "type": "string"
      },
      "serialNumber": {
        "type": "string"
      },
      "sapNumber": {
        "type": "string"
      },
      "dongleTerminationTimeStamp": {
        "type": [
          "string",
          "null"
        ],
        "format": "date-time"
      },
      "type": {
        "type": "string",
        "enum": [
          "flinkey Box",
          "flinkey IQ"
        ]
      }
    }
  }
}

Response

401 UNAUTHORIZED

text/plain

  Access denied due to invalid subscription key. 
  Make sure to provide a valid key for an active subscription.

application/json

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

application/json

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

Response

404 NOT FOUND

text/plain

  Unable to find a manager for the given OAuth ID claim data.
  No car can be found for this carId that is assigned to this customerId.
  No products are assigned to this car.

Response

500 INTERNAL SERVER ERROR

text/plain

  Internal server error.

Get location of car

GET /cars/{carId}/location

Tip

The returned data can be manipulated using OData.

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.
`CarId`	integer	path	Required. The database ID of the car.

Response

200 OK

application/json

{
  "type": "object",
  "properties": {
    "latitude": {
      "type": [
        "string",
        "null"
      ],
      "format": "double"
    },
    "longitude": {
      "type": [
        "string",
        "null"
      ],
      "format": "double"
    },
    "date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "odometerDate": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "odometer": {
      "type": [
        "string",
        "null"
      ],
      "format": "double"
    }
  }
}

Response

401 UNAUTHORIZED

text/plain

  Access denied due to invalid subscription key. 
  Make sure to provide a valid key for an active subscription.

application/json

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

application/json

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

Response

404 NOT FOUND

text/plain

  Unable to find a manager for the given OAuth ID claim data.
  No car can be found for this carId that is assigned to this customerId.
  No products are assigned to this car.

Response

500 INTERNAL SERVER ERROR

text/plain

  Internal server error.

Get location of car of specific date

GET /cars/{carId}/location/{searchDate}

Tip

The returned data can be manipulated using OData.

Info

The format of searchDate is: yyyy-MM-ddTHH:mm:ssZ

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.
`CarId`	integer	path	Required. The database ID of the car.
`searchDate`	string	path	Reqiured. The date coordinates of the flinkey IQ of the car should be searched for.

Response

200 OK

application/json

{
  "type": "object",
  "properties": {
    "latitude": {
      "type": [
        "string",
        "null"
      ],
      "format": "double"
    },
    "longitude": {
      "type": [
        "string",
        "null"
      ],
      "format": "double"
    },
    "date": {
      "description": "This is the date nearest to the desired value of the 'searchDate' parameter.",
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "odometerDate": {
      "description": "This is the odometer date nearest to the desired value of the 'searchDate' parameter.",
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "odometer": {
      "type": [
        "string",
        "null"
      ],
      "format": "double"
    }
  }
}

Response

400 BAD REQUEST

text/plain

  Invalid date format.

Response

401 UNAUTHORIZED

text/plain

  Access denied due to invalid subscription key. 
  Make sure to provide a valid key for an active subscription.

application/json

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

application/json

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

Response

404 NOT FOUND

text/plain

  Unable to find a manager for the given OAuth ID claim data.
  No car can be found for this carId that is assigned to this customerId.
  No products are assigned to this car.

Response

500 INTERNAL SERVER ERROR

text/plain

  Internal server error.