Aller au contenu

Planning rack : occupation par unité physique × jour (Gantt)

GET
/v1/rack
curl --request GET \
--url 'https://example.com/v1/rack?toDate=2026-04-15&fromDate=2026-04-15&establishmentId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
--header 'X-API-Key: <X-API-Key>'
unitTypeId
string format: uuid

Restreint aux unités de ce type

toDate
required
string format: date

Borne haute exclue de la fenêtre (YYYY-MM-DD, max 92 jours après fromDate)

fromDate
required
string format: date

Borne basse incluse de la fenêtre (YYYY-MM-DD)

establishmentId
required
string format: uuid

Occupation par unité physique sur la fenêtre

Media type application/json
object
data
required
object
window
required
object
from
required
string format: date
to
required
string format: date
units
required
Array<object>
object
unitId
required
string format: uuid
code
required
string
name
required
string
unitTypeId
required
string format: uuid
blocks
required
Array<object>
object
kind
required
string
Allowed values: pre_assigned stay out_of_order out_of_service
from
required

Borne basse incluse (tronquée à la fenêtre)

string format: date
to
required

Borne haute exclue (tronquée à la fenêtre)

string format: date
reservationId
string format: uuid
nullable
stayId
string format: uuid
nullable
guestLabel
string
nullable
status

Statut réservation (pre_assigned), checked_in (stay), ou source du hold (OOO/OOS)

string
nullable
Example
{
"data": {
"units": [
{
"blocks": [
{
"kind": "pre_assigned"
}
]
}
]
}
}

Paramètres invalides

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Non authentifié

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Permission refusée ou scope IDOR

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}