Tableau de bord gouvernante (board par établissement)

GET

/v1/housekeeping/board

curl --request GET \
  --url 'https://example.com/v1/housekeeping/board?establishmentId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Query Parameters

establishmentId

required

string format: uuid

Responses

200

Board gouvernante

Media type application/json

object

data

required

Array<object>

object

unitId

required

string format: uuid

code

required

string

name

required

string

hkStatus

required

string

Allowed values: dirty in_progress cleaned inspected ready ooo oos

hkUpdatedAt

string format: date-time

nullable

assignedStaffId

string format: uuid

nullable

taskId

string format: uuid

nullable

taskStatus

string

nullable

Example

{
  "data": [
    {
      "code": "CH-101",
      "name": "Chambre 101",
      "hkStatus": "dirty"
    }
  ]
}

400

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
}

401

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
}

403

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
}