Points de terminaison d'API REST pour Contacts

PaginateContacts

Liste paginée des contacts

Récupération de la liste des contacts.

Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.

Paramètres supplémentaires

page integer

Le numéro de la page de résultats demandé.

format : int32 ≥=1 ≤=999999 default: 1

per_page integer

Limite le nombre d'objets retournés par une page. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.

format : int32 ≥=1 ≤=100 default: 10

Réponses

200 OK

Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Contact (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Contact distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.

GET /contacts

data array of object required

Tableau d'objets contenu dans la page.

100 max items

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

nom string required nullable

Nom de famille du contact.

256 max length

prenom string required nullable

Prénom du contact.

256 max length

fonction string required nullable

La fonction professionnelle d'un contact.

256 max length

telephone_fixe string required nullable

Le numéro de téléphone fixe du contact.

256 max length

telephone_portable string required nullable

Le numéro de téléphone portable du contact.

256 max length

telephone_fax string required nullable

Le numéro de fax du contact.

256 max length

adresse string required nullable

Adresse complète du contact.

256 max length

site_web_url string required nullable

Le site internet du contact.

256 max length

civilite string required nullable

Le titre de civilité utilisé.

Valeurs possibles
M
Monsieur.
Mme
Madame.
Mx
Personne non-binaire ou autre.

societe string required nullable

Nom de la société / entreprise liée à ce contact.

256 max length

email string required nullable

Adresse email du contact.

256 max length

observations string required nullable

Une chaîne de caractères arbitraire rattachée à l'objet. Souvent utile pour affichage aux utilisateurs.

8192 max length

meta object required

Métadonnées de la pagination.

pagination object required

Ensemble d'informations liées à une réponse paginée.

total integer required

Nombre total d'objets.

format : int32 ≥=0 ≤=999999

count integer required

Nombre d'objets contenu dans la page courante.

format : int32 ≥=0 ≤=999999

per_page integer required

Nombre d'objets pouvant être retournés par une page

format : int32 ≥=1 ≤=100

current_page integer required

Numéro de la page courante.

format : int32 ≥=1 ≤=999999

total_pages integer required

Nombres de pages disponibles.

format : int32 ≥=1 ≤=999999

DeleteContactContacts

Suppression d'un contact

Suppression d'une fiche contact existante.

Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.

Réponses

204 No Content

Retourne une réponse vide.

DELETE /contacts/{contact_id}

GetContactContacts

Détails d'un contact

Récupération d'une fiche contact.

Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.

Réponses

200 OK

Retourne un Objet Contact contenant les données demandées.

GET /contacts/{contact_id}

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

nom string required nullable

Nom de famille du contact.

256 max length

prenom string required nullable

Prénom du contact.

256 max length

fonction string required nullable

La fonction professionnelle d'un contact.

256 max length

telephone_fixe string required nullable

Le numéro de téléphone fixe du contact.

256 max length

telephone_portable string required nullable

Le numéro de téléphone portable du contact.

256 max length

telephone_fax string required nullable

Le numéro de fax du contact.

256 max length

adresse string required nullable

Adresse complète du contact.

256 max length

site_web_url string required nullable

Le site internet du contact.

256 max length

civilite string required nullable

Le titre de civilité utilisé.

Valeurs possibles
M
Monsieur.
Mme
Madame.
Mx
Personne non-binaire ou autre.

societe string required nullable

Nom de la société / entreprise liée à ce contact.

256 max length

email string required nullable

Adresse email du contact.

256 max length

observations string required nullable

Une chaîne de caractères arbitraire rattachée à l'objet. Souvent utile pour affichage aux utilisateurs.

8192 max length

PostContactContacts

Mise à jour d'un contact

Mise à jour d'une fiche contact existante en définissant les valeurs des paramètres transmis. Tous les paramètres non fournis resteront inchangés.

Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.

Paramètres du corps de la requête

nom string nullable

Nom de famille du contact.

256 max length

prenom string nullable

Prénom du contact.

256 max length

fonction string nullable

La fonction professionnelle d'un contact.

256 max length

telephone_fixe string nullable

Le numéro de téléphone fixe du contact.

256 max length

telephone_portable string nullable

Le numéro de téléphone portable du contact.

256 max length

telephone_fax string nullable

Le numéro de fax du contact.

256 max length

adresse string nullable

Adresse complète du contact.

256 max length

site_web_url string nullable

Le site internet du contact.

256 max length

civilite string nullable

Le titre de civilité utilisé.

Valeurs possibles
M
Monsieur.
Mme
Madame.
Mx
Personne non-binaire ou autre.

societe string nullable

Nom de la société / entreprise liée à ce contact.

256 max length

email string nullable

Adresse email du contact.

256 max length

observations string nullable

Une chaîne de caractères arbitraire rattachée à l'objet. Souvent utile pour affichage aux utilisateurs.

8192 max length

Réponses

200 OK

Retourne un Objet Contact contenant les données demandées.

POST /contacts/{contact_id}

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

nom string required nullable

Nom de famille du contact.

256 max length

prenom string required nullable

Prénom du contact.

256 max length

fonction string required nullable

La fonction professionnelle d'un contact.

256 max length

telephone_fixe string required nullable

Le numéro de téléphone fixe du contact.

256 max length

telephone_portable string required nullable

Le numéro de téléphone portable du contact.

256 max length

telephone_fax string required nullable

Le numéro de fax du contact.

256 max length

adresse string required nullable

Adresse complète du contact.

256 max length

site_web_url string required nullable

Le site internet du contact.

256 max length

civilite string required nullable

Le titre de civilité utilisé.

Valeurs possibles
M
Monsieur.
Mme
Madame.
Mx
Personne non-binaire ou autre.

societe string required nullable

Nom de la société / entreprise liée à ce contact.

256 max length

email string required nullable

Adresse email du contact.

256 max length

observations string required nullable

Une chaîne de caractères arbitraire rattachée à l'objet. Souvent utile pour affichage aux utilisateurs.

8192 max length