Démarrer un état des lieux

POST

/v1/inspections

curl --request POST \
  --url https://example.com/v1/inspections \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "establishmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "subjectKind": "stay", "subjectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "unitId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "kind": "check_in", "pairedCheckInId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "items": [ { "elementRef": "example", "elementLabel": "example", "expectedCondition": "ok", "isRequired": true, "isMeter": true } ] }'

Authorizations

• ApiKeyAuth
• BearerAuth

Request Body ^required

Media type application/json

object

establishmentId

required

string format: uuid

subjectKind

required

string

Allowed values: stay long_stay_contract

subjectId

required

string format: uuid

unitId

required

string format: uuid

kind

required

string

Allowed values: check_in check_out

pairedCheckInId

string format: uuid

nullable

items

required

Array<object>

>= 1 items <= 200 items

object

elementRef

required

string

<= 128 characters

elementLabel

required

string

<= 200 characters

expectedCondition

required

string

Allowed values: ok worn damaged missing dirty not_applicable

isRequired

required

boolean

isMeter

boolean

nullable

Responses

201

EDL démarré

Media type application/json

object

data

required

object

inspectionId

required

string format: uuid

Example ^generated

{
  "data": {
    "inspectionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
}

400

Corps 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
}

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
}