Tiers.Contact

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

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

POST /v2/contact

Créer l'enregistrement.

Corps de la requête (application/json)

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

PUT /v2/contact

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

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

DELETE /v2/contact

Supprimer l'enregistrement.

Corps de la requête (application/json)

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

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

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

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

POST /v2/contact/save

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

Corps de la requête (application/json)

Schéma ContactDto - 20 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/contact/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.

ContactDto

ContactDto - 20 propriétés

Propriété	Type	Notes
id	integer (int32)	Numéro interne du contact (CD_No), attribué par Sage. Lecture.
nom	string	nullable, Nom (clé fonctionnelle).
prenom	string	nullable, Prénom (clé fonctionnelle).
fonction	string	nullable, Fonction.
civilite	integer (int32)	Civilité (ContactCivilite : Monsieur=0, Madame=1, Mademoiselle=2).
idService	integer (int32)	Identifiant du service (N_Service → IBPServiceContact). Référence non câblée en écriture.
idTypeContact	integer (int32)	Identifiant du type de contact (N_Contact → IBPContact). Référence non câblée en écriture.
telephone	string	nullable, Téléphone (sous-objet Telecom).
portable	string	nullable, Portable (sous-objet Telecom).
fax	string	nullable, Télécopie / fax (sous-objet Telecom).
email	string	nullable, Email (sous-objet Telecom).
adresse	string	nullable, Adresse (sous-objet Adresse).
complement	string	nullable, Complément d'adresse (sous-objet Adresse).
codePostal	string	nullable, Code postal (sous-objet Adresse).
ville	string	nullable, Ville (sous-objet Adresse).
region	string	nullable, Code région (sous-objet Adresse).
pays	string	nullable, Pays (sous-objet Adresse).
facebook	string	nullable, Compte Facebook.
linkedIn	string	nullable, Compte LinkedIn.
skype	string	nullable, Compte Skype.

Voir aussi

• Démarrer avec l'API v2
• Conventions de payload
• Tous les groupes

Écrans qui utilisent ce groupe

• Accès B2B
• Clients, prospects, fournisseurs et contacts