BObookingexperts
RentableIdentities

GET rentable_identities

Changed on

Deprecated, see inventory_objects

get/v3/administrations/{administration_id}/rentable_identities

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, name, created_at, updated_at

fields[rentable_identity]string

Fieldset. Specify a comma separated list of attributes to return

includestring

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

filter[id]string

Filter on ID

filter[name]string

Filter on name

filter[original_identifier]string

Filter on original_identifier

filter[door_name]string

Filter on door_name

filter[energy_label]string

Filter on energy_label

filter[surface_area]string

Filter on surface_area

filter[lot_number]string

Filter on lot_number

filter[blocked]string

Filter on blocked

filter[attachment_text]string

Filter on attachment_text

filter[archived]string

Filter on archived

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[labels]string

Filter on labels. Specify a comma separated list of IDs to filter on.

filter[administration]string

Filter on administration. Specify a comma separated list of IDs to filter on.

filter[cluster_children]string

Filter on cluster_children. Specify a comma separated list of IDs to filter on.

filter[images]string

Filter on images. Specify a comma separated list of IDs to filter on.

include_archivedboolean

When true, archived rentable identities are included in the response

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

RentableIdentityCollectionResponse

Example response

{
  "data": [
    {
      "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"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "external_blocked_agenda_period",
      "relationships": {
        "rentable": {
          "data": {
            "type": "rentable"
          }
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • 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

    • 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

    • 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