BObookingexperts
ReviewForms

GET review_forms

Changed on

Returns review forms of the administration

get/v3/administrations/{administration_id}/review_forms

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, created_at, updated_at

fields[review_form]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[is_active]string

Filter on is_active

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[accommodation_types]string

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

filter[rentable_segments]string

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

filter[review_questions]string

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

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

ReviewFormCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "review_form",
      "relationships": {
        "accommodation_types": {
          "data": [
            {
              "type": "accommodation_type"
            }
          ]
        },
        "rentable_segments": {
          "data": [
            {
              "type": "rentable_segment"
            }
          ]
        },
        "review_questions": {
          "data": [
            {
              "type": "review_question"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "deprecated_accommodation_type"
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • warning

      added the new owners_managers_residence enum value to the /////// response property for the response status

    • warning

      added the new parking_place enum value to the /////// response property for the response status

    • warning

      added the new private_bathroom enum value to the /////// response property for the response status

    • warning

      added the new recreational_vehicle 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