Stock.Collaborateur¶
En bref
8 opérations sur 4 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).
Opérations¶
| Méthode | Chemin | Rôle |
|---|---|---|
GET |
/v2/collaborateur |
Lister les enregistrements |
POST |
/v2/collaborateur |
Créer l'enregistrement |
PUT |
/v2/collaborateur |
Mettre à jour l'enregistrement |
DELETE |
/v2/collaborateur |
Supprimer l'enregistrement |
GET |
/v2/collaborateur/count |
Compter les enregistrements |
POST |
/v2/collaborateur/count |
Compter les enregistrements |
POST |
/v2/collaborateur/recherche |
Rechercher des enregistrements |
POST |
/v2/collaborateur/save |
Créer ou mettre à jour l'enregistrement (upsert) |
Rôle déduit
La spécification ne porte ni summary ni description d'opération : la colonne Rôle est déduite mécaniquement de la méthode HTTP et du chemin.
Détail¶
GET /v2/collaborateur¶
Lister les enregistrements.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
sort |
query | string |
non | — |
where |
query | string |
non | — |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/collaborateur?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/collaborateur¶
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma CollaborateurDto — 32 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/collaborateur" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "nom": "…", "prenom": "…"}'
PUT /v2/collaborateur¶
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma CollaborateurDto — 32 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X PUT "https://<votre-connecteur>/v2/collaborateur" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "nom": "…", "prenom": "…"}'
DELETE /v2/collaborateur¶
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma CollaborateurDto — 32 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X DELETE "https://<votre-connecteur>/v2/collaborateur" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "nom": "…", "prenom": "…"}'
GET /v2/collaborateur/count¶
Compter les enregistrements.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
where |
query | string |
non | — |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/collaborateur/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/collaborateur/count¶
Compter les enregistrements.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/collaborateur/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/collaborateur/recherche¶
Rechercher des enregistrements.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/collaborateur/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/collaborateur/save¶
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma CollaborateurDto — 32 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/collaborateur/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "nom": "…", "prenom": "…"}'
Schémas¶
Schémas résolus à un niveau : les propriétés qui référencent un autre schéma sont citées par leur nom, sans être dépliées.
CollaborateurDto¶
CollaborateurDto — 32 propriétés
| Propriété | Type | Notes |
|---|---|---|
id |
integer (int32) |
— |
nom |
string |
nullable |
prenom |
string |
nullable |
adresse |
string |
nullable |
complement |
string |
nullable |
codePostal |
string |
nullable |
ville |
string |
nullable |
region |
string |
nullable |
pays |
string |
nullable |
telephone |
string |
nullable |
portable |
string |
nullable |
telecopie |
string |
nullable |
email |
string |
nullable |
estEnSommeil |
boolean |
— |
fonction |
string |
nullable |
service |
string |
nullable |
matricule |
string |
nullable |
vendeur |
boolean |
— |
caissier |
boolean |
— |
acheteur |
boolean |
— |
receptionnaire |
boolean |
— |
chargeRecouvrement |
boolean |
— |
financier |
boolean |
— |
chefVentes |
boolean |
— |
idChefVentes |
integer (int32) |
— |
transmission |
integer (int32) |
— |
facebook |
string |
nullable |
linkedIn |
string |
nullable |
skype |
string |
nullable |
dateCreation |
string (date-time) |
— |
dateModification |
string (date-time) |
— |
informationsLibres |
object |
nullable |