Packages (Arrangementen)

Current version: 1.2.0

Read

GET /api2/arrangementen

List of arrangementen (packages) in Recras

This endpoint is also publicly accessible. When this endpoint is requested unauthenticated, only arrangementen (packages) with the attribute mag_api (may_use_api) are displayed, and several fields are hidden:

• mag_uitjes (may_be_used_for_outings)

• mag_api (may_use_api)

• mag_online_geboekt_worden_direct_betalen (may_be_booked_online_direct_payment)

• mag_online_geboekt_worden_achteraf_betalen (may_be_booked_online_pay_later)

• maximum_aantal_personen_online (maximum_number_of_persons_online)

• mag_beschikbaarheidskalender_api (may_use_availability_calendar_api)

• startmomentgroep_id (start_time_group_id)

• mag_online (may_be_booked_online)

• onlineboeking_minimaal_vooruit (online_booking_minimum_in_advance)

• onlineboeking_maximaal_vooruit (online_booking_maximum_in_advance)

• Only certain fields in package-line list regels (lines) are available:

  • id: unique identifier

  • begin: start-time of the line

  • eind: end-time of the line

  • beschrijving_templated (description_templated): Line description, with Recras-tags expanded

  • aantal_personen (number_of_persons): The number of items in the line (only for display of example programme)

  • max: The maximum acceptable number of items for online bookings

  • onlineboeking_aantalbepalingsmethode (online_booking_number_determination_method): The method for determining aantal_personen (number_of_persons) for online bookings.

    Possible values are invullen_door_gebruiker (fill_in_by_user) (the customer should select a number) and boekingsgrootte (booking_size) (to be calculated from the booking size).

  • product.id: unique identifier of the product associated with the line

  • product.weergavenaam (product.display_name): name of the product, suitable for showing to customers

  • product.beschrijving_klant (product.description_customer): a short description of the product, suitable for showing to customers

  • product.uitgebreide_omschrijving (product.extended_description): a longer description of the product, suitable for showing to customers

  • product.verkoop (product.sale_price): the sale price for a single unit of the product

  • product.minimum_aantal (product.minimum_number): the minimum number of units that must be charged of this product

  • product.vereist_product (product.required_product): this list will be empty

  • product.standaardbijlagen (product.default_attachments): this list will be empty

Example request:

GET /api2/arrangementen HTTP/1.1
Host: demo.recras.nl
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
   {
      "id": 4,
      "arrangement": "Boogschieten/Klimmen met Buffet", // (Archery/Climbing with Buffet)
      "ontvangstlocatie": "", // (reception_location)
      "mag_uitjes": true, // (may_be_used_for_outings)
      "mag_api": true, // (may_use_api)
      "mag_online_geboekt_worden_direct_betalen": false, // (may_be_booked_online_direct_payment)
      "mag_online_geboekt_worden_achteraf_betalen": false, // (may_be_booked_online_pay_later)
      "maximum_aantal_personen_online": null, // (maximum_number_of_persons_online)
      "mag_beschikbaarheidskalender_api": false, // (may_use_availability_calendar_api)
      "startmomentgroep_id": null, // (start_time_group_id)
      "aantal_personen": 10, // (number_of_persons)
      "onlineboeking_contactformulier_id": "2", // (online_booking_contact_form_id)
      "onlineboeking_minimaal_vooruit": "PT0S", // (online_booking_minimum_in_advance)
      "onlineboeking_maximaal_vooruit": null, // (online_booking_maximum_in_advance)
      "mag_online": false, // (may_be_booked_online)
      "prijs_totaal_exc": 530, // (price_total_excluding_vat)
      "prijs_totaal_inc": 561.8, // (price_total_including_vat)
      "prijs_pp_exc": 53, // (price_per_person_excluding_vat)
      "prijs_pp_inc": 56.18, // (price_per_person_including_vat)
      "regels": [ // (lines)
         {
            "id": 8,
            "locatie_id": 3, // (location_id)
            "begin": "1970-06-11T13:30:00+01:00", // (start_time)
            "eind": "1970-06-11T14:00:00+01:00", // (end_time)
            "beschrijving": "U wordt ontvangen met koffie,thee en een plak heerlijke cake", // (description: "You will be welcomed with coffee, tea and a delicious slice of cake")
            "aantal_personen": 10, // (number_of_persons)
            "product_id": 10
         },
         {
            "id": 5,
            "locatie_id": 4, // (location_id)
            "begin": "1970-06-11T14:00:00+01:00", // (start_time)
            "eind": "1970-06-11T15:00:00+01:00", // (end_time)
            "beschrijving": "Leer boogschieten op onze boogschietbaan ", // (description: "Learn archery on our archery range")
            "aantal_personen": 10, // (number_of_persons)
            "product_id": 7
         },
         {
            "id": 6,
            "locatie_id": 4, // (location_id)
            "begin": "1970-06-11T15:30:00+01:00", // (start_time)
            "eind": "1970-06-11T18:30:00+01:00", // (end_time)
            "beschrijving": "Klimmen op onze klimbaan onder begeleiding van een ervaren instructeur", // (description: "Climbing on our climbing wall under the guidance of an experienced instructor")
            "aantal_personen": 10, // (number_of_persons)
            "product_id": 6
         },
         {
            "id": 7,
            "locatie_id": 1, // (location_id)
            "begin": "1970-06-11T18:30:00+01:00", // (start_time)
            "eind": "1970-06-11T20:30:00+01:00", // (end_time)
            "beschrijving": "Waan je in Zuidafrika met het Zuidafrikaanse buffet", // (description: "Imagine yourself in South Africa with the South African buffet")
            "aantal_personen": 10, // (number_of_persons)
            "product_id": 1
         }
      ],
      "programma": [ // (program)
         {
            "omschrijving": "U wordt ontvangen met koffie,thee en een plak heerlijke cake", // (description: "You will be welcomed with coffee, tea and a delicious slice of cake")
            "aantal": 10, // (number)
            "begin": "PT0H0M0S", // (start_offset)
            "duur": "PT0H30M0S", // (duration)
            "eind": "PT0H30M0S" // (end_offset)
         },
         {
            "omschrijving": "Leer boogschieten op onze boogschietbaan ", // (description: "Learn archery on our archery range")
            "aantal": 10, // (number)
            "begin": "PT0H30M0S", // (start_offset)
            "duur": "PT1H0M0S", // (duration)
            "eind": "PT1H30M0S" // (end_offset)
         },
         {
            "omschrijving": "Klimmen op onze klimbaan onder begeleiding van een ervaren instructeur", // (description: "Climbing on our climbing wall under the guidance of an experienced instructor")
            "aantal": 10, // (number)
            "begin": "PT2H0M0S", // (start_offset)
            "duur": "PT3H0M0S", // (duration)
            "eind": "PT5H0M0S" // (end_offset)
         },
         {
            "omschrijving": "Waan je in Zuidafrika met het Zuidafrikaanse buffet", // (description: "Imagine yourself in South Africa with the South African buffet")
            "aantal": 10, // (number)
            "begin": "PT5H0M0S", // (start_offset)
            "duur": "PT2H0M0S", // (duration)
            "eind": "PT7H0M0S" // (end_offset)
         }
      ]
   },
   {
      "id": 13,
      "arrangement": "Huur Groepsaccommodatie", // (Rent Group Accommodation)
      "ontvangstlocatie": "", // (reception_location)
      "mag_uitjes": true, // (may_be_used_for_outings)
      "mag_api": true, // (may_use_api)
      "mag_online_geboekt_worden_direct_betalen": true, // (may_be_booked_online_direct_payment)
      "mag_online_geboekt_worden_achteraf_betalen": false, // (may_be_booked_online_pay_later)
      "maximum_aantal_personen_online": null, // (maximum_number_of_persons_online)
      "mag_beschikbaarheidskalender_api": true, // (may_use_availability_calendar_api)
      "startmomentgroep_id": 3, // (start_time_group_id)
      "aantal_personen": 1, // (number_of_persons)
      "onlineboeking_contactformulier_id": 2, // (online_booking_contact_form_id)
      "onlineboeking_minimaal_vooruit": "PT0S", // (online_booking_minimum_in_advance)
      "onlineboeking_maximaal_vooruit": null, // (online_booking_maximum_in_advance)
      "mag_online": true, // (may_be_booked_online)
      "prijs_totaal_exc": 2512.5, // (price_total_excluding_vat)
      "prijs_totaal_inc": 2663.13, // (price_total_including_vat)
      "prijs_pp_exc": 2512.5, // (price_per_person_excluding_vat)
      "prijs_pp_inc": 2663.13, // (price_per_person_including_vat)
      "regels": [ // (lines)
         {
            "id": 38,
            "locatie_id": 6, // (location_id)
            "begin": "1970-06-09T09:00:00+01:00", // (start_time)
            "eind": "1970-06-11T10:00:00+01:00", // (end_time)
            "beschrijving": "Huur accommodatie ma - woe", // (description: "Rent accommodation Mon - Wed")
            "aantal_personen": 1, // (number_of_persons)
            "product_id": 53
         },
         {
            "id": 39,
            "locatie_id": 6, // (location_id)
            "begin": "1970-06-09T13:00:00+01:00", // (start_time)
            "eind": "1970-06-11T14:00:00+01:00", // (end_time)
            "beschrijving": "Huur accommodatie woe - vrij", // (description: "Rent accommodation Wed - Fri")
            "aantal_personen": 1, // (number_of_persons)
            "product_id": 54
         },
         {
            "id": 40,
            "locatie_id": 6, // (location_id)
            "begin": "1970-06-09T17:00:00+01:00", // (start_time)
            "eind": "1970-06-10T18:00:00+01:00", // (end_time)
            "beschrijving": "Huur accommodatie vrij - zon", // (description: "Rent accommodation Fri - Sun")
            "aantal_personen": 1, // (number_of_persons)
            "product_id": 55
         },
         {
            "id": 41,
            "locatie_id": 6, // (location_id)
            "begin": null, // (start_time)
            "eind": null, // (end_time)
            "beschrijving": "Aantal over nachters nacht 1", // (description: "Number of overnight guests night 1")
            "aantal_personen": 1, // (number_of_persons)
            "product_id": 58
         },
         {
            "id": 42,
            "locatie_id": 6, // (location_id)
            "begin": null, // (start_time)
            "eind": null, // (end_time)
            "beschrijving": "Aantal over nachters nacht 2", // (description: "Number of overnight guests night 2")
            "aantal_personen": 1, // (number_of_persons)
            "product_id": 58
         },
         {
            "id": 43,
            "locatie_id": 6, // (location_id)
            "begin": null, // (start_time)
            "eind": null, // (end_time)
            "beschrijving": "Huur bedlinnen", // (description: "Rent bed linen")
            "aantal_personen": 1, // (number_of_persons)
            "product_id": 56
         },
         {
            "id": 44,
            "locatie_id": null, // (location_id)
            "begin": null, // (start_time)
            "eind": null, // (end_time)
            "beschrijving": "Bij aankomst ligt de tandenborstel klaar om bepoetst te worden", // (description: "Upon arrival, the toothbrush is ready to be used")
            "aantal_personen": 1, // (number_of_persons)
            "product_id": 57
         }
      ],
      "programma": [ // (program)
         {
            "omschrijving": "Huur accommodatie ma - woe", // (description: "Rent accommodation Mon - Wed")
            "aantal": 1, // (number)
            "begin": "PT0H0M0S", // (start_offset)
            "duur": "P2DT1H0M0S", // (duration)
            "eind": "P2DT1H0M0S" // (end_offset)
         },
         {
            "omschrijving": "Huur accommodatie woe - vrij", // (description: "Rent accommodation Wed - Fri")
            "aantal": 1, // (number)
            "begin": "PT4H0M0S", // (start_offset)
            "duur": "P2DT1H0M0S", // (duration)
            "eind": "P2DT5H0M0S" // (end_offset)
         },
         {
            "omschrijving": "Huur accommodatie vrij - zon", // (description: "Rent accommodation Fri - Sun")
            "aantal": 1, // (number)
            "begin": "PT8H0M0S", // (start_offset)
            "duur": "P1DT1H0M0S", // (duration)
            "eind": "P1DT9H0M0S" // (end_offset)
         }
      ]
   }
]

Status Codes:

• 200 OK – OK

GET /api2/arrangementen/(int: id)

A specific arrangement (package)

This endpoint is also publicly accessible. When this endpoint is requested unauthenticated, only arrangementen (packages) with the attribute mag_api (may_use_api) are displayed, and several fields are hidden:

• mag_uitjes (may_be_used_for_outings)

• mag_api (may_use_api)

• mag_online_geboekt_worden_direct_betalen (may_be_booked_online_direct_payment)

• mag_online_geboekt_worden_achteraf_betalen (may_be_booked_online_pay_later)

• maximum_aantal_personen_online (maximum_number_of_persons_online)

• mag_beschikbaarheidskalender_api (may_use_availability_calendar_api)

• startmomentgroep_id (start_time_group_id)

• mag_online (may_be_booked_online)

• regels (lines)

• onlineboeking_minimaal_vooruit (online_booking_minimum_in_advance)

• onlineboeking_maximaal_vooruit (online_booking_maximum_in_advance)

Example request:

GET /api2/arrangementen/4 HTTP/1.1
Host: demo.recras.nl
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "id": 4,
   "arrangement": "Boogschieten/Klimmen met Buffet", // (Archery/Climbing with Buffet)
   "ontvangstlocatie": "", // (reception_location)
   "mag_uitjes": true, // (may_be_used_for_outings)
   "mag_api": true, // (may_use_api)
   "mag_online_geboekt_worden_direct_betalen": false, // (may_be_booked_online_direct_payment)
   "mag_online_geboekt_worden_achteraf_betalen": false, // (may_be_booked_online_pay_later)
   "maximum_aantal_personen_online": null, // (maximum_number_of_persons_online)
   "mag_beschikbaarheidskalender_api": false, // (may_use_availability_calendar_api)
   "startmomentgroep_id": null, // (start_time_group_id)
   "aantal_personen": 10, // (number_of_persons)
   "onlineboeking_contactformulier_id": 2, // (online_booking_contact_form_id)
   "onlineboeking_minimaal_vooruit": "PT0S", // (online_booking_minimum_in_advance)
   "onlineboeking_maximaal_vooruit": null, // (online_booking_maximum_in_advance)
   "mag_online": false, // (may_be_booked_online)
   "prijs_totaal_exc": 530, // (price_total_excluding_vat)
   "prijs_totaal_inc": 561.8, // (price_total_including_vat)
   "prijs_pp_exc": 53, // (price_per_person_excluding_vat)
   "prijs_pp_inc": 56.18, // (price_per_person_including_vat)
   "regels": [ // (lines)
      {
         "id": 8,
         "locatie_id": 3, // (location_id)
         "begin": "1970-06-11T13:30:00+01:00", // (start_time)
         "eind": "1970-06-11T14:00:00+01:00", // (end_time)
         "beschrijving": "U wordt ontvangen met koffie,thee en een plak heerlijke cake", // (description: "You will be welcomed with coffee, tea and a delicious slice of cake")
         "aantal_personen": 10, // (number_of_persons)
         "product_id": 10
      },
      {
         "id": 5,
         "locatie_id": 4, // (location_id)
         "begin": "1970-06-11T14:00:00+01:00", // (start_time)
         "eind": "1970-06-11T15:00:00+01:00", // (end_time)
         "beschrijving": "Leer boogschieten op onze boogschietbaan ", // (description: "Learn archery on our archery range")
         "aantal_personen": 10, // (number_of_persons)
         "product_id": 7
      },
      {
         "id": 6,
         "locatie_id": 4, // (location_id)
         "begin": "1970-06-11T15:30:00+01:00", // (start_time)
         "eind": "1970-06-11T18:30:00+01:00", // (end_time)
         "beschrijving": "Klimmen op onze klimbaan onder begeleiding van een ervaren instructeur", // (description: "Climbing on our climbing wall under the guidance of an experienced instructor")
         "aantal_personen": 10, // (number_of_persons)
         "product_id": 6
      },
      {
         "id": 7,
         "locatie_id": 1, // (location_id)
         "begin": "1970-06-11T18:30:00+01:00", // (start_time)
         "eind": "1970-06-11T20:30:00+01:00", // (end_time)
         "beschrijving": "Waan je in Zuidafrika met het Zuidafrikaanse buffet", // (description: "Imagine yourself in South Africa with the South African buffet")
         "aantal_personen": 10, // (number_of_persons)
         "product_id": 1
      }
   ],
   "programma": [ // (program)
      {
         "omschrijving": "U wordt ontvangen met koffie,thee en een plak heerlijke cake", // (description: "You will be welcomed with coffee, tea and a delicious slice of cake")
         "aantal": 10, // (number)
         "begin": "PT0H0M0S", // (start_offset)
         "duur": "PT0H30M0S", // (duration)
         "eind": "PT0H30M0S" // (end_offset)
      },
      {
         "omschrijving": "Leer boogschieten op onze boogschietbaan ", // (description: "Learn archery on our archery range")
         "aantal": 10, // (number)
         "begin": "PT0H30M0S", // (start_offset)
         "duur": "PT1H0M0S", // (duration)
         "eind": "PT1H30M0S" // (end_offset)
      },
      {
         "omschrijving": "Klimmen op onze klimbaan onder begeleiding van een ervaren instructeur", // (description: "Climbing on our climbing wall under the guidance of an experienced instructor")
         "aantal": 10, // (number)
         "begin": "PT2H0M0S", // (start_offset)
         "duur": "PT3H0M0S", // (duration)
         "eind": "PT5H0M0S" // (end_offset)
      },
      {
         "omschrijving": "Waan je in Zuidafrika met het Zuidafrikaanse buffet", // (description: "Imagine yourself in South Africa with the South African buffet")
         "aantal": 10, // (number)
         "begin": "PT5H0M0S", // (start_offset)
         "duur": "PT2H0M0S", // (duration)
         "eind": "PT7H0M0S" // (end_offset)
      }
   ]
}

Status Codes:

• 200 OK – OK

• 404 Not Found – No arrangement (package) with this id

Changelog

Version 1.2.0: fields onlineboeking_minimaal_vooruit (online_booking_minimum_in_advance) and onlineboeking_maximaal_vooruit (online_booking_maximum_in_advance) added