Skip to content

Services

Info

Please find the service definition here.

Get services

GET /services

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
{
  "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.
Response
500 INTERNAL SERVER ERROR
Internal server error.

Get service

GET /services/{serviceId}

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.
serviceId integer path Required. The database ID of the service.
Response
200 OK
{
  "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.
Unable to find a service for the given serviceId which is assigned to the given customerId.
Response
500 INTERNAL SERVER ERROR
Internal server error.

Get product of service

GET /services/{serviceId}/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.
serviceId integer path Required. The database ID of the service.
Response
200 OK
{
  "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.
No service can be found for this serviceId that is assigned to this customerId.
No product can be found that is assigned to this serviceId.
Response
500 INTERNAL SERVER ERROR
Internal server error.