Reservation management

Types of reservations

Scheduled: booked in advance by a user interface or an automated system. Start and end are set at booking.
First come, first served (FCFS): created automatically when the user arrives. The end is set at exit.

FCFS reservations cannot be created, updated or deleted through the API. They are returned when listing reservations.

Lifecycle

sequenceDiagram
    autonumber
    participant C as Your system
    participant API as Izix Public API
    C->>API: GET /access-rights (profile)
    API-->>C: Access policies the profile can use
    C->>API: POST /reservations (dry_run: true)
    API-->>C: Bookable or not, with reason
    C->>API: POST /reservations (dry_run: false)
    API-->>C: 201 reservation
    C->>API: GET /reservations?filters[updated_since]=...
    API-->>C: Created, changed or ended reservations
    C->>API: DELETE /reservations/{reservationId}
    API-->>C: 204 (ended now if already started)

Key attributes

Attribute	Description
`profile_external_reference` or `profile_id`	The profile the reservation is for
`access_policy_id`	A profile may hold rights on several policies. Retrieve its access rights first to choose the right one
`from`, `to`	Aligned on quarter hours. `from` must not be more than 5 minutes in the past
`dry_run`	`true` checks every condition (capacity, rights, credits) without booking. `false` books
`send_notification`	Email a confirmation to the profile. Default is no email

Usage notes

Reservations in the past cannot be created.
A started reservation cannot be deleted. A delete call sets its end to the current time. A finished reservation answers 400 cannot_delete_past_reservation.
GET /reservations supports include_costs=true and filters[updated_since] for incremental sync.
To check availability before booking, see Availability Checks.