Aller au contenu

Catalogue.Famille

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/famille Lister les enregistrements
POST /v2/famille Créer l'enregistrement
PUT /v2/famille Mettre à jour l'enregistrement
DELETE /v2/famille Supprimer l'enregistrement
GET /v2/famille/count Compter les enregistrements
POST /v2/famille/count Compter les enregistrements
POST /v2/famille/recherche Rechercher des enregistrements
POST /v2/famille/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/famille

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/famille?sort=<sort>&where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/famille

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma FamilleDto — 41 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/famille" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"code": "…", "type": {}, "intitule": "…"}'

PUT /v2/famille

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

Schéma FamilleDto — 41 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/famille" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"code": "…", "type": {}, "intitule": "…"}'

DELETE /v2/famille

Supprimer l'enregistrement.

Corps de la requête (application/json)

Schéma FamilleDto — 41 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/famille" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"code": "…", "type": {}, "intitule": "…"}'

GET /v2/famille/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/famille/count?where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/famille/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/famille/count" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/famille/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/famille/recherche" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/famille/save

Créer ou mettre à jour l'enregistrement (upsert).

Corps de la requête (application/json)

Schéma FamilleDto — 41 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/famille/save" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"code": "…", "type": {}, "intitule": "…"}'

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.

FamilleDto

FamilleDto — 41 propriétés
Propriété Type Notes
code string nullable
type TypeFamille —
intitule string nullable
codeFamilleCentralisatrice string nullable
nature integer (int32) —
idUniteVente integer (int32) —
unitePoids integer (int32) —
coefficient number (double) —
typeSuiviStock integer (int32) —
fictif boolean —
statistique1 string nullable
statistique2 string nullable
statistique3 string nullable
statistique4 string nullable
statistique5 string nullable
dateCreation string (date-time) —
dateModification string (date-time) —
garantie integer (int32) —
codeFiscal string nullable
pays string nullable
escompte boolean —
delai integer (int32) —
horsStatistique boolean —
venteAuDebit boolean —
nonImpression boolean —
contremarque boolean —
facturationPoids boolean —
facturationForfait boolean —
publie boolean —
racineReference string nullable
racineCodeBarres string nullable
idCatalogue1 integer (int32) —
idCatalogue2 integer (int32) —
idCatalogue3 integer (int32) —
idCatalogue4 integer (int32) —
nombreColis integer (int32) —
sousTraitance boolean —
criticite integer (int32) —
fraisFixe1 FraisFixeDto —
fraisFixe2 FraisFixeDto —
fraisFixe3 FraisFixeDto —

Voir aussi