Contracts

Get the contract of service

GET /services/{serviceId}/contracts

Info

The Contract is the service of a box.

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

application/json

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

text/plainapplication/jsonapplication/json

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

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

text/plain

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

text/plain

Internal server error.