Introduction Glossaire Guide utilisateur Guide administrateur fonctionnel Guide administrateur technique Prérequis pour Maarch Courrier Installation Script de migration Exploitation Mise en oeuvre de docker Architecture technique Architecture du produit Architecture d'un projet type Description du modèle de données Description des webservices Contacts Resources

Création d'un contact

Route

POST /rest/contacts

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
firstname string Non Prénom
lastname string Oui (Si contact particulier) Nom
email string Oui Email
phone string Non Téléphone
contactType int Oui Type de contact (id lié à la table "contact_types")
isCorporatePerson char (Y/N) Oui Le contact est-il une personne morale
contactPurposeId int Oui Dénomination de l'adresse (id lié à la table "contact_purposes")
society string Non Nom de la société
societyShort string Non Nom raccourci de la société
title string Non Titre du contact
other_data string Non Informations complémentaires
function string Non Fonction du contact
addressNum string Non Numéro
addressStreet string Non Voie
addressZip string Non Code postal
addressTown string Non Ville
addressCountry string Non Pays
addressComplement string Non Complément d'adresse : Tour, bâtiment, immeuble, résidence
occupancy string Non Complément d'adresse : N° app, étage, escalier
website string Non Site web
userId string Non superadmin Login du créateur du contact (user_id lié à la table "users")
isPrivate char (Y/N) Non N Les informations du contacts ne seront pleinement visibles que par l'utilisateur créateur
external_contact_id string Non Identifiant externe
Exemple
// JSON
{
    "firstname" : "Clark",
    "lastname" : "Kent",
    "contactType" : 106,
    "contactPurposeId" : 3,
    "isCorporatePerson" : "N",
    "email" : "clark.kent@daily-planet.com",
    "phone" : "+33120212223",
    "society" : "Daily Planet",
    "societyShort" : "DL",
    "title" : "title3",
    "function" : "Reporter",
    "addressNum" : "30",
    "addressStreet" : "Rue des avions",
    "addressZip" : "75001",
    "addressTown" : "Paris",
    "addressCountry" : "France",
    "userId" : "pwhite"
}

Retour

Code Http Type Description Exemple
200 array Le contact a bien été créé ['contactId' => 21, 'addressId' => 42]
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '[ContactController create] Contact creation has failed']

Création d'une nouvelle adresse

Route

POST /rest/contacts/{id}/addresses

Le paramètre id de la route représente l'identifiant (int) du contact auquel on rajoute une adresse

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
firstname string Non Prénom
lastname string Non Nom
email string Oui Email
phone string Non Téléphone
contactPurposeId int Oui Dénomination de l'adresse (id lié à la table "contact_purposes")
title string Non Titre du contact
other_data string Non Informations complémentaires
function string Non Fonction du contact
addressNum string Non Numéro
addressStreet string Non Voie
addressZip string Non Code postal
addressTown string Non Ville
addressCountry string Non Pays
addressComplement string Non Complément d'adresse : Tour, bâtiment, immeuble, résidence
occupancy string Non Complément d'adresse : N° app, étage, escalier
website string Non Site web
userId string Non superadmin Login du créateur du contact (user_id lié à la table "users")
isPrivate char (Y/N) Non N Les informations du contacts ne seront pleinement visibles que par l'utilisateur créateur
external_contact_id string Non Identifiant externe
Exemple
// JSON
{
    "contactPurposeId" : 3,
    "email" : "office@group.com",
    "phone" : "+33120212223",
    "addressNum" : "14",
    "addressStreet" : "Avenue du Pérou",
    "addressZip" : "75016",
    "addressTown" : "Paris",
    "addressCountry" : "France"
}

Retour

Code Http Type Description Exemple
200 array L'adresse a bien été créé ['addressId' => 43]
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Modification d'un contact

Route

PUT /rest/contacts/{id}

Le paramètre id de la route représente l'identifiant (int) du contact à modifier

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
firstname string Non Prénom
lastname string Non Nom
contact_type int Non Type de contact (id lié à la table "contact_types")
is_corporate_person char (Y/N) Non Le contact est-il une personne morale
title string Non Titre du contact
society string Non Nom de la société
society_short string Non Nom raccourci de la société
other_data string Non Informations complémentaires
function string Non Fonction du contact
Exemple
// JSON
{
    "firstname" : "Kal",
    "lastname" : "El",
    "society" : "the torch",
    "function" : "CTO"
}

Retour

Code Http Type Description Exemple
200 array Le contact a bien été modifié ['success' => 'success']
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Modification d'une adresse

Route

PUT /rest/contacts/{id}/addresses/{addressId}

Le paramètre id de la route représente l'identifiant (int) du contact
Le paramètre addressId de la route représente l'identifiant (int) de l'adresse à modifier

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
firstname string Non Prénom
lastname string Non Nom
email string Non Email
phone string Non Téléphone
contact_purpose_id int Non Dénomination de l'adresse (id lié à la table "contact_purposes")
title string Non Titre du contact
other_data string Non Informations complémentaires
function string Non Fonction du contact
address_num string Non Numéro
address_street string Non Voie
address_postal_code string Non Code postal
address_town string Non Ville
address_country string Non Pays
address_complement string Non Complément d'adresse : Tour, bâtiment, immeuble, résidence
occupancy string Non Complément d'adresse : N° app, étage, escalier
website string Non Site web
is_private char (Y/N) Non Les informations du contacts ne seront pleinement visibles que par l'utilisateur créateur
external_contact_id string Non Identifiant externe
Exemple
// JSON
{
    "email" : "office-updated@group.com",
    "phone" : "+33120212244",
    "address_num" : "14 Bis",
    "address_street" : "Avenue du Pérou"
}

Retour

Code Http Type Description Exemple
200 array Le contact a bien été modifié ['success' => 'success']
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Récupération des taux de complétion des contacts

Route

GET /rest/contactsFilling

Retour

Code Http Type Description
200 array Informations liées aux taux de complétion des contacts
Données
Valeur Type Description
id int Identifiant dans la table (pas d'utilité)
enable bool Indique si la fonctionnalité est activée
rating_columns array Liste les colonnes prises en compte pour le calcul du taux
first_threshold int Premier palier (%)
second_threshold int Second palier (%)

La couleur rouge correspond de 0 à {first_threshold} %
La couleur orange correspond de {first_threshold} à {second_threshold} %
La couleur verte correspond de {second_threshold} à 100 %

Exemple
// JSON
{
    "contactsFilling" : {
        "id" : 1,
        "enable" : true,
        "rating_columns" : ["society", "function", "other_data"],
        "first_threshold" : 33,
        "second_threshold" : 66
    }

}

Modification des taux de complétion des contacts

Route

PUT /rest/contactsFilling

Paramètres

Body
Valeur Type Obligatoire Description
enable bool Oui Indique si la fonctionnalité est activée
rating_columns array Oui Tableau des colonnes prises en compte pour le calcul du taux
first_threshold int Oui Taux du premier palier
second_threshold int Oui Taux du second palier
Exemple
// JSON
{
    "enable" : true,
    "rating_columns" : ["society", "function"],
    "first_threshold" : 22,
    "second_threshold" : 85
}

Retour

Code Http Type Description Exemple
200 array Le contact a bien été modifié ['success' => 'success']
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

results matching ""

    No results matching ""