Lister les états des lieux d'un établissement

GET

/v1/inspections

curl --request GET \
  --url 'https://example.com/v1/inspections?pageSize=20&page=1&status=draft&establishmentId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'X-API-Key: <X-API-Key>'

Permet au front d’ouvrir un EDL par stayId sans connaître son UUID. Triés par date de création DESC.

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Query Parameters

pageSize

integer

>= 1 <= 100

Example

20

page

integer

>= 1

Example

1

stayId

Filtrer par séjour (subjectId quand subjectKind=stay)

string format: uuid

status

string

Allowed values: draft completed signed voided

establishmentId

required

string format: uuid

Responses

200

Page d’états des lieux

Media type application/json

object

data

required

Array<object>

object

id

required

string format: uuid

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

status

required

string

Allowed values: draft completed signed voided

pairedCheckInId

string format: uuid

nullable

catalogSnapshotAt

required

string format: date-time

meta

required

object

page

required

integer

pageSize

required

integer

total

required

integer

Example

{
  "data": [
    {
      "subjectKind": "stay",
      "kind": "check_in",
      "status": "draft"
    }
  ]
}

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
}