Changer le statut de propreté d'une unité

POST

/v1/housekeeping/units/{unitId}/status

curl --request POST \
  --url https://example.com/v1/housekeeping/units/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/status \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "establishmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "action": "startCleaning", "reason": "example" }'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

unitId

required

string format: uuid

Request Body ^required

Media type application/json

object

establishmentId

required

string format: uuid

action

required

string

Allowed values: startCleaning markCleaned markInspected markReady markDirty setOutOfOrder setOutOfService clearOutOfOrder clearOutOfService

reason

string

nullable

Responses

200

Statut mis à jour

Media type application/json

object

data

required

object

status

required

string

Example

{
  "data": {
    "status": "cleaning"
  }
}

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
}

409

Transition invalide

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
}