NAV

Introduction

Dendreo est un logiciel de gestion pour centre de formation.

Vous pouvez créer un compte d'essai de 14 jours sur notre site internet.

Fonctionnement général

Authentification

Nous proposons une authentification par token. Le token peut être communiqué de deux manières différentes :

L'absence de ce token ou l'utilisation d'un token invalide, entrainera une erreur 401 (Unauthorized).

Attention, l'URL de l'API dépend de votre URL de connexion. Dans les exemples ci-dessous, les URLs sont fournis pour le compte demo.

Exemple : https://pro.dendreo.com/demo/api/entreprises.php

Formats

Requêtes

Deux stratégies sont proposées pour les requêtes liées à la création ou la mise à jour d'un élément :

Réponses

Seul le format JSON est proposé actuellement.

Erreurs

{
  "status": "failure",
  "errors": [
    "Une raison sociale est obligatoire (raison_sociale est vide)"
  ]
}

Quand des attributs sont validés par l'API (présence, format, existence), si aucune erreur n'est détectée, un statut 200 (Success) ou 201 (Created) sera retourné par l'API.

Dans le cas contraire, un statut 422 (Unprocessable Entity) sera retourné accompagné des messages d'erreurs associés aux validations qui ont échouée.

Requêtes

[
  {
    "id_entreprise": "3",
    "raison_sociale": "EDF"
  },
  {
    "id_entreprise": "4",
    "raison_sociale": "Peugeot"
  }
]

Dans le cas des requêtes GET il est possible de requêter plus d'un objet, en mettant plusieurs id à la suite, séparés par des virgules

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?id=12,14,16

Dans le cas des requêtes SHOW et INDEX il est possible de restreindre les colonnes à afficher en renseignant le paramètre fields.

Exemple : GET https://pro.dendreo.com/demo/api/entreprises.php?fields=id_entreprise,raison_sociale

Il est aussi possible d'inclure dans la réponse des éléments liés en les indiquant dans le paramètre “include”.

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?include=entreprise

Recherche/filtre

Dans le cas des requêtes INDEX il est possible de filtrer les résultats en indiquant une clef de recherche dans le paramètre search.

Exemple : GET https://pro.dendreo.com/demo/api/entreprises.php?search=EDF

Les champs sur lesquels cette recherche est effectuée sont précisés pour chaque objet.

Integrations

PHP

En cours de développement.

Catégories de module

Exemple de réponse

{
  "id_categorie_module": "3",
  "intitule": "Management",
  "status": "1"
}

Une catégorie de module correspond à un système de classification des modules de formation qui constituent le catalogue.

Actions disponibles

Action Méthode URL
INDEX GET /api/categories_module.php
SHOW GET /api/categories_module.php?id=3

Catégories de produits

Exemple de réponse

{
  "id_categorie_produit": "2",
  "intitule": "E-Learning",
  "color": "490A3D",
  "status": "1"
}

Lorsque le mode “Multi-Produits” est activé Dendreo est capable de gérer différents Produits, autres que de la formation. Vous pourrez ajouter différents types de Produits à votre Catalogue, puis utiliser ces Produits au sein de vos Actions de Formation. Vous pouvez même réaliser des Actions Hors Formation, c'est à dire des Actions ne comportant aucun Module de formation.

Actions disponibles

Action Méthode URL
INDEX GET /api/categories_produit.php
SHOW GET /api/categories_produit.php?id=3

Modules/Produits

Par défaut, Dendreo permet de programmer de la formation. Il existe cependant une option appelée “Multi-Produits” qui permet d'associer d'autres produits (modules) à une action de formation.

La catégorie de produit par défaut (id_categorie_produit = 1) correspond à de la formation. Un module avec un id_categorie_produit différent de 1 est donc considéré comme un produit autre que de la formation.

Lister tous les modules de formation

[
  {
    "id_module": "4",
    "id_categorie_produit": "1",
    "intitule": "[Demo] Les Bases Du Management",
    "include_in_bpf": "1",
    "numero": "4",
    "numero_complet": "MOD_2014004",
    "numero_comptable": "",
    "description": "Les bases du management",
    "prix": "1000.00",
    "duree_heures": "4.00",
    "duree_jours": "1.00",
    "id_formacode": "0",
    "id_specialite": "2",
    "id_formateur": "0",
    "id_categorie_module": "1",
    "nb_participants": "0",
    "objectif": "",
    "public_vise": "",
    "pre_requis": "",
    "intitules": "",
    "id_salle_de_formation": "0",
    "moyens_pedago": ""
  }
]

Accède à tous les modules de formation présents sur Dendreo.

Il est possible d'afficher des données supplémentaires pour les modules en renseignant le paramètre include.

Exemple : GET https://pro.dendreo.com/demo/api/modules.php?include=visuel

Requête HTTP

GET https://pro.dendreo.com/demo/api/modules.php

Afficher un module de formation

{
  "id_module": "4",
  "id_categorie_produit": "1",
  "intitule": "[Demo] Les Bases Du Management",
  "include_in_bpf": "1",
  "numero": "4",
  "numero_complet": "MOD_2014004",
  "numero_comptable": "",
  "description": "Les bases du management",
  "prix": "1000.00",
  "duree_heures": "4.00",
  "duree_jours": "1.00",
  "id_formacode": "0",
  "id_specialite": "2",
  "id_formateur": "0",
  "id_categorie_module": "1",
  "nb_participants": "0",
  "objectif": "",
  "public_vise": "",
  "pre_requis": "",
  "intitules": "",
  "id_salle_de_formation": "0",
  "moyens_pedago": "",
  "actions_de_formation_programmees": [
    {
      "id_action_de_formation": "132",
      "intitule": "[Demo] Les Bases Du Management",
      "date_debut": "2016-09-02 09:00:00",
      "date_fin": "2016-09-02 17:00:00"
    }
  ]
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/modules.php?id=4

Il est possible de récupérer l'url du visuel associé au module dans la réponse, en rajoutant include=visuel à votre requête.

Exemple : GET https://pro.dendreo.com/demo/api/modules.php?id=4&include=visuel

Notez que les actions_de_formation_programmees retournées pour un module sont uniquement les actions de formation dans une étape de type “prévisionnelle” (cela exclue donc les formations en cours de réalisation ou terminées).

Formateurs

Lister tous les formateurs

[
  {
    "id_formateur": "5",
    "numero": "1",
    "numero_complet": "",
    "n_secu": "",
    "civilite": "M.",
    "nom": "Dupond",
    "nom_jeune_fille": "",
    "prenom": "Jacques",
    "date_de_naissance": "1963-09-01",
    "lieu_de_naissance": "LYON",
    "nationalite": "Française",
    "situation_familiale": "-",
    "adresse": "33 rue Bichat",
    "code_postal": "75006",
    "ville": "PARIS",
    "profession": "Formateur Professionnel d'Adultes",
    "telephone_perso": "0676655443",
    "telephone_pro": "0676655443",
    "email_perso": "",
    "email_pro": "contact@cformateur.fr",
    "statut": "travailleur_independant",
    "remu_horaire_par_defaut": "0.00",
    "diplomes": "",
    "id_externe": ""
  }
]

Accède à tous les formateurs présents sur Dendreo.

Requête HTTP

GET https://pro.dendreo.com/demo/api/formateurs.php

Afficher un formateur

{
  "id_formateur": "5",
  "numero": "1",
  "numero_complet": "",
  "n_secu": "",
  "civilite": "M.",
  "nom": "Dupond",
  "nom_jeune_fille": "",
  "prenom": "Jacques",
  "date_de_naissance": "1963-09-01",
  "lieu_de_naissance": "LYON",
  "nationalite": "Française",
  "situation_familiale": "-",
  "adresse": "33 rue Bichat",
  "code_postal": "75006",
  "ville": "PARIS",
  "profession": "Formateur Professionnel d'Adultes",
  "telephone_perso": "0676655443",
  "telephone_pro": "0676655443",
  "email_perso": "",
  "email_pro": "contact@cformateur.fr",
  "statut": "travailleur_independant",
  "remu_horaire_par_defaut": "0.00",
  "diplomes": "",
  "id_externe": ""
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/formateurs.php?id=5

Il est possible de récupérer l'url de la photo de profil du formateur dans la réponse, en rajoutant include=photo à votre requête.

Exemple : GET https://pro.dendreo.com/demo/api/formateurs.php?id=5&include=photo

Entreprises

Lister toutes les entreprises

[
  {
    "id_entreprise": "1375",
    "numero": "1",
    "numero_complet": "",
    "numero_compte_client": "",
    "siret": "1678637863 00013",
    "raison_sociale": "EDF",
    "appellation": "",
    "sigle": "Entreprise privée",
    "statut_juridique": "SARL",
    "telephone": "04 76 76 54 53",
    "fax": "04 67 65 53 64",
    "site_internet": "",
    "email_standard": "",
    "adresse": "8 AVenue du Gal ",
    "code_postal": "75002",
    "ville": "Paris",
    "pays": "France",
    "facturation_raison_sociale": "",
    "facturation_adresse": "",
    "facturation_code_postal": "",
    "facturation_ville": "",
    "facturation_pays": "",
    "mode_financement_par_defaut": "entreprise",
    "nb_employes": "0",
    "enjeu": "0",
    "client": "0",
    "id_contact": "0",
    "id_contact_secondaire": "0",
    "commentaires": "",
    "particulier": "0",
    "id_externe": "",
    "tva_intra": "16786387 00013"
  }
]

Il est possible de filtrer les entreprises sur les attributs raison_sociale ou siret.

Exemple : GET https://pro.dendreo.com/demo/api/entreprises.php?search=EDF

Requête HTTP

GET https://pro.dendreo.com/demo/api/entreprises.php

Afficher une entreprise

{
  "id_entreprise": "1375",
  "numero": "1",
  "numero_complet": "",
  "numero_compte_client": "",
  "siret": "1678637863 00013",
  "raison_sociale": "EDF",
  "appellation": "",
  "sigle": "Entreprise privée",
  "statut_juridique": "SARL",
  "telephone": "04 76 76 54 53",
  "fax": "04 67 65 53 64",
  "site_internet": "",
  "email_standard": "",
  "adresse": "8 AVenue du Gal ",
  "code_postal": "75002",
  "ville": "Paris",
  "pays": "France",
  "facturation_raison_sociale": "",
  "facturation_adresse": "",
  "facturation_code_postal": "",
  "facturation_ville": "",
  "facturation_pays": "",
  "mode_financement_par_defaut": "entreprise",
  "nb_employes": "0",
  "enjeu": "0",
  "client": "0",
  "id_contact": "0",
  "id_contact_secondaire": "0",
  "commentaires": "",
  "particulier": "0",
  "id_externe": "",
  "tva_intra": "16786387 00013"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/entreprises.php?id=1375

Ajouter une entreprise

Seule la présence de l'attribut raison_sociale est validée.

{
  "id_entreprise": "1375",
  "numero": "1",
  "numero_complet": "",
  "numero_compte_client": "",
  "siret": "1678637863 00013",
  "raison_sociale": "EDF",
  "appellation": "",
  "sigle": "Entreprise privée",
  "statut_juridique": "SARL",
  "telephone": "04 76 76 54 53",
  "fax": "04 67 65 53 64",
  "site_internet": "",
  "email_standard": "",
  "adresse": "8 Avenue du Gal ",
  "code_postal": "75002",
  "ville": "Paris",
  "pays": "France",
  "facturation_raison_sociale": "",
  "facturation_adresse": "",
  "facturation_code_postal": "",
  "facturation_ville": "",
  "facturation_pays": "",
  "mode_financement_par_defaut": "entreprise",
  "nb_employes": "0",
  "enjeu": "0",
  "client": "0",
  "id_contact": "0",
  "id_contact_secondaire": "0",
  "commentaires": "",
  "particulier": "0",
  "id_externe": "",
  "tva_intra": "16786387 00013"
}

Paramètres

Intitulé Obligatoire Description
raison_sociale oui Raison sociale
siret non N° SIRET
appellation non Appellation
sigle non Sigle
statut_juridique non Statut juridique
telephone non Téléphone
fax non Fax
site_internet non Site internet
telephone non Téléphone
email_standard non Email standard
adresse non Adresse
code_postal non Code postal
ville non Ville
pays non Pays
nb_employes non Nombre d'employés
commentaires non Commentaires
id_administrateur non Commercial associé (existence vérifiée)
id_externe non ID externe (synchro)
facturation_raison_sociale non Raison sociale (facturation)
facturation_adresse non Adresse (facturation)
facturation_code_postal non Code postal (facturation)
facturation_ville non Ville (facturation)
facturation_pays non Pays (facturation)

Requête HTTP

POST https://pro.dendreo.com/demo/api/entreprises.php

Contacts

Lister tous les contacts

[
  {
    "id_contact": "3",
    "id_entreprise": "3",
    "civilite": "Mme",
    "nom": "Marue ",
    "prenom": "",
    "fonction": "Responsable Formation ",
    "telephone_direct": "01 02 03 04 05",
    "portable": "",
    "email": "maru@domaine.fr",
    "particulier": "0",
    "id_externe": ""
  }
]

Il est possible de n'afficher que les contacts appartenants à une entreprise en renseignant l'attribut id_entreprise.

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?id_entreprise=3

Il est aussi possible de filtrer les contacts sur les attributs nom ou email ainsi que d'inclure les informations de l'entreprise via l'attribut include.

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?include=entreprise

Requête HTTP

GET https://pro.dendreo.com/demo/api/contacts.php

Afficher un contact

{
  "id_contact": "3",
  "id_entreprise": "3",
  "civilite": "Mme",
  "nom": "Marue ",
  "prenom": "",
  "fonction": "Responsable Formation ",
  "telephone_direct": "01 02 03 04 05",
  "portable": "",
  "email": "maru@domaine.fr",
  "particulier": "0",
  "id_externe": ""
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/contacts.php?id=3

Il est possible de récupérer l'url de la photo de profil du contact dans la réponse, en rajoutant include=photo à votre requête.

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?id=5&include=photo

Ajouter un contact

{
  "id_contact": "3",
  "id_entreprise": "3",
  "civilite": "Mme",
  "nom": "Marue ",
  "prenom": "",
  "fonction": "Responsable Formation ",
  "telephone_direct": "01 02 03 04 05",
  "portable": "",
  "email": "maru@domaine.fr",
  "particulier": "0",
  "id_externe": ""
}

Rattacher le contact à une entreprise

Il existe trois façons de rattacher un contact à une entreprise qui sont évaluées dans l'ordre de préférence suivant :

Paramètres

Intitulé Obligatoire Description
id_entreprise non ID Entreprise (existence vérifiée)
nom oui Nom
prenom non prénom
civilite non Civilité (format vérifié)
fonction non Fonction
telephone_direct non Téléphone direct
portable non Portable
email non Email
id_externe non ID Externe (synchro)
entreprise_raison_sociale non Liaison avec l'entreprise via la raison sociale
entreprise_id_externe non Liaison avec l'entreprise via son id externe

Requête HTTP

POST https://pro.dendreo.com/demo/api/contacts.php

Particuliers

Ajouter un particulier

L'ajout d'un particulier se fait sur le même URL qu'un contact avec la variable particulier égale à 1.

{
  "id_contact": "3",
  "id_entreprise": "3",
  "civilite": "Mme",
  "nom": "Marue ",
  "prenom": "",
  "fonction": "Responsable Formation ",
  "telephone_direct": "01 02 03 04 05",
  "portable": "",
  "email": "maru@domaine.fr",
  "particulier": "1",
  "id_externe": ""
}

Paramètres

Intitulé Obligatoire Description
particulier oui valeur égale à 1 sinon ajout d'un contact
nom oui Nom
prenom non prénom
civilite non Civilité (format vérifié)
fonction non Fonction
telephone_direct non Téléphone direct
portable non Portable
email non Email
id_externe non ID Externe (synchro)
adresse non Adresse
code_postal non Code postal
ville non Ville
pays non Pays
id_administrateur non Commercial associé (existence vérifiée)

Requête HTTP

POST https://pro.dendreo.com/demo/api/contacts.php

Participants

Lister tous les participants

[
  {
    "id_participant": "17",
    "civilite": "Mme",
    "nom": "Duru ",
    "prenom": "Françoise ",
    "email": "",
    "commentaires": "",
    "portable": "",
    "fonction": "Assistante RH",
    "date_de_naissance": "0000-00-00",
    "id_entreprise": "4",
    "particulier": "0",
    "id_externe": ""
  }
]

Il est possible de n'afficher que les participants appartenants à une entreprise en renseignant l'attribut id_entreprise.

Exemple : GET https://pro.dendreo.com/demo/api/participants.php?id_entreprise=4

Il est aussi possible de filtrer les participants sur les attributs nom ou email (via l'attribut search) ainsi que d'inclure les informations de l'entreprise via l'attribut include.

Exemple : GET https://pro.dendreo.com/demo/api/participants.php?search=user@domain.tld

Exemple : GET https://pro.dendreo.com/demo/api/participants.php?include=entreprise

Requête HTTP

GET https://pro.dendreo.com/demo/api/participants.php

Afficher un participant

{
  "id_participant": "17",
  "civilite": "Mme",
  "nom": "Duru ",
  "prenom": "Françoise ",
  "email": "",
  "commentaires": "",
  "portable": "",
  "fonction": "Assistante RH",
  "date_de_naissance": "0000-00-00",
  "id_entreprise": "4",
  "particulier": "0",
  "id_externe": ""
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/participants.php?id=17

Il est possible de récupérer l'url de la photo de profil du participant dans la réponse, en rajoutant include=photo à votre requête.

Exemple : GET https://pro.dendreo.com/demo/api/participants.php?id=5&include=photo

Il est aussi possible de requêter directement les informations de l'entreprise, du contact principal de l'entreprise, et du contact secondaire de l'entreprise du ou des participants via l'attribut include.

Exemple : GET https://pro.dendreo.com/demo/api/participants.php?id=12,14,28&include=entreprise,entreprise_contact,entreprise_contact_secondaire

Ajouter un participant

{
  "id_participant": "17",
  "civilite": "Mme",
  "nom": "Duru ",
  "prenom": "Françoise ",
  "email": "",
  "commentaires": "",
  "portable": "",
  "fonction": "Assistante RH",
  "date_de_naissance": "0000-00-00",
  "id_entreprise": "4",
  "particulier": "0",
  "id_externe": ""
}

Rattacher le participant à une entreprise

Il existe trois façons de rattacher un participant à une entreprise qui sont évaluées dans l'ordre de préférence suivant :

Paramètres

Intitulé Obligatoire Description
id_entreprise non ID Entreprise (existence vérifiée)
nom oui Nom
prenom non prénom
civilite non Civilité (format vérifié)
fonction non Fonction
commentaires non Commentaires
portable non Portable
email non Email
date_de_naissance non Date de naissance (format “AAAA-MM-JJ” ou “JJ/MM/AAAA”)
id_externe non ID Externe (synchro)
entreprise_raison_sociale non Liaison avec l'entreprise via la raison sociale
entreprise_id_externe non Liaison avec l'entreprise via son id externe

Requête HTTP

POST https://pro.dendreo.com/demo/api/participants.php

Etapes

Lister toutes les étapes

[
  {
    "id_etape_process": "2",
    "intitule": "Réalisation",
    "id_parent": "0",
    "status": "1",
    "ordre": "2",
    "name": "real",
    "cible": "intra"
  }
]

Accède à toutes les étapes présentes sur Dendreo.

Requête HTTP

GET https://pro.dendreo.com/demo/api/etapes.php

Afficher une étape

{
  "id_etape_process": "2",
  "intitule": "Réalisation",
  "id_parent": "0",
  "status": "1",
  "ordre": "2",
  "name": "real",
  "cible": "intra"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/etapes.php?id=2

Centres de formation

Lister tous les centres de formation

[
  {
    "id_centre_de_formation": "1",
    "raison_sociale": "Centre principal"
  }
]

Accède à tous les centres de formation présents sur Dendreo.

Requête HTTP

GET https://pro.dendreo.com/demo/api/centres_de_formation.php

Afficher un centre de formation

{
  "id_centre_de_formation": "1",
  "raison_sociale": "Centre principal"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/centres_de_formation.php?id=1

Salles de formation

Lister toutes les salles de formation

[
  {
    "id_salle_de_formation": "3",
    "intitule": "Salle Einstein",
    "capacite_max": "20",
    "adresse": "",
    "code_postal": "",
    "ville": "",
    "pays": ""
  },
  {
    "id_salle_de_formation": "4",
    "intitule": "Salle Amandre",
    "capacite_max": "42",
    "adresse": "",
    "code_postal": "",
    "ville": "",
    "pays": ""
  }
]

Accède à toutes les salles de formation présentes sur Dendreo.

Requête HTTP

GET https://pro.dendreo.com/demo/api/salles_de_formation.php

Afficher une salle de formation

{
  "id_salle_de_formation": "4",
  "intitule": "Salle Amandre",
  "capacite_max": "42",
  "adresse": "",
  "code_postal": "",
  "ville": "",
  "pays": ""
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/salles_de_formation.php?id=4

Factures

Lister toutes les factures émises

[
  {
    "id_facture": "19",
    "date_emission": "2016-10-09 10:42:59",
    "date_paiement": "0000-00-00 00:00:00",
    "moyen_paiement": "",
    "numero": "1",
    "numero_complet": "",
    "id_entreprise": "876",
    "id_opca": "0",
    "id_participant": "0",
    "montant_total_ht": "870.00",
    "raison_sociale": "EDF",
    "adresse": "28 rue Bigleuil",
    "code_postal": "75006",
    "ville": "Paris",
    "pays": "FRANCE",
    "remarque": "",
    "tva": "0",
    "remise": "0",
    "id_avoir": "0"
  }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/factures.php

Paramètres

Intitulé Obligatoire Description
date_emission non Filtrer sur la date d'émission (format vérifié : “AAAA-MM-JJ”)
date_paiement non Filtrer sur la date de paiement (format vérifié : “AAAA-MM-JJ”)
id_entreprise non Filtrer sur les factures à destination de cette entreprise
id_opca non Filtrer sur les factures à destination de ce financeur

Afficher une facture

[
  {
    "id_facture": "19",
    "date_emission": "2016-10-09 10:42:59",
    "date_paiement": "0000-00-00 00:00:00",
    "moyen_paiement": "",
    "numero": "1",
    "numero_complet": "",
    "id_entreprise": "876",
    "id_opca": "0",
    "id_participant": "0",
    "montant_total_ht": "870.00",
    "raison_sociale": "EDF",
    "adresse": "28 rue Bigleuil",
    "code_postal": "75006",
    "ville": "Paris",
    "pays": "FRANCE",
    "remarque": "",
    "tva": "0",
    "remise": "0",
    "id_avoir": "0"
  }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/factures.php?id=19

Actions de formation

Lister toutes les actions de formation

[
  {
    "id_action_de_formation": "37",
    "id_centre_de_formation": "0",
    "id_salle_de_formation": "0",
    "numero": "1",
    "numero_complet": "",
    "numero_comptable": "",
    "type": "intra",
    "intitule": "Intitulé",
    "description": "Description",
    "id_entreprise": "4",
    "id_contact": "4",
    "id_etape_process": "10",
    "date_debut": "2016-01-20 09:00:00",
    "date_fin": "2016-01-21 16:00:00",
    "date_etape_realisation": "2016-01-23 16:21:44",
    "date_etape_archivage": "2016-02-06 14:17:06",
    "date_etape_echec": "0000-00-00 00:00:00",
    "lieu": "",
    "nb_participants_max": "12",
    "objectif": "autre",
    "nature": "2",
    "inscription_online": "1",
    "include_in_bpf": "1",
    "total_heures_participants": "14",
    "total_participants": "10"
  }
]

Accède à toutes les actions de formation présentes sur Dendreo.

Il est possible d'afficher des données supplémentaires pour les actions de formations en renseignant le paramètre include.

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?include=stats,modules,participants,formateurs,creneaux,visuel

Il est possible de filtrer les actions de formation via les paramètres suivant :

nb_jours : les actions ajoutées et/ou modifiées sur les N derniers jours

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?nb_jours=3

id_entreprise : les actions INTRA liées à l'entreprise sélectionnée

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?type=intra&id_entreprise=38

id_module : les actions qui contiennent le module sélectionné

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?id_module=657

Requête HTTP

GET https://pro.dendreo.com/demo/api/actions_de_formation.php

Afficher une action de formation

{
  "id_action_de_formation": "37",
  "id_centre_de_formation": "0",
  "id_salle_de_formation": "0",
  "numero": "1",
  "numero_complet": "",
  "numero_comptable": "",
  "type": "intra",
  "intitule": "Intitulé",
  "description": "Description",
  "id_entreprise": "4",
  "id_contact": "4",
  "id_etape_process": "10",
  "date_debut": "2016-01-20 09:00:00",
  "date_fin": "2016-01-21 16:00:00",
  "date_etape_realisation": "2016-01-23 16:21:44",
  "date_etape_archivage": "2016-02-06 14:17:06",
  "date_etape_echec": "0000-00-00 00:00:00",
  "lieu": "",
  "nb_participants_max": "12",
  "objectif": "autre",
  "nature": "2",
  "inscription_online": "1",
  "include_in_bpf": "1",
  "total_heures_participants": "14",
  "total_participants": "10",
  "nb_participants_inscrits": "6",
  "nb_participants_non_inscrits": "2",
  "nb_participants_en_attente": "1"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/actions_de_formation.php?id=37

Il est possible de récupérer l'url du visuel associé à l'action de formation dans la réponse, en rajoutant include=visuel à votre requête.

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?id=37&include=visuel

Ajouter une action de formation

Les validations effectuées sont dépendantes du type fourni.

{
  "id_action_de_formation": "37",
  "id_centre_de_formation": "0",
  "id_salle_de_formation": "0",
  "numero": "1",
  "numero_complet": "",
  "numero_comptable": "",
  "type": "intra",
  "intitule": "Intitulé",
  "description": "Description",
  "id_entreprise": "4",
  "id_contact": "4",
  "id_etape_process": "10",
  "date_debut": "2016-01-20 09:00:00",
  "date_fin": "2016-01-21 16:00:00",
  "date_etape_realisation": "2016-01-23 16:21:44",
  "date_etape_archivage": "2016-02-06 14:17:06",
  "date_etape_echec": "0000-00-00 00:00:00",
  "lieu": "",
  "nb_participants_max": "12",
  "objectif": "autre",
  "nature": "2",
  "inscription_online": "1",
  "include_in_bpf": "1",
  "total_heures_participants": "14",
  "total_participants": "10",
  "nb_participants_inscrits": "6",
  "nb_participants_non_inscrits": "2",
  "nb_participants_en_attente": "1"
}

Paramètres

Intitulé Obligatoire Description
intitule oui Intitulé
type oui Type (inter ou intra)
date_debut oui Date de début (format vérifié : “AAAA-MM-JJ”)
date_fin oui Date de fin (format vérifié : “AAAA-MM-JJ”)
id_salle_de_formation non ID Salle de formation (existence vérifiée)
id_centre_de_formation non ID Centre de formation (existence vérifiée)
id_entreprise oui si (type = ‘intra’), non sinon ID Entreprise (existence vérifiée, paramètre interdit si type = ‘inter’)
id_contact non ID Contact (existence vérifiée)
id_etape_process non ID Etape (existence vérifiée)
numero non Numéro
numero_complet non numero_complet

Requête HTTP

POST https://pro.dendreo.com/demo/api/actions_de_formation.php

Créneaux

Afficher les créneaux

Vous pouvez sélectionner les créneaux d'une seule action de formation via l'attribut id_action_de_formation.

Exemple : GET https://pro.dendreo.com/demo/api/creneaux.php?id_action_de_formation=12

[
    {
        "id_creneau": "864",
        "id_add": "5",
        "id_edit": "0",
        "id_action_de_formation": "617",
        "id_lam": "619",
        "date_debut": "2017-01-10 10:00:00",
        "date_fin": "2017-01-10 11:00:00",
        "name": "",
        "icon": ""
    },
    {
        "id_creneau": "1544",
        "id_add": "5",
        "id_edit": "0",
        "id_action_de_formation": "1297",
        "id_lam": "1299",
        "date_debut": "2017-01-11 10:00:00",
        "date_fin": "2017-01-11 12:00:00",
        "name": "",
        "icon": ""
    }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/creneaux.php

Afficher un créneau

{
        "id_creneau": "950",
        "id_add": "5",
        "id_edit": "0",
        "id_action_de_formation": "617",
        "id_lam": "619",
        "date_debut": "2017-01-11 10:00:00",
        "date_fin": "2017-01-11 12:00:00",
        "name": "Théorie",
        "icon": "star"
    }

Requête HTTP

GET https://pro.dendreo.com/demo/api/creneaux.php?id=950

Inscription d'un participant

Afficher les inscriptions d'une action de formation

Attention, la sélection d'une action de formation, via id_action_de_formation, id_participant ou id_entreprise est obligatoire.

Il est possible d'enrichir les informations de l'inscription d'un participant via l'attribut include.

Exemple : GET https://pro.dendreo.com/demo/api/laps.php?id_entreprise=371&include=lmps

[
  {
    "id_lap": "950",
    "id_action_de_formation": "330",
    "id_entreprise": "170",
    "id_participant": "0",
    "satisfaction_status": "0",
    "status": "1",
    "source": "dendreo",
    "inscription_lmp": "1",
    "lmps": [
      {
        "status": "1",
        "prix": "670.00",
        "prix_personnalise": "1",
        "total_heures_presence": "0.00"
      }
    ]
  }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/laps.php?id_action_de_formation=330

Afficher une inscription

{
  "id_lap": "950",
  "id_action_de_formation": "330",
  "id_entreprise": "170",
  "id_participant": "0",
  "satisfaction_status": "0",
  "status": "1",
  "source": "dendreo",
  "inscription_lmp": "1"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/laps.php?id=950

Ajouter une inscription

L'inscription d'un participant possède deux modes. Le choix se fait au niveau de la valeur de source :

Il est par ailleurs possible d'ajouter un participant “Inconnu” (à renseigner ultérieurement dans Dendreo) en renseignant l’id_participant à 0.

{
  "id_lap": "950",
  "id_action_de_formation": "330",
  "id_entreprise": "170",
  "id_participant": "0",
  "satisfaction_status": "0",
  "status": "1",
  "source": "dendreo",
  "inscription_lmp": "1"
}

Paramètres

Intitulé Obligatoire Description
id_action_de_formation oui ID action de formation (existence vérifiée)
id_participant non ID participant (existence vérifiée)
source non Mode de fonctionnement (api ou dendreo)

Requête HTTP

POST https://pro.dendreo.com/demo/api/laps.php

Programmation d'un module

Afficher les programmations d'une action de formation

Sélectionnez l'Action de Formation via id_action_de_formation.

Exemple : GET https://pro.dendreo.com/demo/api/lams.php?id_action_de_formation=26

[
    {
        "id_lam": "474",
        "id_add": "16",
        "id_edit": "16",
        "id_action_de_formation": "472",
        "id_module": "66",
        "date_debut": "2017-10-02 09:30:00",
        "date_fin": "2017-12-13 17:00:00",
        "ordre": "2",
        "prix": "450",
        "prix_achat": "0",
        "quantite": "0"
    }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/lams.php

Afficher une programmation

Exemple : GET https://pro.dendreo.com/demo/api/lams.php?id=474

[
    {
        "id_lam": "474",
        "id_add": "16",
        "id_edit": "16",
        "id_action_de_formation": "472",
        "id_module": "66",
        "date_debut": "2017-10-02 09:30:00",
        "date_fin": "2017-12-13 17:00:00",
        "ordre": "2",
        "prix": "450",
        "prix_achat": "0",
        "quantite": "0"
    } 
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/lams.php?id=474

Ajouter une programmation

{
  "id_lam": "197",
  "id_action_de_formation": "330",
  "id_module": "17",
  "ordre": "2",
  "quantite": "0",
  "prix": "0.00",
  "prix_achat": "0.00",
  "id_shadow_lam": "0",
  "ordre_shadow": "0"
}

Spécifier un nombre de jours

Par défaut, lorsqu'un module est programmé sur une action de formation, son template de génération est respecté (ie: si ce module est par défaut sur 3 jours, les 3 journées seront créées).

Il est cependant possible de modifier le paramètre nb_jours afin de définir le nombre de jours de formation.

Si le nombre de jours demandé est supérieur au nombre de jours spécifiés par défaut dans le template, le modèle de la dernière journée sera alors répété afin de complèter le nombre de jours demandé.

Option “Multi-Produits”

Par défaut, l'option “Multi-Produits” n'est pas activée sur Dendreo, tous les modules correspondent donc à de la formation.

Si l'option Multi-Produits est activée, et que vous souhaitez programmer un module qui n'est pas de la formation mais qui a l'option hors_formation_dates activée (produit ayant des dates), il faudra renseigner les paramètres date_debut et date_fin. Ces deux paramètres sont optionnels si le produit est réglé sur hors_formation_dates à 0.

Par ailleurs, si un produit a des dates ET si l'option hors_formation_prix_par_jour est désactivée (produit non configuré en tarification par jour), vous pouvez utiliser l'attribut quantite. Si hors_formation_prix_par_jour est réglé à 1 sur le produit, la quantité est automatiquement égale à la durée du produit en jours.

Paramètres

Intitulé Obligatoire Description
id_action_de_formation oui ID action de formation (existence vérifiée)
id_module oui ID module (existence vérifiée)
date_debut oui* Date de début (format vérifié : “AAAA-MM-JJ”) *Sauf en Multi-Produits, si l'option hors_formation_dates est désactivée sur le produit concerné
date_fin non* Date de fin (format vérifié : “AAAA-MM-JJ”). *Sauf en Multi-Produits, si l'option hors_formation_dates est activée sur le produit concerné
prix non Prix
prix_achat non Prix d'achat
nb_jours non Nombre de jours
quantite non* Quantité *Sauf si l'option hors_formation_prix_par_jour (tarification à la journée) est désactivée sur le module concerné

Requête HTTP

POST https://pro.dendreo.com/demo/api/lams.php

Mails

Logs des mails envoyé par Dendreo

[
  {
    "id_mail": "1",
    "cible": "",
    "id_entite": "0",
    "id_action_de_formation": "0",
    "id_mail_type": "0",
    "id_add": "1",
    "date_add": "0000-00-00 00:00:00",
    "from_email": "'Inscription' <nom@domaine.fr>",
    "domain": "dendreo.com",
    "to_email": "'Prénom NOM' <nom@domaine.fr>",
    "bcc_email": "nom@domain.fr",
    "title": "Intitulee",
    "http_response_code": "200",
    "http_error_msg": "",
    "event": "",
    "code": "0",
    "error": "",
    "notification": "",
    "reason": "",
    "description": ""
  }
]

Affiche la liste des emails envoyés par Dendreo

Exemple : GET https://pro.dendreo.com/demo/api/emails.php?key=123456

Les valeurs possibles de http_response_code sont :

Si http_response_code est à 200, les valeurs possibles de event sont :

Un email correctement reçu a donc un http_response_code à 200 et un event à delivered.

En cas d'erreur http_error_msg, code, error, notification, reason et description peuvent contenir des informations de diagnostique. Le champ le plus utile et explicite est en général reason.

Paramètres

Intitulé Obligatoire Description
key oui Clé api
id_action_de_formation non ID Action de formation (existence vérifiée)
to_email non Destinataire
http_response_code non Code de réponse de l'email
event non delivered, dropped, bounced, complained
offset non Pagination (affiche 100 résultats à partir de cette valeur)