Aller au contenu

Lister les notes internes visibles d'un client (filtrées selon les rôles du demandeur)

GET
/v1/guests/{id}/notes
curl --request GET \
--url https://example.com/v1/guests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/notes \
--header 'X-API-Key: <X-API-Key>'

La visibilité est filtrée par le serveur : safety toujours visible, notes restreintes visibles seulement si le demandeur a l’un des rôles requis.

id
required
string format: uuid

Notes visibles

Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
kind
required
string
Allowed values: safety commercial operational
text
required
string
restrictedToRoles
Array<string>
createdBy
required
string format: uuid
Example
{
"data": [
{
"kind": "safety"
}
]
}

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 (guest.read)

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
}