Aller au contenu

Forecast occupation par jour sur une fenêtre future (basis points)

GET
/v1/reporting/forecast
curl --request GET \
--url 'https://example.com/v1/reporting/forecast?days=30&fromDate=2026-06-11&establishmentId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
--header 'X-API-Key: <X-API-Key>'
days
required

Nombre de jours (1-120)

string
/^\d{1,3}$/
Example
30
fromDate
required
string format: date
Example
2026-06-11
establishmentId
required
string format: uuid

Occupation prévue par jour

Media type application/json
object
data
required
object
establishmentId
required
string format: uuid
fromDate
required
string format: date
days
required
integer
forecast
required
Array<object>
object
date
required
string format: date
occupancyBasisPoints
required

Occupation prévue en points de base (ex: 7500 = 75.00%), 0 si capacité nulle

integer
reservedUnits
required
integer
totalUnits
required
integer
Example generated
{
"data": {
"establishmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"fromDate": "2026-04-15",
"days": 1,
"forecast": [
{
"date": "2026-04-15",
"occupancyBasisPoints": 1,
"reservedUnits": 1,
"totalUnits": 1
}
]
}
}

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 périmètre non vérifiable

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
}