Skip to content

Contracts

Info

Please find the contract definition here.

Get the contract of a service

GET /services/{serviceId}/contracts

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 string path Required. The database ID of the service.
Response
200 OK

{
  "type": "object",
  "properties": {
    "orderNumber": {
      "type": "string"
    },
    "documentNumber": {
      "type": "string"
    },
    "orderPosition": {
      "type": [
        "number",
        "null"
      ],
      "format": "int32"
    },
    "start": {
      "type": "string",
      "format": "date-time"
    },
    "end": {
      "type": "string",
      "format": "date-time"
    },
    "termOfContract": {
      "type": [
        "number",
        "null"
      ],
      "format": "int32"
    },
    "termOfNotice": {
      "type": [
        "number",
        "null"
      ],
      "format": "int32"
    },
    "unitOfNotice": {
      "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.
Response
500 INTERNAL SERVER ERROR

Internal server error.