Aller au contenu

Lister les holds OOO/OOS manuels actifs d'un établissement

GET
/v1/establishments/{establishmentId}/out-of-service
curl --request GET \
--url 'https://example.com/v1/establishments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/out-of-service?pageSize=50&page=1' \
--header 'X-API-Key: <X-API-Key>'

Retourne les holds manuels actifs (source=manual). Permet au front de lever un hold posé hors session courante.

establishmentId
required
string format: uuid
pageSize
integer
>= 1 <= 100
Example
50
page
integer
>= 1
Example
1

Page de holds OOO/OOS manuels actifs

Media type application/json
object
data
required
Array<object>
object
refId
required

Référence du hold — utiliser pour lift/update-return

string
unitId
required
string format: uuid
unitTypeId
required
string format: uuid
kind
required
string
Allowed values: ooo oos
oooFrom
required

1re nuit hors service (incluse)

string format: date
oooUntil

Date de retour estimée (rappel seul, pas une borne de lift)

string format: date
nullable
createdAt
required
string format: date-time
createdBy
string format: uuid
nullable
meta
required
object
page
required
integer
pageSize
required
integer
total
required
integer
Example
{
"data": [
{
"kind": "ooo"
}
]
}

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

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
}