Aller au contenu

Créer un membre du personnel

POST
/v1/staff-members
curl --request POST \
--url https://example.com/v1/staff-members \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "establishmentIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "jobRole": "receptionist", "skills": [ "example" ], "languages": [ "example" ], "defaultZone": "example", "color": "example" }'
Media type application/json
object
userId
required
string format: uuid
establishmentIds
required
Array<string>
>= 1 items
jobRole
required
string
Allowed values: receptionist housekeeper housekeeping_supervisor technician maintenance_manager front_desk_manager sales accountant general_manager other
skills
Array<string>
languages
Array<string>
defaultZone
string
nullable
color
required
string
/^#[0-9a-fA-F]{6}$/

StaffMember créé

Media type application/json
object
data
required
object
staffMemberId
required
string format: uuid
Example generated
{
"data": {
"staffMemberId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
}

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
}

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

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
}