Aller au contenu

Stock.DepotContact

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

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

POST /v2/depotcontact

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma DepotContactDto - 15 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/depotcontact" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"idDepot": 0, "id": 0, "nom": "…"}'

PUT /v2/depotcontact

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

Schéma DepotContactDto - 15 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/depotcontact" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"idDepot": 0, "id": 0, "nom": "…"}'

DELETE /v2/depotcontact

Supprimer l'enregistrement.

Corps de la requête (application/json)

Schéma DepotContactDto - 15 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/depotcontact" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"idDepot": 0, "id": 0, "nom": "…"}'

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

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

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

POST /v2/depotcontact/save

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

Corps de la requête (application/json)

Schéma DepotContactDto - 15 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/depotcontact/save" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"idDepot": 0, "id": 0, "nom": "…"}'

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.

DepotContactDto

DepotContactDto - 15 propriétés
Propriété Type Notes
idDepot integer (int32) Numéro interne du dépôt parent (DE_No).
id integer (int32) Numéro interne du contact (DC_No). Lecture seule.
nom string nullable, Nom (DC_Nom).
prenom string nullable, Prénom (DC_Prenom).
idService integer (int32) Identifiant du service (N_Service). Non câblé en écriture (réf. IBPServiceContact).
fonction string nullable, Fonction (DC_Fonction).
telephone string nullable, Téléphone (DC_Telephone).
portable string nullable, Téléphone portable (DC_TelPortable).
telecopie string nullable, Télécopie (DC_Telecopie).
email string nullable, Adresse e-mail (DC_EMail).
civilite integer (int32) Civilité (DC_Civilite - enum COM ContactCivilite).
typeContact integer (int32) Type de contact (N_Contact). Non câblé en écriture (réf. IBPContact).
facebook string nullable, Compte Facebook (DC_Facebook).
linkedIn string nullable, Compte LinkedIn (DC_LinkedIn).
skype string nullable, Compte Skype (DC_Skype).

Voir aussi

Documentation de SenSaaS v2. Chaque page est écrite à partir du produit livré ; ce qui reste à vérifier y est signalé.