BObookingexperts
Contractors

GET contractor

Changed on

Returns the contractor for the given ID

get/v3/administrations/{administration_id}/contractors/{id}

Request

Path parameters

administration_idstring required

Administration ID

idstring required

Resource ID

Query parameters

fields[contractor]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

ContractorResponse

Example response

{
  "data": {
    "id": "1",
    "type": "contractor",
    "attributes": {
      "title": "mr",
      "locale": "cs"
    },
    "relationships": {
      "rentable_identities": {
        "data": [
          {
            "type": "rentable_identity"
          }
        ]
      },
      "inventory_objects": {
        "data": [
          {
            "type": "inventory_object"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "rentable_identity",
      "relationships": {
        "current_or_future_external_blocked_agenda_periods": {
          "data": [
            {
              "type": "external_blocked_agenda_period"
            }
          ]
        },
        "labels": {
          "data": [
            {
              "type": "label"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "cluster_children": {
          "data": [
            {
              "type": "inventory_object"
            }
          ]
        },
        "images": {
          "data": [
            {
              "type": "image"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • warning

      added the new da-DK enum value to the // response property for the response status

    • warning

      added the new en-GB enum value to the // response property for the response status

    • warning

      added the new en-US enum value to the // response property for the response status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status