ExtraPackages

GET extra packages

Changed on

Returns extra packages of the administration

get/v3/administrations/{administration_id}/extra_packages

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[extra_package]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[description]string

Filter on description

filter[confirm_by_guest]string

Filter on confirm_by_guest

filter[archived]string

Filter on archived

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[administration]string

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

filter[book_period]string

Filter on book_period. 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 extra packages 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

ExtraPackageCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "extra_package",
      "relationships": {
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "book_period": {
          "data": {
            "type": "period"
          }
        },
        "stay_period": {
          "data": {
            "type": "period"
          }
        },
        "images": {
          "data": [
            {
              "type": "image"
            }
          ]
        },
        "package_entries": {
          "data": [
            {
              "type": "package_entry"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "administration",
      "relationships": {
        "city": {
          "data": {
            "type": "city"
          }
        },
        "checkin_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "checkout_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "interactive_map": {
          "data": {
            "type": "interactive_map"
          }
        },
        "payment_handlers": {
          "data": [
            {
              "type": "payment_handler"
            }
          ]
        }
      }
    }
  ]
}

Changes

    • info

      added the new optional query request parameter filter[images]

    • 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

    • 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 to the / response property anyOf list for the response status