Parametres.Vente.Rappel
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/rappel |
Lister les enregistrements |
POST |
/v2/rappel |
Créer l'enregistrement |
PUT |
/v2/rappel |
Mettre à jour l'enregistrement |
DELETE |
/v2/rappel |
Supprimer l'enregistrement |
GET |
/v2/rappel/count |
Compter les enregistrements |
POST |
/v2/rappel/count |
Compter les enregistrements |
POST |
/v2/rappel/recherche |
Rechercher des enregistrements |
POST |
/v2/rappel/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/rappel
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/rappel?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/rappel
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma RappelDto - 5 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/rappel" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "intitule": "…", "debut": 0}'
PUT /v2/rappel
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma RappelDto - 5 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/rappel" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "intitule": "…", "debut": 0}'
DELETE /v2/rappel
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma RappelDto - 5 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/rappel" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "intitule": "…", "debut": 0}'
GET /v2/rappel/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/rappel/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/rappel/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/rappel/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/rappel/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/rappel/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/rappel/save
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma RappelDto - 5 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/rappel/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "intitule": "…", "debut": 0}'
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.
RappelDto
RappelDto - 5 propriétés
| Propriété | Type | Notes |
|---|---|---|
id |
integer (int32) |
Indice du rappel (clé, cbIndice). |
intitule |
string |
nullable, Intitulé (35 caractères max). |
debut |
integer (int32) |
Borne de début (jours). |
fin |
integer (int32) |
Borne de fin (jours). |
nbJours |
integer (int32) |
Nombre de jours. |