Skip to content

Grouping

Info

Please find the group definition here.

Get groups

GET /groups
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

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "integer",
        "format": "int32"
      },
      "name": {
        "type": "string"
      }
    }
  }
}
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.
Response
500 INTERNAL SERVER ERROR

Internal server error.

Get cars of group

GET /groups/{groupId}/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.
groupId integer path Required. The database ID of the group.
Response
200 OK

{
  "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



{
  "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.

Could not find the group with the given Id.
Response
500 INTERNAL SERVER ERROR

Internal server error.

Get users of group

GET /groups/{groupId}/users
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.
groupId integer path Required. The database ID of the group.
Response
200 OK

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "format": "int32"
      },
      "emailAddress": {
        "type": "string"
      },
      "userData": {
        "type": "object",
        "properties": {
          "firstName": {
            "type": [
              "string",
              "null"
            ]
          },
          "lastName": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  }
}
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.

Could not find the group with the given Id.
Response
500 INTERNAL SERVER ERROR

Internal server error.

Get services of group

GET /groups/{groupId}/services
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.
groupId integer path Required. The database ID of the group.
Response
200 OK

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "format": "int32"
      },
      "name": {
        "type": "string"
      },
      "isTerminated": {
        "type": "boolean"
      },
      "terminationDate": {
        "type": [
          "string",
          "null"
        ],
        "format": "date-time"
      },
      "terminationCause": {
        "type": [
          "string",
          "null"
        ]
      }
    }
  }
}
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.

Could not find the group with the given Id.
Response
500 INTERNAL SERVER ERROR

Internal server error.

Get products of group

GET /groups/{groupId}/products
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.
groupId integer path Required. The database ID of the group.
Response
200 OK

{
  "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



{
  "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.

Could not find the group with the given Id.
Response
500 INTERNAL SERVER ERROR

Internal server error.

Create group

PUT /groups
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": {
    "name": {
      "type": "string"
    }
  }
}
Response
201 CREATED

{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "format": "int32"
    }
  }
}
Response
400 BAD REQUEST

Could not create group. No group name given.
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.
Response
409 CONFLICT

A group with the same name already exists.
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.

Assign car to group

PUT /groups/{groupId}/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
groupId integer path Required. The database ID of the group.
Request body
{
  "type": "object",
  "properties": {
    "carId": {
      "type": "number",
      "format": "int32"
    }
  }
}
Response
204 NO CONTENT
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.

Could not find group with the given Id.

Could not find car with the given Id.
Response
409 CONFLICT

The car with the given Id is already assigned to the group with the given Id.
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.

Assign user to group

PUT /groups/{groupId}/users
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
groupId integer path Required. The database ID of the group.
Request body
{
  "type": "object",
  "properties": {
    "userId": {
      "type": "number",
      "format": "int32"
    }
  }
}
Response
204 NO CONTENT
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.

Could not find group with the given Id.

Could not find user with the given Id.
Response
409 CONFLICT

The user with the given Id is already assigned to the group with the given Id.
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.

Assign service to group

PUT /groups/{groupId}/services
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
groupId integer path Required. The database ID of the group.
Request body
{
  "type": "object",
  "properties": {
    "serviceId": {
      "type": "number",
      "format": "int32"
    }
  }
}
Response
204 NO CONTENT
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
Response
404 NOT FOUND

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

Could not find group with the given Id.

Could not find service with the given Id.
Response
409 CONFLICT

The servie with the given Id is already assigned to the group with the given Id.
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.

Assign product to group

PUT /groups/{groupId}/products
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
groupId integer path Required. The database ID of the group.
Request body
{
  "type": "object",
  "properties": {
    "productId": {
      "type": "number",
      "format": "int32"
    }
  }
}
Response
204 NO CONTENT
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.

Could not find group with the given Id.

Could not find product with the given Id.
Response
409 CONFLICT

The product with the given Id is already assigned to the group with the given Id.
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.

Update group

PATCH /groups/{groupId}
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
groupId integer path Required. The database ID of the group.
Request body
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "op": {
        "type": "string",
        "enum": [
          "replace"
        ]
      },
      "path": {
        "type": "string",
        "enum": [
          "/name"
        ]
      },
      "value": {
        "type": [
          "string",
          "null"
        ]
      }
    }
  }
}
Response
204 NO CONTENT
Response
400 BAD REQUEST

The group name must not be null, empty or white space.

The group name must be of maximum length '250'.
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.

No group can be found for this groupId that is assigned to this customerId.

Could not find group with the given Id.
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.

Delete group

DELETE /groups/{groupId}
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.
groupId integer path Required. The database ID of the group.
Response
204 NO CONTENT
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.

Could not find group with the given Id.
Response
409 CONFLICT

Could not delete group because of existing relations. Please delete all relations to the group and try again.
Response
500 INTERNAL SERVER ERROR

Internal server error.

Remove user from group

DELETE /groups/{groupId}/users/{userId}
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.
groupId integer path Required. The database ID of the group.
userId integer path Required. The database ID of the user.
Response
204 NO CONTENT
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.

Could not find group with the given Id.

Could not find user with the given Id.

The user with the given Id is not assigned to the group with the given Id.
Response
500 INTERNAL SERVER ERROR

Internal server error.

Remove car from group

DELETE /groups/{groupId}/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.
groupId integer path Required. The database ID of the group.
carId integer path Required. The database ID of the car.
Response
204 NO CONTENT
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.

Could not find group with the given Id.

Could not find car with the given Id.

The car with the given Id is not assigned to the group with the given Id.
Response
500 INTERNAL SERVER ERROR

Internal server error.

Remove service from group

DELETE /groups/{groupId}/services/{serviceId}
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.
groupId integer path Required. The database ID of the group.
serviceId integer path Required. The database ID of the service.
Response
204 NO CONTENT
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.

Could not find group with the given Id.

Could not find service with the given Id.

The service with the given Id is not assigned to the group with the given Id.
Response
500 INTERNAL SERVER ERROR

Internal server error.

Remove product from group

DELETE /groups/{groupId}/products/{productId}
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.
groupId integer path Required. The database ID of the group.
productId integer path Required. The database ID of the products.
Response
204 NO CONTENT
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.

Could not find group with the given Id.

Could not find product with the given Id.

The product with the given Id is not assigned to the group with the given Id.
Response
500 INTERNAL SERVER ERROR

Internal server error.