NAV

Introduction

Dendreo est un logiciel de gestion performant pour centres de formation exigeants !

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 :

Vous pouvez retrouver vos clés d'API ici.

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

Permissions

La gestion de clés d'API multiple vous permet de leur attribuer des droits spécifiques de lecture (GET) et d'écriture (POST, PUT et DELETE) indépendamment sur chaque point d'entrée.

L'absence de permissions sur un point d'entrée entrainera une erreur 401 (Unauthorized).

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.

Throttling

L'API de Dendreo impose les limites suivantes :

En cas de dépassement, vous recevrez une erreur 429 - HTTP_TOO_MANY_REQUESTS.

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

Pour les objets de type : Entreprise, Contact, Participant, Formateur et Action De Formation il est possible d'utiliser id_externe à la place de id

Exemple : GET https://pro.dendreo.com/demo/api/entreprises.php?id_externe=externe_12,externe_14,externe_16

Notez qu'il est possible d'utiliser id ou id_objet, par exemple id ou id_contact pour afficher un contact particulier :

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

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

Enfin, certains attributs sont cachés par défaut mais vous pouvez les afficher avec le paramètre show. Ces champs champs sont notamment date_add, date_edit et date_delete.

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?id=12&show=date_edit,date_delete

Édition

La plupart du temps il est possible, d'éditer les objets en envoyant simplement une requête POST (ou PUT) et en précisant un identifiant déjà existant via le paramètre id ou id_objet (ex. id_participant).

L'endpoint Particulier est un cas spécifique : la création se fait via l'endpoint Contacts et l'édition via l'endpoint Particuliers.

Suppression

Il est également souvent possible de supprimer les objets en envoyant une requête DELETE sur un objet identifié par son ID.

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.

Certains objets proposent de filtrer les résultats de recherche par date d'ajout et d'édition: created_after, created_before, updated_after, updated_before

le format de date est : YYYY-MM-DD (= 'YYYY-MM-DD 00:00:00' ou YYYY-MM-DD hh:mm:ss)

Et retournera les objets dont la date_add ou date_edit est "inférieur ou égale" ou "supérieur ou égale" à la date donnée.

Ces parametres peuvent être cumulés.

Les objets sur lesquels ce filtre est disponible sont : Contact, Facture, Financement, Entreprise, Formateur, Participant, Opportunité et les Fichiers.

Pour les objets ActionDeFormation , Lam et Creneaux vous pouvez filtrer sur la date de début ou de fin: started_after, started_before, ended_after, ended_before

le format de date est : YYYY-MM-DD (= 'YYYY-MM-DD 00:00:00' ou YYYY-MM-DD hh:mm:ss)

Et retournera les objets dont la date_debut ou date_fin est "inférieur ou égale" ou "supérieur ou égale" à la date donnée.

Ces parametres peuvent être cumulés.

Catégories de Module

Lister toutes les Catégories de Module

Une Catégorie de Module correspond à un système de classification des Modules de formation qui constituent le Catalogue.

Requête HTTP

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

[
    {
        "id_categorie_module": "1",
        "date_add": "2011-09-29 16:47:36",
        "id_add": "1",
        "date_edit": "2021-09-24 15:40:08",
        "id_edit": "0",
        "intitule": "Management",
        "description": "",
        "color": "",
        "status": "1",
        "order": "0",
        "id_parent": "",
        "deleted_at": ""
    },
    {
        "id_categorie_module": "3",
        "date_add": "2021-02-18 07:59:59",
        "id_add": "0",
        "date_edit": "2022-02-15 10:30:42",
        "id_edit": "0",
        "intitule": "Cuisine",
        "description": "",
        "color": "",
        "status": "1",
        "order": "1",
        "id_parent": "",
        "deleted_at": ""
    },
]

Afficher une catégorie de Module

Requête HTTP

GET https://pro.dendreo.com/demo/api/categories_module.php?id=8

{
    "id_categorie_module": "8",
    "date_add": "2022-09-02 15:46:16",
    "id_add": "0",
    "date_edit": "2022-09-02 15:46:19",
    "id_edit": "0",
    "intitule": "Cuisine végétarienne",
    "description": "",
    "color": "",
    "status": "1",
    "order": "2",
    "id_parent": "3",
    "deleted_at": ""
}

Ajouter / Editer une catégorie de Module

Paramètres

Intitulé Obligatoire Description
id_categorie_module non ID de la Catégorie (si vide -> création d'une nouvelle Catégorie, sinon -> édition de la Catégorie existante)
intitule oui Intitulé de la catégorie
description non Description de la catégorie
color non Si non vide remplace la couleur dans l'Agenda
status non Booléen : 1 Catégorie active, 0 Catégorie désactivée
order non Ordre d'affichage (entier)
id_parent non ID de la Catégorie parent 
{
    "id_categorie_module": "10",
    "date_add": "2023-01-05T10:39:05.000000Z",
    "id_add": "0",
    "date_edit": "2023-01-05T10:39:05.000000Z",
    "id_edit": "0",
    "intitule": "Ma catégorie de module",
    "description": "Description de ma catégorie de module",
    "color": "7866FF",
    "status": "0",
    "order": "1",
    "id_parent": "3",
    "deleted_at": ""
}

Requête HTTP

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

Types de produit

Lister tous les types de produit

Lorsque le mode "Multi-Produits" est activé, Dendreo est capable de gérer différents Produits autres que de la formation. Vous pouvez 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.

Requête HTTP

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

[
    {
        "id_categorie_produit": "1",
        "date_add": "2021-07-18 17:20:45",
        "id_add": "0",
        "date_edit": "",
        "id_edit": "0",
        "intitule": "Formation",
        "color": "1b86d8",
        "status": "1"
    },
    {
        "id_categorie_produit": "2",
        "date_add": "2021-09-16 10:33:18",
        "id_add": "0",
        "date_edit": "",
        "id_edit": "0",
        "intitule": "Licences",
        "color": "",
        "status": "1"
    }
]

Afficher un type de produit

Requête HTTP

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

    {
        "id_categorie_produit": "2",
        "date_add": "2021-09-16 10:33:18",
        "id_add": "0",
        "date_edit": "",
        "id_edit": "0",
        "intitule": "Licences",
        "color": "",
        "status": "1"
    }

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",
    "prix_intra": "0.0000",
    "prix_edof": "0.0000",
    "prix_inter_category_1": "0.0000",
    "prix_intra_category_1": "0.0000",
    "prix_achat": "0.0000",
    "duree_heures": "4.00",
    "duree_jours": "1.00",
    "id_formacode": "0",
    "id_specialite": "2",
    "id_formateur": "0",
    "id_categorie_module": "1",
    "nb_participants_min": "0",
    "nb_participants": "0",
    "objectif": "",
    "public_vise": "",
    "pre_requis": "",
    "intitules": "",
    "id_salle_de_formation": "0",
    "moyens_pedago": "",
    "id_centre_de_formation": "1,2",
    "formateurs_aptes": [
        {
          "id_formateur": "5",
          "date_add": "2012-05-10 10:53:30",
          "id_add": "1",
          "date_edit": "2021-09-13 09:20:03",
          "id_edit": "0",
          "user_id": "9300",
          "anonyme": "0",
          "numero": "1",
          "numero_complet": "FORM_2012001",
          "numero_perso": "0",
          "n_secu": "000",
          "civilite": "Mme",
          "nom": "Skapa",
          "nom_jeune_fille": "",
          "prenom": "Petra",
          "color": "",
          "date_de_naissance": "",
          "lieu_de_naissance": "",
          "nationalite": "Française",
          "situation_familiale": "marie",
          "adresse": "",
          "code_postal": "",
          "ville": "",
          "profession": "",
          "invisible_catalogue": "0",
          "biographie_catalogue": "",
          "telephone_perso": "",
          "telephone_pro": "",
          "email_perso": "",
          "email_pro": "",
          "statut": "Travailleur indépendant\/gérant non salarié",
          "statut_bpf": "Personne de votre organisme (CDI, CDD, occasionnel, bénévole)",
          "mode_remu": "Horaire",
          "remu_horaire_par_defaut": "0.0000",
          "adeli_rpps": "",
          "key_uniq": "cd66ec97913376e2f9f3e6b34a9b1f66",
          "id_externe": "",
          "global_visible": "1",
          "id_entreprise": "",
          "message_extranet": "",
          "infos_adf": "",
          "num_da": "",
          "siret": "",
          "diplomes": "",
          "nom_commercial": "",
          "responsable_dequipe_id": "",
          "tva": "",
          "centre_id": "0",
          "pivot": {
            "id_module": "69",
            "id_formateur": "5"
          }
        }
      ],
      "competences_requises": [
        {
          "id": "15",
          "label": "Management",
          "badge_type": "competences",
          "evaluable": "",
          "created_at": "2018-03-01 10:25:26",
          "updated_at": "2021-11-05 19:29:30",
          "deleted_at": "",
          "pivot": {
            "badgeable_id": "4",
            "badge_id": "15",
            "badgeable_type": "Models\\Module"
          }
        }
      ]
  }
]

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

Il est possible de filtrer les Modules via les paramètres suivants :

numero_complet : Le numéro complet du Module

Exemple : GET https://pro.dendreo.com/demo/api/modules.php?numero_complet=MOD_2019001

intitule : L'intitulé du Module (ou intitulé court)

Exemple : GET https://pro.dendreo.com/demo/api/modules.php?intitule=Excel

Exemple : GET https://pro.dendreo.com/demo/api/modules.php?id_categorie_module=12

Exemple : GET https://pro.dendreo.com/demo/api/modules.php?catalogue=1

Il est aussi possible d'inclure les informations formateurs_aptes, competences_requises ou certification_complete_code sur les modules via l'attribut include.

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

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

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

certification_complete_code permet d'obtenir les informations liées à la Certification (Code RS / RNCP / CPF / CertifInfo)

Requête HTTP

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

Afficher un module de formation

{
  "id_module": "4",
  "id_externe": "",
  "catalogue": "1",
  "id_categorie_produit": "1",
  "intitule": "[Demo] Les Bases Du Management",
  "intitule_court": "BM",
  "slug": "les-bases-du-management",
  "color": "",
  "include_in_bpf": "1",
  "numero": "4",
  "numero_complet": "MOD_2014004",
  "numero_comptable": "",
  "description": "Les bases du management",
  "description_meta": "",
  "hors_formation_dates": "0",
  "hors_formation_prix_par_jour": "0",
  "prix": "1000.0000",
  "prix_intra": "2000.0000",
  "prix_edof": "0.0000",
  "prix_inter_category_1": "0.0000",
  "prix_intra_category_1": "0.0000",
  "prix_achat": "0.0000",
  "duree_heures": "4.00",
  "duree_jours": "1.00",
  "id_formacode": "0",
  "id_specialite": "2",
  "id_formateur": "0",
  "id_entreprise_formateur": "0",
  "id_categorie_module": "1",
  "nb_participants_min": "0",
  "nb_participants": "0",
  "objectif": "",
  "public_vise": "",
  "pre_requis": "",
  "profil_formateurs": "",
  "id_salle_de_formation": "0",
  "modalites_devaluation": "",
  "moyens_supports_pedagogiques": "",
  "modalites_pedagogiques": "",
  "id_centre_de_formation": "1,2",
  "duree_de_validite": "0",
  "id_responsable": "0",
  "eligible_cpf": "0",
  "code_certifinfo": "",
  "mode_organisation": "presentiel",
  "duree_planning_type": "907200",
  "duree_plage_jours": "38",
  "commentaires_devis": "",
  "type_parcours_id": "1",
  "objectif_general_id": "0",
  "niveau_entree_id": "0",
  "codes_modalites_admission": [
        "99999"
    ],
  "points_forts": "",
  "eligible_dpc": "0",
  "mention_a_partir_de": "0",
  "nouveaute": "0",
  "cache_note_moyenne": "0",
  "moyenne_satisfaction": "100",
  "satisfaction_nb_avis": "1",
  "satisfaction_nb_total": "1",
  "document_presentation_url": "",
  "visuel_url": "",
  "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"
    }
  ],
  "competences_list": [
      "word",
      "excel"
  ],
  "public_url_catalogue": "https://catalogue-demo.dendreo.test/formation/4/formation-les-bases-du-management",
  "formateurs_aptes": [
      {
        "id_formateur": "5",
        "date_add": "2012-05-10 10:53:30",
        "id_add": "1",
        "date_edit": "2021-09-13 09:20:03",
        "id_edit": "0",
        "user_id": "9300",
        "anonyme": "0",
        "numero": "1",
        "numero_complet": "FORM_2012001",
        "numero_perso": "0",
        "n_secu": "000",
        "civilite": "Mme",
        "nom": "Skapa",
        "nom_jeune_fille": "",
        "prenom": "Petra",
        "color": "",
        "date_de_naissance": "",
        "lieu_de_naissance": "",
        "nationalite": "Française",
        "situation_familiale": "marie",
        "adresse": "",
        "code_postal": "",
        "ville": "",
        "profession": "",
        "invisible_catalogue": "0",
        "biographie_catalogue": "",
        "telephone_perso": "",
        "telephone_pro": "",
        "email_perso": "",
        "email_pro": "",
        "statut": "Travailleur indépendant\/gérant non salarié",
        "statut_bpf": "Personne de votre organisme (CDI, CDD, occasionnel, bénévole)",
        "mode_remu": "Horaire",
        "remu_horaire_par_defaut": "0.0000",
        "adeli_rpps": "",
        "key_uniq": "cd66ec97913376e2f9f3e6b34a9b1f66",
        "id_externe": "",
        "global_visible": "1",
        "id_entreprise": "",
        "message_extranet": "",
        "infos_adf": "",
        "num_da": "",
        "siret": "",
        "diplomes": "",
        "nom_commercial": "",
        "responsable_dequipe_id": "",
        "tva": "",
        "centre_id": "0",
        "pivot": {
          "id_module": "69",
          "id_formateur": "5"
        }
      }
    ],
    "competences_requises": [
      {
        "id": "15",
        "label": "Management",
        "badge_type": "competences",
        "evaluable": "",
        "created_at": "2018-03-01 10:25:26",
        "updated_at": "2021-11-05 19:29:30",
        "deleted_at": "",
        "pivot": {
          "badgeable_id": "4",
          "badge_id": "15",
          "badgeable_type": "Models\\Module"
        }
      }
    ]
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/modules.php?id=4 GET https://pro.dendreo.com/demo/api/modules.php?id_module=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

Il est aussi possible d'inclure les informations formateurs_aptes, competences_requises ou certification_complete_code sur les modules via l'attribut include.

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

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

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

certification_complete_code permet d'obtenir les informations liées à la Certification (Code RS / RNCP / CPF / CertifInfo)

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).

Ajouter / Editer un Module de formation

{
    "id_module": "91",
    "date_add": "2023-01-06 17:46:56",
    "id_add": "0",
    "date_edit": "2023-01-06 17:46:56",
    "id_edit": "0",
    "id_delete": "0",
    "id_externe": "",
    "lms_custom_url": "",
    "catalogue": "1",
    "intitule": "Mon nouveau Module",
    "intitule_court": "",
    "slug": "mon-nouveau-module",
    "color": "",
    "id_categorie_produit": "1",
    "include_in_bpf": "1",
    "numero": "91",
    "numero_complet": "MOD_2023091",
    "numero_perso": "0",
    "numero_comptable": "",
    "langue": "FR",
    "description": "",
    "description_meta": "",
    "hors_formation_dates": "1",
    "hors_formation_prix_par_jour": "1",
    "prix": "0.0000",
    "prix_intra": "0.0000",
    "prix_edof": "",
    "prix_inter_category_1": "0.0000",
    "prix_intra_category_1": "0.0000",
    "prix_achat": "0.0000",
    "duree_heures": "18.000",
    "duree_jours": "2",
    "id_formacode": "0",
    "id_specialite": "0",
    "id_formateur": "0",
    "id_entreprise_formateur": "",
    "id_categorie_module": "",
    "nb_participants_min": "0",
    "nb_participants": "0",
    "objectif": "",
    "public_vise": "",
    "pre_requis": "",
    "profil_formateurs": "",
    "id_salle_de_formation": "0",
    "id_orientation_ogdpc": "0",
    "color_adf_par_defaut": "",
    "modalites_devaluation": "",
    "moyens_supports_pedagogiques": "",
    "infos_admission": "",
    "accessibilite": "",
    "modalites_pedagogiques": "",
    "global_visible": "1",
    "duree_de_validite": "",
    "infos_adf": "",
    "id_responsable": "",
    "eligible_cpf": "0",
    "code_cpf_id": "",
    "mode_organisation": "presentiel",
    "duree_planning_type": "64800",
    "duree_plage_jours": "2",
    "commentaires_devis": "",
    "type_parcours_id": "1",
    "objectif_general_id": "",
    "niveau_entree_id": "0",
    "codes_modalites_admission": "",
    "points_forts": "",
    "eligible_dpc": "0",
    "mention_a_partir_de": "0",
    "nouveaute": "0",
    "formation_prioritaire": "0",
    "cache_note_moyenne": "1",
    "cache_taux_reussite": "1",
    "moyenne_satisfaction_init": "",
    "ponderation_satisfaction_init": "",
    "date_satisfaction_init": "",
    "taux_reussite_evaluation_init": "",
    "ponderation_evaluation_init": "",
    "date_evaluation_init": "",
    "frais_certif_inclus": "1",
    "frais_anpec": "",
    "detail_frais_anpec": "",
    "catalogue_order": "76",
    "satisfaction_evaluable": "1",
    "evaluation_evaluable": "1",
    "c_bool": "",
    "code_certifinfo": "",
    "c_description": "",
    "catalogue_limited_visibility": "0",
    "stripe_catalogue_public_payment_strategy": "",
    "stripe_catalogue_public_module_help_text": "",
    "code_certification_id": "",
    "is_master_module": "0",
    "code_analytique": ""
}

Précisions concernant le planning d'un Module de formation

Les champs duree_jours et duree_plage_jours servent si vous faites de la planification progressive, c'est-à-dire lorsque vous connaissez la durée totale du Module, mais pas encore son planning.

Si vous connaissez déjà le planning type de votre Module, vous avez 5 solutions :

Paramètres

Intitulé Obligatoire Description
id (ou id_module) non ID du Module de formation (si vide -> ajout d'un nouveau Module au Catalogue, sinon -> édition du Module existant)
id_centre_de_formation non ID Centre de formation (existence vérifiée), plusieurs ID possible (séparés par des virgules ex : 1,2,3)
intitule oui Intitulé du Module
include_in_bpf non Module inclus dans le BPF : 1 ou 0
catalogue non Module affiché sur le Catalogue : 1 ou 0
eligible_cpf non Éligibilité CPF : 1 ou 0
mode_organisation non Mode d'organisation (valeurs possibles : presentiel, elearning_sync, mixte, elearning_async, stage)
import_creneaux non Créneaux du Module de formation (si renseigné, prend le dessus sur import_duree) ex : 09:00-12:00;14:30-18:00 ou default_config (prendra la configuration par défaut de vos Créneaux)
import_duree non Durée en heures (si import_creneaux non renseigné)
duree_heures non Durée en heures (si import_duree non renseigné)
duree_plage_jours_elearning non Si mode_organisation = elearning_async uniquement. Si non renseigné, prend la valeur de la configuration de vos Modules du champ "Durée en jours par défaut"
import_jours non Durée (en nombre de jours) du Module
prix non Prix INTER
prix_intra non Prix INTRA
prix_inter_category_1 non Prix Adhérents INTER
prix_intra_category_1 non Prix Adhérents INTRA
prix_achat non Prix achat (hors-formation uniquement)
id_formateur non ID du Formateur (existence et visibilité sur les centers de formation vérifiées) staffé par défault
id_entreprise_formateur non ID de l'Entreprise sous-traitante (existence et visibilité sur les centers de formation vérifiées) staffée par défault
formateurs non ID Formateurs aptes à réaliser ce Module de formation, plusieurs ID possible (séparés par des virgules ex : 1,2,3)
orientations_dpc non Éligibilité DPC : 1 ou 0
competences_ids non ID des Compétences requises, plusieurs ID possible (séparés par des virgules ex : 1,2,3)
competences_requises non Intitulé des Compétences requises, plusieurs intitulés possible (séparés par des point-virgules ex : Compétences requises n°1;Compétences requises n°2)
competences_list non ID des Compétences, plusieurs intitulés possible (séparés par des point-virgules ex: Compétences n°1;Compétences n°2)
id_specialite non ID Spécialité (si renseigné, prend le dessus sur specialite_code)
specialite_code non Code Spécialité (si id_specialite non renseigné)
id_categorie_module non ID Catégorie (si renseigné, prend le dessus sur categorie_module_intitule)
categorie_module_intitule non Intitulé Catégorie (si id_categorie_module non renseigné)
codes_modalites_admission non Modalités d'admission
certification_code non Code de certification (Si eligible_cpf = 1) ex: RS5355, CPF5355, RNCP5355, CERTIFINFO5355
formacode non Formacode
nb_participants_min non Nombre minimum de Participants
nb_participants non Nombre maximum de Participants
public_vise non Public visé
pre_requis non Prérequis
infos_admission non Informations sur l'admission
modalites_pedagogiques non Modalités pédagogiques
moyens_supports_pedagogiques non Moyens et supports pédagogiques
modalites_devaluation non Modalités d'évaluation et de suivi
accessibilite non Informations sur l'accessibilité
duree_plage_jours_elearning non Période d'ouverture
num_programme_dpc non Numéro de programme DPC : valeur modifiable si l'option "Affichage des options DPC sur les ADFs et Participants" est activé

Requête HTTP

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

Supprimer un Module

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/modules.php?id=1 DELETE https://pro.dendreo.com/demo/api/modules.php?id_module=1,2,3

Paramètres

Intitulé Obligatoire Description
id ou id_module oui ID Module (existence vérifiée)

Sessions Permanentes

Lister toutes les Sessions Permanentes

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

Exemple : GET https://pro.dendreo.com/demo/api/sessions_permanentes.php

[
    {
        "id": "39",
        "salle_de_formation_id": "73",
        "module_id": "320",
        "responsable_id": "",
        "mode_pricing": "forfaitaire",
        "rythmes": [
            "1"
        ],
        "prix": "1800.0000",
        "duree": "0",
        "garantie": "0",
        "active": "1",
        "url_edof": "",
        "created_at": "2022-10-18 16:44:51",
        "updated_at": "2022-11-24 10:43:56",
        "deleted_at": "",
        "id_centre_de_formation": "0",
        "pre_requis": "",
        "visible_cp": "0"
    },
]

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id ou id_session_permanente non ID des sessions (séparé par des virgules)
id_module ou module_id non ID du Module (séparé par des virgules)

Afficher une Session Permanente

{
    "id": "39",
    "salle_de_formation_id": "73",
    "module_id": "320",
    "responsable_id": "",
    "mode_pricing": "forfaitaire",
    "rythmes": [
        "1"
    ],
    "prix": "1800.0000",
    "duree": "0",
    "garantie": "0",
    "active": "1",
    "url_edof": "",
    "created_at": "2022-10-18 16:44:51",
    "updated_at": "2022-11-24 10:43:56",
    "deleted_at": "",
    "id_centre_de_formation": "0",
    "pre_requis": "",
    "visible_cp": "0"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/sessions_permanentes.php?id=372

Ajouter une Session Permanente

{
    "id": "44",
    "salle_de_formation_id": "69",
    "module_id": "314",
    "responsable_id": "",
    "mode_pricing": "forfaitaire",
    "rythmes": "",
    "prix": "1700.0000",
    "duree": "0",
    "garantie": "0",
    "active": "1",
    "url_edof": "",
    "created_at": "2022-12-20 14:59:18",
    "updated_at": "2022-12-20 14:59:18",
    "deleted_at": "",
    "id_centre_de_formation": "0",
    "pre_requis": "",
    "visible_cp": "0"
}

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id oui ID Session Permanente
salle_de_formation_id oui ID de la salle de formation (existence vérifiée)
id_module oui ID du Module (existence vérifiée)
id_centre_de_formation non ID du Centre de formation
mode_pricing non Mode de pricing ('forfaitaire' (default) ou 'assiduite')
prix non Prix
duree non Durée en heures,
rythmes non Rythmes de la formation () ('1' => 'En journée','2' => 'En soirée','3' => 'En semaine','4' => 'Le week-end','5' => 'Temps plein','6' => 'Temps partiel','7' => 'Plusieurs rythmes possibles')
id_responsable non ID du Responsable Administrateur (existence vérifiée)
active non Session ouverte (booléen)
garantie non Session garantie (booléen)
pre_requis non Pré requis (format HTML)
url_edof non URL de l'Action (optionnel)

Modifier une Session Permanente

{
    "id": "44",
    "salle_de_formation_id": "69",
    "module_id": "314",
    "responsable_id": "",
    "mode_pricing": "forfaitaire",
    "rythmes": "",
    "prix": "1200.0000",
    "duree": "0",
    "garantie": "0",
    "active": "1",
    "url_edof": "",
    "created_at": "2022-12-20 14:59:18",
    "updated_at": "2022-12-20 15:02:45",
    "deleted_at": "",
    "id_centre_de_formation": "0",
    "pre_requis": "",
    "visible_cp": "0"
}

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id non ID Session Permanente
salle_de_formation_id non ID de la salle de formation (existence vérifiée)
id_centre_de_formation non ID du Centre de formation
mode_pricing non Mode de pricing ('forfaitaire' (default) ou 'assiduite')
prix non Prix
duree non Durée en heures,
rythmes non Rythmes de la formation () ('1' => 'En journée','2' => 'En soirée','3' => 'En semaine','4' => 'Le week-end','5' => 'Temps plein','6' => 'Temps partiel','7' => 'Plusieurs rythmes possibles')
id_responsable non ID du Responsable Administrateur (existence vérifiée)
active non Session ouverte (booleen)
garantie non Session garantie (booleen)
pre_requis non Pré requis (format HTML)
url_edof non URL de l'Action (optionnel)

Supprimer une Session Permanente

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/sessions_permanentes.php

Paramètres

Intitulé Obligatoire Description
id oui ID Session Permanente (existence vérifiée)

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": "",
    "id_centre_de_formation": "1,2",
    "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1"
  }
]

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

Il est possible de filtrer les formateurs via les paramètres suivants (vous pouvez faire plusieurs recherches d'un coup en séparant les keywords par des virgules) :

Exemple : GET https://pro.dendreo.com/demo/api/formateurs.php?numero_complet=FORM_2019001

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": "",
  "id_centre_de_formation": "1,2",
  "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1"
}

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

Ajouter / Editer un formateur

{
    "id_formateur": "5",
    "id_add": "0",
    "id_edit": "0",
    "numero": "9",
    "numero_complet": "FORM_2018009",
    "numero_perso": "0",
    "n_secu": "",
    "civilite": "M.",
    "nom": "Dupond",
    "nom_jeune_fille": "",
    "prenom": "Jacques",
    "color": "",
    "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",
    "biographie_catalogue": "",
    "telephone_perso": "0676655443",
    "telephone_pro": "0676655443",
    "email_perso": "",
    "email_pro": "contact@cformateur.fr",
    "statut": "Travailleur indépendant/gérant non salarié",
    "statut_bpf": "Personne de votre organisme (CDI, CDD, occasionnel, bénévole)",
    "mode_remu": "Horaire",
    "remu_horaire_par_defaut": "0",
    "key_uniq": "",
    "id_externe": "",
    "id_centre_de_formation": "1,2",
    "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1"
}

Paramètres

Intitulé Obligatoire Description
id_formateur non ID du Formateur (si vide -> ajout d'un nouveau Formateur, sinon -> édition)
nom oui Nom
prenom oui Prénom
civilite non Civilité (format vérifié)
date_de_naissance non Date de naissance (format "AAAA-MM-JJ" ou "JJ/MM/AAAA")
statut non travailleur_independant, cdi, cdd, occasionnel, benevoles, exterieur
statut_bpf non interieur, exterieur
mode_remu non Mode de rémunération : horaire, journalier
remu_horaire_par_defaut  non Rémunération Horaire par défaut
remu_journaliere_par_defaut  non Rémunération Journalière par défaut
n_secu non Numéro de sécurité sociale
lieu_de_naissance non Lieu de naissance
nationalite non Nationalité
situation_familiale non Situation familliale
adresse non Adresse (Rue)
code_postal non Code postal
ville non Ville
profession non Profession
biographie_catalogue non Biographie affichée sur le catalogue
telephone_perso non Téléphone perso
telephone_pro non Téléphone pro
email_perso non Email perso
email_pro non Email pro
id_centre_de_formation non ID Centre de formation (existence vérifiée, possibilité de mettre des IDs séparés par une virgule)
langue_principale non Langue principale du Formateur (ISO 639-1)
langues_secondaires non Liste des langues secondaires du Formateur (existence vérifiée, codes ISO 639-1 séparés par des virgules)
competences_ids non ID des Compétences du Formateur, plusieurs ID possible (séparés par des virgules ex : 1,2,3)
dispo_geo_ids non ID des Disponibilités géographiques du Formateur, plusieurs ID possible (séparés par des virgules ex : 1,2,3)

Requête HTTP

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

Supprimer un Formateur

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/formateurs.php?id=1
DELETE https://pro.dendreo.com/demo/api/formateurs.php?id_formateur=1,2,3

Paramètres

Intitulé Obligatoire Description
id ou id_formateur oui ID Formateur (existence vérifiée)

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": "",
    "post_it_commercial": "",
    "particulier": "0",
    "id_externe": "",
    "tva_intra": "16786387 00013",
    "id_centre_de_formation": "1,2",
    "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1",
    "ape_code": "3511Z",
    "code_naf": {
        "id_code_naf": "639",
        "code_naf": "3511Z",
        "intitule": "Production d'électricité"
    }
  }
]

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

search : La raison_sociale ou le siret de l'entreprise (recherche partielle)

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

numero_complet : Le numéro complet de l'entreprise

Exemple : GET https://pro.dendreo.com/demo/api/entreprises.php?numero_complet=ENT_2019001

particulier : Filtrer pour avoir soit les Particuliers, soit les Entreprises (1 pour avoir uniquement les Particuliers, 0 pour avoir uniquement les Entreprises)

Exemple : GET https://pro.dendreo.com/demo/api/entreprises.php?particulier=1

Il est possible d'afficher des statistiques supplémentaires en renseignant le paramètre include sur la valeur stats. Le retour ajoute "ca_facture" (chiffre d'affaire facturé), "ca_genere_formation" (chiffre d'affaire lié uniquement à la formation) et "recettes_with_previsionnal" (Recettes incluant prévisionnel),

Exemple : GET https://pro.dendreo.com/demo/api/entreprises.php?include=stats

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": "",
  "post_it_commercial": "",
  "particulier": "0",
  "id_externe": "",
  "tva_intra": "16786387 00013",
  "id_centre_de_formation": "1,2",
  "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1"
}

Requête HTTP

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

Ajouter / Editer une entreprise

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

{
  "id_entreprise": "1375",
  "numero": "1",
  "numero_complet": "",
  "numero_compte_client": "",
  "numero_compte_client_auxiliaire": "",
  "numero_comptable_adf": "",
  "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": "",
  "post_it_commercial": "",
  "particulier": "0",
  "id_externe": "",
  "tva_intra": "16786387 00013",
  "id_centre_de_formation": "1,2",
  "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1"
}

Paramètres

Intitulé Obligatoire Description
id_entreprise non ID de l'Entreprise (si vide -> ajout d'une nouvelle Entreprise, sinon -> édition)
raison_sociale oui Raison sociale
siret non N° SIRET
numero_compte_client non N° Compte général
numero_compte_client_auxiliaire non N° compte tiers (auxiliaire)
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
code_naf non Code Naf (alphanumerique, type 6201Z)
nb_employes non Nombre d'employés
commentaires non Commentaires
post_it_commercial non Texte du Post-it Actions Commerciales
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)
id_entreprise_parente (ou entreprise_id) non ID de l'Entreprise parente. Vous pouvez aussi utiliser :
entreprise_parente (ou entreprise_parente_raison_sociale) non Raison sociale de l'Entreprise parente, pour rechercher automatiquement un ID Entreprise parente
id_centre_de_formation non ID Centre de formation (existence vérifiée, possibilité de mettre des IDs séparés par une virgule)
delai_paiement non Délai de paiement ( 'reception'=> 'À réception', '10_j' => '10 jours', '15_j'=> '15 jours', '30_j'=> '30 jours', '30_j_fdm' => '30 jours fin de mois', '30_j_fdm_10' => '30 jours fin de mois le 10', '30_j_fdm_15' => '30 jours fin de mois le 15', '40_j_fdm' => '40 jours fin de mois', '45_j'=> '45 jours', '45_j_fdm' => '45 jours fin de mois', '45_j_fdm_15' => '45 jours fin de mois le 15', '50_j'=> '50 jours', '50_j_fdm' => '50 jours fin de mois', '60_j'=> '60 jours', '60_j_fdm' => '60 jours fin de mois', '90_j'=> '90 jours', 'manuel' => 'Manuel')

Requête HTTP

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

Supprimer une Entreprise

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/entreprises.php?id=1
DELETE https://pro.dendreo.com/demo/api/entreprises.php?id_entreprise=1,2,3

Paramètres

Intitulé Obligatoire Description
id ou id_entreprise oui ID Entreprise (existence vérifiée)

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": "",
    "id_centre_de_formation": "1,2"
  }
]

Il est possible de n'afficher que les contacts appartenants à une entreprise en renseignant l'attribut id_entreprise. Il est aussi possible de filtrer les contacts sur les attributs nom ou email via l'argument search (recherche partielle).

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": "",
  "id_centre_de_formation": "1,2"
}

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 / Editer 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": "",
  "id_centre_de_formation": "1,2"
}

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 :

Configurer le type de contact

Il est possible de choisir si ce contact sera le contact principal, secondaire, ou facturation de son entreprise.

Pour cela, ajoutez un des paramètres suivant à votre requête :

contact_principal: true

contact_secondaire: true

contact_facturation: true

Paramètres

Intitulé Obligatoire Description
id_contact non ID du Contact (si vide -> ajout d'un nouveau Contact, sinon -> édition)
id_entreprise oui (sauf pour édition) ID Entreprise (existence vérifiée), indispensable pour rattacher le contact à une entreprise à sa création
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
contact_principal non Contact principal de l'entreprise
contact_secondaire non Contact secondaire de l'entreprise
contact_facturation non Contact facturation de l'entreprise
langue_principale non Langue principale du Contact (ISO 639-1)
langues_secondaires non Liste des langues secondaires du Contact (existence vérifiée, codes ISO 639-1 séparés par des virgules)

Requête HTTP

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

Transformer un Particulier en Entreprise + Contact + Participant

Il faut rajouter le paramètre suivant dans le corps de la requête POST : convert_to_entreprise_contact_participant=1

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id_contact oui ID du Contact
convert_to_entreprise_contact_participant oui Paramètre à mettre à "1" pour effectuer la conversion

Supprimer un contact

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/contacts.php?id=1 DELETE https://pro.dendreo.com/demo/api/contacts.php?id_contact=1,2,3

Paramètres

Intitulé Obligatoire Description
id ou id_contact oui ID contact (existence vérifiée)

Particuliers

Ajouter un particulier

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

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

Paramètres

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

Requête HTTP

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

Editer un particulier

{
  "id": "3",
  "nom": "Marie",
  "portable": "06 02 03 04 05",
  "email": "marie@domaine.fr",
}

Paramètres

Intitulé Obligatoire Description
id_entreprise ou id_contact ou id_participant oui ID de la fiche à modifier (Fournir un seul des ID au choix)
nom non 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)
statut_bpf non independant,cpf_autonome,recherche_emploi,hors_bpf

Requête HTTP

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

Participants

Lister tous les participants

[
  {
    "id_participant": "17",
    "id_add": "0",
    "id_edit": "0",
    "id_delete": "0",
    "civilite": "Mme",
    "nom": "Duru ",
    "prenom": "Françoise ",
    "email": "",
    "commentaires": "",
    "portable": "",
    "fonction": "Assistante RH",
    "statut_bpf": "salarie",
    "date_de_naissance": "0000-00-00",
    "departement_naissance": "",
    "adresse": "",
    "code_postal": "",
    "ville": "",
    "pays": "",
    "id_entreprise": "4",
    "particulier": "0",
    "id_externe": "",
    "newsletter_optin": "0",
    "id_centre_de_formation": "1,2",
    "id_contact": "",
    "responsable_type": "",
    "responsable_id": "",
    "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1",
    "extranet_url": "https://extranet.centredemo.com",
    "extranet_code": "012-345-678",
    "extranet_autologin_url": "https://extranet.centredemo.com/autologin/012-345-678"
  }
]

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, email ou date_de_naissance (format “AAAA-MM-JJ” ou “JJ/MM/AAAA”) (via l'attribut search qui fera une recherche "OR" sur email, nom ou date_de_naissance). Si vous souhaitez chercher juste sur l'email ou le nom (ou faire une recherche "AND"), vous pouvez le faire via les attributs email ou nom en GET qui sont aussi acceptés (par exemple participants.php?email=test@example.com&nom=dupont pour chercher les participants ayant cet email ET ce nom). Vous pouvez aussi 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",
  "id_add": "0",
  "id_edit": "0",
  "id_delete": "0",
  "civilite": "Mme",
  "nom": "Duru ",
  "prenom": "Françoise ",
  "email": "",
  "commentaires": "",
  "portable": "",
  "fonction": "Assistante RH",
  "statut_bpf": "salarie",
  "date_de_naissance": "0000-00-00",
  "departement_naissance": "",
  "adresse": "",
  "code_postal": "",
  "ville": "",
  "pays": "",
  "id_entreprise": "4",
  "particulier": "0",
  "newsletter_optin": "0",
  "id_externe": "",
  "id_centre_de_formation": "1,2",
  "id_contact": "",
  "responsable_type": "",
  "responsable_id": "",
  "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1",
  "extranet_url": "https://extranet.centredemo.com",
  "extranet_code": "012-345-678",
  "extranet_autologin_url": "https://extranet.centredemo.com/autologin/012-345-678"
}

Requête HTTP

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

ou

GET https://pro.dendreo.com/demo/api/participants.php?code_extranet=123-456-789

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 / Editer un participant

{
  "id_participant": "17",
  "id_add": "0",
  "id_edit": "0",
  "id_delete": "0",
  "civilite": "Mme",
  "nom": "Duru ",
  "prenom": "Françoise ",
  "email": "",
  "commentaires": "",
  "portable": "",
  "fonction": "Assistante RH",
  "statut_bpf": "salarie",
  "date_de_naissance": "0000-00-00",
  "departement_naissance": "",
  "adresse": "",
  "code_postal": "",
  "ville": "",
  "pays": "",
  "id_entreprise": "4",
  "particulier": "0",
  "id_externe": "",
  "id_centre_de_formation": "1,2",
  "id_contact": "",
  "newsletter_optin": "0",
  "responsable_type": "",
  "responsable_id": "",
  "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1"
}

Attention, si votre Participant est un Particulier (personne en recherche d'emploi, indépendant, CPF Auotonme), vous ne devriez pas utiliser cet endpoint, mais plutôt l'endpoint Particuliers. En savoir plus.

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_participant non ID du Participant (si vide -> ajout d'un nouveau Participant, sinon -> édition)
id_entreprise non ID Entreprise (existence vérifiée)
nom oui Nom
prenom oui 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
statut_bpf non Salarie,agent_public,non_salarie,benevole,autre
id_centre_de_formation non ID Centre de formation (existence vérifiée, possibilité de mettre des IDs séparés par une virgule)
id_contact non Liaison avec une fiche contact (même personne, existence vérifiée)
newsletter_optin non Accepte les newsletters
responsable_id non Liaison avec un participant ou un contact en tant que responsable hierarchique (existence vérifiée)
responsable_type non Type du responsable hierarchique : participant ou contact
message_extranet non Message pour le Participant sur son accès extranet (au format HTML)
generer_code_extranet non Générer le code extranet immédiatement même si le Participant n'est encore inscrit à aucune Action de Formation
langue_principale non Langue principale du Participant (ISO 639-1)
langues_secondaires non Liste des langues secondaires du Participant (existence vérifiée, codes ISO 639-1 séparés par des virgules)
niveau_diplome non Valeurs possibles : sans, cqp, cap-bep, bac, bac+2, bac+3, bac+5, bac+8

Champs disponibles en modification uniquement

Intitulé Obligatoire Description
date_changement_entreprise_id oui Id de l'Entreprise concerné par la date de changement d'Entreprise
date_changement_entreprise non Date de changement d'Entreprise (format "AAAA-MM-JJ" ou "JJ/MM/AAAA")

Requête HTTP

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

Supprimer un Participant

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/participants.php?id=1 DELETE https://pro.dendreo.com/demo/api/participants.php?id_participant=1,2,3

Paramètres

Intitulé Obligatoire Description
id ou id_participant oui ID Participant (existence vérifiée)

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",
    "color": "",
    "status": "1",
    "capacite_max": "20",
    "adresse": "",
    "code_postal": "",
    "ville": "",
    "pays": "",
    "id_centre_de_formation": "1,2",
    "lien_google_maps": "https://www.google.fr/maps",
    "acces": "Porte extérieure : appuyer sur P",
    "inside": "1",
    "telephone": "01 23 45 67 89",
    "email": "",
    "accueil": "",
    "nom_contact": "",
    "commentaires_internes": "",
    "no_conflits": "0",
    "elearning": "0",
    "url_connexion": "",
    "emplacement_type": "CentresDeFormation",
    "emplacement_id": "1",
    "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1"
  }
]

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

L'emplacement de la salle peut être CentresDeFormation ou Entreprise. Dans les 2 cas, le champ inside peut être à 1 ou 0. Dans le cas où c'est une salle elearning, le champ elearning sera à 1, et le champ inside à 0.

Paramètres

Intitulé Obligatoire Description
inside non Permet de filtrer sur le champ "inside" (valeur : 0 ou 1)
emplacement_cible non Permet de filtrer sur le champ "Emplacement de la salle" (valeur : 'CentresDeFormation' ou 'Entreprise')

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",
  "color": "",
  "status": "1",
  "capacite_max": "42",
  "adresse": "",
  "code_postal": "",
  "ville": "",
  "pays": "",
  "id_centre_de_formation": "1,2",
  "lien_google_maps": "",
  "acces": "",
  "inside": "1",
  "telephone": "",
  "email": "",
  "accueil": "",
  "nom_contact": "",
  "commentaires_internes": "",
  "no_conflits": "0",
  "elearning": "0",
  "url_connexion": "",
  "emplacement_type": "CentresDeFormation",
  "emplacement_id": "1",
  "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1"
}

L'emplacement de la salle peut être CentresDeFormation ou Entreprise. Dans les 2 cas, le champ inside peut être à 1 ou 0. Dans le cas où c'est une salle elearning, le champ elearning sera à 1, et le champ inside à 0.

Requête HTTP

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

Ajouter une salle de formation

{
  "id_salle_de_formation": "4",
  "intitule": "Salle Amandre",
  "color": "",
  "status": "1",
  "capacite_max": "42",
  "adresse": "",
  "code_postal": "",
  "ville": "",
  "pays": "",
  "id_centre_de_formation": "1,2",
  "lien_google_maps": "",
  "acces": "",
  "inside": "1",
  "telephone": "",
  "email": "",
  "accueil": "",
  "nom_contact": "",
  "commentaires_internes": "",
  "no_conflits": "0",
  "elearning": "0",
  "url_connexion": "",
  "emplacement_type": "CentresDeFormation",
  "emplacement_id": "1",
  "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1"
}

Paramètres

Intitulé Obligatoire Description
intitule oui Nom de la salle
emplacement_cible oui Emplacement de la salle ('cdf_outside', 'elearning', 'client', 'client_outside' ou un id_centre_de_formation valide)
id_entreprise oui si emplacement_cible = client ou client_outside Entreprise lié à cette salle (existance vérifiée)
color non Couleur de la salle
id_centre_de_formation non Visiblité de la salle (possibilité de mettre des IDs séparés par une virgule)
capacite_max non Capaxité maximum de la salle
commentaires_internes non Commentaires internes de la salle
no_conflits non Détecter ou non les conflit de la salle (0 ou 1)

En emplacement_cible client_outside ou cdf_outside uniquement

Intitulé Obligatoire Description
nom_contact non Nom du contact
adresse non Adresse de la salle
code_postal non Code postal de la salle
ville non Ville de la salle
pays non Pays de la salle
telephone non Téléphone de la salle
email non Email de la salle (structure vérifiée)
lien_google_maps non Lien Google Maps
acces non Informations pratiques d'accès de la salle
accueil non Informations d'accueil de la salle

En emplacement_cible elearning uniquement

Intitulé Obligatoire Description
url_connexion non Url de connexion de la salle

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_min": "0",
    "nb_participants_max": "12",
    "objectif": "autre",
    "nature": "2",
    "inscription_online": "1",
    "include_in_bpf": "1",
    "total_heures_participants": "14",
    "total_participants": "10",
    "categorie_module_id": "9",
    "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1",
    "pourcentage_planification": 70
  }
]

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,entreprises,creneaux,visuel,salles,etapeProcess,recettes

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

nb_jours : les actions de formation 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 de formation 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 de formation qui contiennent le module sélectionné

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

id_salle_de_formation : les actions de formation qui ont au moins un lieu correspondant à cette salle

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?id_salle_de_formation=2

id_formateur : les actions de formation qui ont ce formateur staffé à au moins 1 créneau

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?id_formateur=56

numero_complet : l'action de formation portant ce numero complet

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?numero_complet=ADF_2019001

Il est enfin possible de filtrer les actions de formations sur les attributs intitule ou numero_complet via l'argument search (recherche partielle).

Attention, par défaut, seules les actions de formation de la dernière année sont retournées !

Mais, comme indiqué dans la section recherche/filtre, vous pouvez filtrer les Actions de Formation selon leur date de début ou de fin pour étendre cette sélection ou affiner votre recherche.

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?ended_after=2020-12-31

Requête HTTP

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

Listing pour Catalogue public

Si vous souhaitez afficher un petit widget sur votre site web qui indique par exemple "Nos 3 prochaines sessions de formation", vous pouvez utiliser cet endpoint spécial qui a pour effet de vous retourner une liste pré-compilées de prochaines Actions de Formation.

Il ne s'agit pas exactement de l'objet Action de Formation, le retour est un mélange d'informations simples du Module, et de l'Action de Formation, ainsi que certaines infos concernant le prix, le remplissage et le lieux de la session.

Cet endpoint a l'avantage de filtrer automatiquement les Modules et Actions de Formation pour ne prendre en compte uniquement :

Le résultat est donc identique à ce que notre option Catalogue en ligne affiche si vous l'utilisez.

[
    {
        "intitule": "Intitule",
        "date_debut": "2019-07-31 08:00:00",
        "date_fin": "2019-07-31 17:00:00",
        "id_action_de_formation": "193",
        "id_lam": "112",
        "id_module": "39",
        "categorie": "Catégorie",
        "slug_categorie": "https://pro.dendreo.com/demo/public/catalogue/categorie/1/categorie",
        "remplissage": "2/5",
        "total_participants": "2",
        "nb_participants_max": "5",
        "prix_formation": "100",
        "prix_module": "300",
        "slug": "https://pro.dendreo.com/demo/public/catalogue/formation/117/intitule/75",
        "lieux": [
            {
                "intitule": "Salle 1",
                "adresse": "4 rue du Test",
                "ville": "Paris",
                "code_postal": "75008",
                "pays": "France",
                "lien_google_maps": "",
                "acces": "",
                "telephone": "01 02 03 04 05",
                "email": "",
                "accueil": "",
                "nom_contact": ""
            }
        ]
    }
]

Requête HTTP

Notez que l'endpoint n'est pas actions_de_formation !

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

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

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

Il est possible de récupérer la moyenne de satisfaction associé à chaque Module, dans la réponse, en rajoutant include=satisfaction à votre requête.

Exemple : `GET https://pro.dendreo.com/demo/api/catalogue_prochaines_sessions.php?include=satisfaction

Il est possible de récupérer les Créneaux dans la réponse, en rajoutant include=creneaux à votre requête.

Exemple : `GET https://pro.dendreo.com/demo/api/catalogue_prochaines_sessions.php?include=creneaux

Il est possible de récupérer les Salles de chaque Créneaux dans la réponse, en rajoutant include=creneaux,creneaux.salle (les 2 sont nécessaires) à votre requête.

Exemple : `GET https://pro.dendreo.com/demo/api/catalogue_prochaines_sessions.php?include=creneaux,creneaux.salle

Paramètres

Intitulé Obligatoire Description
limit non Nombre d'Actions de Formation renvoyées (défaut: 10)
id_centre_de_formation non Id du centre de formation à afficher
id_module non Id du Module pour filtre
id_categorie non Id de la Catégorie pour filtre
show_inter_only non Si mis à "true", alors les Intra sont exclues

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_min": "0",
  "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",
  "categorie_module_id": "9"
}

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 / Editer 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_min": "0",
  "nb_participants_max": "12",
  "objectif": "autre",
  "nature": "2",
  "inscription_online": "1",
  "include_in_bpf": "1",
  "total_heures_participants": "14",
  "total_participants": "10",
  "objectif_pedagogique": "Objectif pédagogique",
  "modalites_pedagogiques": "Modalités pédagogiques",
  "moyens_supports_pedagogiques": "Moyens et supports pédagogiques",
  "public_vise": "Public visé",
  "pre_requis": "Prérequis",
  "infos_admission": "Informations sur l'admission",
  "modalites_devaluation": "Modalités d’évaluation et de suivi",
  "accessibilite": "Informations sur l'accessibilité",
  "profil_formateurs": "Profil du / des Formateur(s)",
  "nb_participants_inscrits": "6",
  "nb_participants_non_inscrits": "2",
  "nb_participants_en_attente": "1",
  "categorie_module_id": "9"
}

Paramètres

Intitulé Obligatoire Description
id non ID de l'Action de Formation (si vide -> ajout d'une nouvelle action de formation, sinon -> édition)
intitule oui Intitulé
intitule_court non Si non vide remplace l'Intitulé dans l'Agenda
type oui Type (inter ou intra, non disponible en édition)
include_in_bpf oui Booléen. Inclure dans le BPF, par défaut "1"
date_debut oui Date de début (format vérifié : "AAAA-MM-JJ" ou "AAAA-MM-JJ HH:MM:SS" , non disponible en édition)
date_fin oui (Obligatoire sauf si id_module est précisé) Date de fin (format vérifié : "AAAA-MM-JJ" ou "AAAA-MM-JJ HH:MM:SS", non disponible en édition)
id_module non Module à programmer directement dans l'ADF
prix non Défini un prix personnalisé si id_module est également précisé
id_formateur non Permet de staffer automatiquement un Formateur si id_module est également précisé. Renseignez la valeur null ou 0 pour ne pas staffer le Formateur par défaut du Module (si renseigné)
id_entreprise_formateur non Permet de staffer automatiquement une Entreprise Sous-Traitante si id_module est également précisé. Renseignez la valeur null ou 0 pour ne pas staffer l'Entreprise Sous-Traitante par défaut du Module (si renseigné)
id_salle_de_formation non ID Salle de formation (existence vérifiée)
salle_client non Booléen. Si à "true", le paramètre id_entreprise doit être fourni et le type de l'Action de formation doit être "Intra". Une salle de formation interne au client sera récupérée ou créée et liée à l'Action de formation
id_centre_de_formation non ID Centre de formation (existence vérifiée, non disponible en édition)
id_entreprise oui si (type = 'intra') ID Entreprise (existence vérifiée, paramètre interdit si type = 'inter')
id_contact non ID Contact (existence vérifiée, paramètre interdit si type = 'inter')
id_externe_contact non ID Contact Externe (existence vérifiée, paramètre interdit si type = 'inter')
id_etape_process non ID Etape (existence vérifiée)
numero non Numéro
numero_complet non numero_complet
objectif_pedagogique non Objectif pédagoqique
modalites_pedagogiques non Modalités pédagogiques
moyens_supports_pedagogiques non Moyens et supports pédagogiques
public_vise non Public visé
pre_requis non Prérequis
infos_admission non Informations sur l'admission
modalites_devaluation non Modalités d'évaluation et de suivi
accessibilite non Informations sur l'accessibilité
profil_formateurs non Profil du / des Formateur(s)
categorie_module_id non ID catégorie du module (existence vérifiée)
nb_participants_min non Nombre minimum de participants
nb_participants_max non Nombre maximum de participants
id_responsable non Responsable Dendreo
id_commercial non Commercial rattaché à action de formation
mode_pricing non En ajout et en INTRA seulement. Valeurs : par_jour ou global
commentaires non Commentaires Internes
commentaires_agenda non Commentaires visibles sur l'agenda (disponible pour les Formateurs)
esignature non Active ou non les émargements electroniques. Si absent, la configuration du centre sera utilisée.
remuneration_par_lmf non Active ou non l'option "Rémunération des Formateurs par Module"
objectif non Valeurs possibles : niveau12, niveau3, niveau4, niveau5, niveau2, cqp_sans, cqp_rs, cqp_non_rs, autres, bilan, accompagnement
nature non Valeurs possibles : 101 (Action de Formation), 102 (Bilan de compétences), 103 (Action permettant de faire valider les acquis de l'expérience), 104 (Action de Formation par apprentissage)
num_session_dpc non Numéro de session DPC : valeur modifiable si l'option "Affichage des options DPC sur les ADFs et Participants" est activé

Requête HTTP

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

Supprimer une Action de Formation

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/actions_de_formation.php?id=1
DELETE https://pro.dendreo.com/demo/api/actions_de_formation.php?id_action_de_formation=1,2,3

Paramètres

Intitulé Obligatoire Description
id ou id_action_de_formation oui ID Action de Formation (existence vérifiée)

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. De même vous pouvez sélectionner tous les créneaux d'un Lam (Lien Action de formation - Module) via l'attribut id_lam et tous les créneaux d'un Module (quelle que soit l'Action de formation) via l'attribut id_module.

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

Vous pouvez également inclure la liste des formateurs effectuant ces créneaux en ajoutant le paramètre include=formateurs

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

Vous pouvez également sélectionner les créneaux d'un seul Participant via l'attribut id_participant ou participant_id_externe en ajoutant le paramètre id_participant=1912 ou participant_id_externe=1912

Exemple : GET https://pro.dendreo.com/demo/api/creneaux.php?id_participant=1912

Vous pouvez également sélectionner les créneaux d'un seul Formateur via l'attribut id_formateur ou formateur_id_externe en ajoutant le paramètre id_formateur=1912 ou formateur_id_externe=1912

Exemple : GET https://pro.dendreo.com/demo/api/creneaux.php?id_formateur=1912

[
    {
        "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_salle_de_formation": "4",
        "formation_presente": "1"
    },
    {
        "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": "",
        "id_salle_de_formation": "4",
        "formation_presente": "0",
        "url_connexion": "https://extranet-demo.dendreo.com/participants/liverooms/5",
        "url_connexion_invite": "https://extranet-demo.dendreo.com/liverooms/xxxx"
    }
]

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",
    "id_salle_de_formation": "4",
    "formation_presente": "1",
    "url_connexion": "https://extranet-demo.dendreo.com/participants/liverooms/5",
    "url_connexion_invite": "https://extranet-demo.dendreo.com/liverooms/xxxx"
    "lcps": [
        {
            "id_lcp": "93",
            "id_add": "0",
            "id_edit": "0",
            "id_creneau": "950",
            "id_lmp": "28",
            "id_lap": "25",
            "presence": "1",
            "justified": "0",
            "justification": "",
            "lap": {
                "id_lap": "25",
                "id_participant": "2",
                "id_entreprise": "1",
                "participant": {
                    "id_participant": "2",
                    "nom": "Duru",
                    "prenom": "Françoise",
                    "email": "",
                    "id_entreprise": "2",
                    "particulier": "0"
                }
            }
        }
    ]
}

Vous pouvez inclure :

Un lcp est le lien entre un creneau et un lap, puis le lap, fait le lien avec le participant à proprement parlé. Dans le lcp vous avez accès aux variables concernant les présences, et l'émargement dans "emargement_count" (vaut 1 si signature, 0 si absence de signature)

Un lcf est le lien entre un creneau et un laf, puis le laf, fait le lien avec le formateur à proprement parlé. Dans le lcf vous avez accès à l'émargement dans "emargement_count" (vaut 1 si signature, 0 si absence de signature)

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

Requête HTTP

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

Ajouter / Editer un Créneau

{
    "id_lam": "120",
    "date_debut": "2021-07-21 13:30:00",
    "date_fin": "2021-07-21 17:45:00",
    "name": "Intitulé du créneau",
    "id_salle_de_formation": "",
    "date_edit": "2021-07-21 14:51:11",
    "date_add": "2021-07-21 14:51:11",
    "id_creneau": "328",
    "id_add": "0",
    "id_edit": "0"
}

Pour ajouter un Créneau vous avez le choix entre 3 solutions :

Dans les deux derniers cas, la première paire Action de Formation/Module sera prise en compte au cas où il y aurait plusieurs fois le même Module au sein d'une même Action de Formation.

Pour editer un Créneau :

Paramètres

Intitulé Obligatoire Description
id non ID du Créneau (si vide -> ajout d'un nouveau Créneau, sinon -> édition du Créneau existant)
id_lam oui Obligatoire sauf si id_action_de_formation ET id_module sont fournis ou id_externe_action_de_formation ET id_externe_module sont fournis
id_action_de_formation ou id_module oui Obligatoire sauf si id_lam, id_externe_action_de_formation ou id_externe_module sont fournis
id_externe_action_de_formation ou id_externe_module oui Obligatoire sauf si id_lam, id_action_de_formation ou id_module
date oui format AAAA-MM-JJ
heure_debut oui format HH:MM
heure_fin oui format HH:MM (doit être sur un interval de 5 minutes pleines)
name non intitule spécifique du Créneau
id_salle_de_formation non id d'une Salle (existence vérifiée). Obligatoire si url_participants est renseignée
url_participants non URL de connexion pour les Participants (si la Salle est une Salle virtuelle)
url_formateurs non URL de connexion pour les Formateurs (si la Salle est une Salle virtuelle et que url_participants est renseignée)

Requête HTTP

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

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'ajouter à la réponse les informations du participant via le paramètre include=participant.

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

Il est également possible d'enrichir les informations de l'inscription d'un participant via le paramètre include=lmps.

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

Vous pouvez aussi utiliser les 2 paramètres conjointement :

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

Enfin, si vous voulez encore plus de détail vous pouvez inclure les lcps (créneaux) :

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

[
  {
    "id_lap": "950",
    "id_action_de_formation": "330",
    "id_entreprise": "170",
    "id_participant": "0",
    "satisfaction_status": "0",
    "status": "1",
    "source": "dendreo",
    "inscription_lmp": "1",
    "id_groupe": "1",
    "lmps": [
      {
        "id_lmp": "182",
        "id_lam": "799",
        "status": "1",
        "prix": "670.00",
        "prix_personnalise": "1",
        "total_heures_presence": "0.00"
      }
    ],
    "participant" : {
        "id_participant": "17",
        "id_add": "0",
        "id_edit": "0",
        "id_delete": "0",
        "civilite": "Mme",
        "nom": "Duru",
        "prenom": "Françoise"
        ...
      }
  }
]

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",
  "id_groupe": "1",
  "lmps": [
    {
      "id_lmp": "182",
      "id_lam": "799",
      "status": "1",
      "prix": "670.00",
      "prix_personnalise": "1",
      "total_heures_presence": "0.00"
    }
  ],
  "participant" : {
      "id_participant": "17",
      "id_add": "0",
      "id_edit": "0",
      "id_delete": "0",
      "civilite": "Mme",
      "nom": "Duru",
      "prenom": "Françoise"
      ...
    }
}

Requête HTTP

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

Ajouter / Editer une Inscription

Il est par ailleurs possible d'ajouter un Participant "Non identifié" (à renseigner ultérieurement dans Dendreo) en ne renseignant pas l'id_participant (En Inter, un id_entreprise est requis). Vous pouvez également ajouter plusieurs participants non identifiés d'un coup en précisant le paramètre nb_participants_anonymes

{
  "id_lap": "950",
  "id_action_de_formation": "330",
  "id_entreprise": "170",
  "id_participant": "0",
  "satisfaction_status": "0",
  "status": "1",
  "source": "dendreo",
  "inscription_lmp": "1",
  "id_groupe": "1",
  "total_heures_presence": "3",
  "presence_percent": "42.86",
  "total_heures_absence": "4",
  "absence_percent": "57.14",
  "presence": "INC."
}

Paramètres

Intitulé Obligatoire Description
id_lap non ID du Lap (si vide -> inscription du Participant à l'ADF, sinon -> édition de l'inscription existante)
id_action_de_formation oui ID action de formation (existence vérifiée)
id_participant non ID participant (existence vérifiée, entreprise vérifiée)
id_entreprise non sauf si id_participant non fourni en Inter : ID entreprise (existence vérifiée)
id_groupe non ID du groupe auquel rattacher le Lap
prix non Prix personnalisé par Participant (Valable uniquement dans le cas où l'action de formation ne contient qu'un seul Module)
nb_participants_anonymes non Permet d'ajouter des Participants anonymes (ne pas préciser id_participant dans ce cas)

Autres paramètres optionnels

Intitulé Description
marquer_present Si vaut "true", le Participant est marqué présent à tous les créneaux déjà passés
disable_inscription_auto Si ce paramètre est à 1, alors le Lap est ajouté mais il n'est pas inscrit aux Modules de formation
force_sync_lms Si ce paramètre est à 1, alors en cas de Module e-learning avec synchronisation LMS, l'inscription sur la plateforme est faite immédiatement, au lieu d'être faite à la date de début de la formation. Notez que si la formation a déjà commencé, il est nécessaire de passer ce paramètre à 1 si vous souhaitez que l'inscription côté LMS soit faite automatiquement.

Requête HTTP

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

Supprimer une Inscription

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/laps.php?id_lap=1,2,3

Paramètres

Intitulé Obligatoire Description
id_lap oui ID Lap (existence vérifiée)

Réponses aux Questionnaires de Satisfaction

Lister les Réponses aux questionnaires

Accède à toutes les Réponses aux questionnaires de satisfaction en fonction d'un filtre.

Attention, au moins 1 filtre est obligatoire

Exemple : GET https://pro.dendreo.com/demo/api/reponses_questionnaire_satisfaction.php?id_action_de_formation=949

[
    {
        "id_reponse_satisfaction": "146",
        "date_add": "2022-12-19 14:49:40",
        "date_edit": "2022-12-19 14:49:40",
        "id_question_satisfaction": "4",
        "id_lam": "1354",
        "id_laf": "0",
        "note": "5",
        "amplitude_notation": "6",
        "texte": "",
        "question_liste_choix_id": "",
        "subsubject_type": "",
        "subsubject_id": "",
        "owner_type": "Models\\Lap",
        "owner_id": "4227",
        "notation_normalise": "83",
        "id_action_de_formation": "949",
        "module": {
            "id_module": "308",
            "intitule": "Anglais",
            "numero_complet": "MOD_2022006"
        },
        "participant": {
            "id_participant": "2002",
            "date_add": "2022-08-23 16:29:11",
            "id_add": "0",
            "date_edit": "2022-08-23 16:29:11",
            "id_edit": "0",
            "civilite": "Mme.",
            "nom": "Lebreton",
            "prenom": "Adrienne",
            "..." :
        }
    }
]

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id ou id_reponse_satisfaction non ID de la réponse (séparé par des virgules)
id_question_satisfaction non Filtrer sur les l'ID du questionnaire (séparé par des virgules)
id_action_de_formation non Filtrer sur les l'ID des Actions de Formation (séparé par des virgules)
id_lam non Filtrer sur les l'ID des LAMs (séparé par des virgules)
id_module non Filtrer sur les l'ID des Modules (séparé par des virgules)
id_laf non Filtrer sur les l'ID du Staffing des Formateurs (séparé par des virgules)
id_formateur non Filtrer sur les l'ID des Formateurs (séparé par des virgules)
id_salle_de_formation non Filtrer sur les l'ID des Salles de Formation (séparé par des virgules)

Entreprises liées

Lister toutes les Entreprises d'une Action De Formation

[
    {
        "id_lae": "876",
        "id_add": "0",
        "date_add": "2019-10-08 14:18:52",
        "id_edit": "0",
        "date_edit": "2019-10-08 14:18:52",
        "id_action_de_formation": "538",
        "id_entreprise": "551",
        "mode_financement": "entreprise",
        "id_contact": "",
        "entreprise": {
            "id_entreprise": "551",
            "numero": "6",
            "numero_complet": "ENT_2019006",
            "siret": "",
            "raison_sociale": "Monnier",
            "...":
        }
    },
    {
        "id_lae": "877",
        "id_add": "0",
        "date_add": "2019-10-08 14:19:15",
        "id_edit": "0",
        "date_edit": "2019-10-08 14:19:15",
        "id_action_de_formation": "532",
        "id_entreprise": "551",
        "mode_financement": "entreprise",
        "id_contact": "",
        "entreprise": {
            "id_entreprise": "551",
            "numero": "6",
            "numero_complet": "ENT_2019006",
            "siret": "",
            "raison_sociale": "Monnier",
            "...":
        }
    }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/laes.php?id_action_de_formation=532

Afficher un lien Action de Formation <-> Entreprise (Lae)

Requête HTTP

GET https://pro.dendreo.com/demo/api/laes.php?id=877

Editer le Contact d'une Entreprise pour une Action De Formation

Il est possible de modifier le Contact associé à une Entreprise dans le cadre d'une Action De Formation particulière.

{
    "id_lae": "876",
    "id_add": "0",
    "date_add": "2019-10-08 14:18:52",
    "id_edit": "0",
    "date_edit": "2019-10-09 15:27:48",
    "id_action_de_formation": "538",
    "id_entreprise": "551",
    "mode_financement": "entreprise",
    "id_contact": "386",
    "entreprise": {
        "id_entreprise": "551",
        "numero": "6",
        "numero_complet": "ENT_2019006",
        "siret": "",
        "raison_sociale": "Monnier",
        "...":
    }
}

Paramètres

Intitulé Obligatoire Description
id_lae oui ID du lien Action de Formation <-> Entreprise
id_contact oui ID contact (existence vérifiée, même entreprise obligatoire)

Requête HTTP

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

Intervention d'un Formateur

Lister tous les Formateurs intervenants dans une Action de Formation

[
    {
        "id_laf": "62",
        "date_add": "2021-02-18 10:46:10",
        "id_add": "2",
        "date_edit": "2021-02-18 10:48:44",
        "id_edit": "2",
        "id_action_de_formation": "51",
        "id_formateur": "8",
        "referent": "1",
        "statut": "travailleur_independant",
        "statut_bpf": "interieur", //interieur, exterieur
        "id_entreprise": "6",
        "id_contact": "",
        "participant_evaluation_mode": "",
        "tva": "",
        "formateur": {
            "id_formateur": "8",
            "date_add": "2021-02-17 15:26:06",
            "id_add": "2",
            "date_edit": "2022-01-20 10:26:08",
            "id_edit": "0",
            "id_delete": "0",
            "user_id": "",
            "anonyme": "0",
            "numero": "4",
            "numero_complet": "FORM_20210004",
            "...": ""
        }
    },
    "...": ""
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/lafs.php?id_action_de_formation=51

Vous pouvez également inclure la liste des Budgets liés à ces interventions de Formateurs en ajoutant le paramètre include=budgets

Lister toutes les interventions d'un Formateur

[
    {
        "id_laf": "62",
        "date_add": "2021-02-18 10:46:10",
        "id_add": "2",
        "date_edit": "2021-02-18 10:48:44",
        "id_edit": "2",
        "id_action_de_formation": "51",
        "id_formateur": "8",
        "referent": "1",
        "statut": "travailleur_independant",
        "statut_bpf": "interieur",
        "id_entreprise": "6",
        "id_contact": "",
        "participant_evaluation_mode": "",
        "tva": "",
        "formateur": {
            "id_formateur": "8",
            "date_add": "2021-02-17 15:26:06",
            "id_add": "2",
            "date_edit": "2022-01-20 10:26:08",
            "id_edit": "0",
            "id_delete": "0",
            "user_id": "",
            "anonyme": "0",
            "numero": "4",
            "numero_complet": "FORM_20210004",
            "...":
        }
    },
    {
        "id_laf": "64",
        "date_add": "2021-03-12 15:27:36",
        "id_add": "0",
        "date_edit": "",
        "id_edit": "0",
        "id_action_de_formation": "55",
        "id_formateur": "8",
        "referent": "1",
        "statut": "travailleur_independant",
        "statut_bpf": "Personne extérieure (prestation de service, sous-traitance, honoraires)",
        "id_entreprise": "6",
        "id_contact": "",
        "participant_evaluation_mode": "",
        "tva": "20",
        "formateur": {
            "id_formateur": "8",
            "date_add": "2021-02-17 15:26:06",
            "id_add": "2",
            "date_edit": "2022-01-20 10:26:08",
            "id_edit": "0",
            "id_delete": "0",
            "user_id": "",
            "anonyme": "0",
            "numero": "4",
            "numero_complet": "FORM_20210004",
            "...":
        }
    },
    "...":
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/lafs.php?id_formateur=8

Vous pouvez également inclure la liste des Budgets liés à ces interventions de Formateurs en ajoutant le paramètre include=budgets

Afficher le détail d'une intervention d'un Formateur

{
    "id_laf": "62",
    "date_add": "2021-02-18 10:46:10",
    "id_add": "2",
    "date_edit": "2021-02-18 10:48:44",
    "id_edit": "2",
    "id_action_de_formation": "51",
    "id_formateur": "8",
    "referent": "1",
    "statut": "travailleur_independant",
    "statut_bpf": "interieur",
    "id_entreprise": "6",
    "id_contact": "",
    "participant_evaluation_mode": "",
    "tva": "",
    "formateur": {
        "id_formateur": "8",
        "date_add": "2021-02-17 15:26:06",
        "id_add": "2",
        "date_edit": "2022-01-20 10:26:08",
        "id_edit": "0",
        "id_delete": "0",
        "user_id": "",
        "anonyme": "0",
        "numero": "4",
        "numero_complet": "FORM_20210004",
        "...":
    }
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/lafs.php?id=62 Vous pouvez également inclure la liste des Budgets liés à ces interventions de Formateurs en ajoutant le paramètre include=budgets

Créer une intervention pour un Formateur

Si la configuration Staffer automatiquement un Formateur sur tous les Modules est à "Oui", le Formateur sera automatiquement staffé sur tous les Créneaux de tous les Modules de l'Action de formation.

Paramètres

Intitulé Obligatoire Description
id_formateur oui si pas id_entreprise_formateur ID du Formateur
id_entreprise_formateur oui si pas id_formateur ID de l'entreprise sous-traitante
id_action_de_formation oui ID action de formation
autres non Tous les autres champs qui sont disponibles hormis "statut", "participant_evaluation_mode", "tva" et "id_entreprise"
remuneration_horaire non Par défaut, est appliquée sur l'ensemble de l'ADF, ou sur chacun des Lams si le champ "Rémunération de Formateurs par Module" de l'ADF est à "Oui"

Requête HTTP

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

Modifier une intervention d'un Formateur

Paramètres

Intitulé Obligatoire Description
id_laf oui ID du staffing de Formateur
autres non Tous les autres champs qui sont disponibles
remuneration_horaire non Par défaut, est appliquée sur l'ensemble de l'ADF, ou sur chacun des Lams si le champ "Rémunération de Formateurs par Module" de l'ADF est à "Oui"

Attention, il n'est pas possible de modifier les champs : id_action_de_formation, id_formateur, statut, participant_evaluation_mode, tva et id_entreprise.

Requête HTTP

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

Supprimer l'intervention d'un Formateur

Paramètres

Intitulé Obligatoire Description
id_laf oui ID du staffing

Attention, un staffing ne peut pas être supprimé si il y a un émargement ou une Facture associée !

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/lafs.php

Intervention d'un Formateur par créneau

Lister les interventions des formateurs aux créneaux

Vous pouvez filtrer les résultats en fonction des paramètres suivants :

id_action_de_formation, id_laf, id_creneau, id_formateur, id_module, id_lmf

Il est possible d'ajouter à la réponse les informations du Formateur via le paramètre include=formateur.

Exemple : GET https://pro.dendreo.com/demo/api/lcfs.php?id_action_de_formation=330&include=formateur

Il est également possible d'afficher les données du Module :

Exemple : GET https://pro.dendreo.com/demo/api/lcfs.php?id_action_de_formation=330&include=module

Il est également possible d'afficher les données de l'Action de Formation :

Exemple : GET https://pro.dendreo.com/demo/api/lcfs.php?id_action_de_formation=330&include=formation

Enfin, si vous voulez encore plus de détail vous pouvez inclure les informations du créneau :

Exemple : GET https://pro.dendreo.com/demo/api/lcfs.php?id_action_de_formation=330&include=creneau

Vous pouvez aussi utiliser plusieurs paramètres conjointement : include=formateur,module,...

[
    {
        "id_lcf": "971",
        "date_add": "2022-06-03 16:23:40",
        "id_add": "0",
        "date_edit": "2022-06-10 13:24:44",
        "id_edit": "0",
        "id_creneau": "3386",
        "id_laf": "248",
        "id_lmf": "271",
        "status": "1",
        "nb_heures": "3.000",
        "role_id": "",
        "formateur_factures_id": "",
        "invoiced_at": "",
        "rsvp_uuid": "",
        "rsvp_status": "",
        "rsvp_sent_at": "",
        "rsvp_notes": ""
    }
]

Requête HTTP

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

Afficher l'intervention à un créneau pour un Formateur

[
    {
        "id_lcf": "971",
        "date_add": "2022-06-03 16:23:40",
        "id_add": "0",
        "date_edit": "2022-06-10 13:24:44",
        "id_edit": "0",
        "id_creneau": "3386",
        "id_laf": "248",
        "id_lmf": "271",
        "status": "1",
        "nb_heures": "3.000",
        "role_id": "",
        "formateur_factures_id": "",
        "invoiced_at": "",
        "rsvp_uuid": "",
        "rsvp_status": "",
        "rsvp_sent_at": "",
        "rsvp_notes": ""
    }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/lcfs.php?id=971

Créer une intervention à un Créneau pour un Formateur

[
    {
        "id_lcf": "971",
        "date_add": "2022-06-03 16:23:40",
        "id_add": "0",
        "date_edit": "2022-06-10 13:24:44",
        "id_edit": "0",
        "id_creneau": "3386",
        "id_laf": "248",
        "id_lmf": "271",
        "status": "1",
        "nb_heures": "3.000",
        "role_id": "",
        "formateur_factures_id": "",
        "invoiced_at": "",
        "rsvp_uuid": "",
        "rsvp_status": "",
        "rsvp_sent_at": "",
        "rsvp_notes": ""
    }
]

Paramètres

Intitule Obligatoire Description
id_creneau oui ID du Créneau (existence vérifiée)
id_laf oui si ni id_formateur ni id_entreprise_formateur ne sont fournis ID du lien Action de formation <-> Formateur au sein d'une Action De Formation (existence vérifiée)
id_formateur oui si ni id_laf ni id_entreprise_formateur ne sont fournis ID du Formateur (existence vérifiée). Le Formateur est staffé sur l'Action de formation si ce n'est pas déjà le cas.
id_entreprise_formateur oui si ni id_laf ni id_formateur ne sont fournis ID de l'Entreprise sous-traitante (existence vérifiée). Un Formateur anonyme pour l'entreprise sous-traitante est staffé sur l'Action de formation si ce n'est pas déjà le cas. Attention : zéro ou un seul Formateur anonyme de cette Entreprise doit être staffé, sinon il faut utiliser l'id_laf ou l'id_formateur correspondant.
status non Si mis à "true", le Lcf est staffé à 100% (nombre d'heure total du créneau). Si mis à "false", le Lcf est déstaffé (nombre d'heure = 0)
nb_heures non Est pris en compte seulement si "status" vaut "true". Défini le nombre d'heures à staffer (ne peut pas dépasser le nombre d'heures totales du Créneau)
date_facture non Déclarer un LCF comme déjà facturé

Requête HTTP

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

Modifier une intervention à un Créneau pour un Formateur

[
    {
        "id_lcf": "971",
        "date_add": "2022-06-03 16:23:40",
        "id_add": "0",
        "date_edit": "2022-06-10 13:24:44",
        "id_edit": "0",
        "id_creneau": "3386",
        "id_laf": "248",
        "id_lmf": "271",
        "status": "1",
        "nb_heures": "3.000",
        "role_id": "",
        "formateur_factures_id": "",
        "invoiced_at": "",
        "rsvp_uuid": "",
        "rsvp_status": "",
        "rsvp_sent_at": "",
        "rsvp_notes": "",
    }
]

Paramètres

Intitule Obligatoire Description
id_lcf oui si au moins l'un des couples (id_creneau, id_laf) ou (id_creneau, id_formateur) ou (id_creneau, id_entreprise_formateur) n'est pas fourni ID du Lcf (existence vérifiée)
id_creneau oui si id_lcf n'est pas fourni ID du lien Créneau <-> Formateur au sein d'une Action de formation (existence vérifiée)
id_laf oui si id_lcf, id_formateur, id_entreprise_formateur ne sont pas fournis ID du lien Action de formation <-> Formateur au sein d'une Action De Formation (existence vérifiée)
id_formateur oui si id_lcf, id_laf, id_entreprise_formateur ne sont pas fournis ID du Formateur (existence vérifiée). Le Formateur est staffé sur l'Action de formation si ce n'est pas déjà le cas.
id_entreprise_formateur oui si id_lcf, id_laf, id_formateur ne sont pas fournis ID de l'Entreprise sous-traitante (existence vérifiée). Un Formateur anonyme pour l'entreprise sous-traitante est staffé sur l'Action de formation si ce n'est pas déjà le cas. Attention : zéro ou un seul Formateur anonyme de cette Entreprise doit être staffé, sinon il faut utiliser l'id_laf ou l'id_formateur correspondant.
status non Si mis à "true", le Lcf est staffé à 100% (nombre d'heure total du créneau). Si mis à "false", le Lcf est déstaffé (nombre d'heure = 0)
nb_heures non Est pris en compte seulement si "status" vaut "true". Défini le nombre d'heures à staffer (ne peut pas dépasser le nombre d'heures totales du Créneau)
date_facture non Déclarer un LCF comme déjà facturé

Requête HTTP

POST https://pro.dendreo.com/demo/api/lcfs.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=882

Vous pouvez aussi filtrer les résultats par Module :

Exemple : GET https://pro.dendreo.com/demo/api/lams.php?id_module=175

[
    {
        "id_lam": "1195",
        "date_add": "2023-04-25 16:31:24",
        "id_add": "0",
        "date_edit": "2023-04-26 10:53:55",
        "id_edit": "0",
        "id_action_de_formation": "882",
        "id_module": "175",
        "id_categorie_produit": "1",
        "intitule": "Cours Laravel",
        "date_debut": "2023-04-26 09:00:00",
        "date_fin": "2023-04-27 17:00:00",
        "duree": "50400",
        "prix": "500.0000",
        "prix_edof": "",
        "prix_achat": "0.0000",
        "id_shadow_lam": "0",
        "dual_lam_id": "",
        "quantite": "1.00",
        "id_salle_de_formation": "0",
        "duree_planifiee": "",
        "mode_organisation": "presentiel",
        "satisfaction_evaluable": "1",
        "evaluation_evaluable": "1",
        "duree_de_validite": "0",
        "visible_on_cp_in_adf_mm": "0",
        "dokeos_training_gate_id": "",
        "master_lam_id": "",
        "nb_participants_min": "1",
        "nb_participants_max": "10",
        "intitule_module": "Cours Laravel",
        "description": "",
        "formateurs": [
            {
                "id_laf": "750",
                "id_lmf": "1066",
                "id_formateur": "8",
                "civilite": "M.",
                "nom": "Banksto",
                "prenom": "Arlen",
                "email_pro": "arlen.bankston@lithespeed.com",
                "email_perso": ""
            }
        ]
    }
]

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=1195

Le champ id_salle_de_formation correspond à la salle qui a été lié au Lam durant sa programmation, selon le contexte, cela peut être la Salle de l'Action de formation, la Salle par défaut du Module, ou une valeur vide. Cependant s'il y a des Créneaux sur le Lam, il est pertinent de récupérer les Salles liées à ces Créneaux, pour cela, il est possible d'ajouter le paramètre include=lieux.

Exemple : GET https://pro.dendreo.com/demo/api/lams.php?id=1195&include=lieux

Il est également possible d'ajouter à la réponse les informations des Participants via le paramètre include=participants.

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

Il est également possible d'afficher les données du Module :

Exemple : GET https://pro.dendreo.com/demo/api/lams.php?id=1195&include=module

Des LMPs :

Exemple : GET https://pro.dendreo.com/demo/api/lams.php?id=1195&include=lmps

Ou des Créneaux :

Exemple : GET https://pro.dendreo.com/demo/api/lams.php?id=1195&include=creneaux

Vous pouvez aussi utiliser plusieurs paramètres conjointement : include=participants,modules,...

[
    {
        "id_lam": "1195",
        "date_add": "2023-04-25 16:31:24",
        "id_add": "0",
        "date_edit": "2023-04-26 10:53:55",
        "id_edit": "0",
        "id_action_de_formation": "882",
        "id_module": "175",
        "id_categorie_produit": "1",
        "intitule": "Cours Laravel",
        "date_debut": "2023-04-26 09:00:00",
        "date_fin": "2023-04-27 17:00:00",
        "duree": "50400",
        "prix": "500.0000",
        "prix_edof": "",
        "prix_achat": "0.0000",
        "id_shadow_lam": "0",
        "dual_lam_id": "",
        "quantite": "1.00",
        "id_salle_de_formation": "0",
        "duree_planifiee": "",
        "mode_organisation": "presentiel",
        "satisfaction_evaluable": "1",
        "evaluation_evaluable": "1",
        "duree_de_validite": "0",
        "visible_on_cp_in_adf_mm": "0",
        "dokeos_training_gate_id": "",
        "master_lam_id": "",
        "nb_participants_min": "1",
        "nb_participants_max": "10",
        "intitule_module": "Cours Laravel",
        "description": "",
        "formateurs": [
            {
                "id_laf": "750",
                "id_lmf": "1066",
                "id_formateur": "8",
                "civilite": "M.",
                "nom": "Banksto",
                "prenom": "Arlen",
                "email_pro": "arlen.bankston@lithespeed.com",
                "email_perso": ""
            }
        ],
        "participants": [
            {
                "id_lap": "3911",
                "id_lmp": "6246",
                "id_participant": "707",
                "civilite": "M.",
                "nom": "Ababou",
                "prenom": "Jamal",
                "email": "jamalabadou@yahoo.com"
            }
        ]
    }
]

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",
    "quantite": "0",
    "prix": "0.00",
    "prix_achat": "0.00",
    "id_shadow_lam": "0"
}

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é. Vous pouvez également passer une date de fin pour un Module en planification progressive ou pour un Module e-learning
duree non Durée en heures. Permet de faire de la planification progressive
id_formateur non ID du Formateur à staffer (si non fourni, le Formateur par défaut du Module -s'il est défini- sera staffé. Renseignez la valeur null ou 0 pour ne pas staffer le Formateur par défaut du Module)
id_entreprise_formateur non ID de l'Entreprise sous-traitante à staffer (si non fourni, l'Entreprise sous-traitante par défaut du Module -si elle est définie- sera staffée. Renseignez la valeur null ou 0 pour ne pas staffer l'Entreprise sous-traitante par défaut du Module)
prix non Prix
prix_achat non Prix d'achat
quantite non* Quantité *Sauf si l'option hors_formation_prix_par_jour (tarification à la journée) est désactivée sur le module concerné
id_salle_de_formation non ID de la Salle. Si vide, la Salle programmée pour l'ADF sera utilisée, le cas échéant, ou alors la Salle par défaut du Module.
intitule non Intitulé surchargeant l'intitulé du Module
remuneration non Prix de rémunération du formateur par LAM (Nécessite que l'option "Rémunération des Formateurs par Module" soit active sur l'ADF et qu'un id_formateur et/ou id_entreprise_formateur soit également fourni)
num_unite_dpc non Numéro d'unité DPC : valeur modifiable si l'option "Affichage des options DPC sur les ADFs et Participants" est activé

Requête HTTP

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

Ajouter une séance alternative

Permet de créer une séance alternative pour cette programmation . Sous reserve que l'option multi-séance soit activée sur votre compte et que cela concerne un Module de Formation (hors e-learning)

Paramètres

Intitulé Obligatoire Description
id_lam oui ID du Lam sur lequel on souhaite ajouter une séance alternative
create_shadow oui 1 ou true

Requête HTTP

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

Supprimer une programmation

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id_lam oui ID Lam (existence vérifiée)

Gérer les inscriptions aux modules

Un Lmp représente le lien entre un Participant et un Module, au sein d'une Action De Formation

En d'autres termes, c'est un lien entre un Lap et un Lam

Note importante : tous les Lmp sont créés en même temps que les Laps. C'est à dire que dès qu'un Participant est ajouté à une Action de Formation (Lap), tous les Lmp relatifs aux Modules (Lam) sont créés.

Lister les inscriptions des participants aux modules

Vous pouvez filtrer les résultats en fonction des paramètres suivants :

id_action_de_formation, id_lap, id_lam, id_participant, id_module

Il est possible d'ajouter à la réponse les informations du Participant via le paramètre include=participant.

Exemple : GET https://pro.dendreo.com/demo/api/lmps.php?id_action_de_formation=330&include=participant

Il est également possible d'afficher les données du Module :

Exemple : GET https://pro.dendreo.com/demo/api/lmps.php?id_action_de_formation=330&include=module

Si vous voulez encore plus de détail vous pouvez inclure les lcps (créneaux) :

Exemple : GET https://pro.dendreo.com/demo/api/lmps.php?id_action_de_formation=330&include=lcps

Enfin, il est également possible de consulter les évaluations des modules & des compétences associées :

Exemple : GET https://pro.dendreo.com/demo/api/lmps.php?id_action_de_formation=330&include=evaluation

Vous pouvez aussi utiliser plusieurs paramètres conjointement : include=participant,module,...

[
    {
        "id_lmp": "3093",
        "date_add": "2019-11-28 16:31:54",
        "id_add": "0",
        "date_edit": "2019-12-03 09:58:49",
        "id_edit": "0",
        "id_lam": "674",
        "id_lap": "2356",
        "status": "0",
        "prix": "100.0000",
        "prix_personnalise": "0",
        "total_heures_presence": "0.000",
        "total_heures_absence": "0.000",
        "duree_de_validite": "",
        "recyclage_id": "",
        "custom_properties": "",
        "lms_progression": "",
        "lms_started_at": "",
        "lms_last_access_at": "",
        "lms_completed_at": "",
        "duree_de_validite": "",
        "lms_tempspasse": "",
        "master_lmp_id": "",
        "is_thinkific_conflicted": "0",
        "moyenne_satisfaction": "",
        "satisfaction_nb_avis": "0",
        "is_evaluated": "1",
        "has_pre_auto_positionnements": "0",
        "has_post_auto_positionnements": "0",
        "evaluation_count": "1",
        "budget": "",
        "master_lmp": ""
    },
    {
        "id_lmp": "3094",
        "date_add": "2019-11-28 16:31:58",
        "id_add": "0",
        "date_edit": "2019-12-03 09:59:12",
        "id_edit": "0",
        "id_lam": "674",
        "id_lap": "2357",
        "status": "0",
        "prix": "150.0000",
        "prix_personnalise": "1",
        "total_heures_presence": "4.000",
        "total_heures_absence": "0.000",
        "duree_de_validite": "",
        "recyclage_id": "",
        ...
    }
]

Requête HTTP

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

Afficher une inscription à un module

{
    "id_lmp": "3093",
    "date_add": "2019-11-28 16:31:54",
    "id_add": "0",
    "date_edit": "2019-12-03 09:58:49",
    "id_edit": "0",
    "id_lam": "674",
    "id_lap": "2356",
    "status": "0",
    "prix": "100.0000",
    "prix_personnalise": "0",
    "total_heures_presence": "0.000",
    "total_heures_absence": "0.000",
    "duree_de_validite": "",
    "recyclage_id": "",
    ...
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/lmps.php?id=3093

Modifier l'inscription d'un participant pour un module

{
    "id_lmp": "3932",
    "date_add": "2022-12-02 10:52:58",
    "id_add": "0",
    "date_edit": "2022-12-02 10:52:59",
    "id_edit": "0",
    "id_lam": "1129",
    "id_lap": "741",
    "status": "1",
    "prix": "100.0000",
    "prix_personnalise": "0",
    "total_heures_presence": "0.000",
    "total_heures_absence": "0.000",
    "recyclage_id": "44",
    ...
}

Paramètres

Intitulé Obligatoire Description
id_lmp oui ID du lien Participant <-> Module au sein d'une Action De Formation
inscription non 1 ou 0
progression non Seulement pour le e-learning, progression en pourcentage
prix non Prix personnalisé pour ce Lmp (seulement en Inter et si l'option est activée)
validated non 1 ou 0 réussite ou non d'un Participant à un LMP
note non décimal
amplitude_notation non entier
appreciation non text

Requête HTTP

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

Gérer la présence des participants

Un LCP représente le lien entre le Créneau d'un Module de formation et un participant, au sein d'une Action De Formation

En d'autres termes, c'est un lien entre un Lap, un LMP et un Créneau

Note importante : tous les LCPs sont créés en même temps que les LAPs. C'est à dire que dès qu'un Participant est ajouté à une Action de Formation (LAP), tous les LMP relatifs aux Modules (LAM) sont créés et tous les LCP relatifs aux Créneaux de ces Modules également.

Lister les présences des participants aux créneaux

Vous pouvez filtrer les résultats en fonction des paramètres suivants :

id_action_de_formation, id_lap, id_creneau, id_participant, id_module

Il est possible d'ajouter à la réponse les informations du Participant via le paramètre include=participant.

Exemple : GET https://pro.dendreo.com/demo/api/lcps.php?id_action_de_formation=330&include=participant

Il est également possible d'afficher les données du Module :

Exemple : GET https://pro.dendreo.com/demo/api/lcps.php?id_action_de_formation=330&include=module

Enfin, si vous voulez encore plus de détail vous pouvez inclure les informations du créneau :

Exemple : GET https://pro.dendreo.com/demo/api/lcps.php?id_action_de_formation=330&include=creneau

Vous pouvez aussi utiliser plusieurs paramètres conjointement : include=participant,module,...

[
    {
        "id_lcp": "7483",
        "date_add": "2012-12-18 17:33:19",
        "id_add": "2",
        "date_edit": "2019-02-06 17:55:39",
        "id_edit": "2",
        "id_creneau": "873",
        "id_lmp": "1858",
        "id_lap": "1607",
        "presence": "1",
        "total_heures_presence": "2.5",
        "total_heures_absence": "0",
        "justified": "0",
        "justification": ""
    }
]

Requête HTTP

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

Afficher la présence à un créneau pour un participant

{
    "id_lcp": "7483",
    "date_add": "2012-12-18 17:33:19",
    "id_add": "2",
    "date_edit": "2019-02-06 17:55:39",
    "id_edit": "2",
    "id_creneau": "873",
    "id_lmp": "1858",
    "id_lap": "1607",
    "presence": "1",
    "total_heures_presence": "2.5",
    "total_heures_absence": "0",
    "justified": "0",
    "justification": ""
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/lcps.php?id=7483

Modifier la présence d'un participant pour un créneau

{
    "id_lcp":"13346",
    "date_add":"2020-02-12 11:21:35",
    "id_add":"0",
    "date_edit":"2020-11-30 12:00:23",
    "id_edit":"0",
    "id_creneau":"2870",
    "id_lmp":"3107",
    "id_lap":"2366",
    "presence":"1",
    "total_heures_presence": "2.5",
    "total_heures_absence": "0",
    "justified":"0",
    "justification":""
}

Pour effectuer la modification vous pouvez fournir soit : * un id_lcp * un id_creneau + id_lap * un id_creneau + id_participant

Paramètres

Intitulé Obligatoire Description
id_lcp oui si au moins l'un des couples id_creneau + id_lap ou id_creneau + id_participant n'est pas fourni ID du lien Participant <-> Créneau au sein d'une Action De Formation
id_creneau oui si id_lcp n'est pas fourni ID du lien Créneau <-> Participant au sein d'une Action de formation (existence vérifiée)
id_lap oui si id_participant n'est pas fourni ID du lien Action de formation <-> Participant (existence vérifiée)
id_participant oui si id_lap n'est pas fourni ID du Participant (existence vérifiée)
presence non 1 ou 0
duree non En cas de présence ou absence partielle. Durée en heures. Si non précisée, la durée complète du créneau sera prise en compte.
justified non 1 ou 0 selon si l'absence est justifiée ou non
justification non texte de justification de l'absence

Requête HTTP

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

Pour indiquer un participant comme présent, renvoyer l'attribut presence à 1 Pour indiquer une absence, renvoyer l'attribut justified à 1 pour une absence justifiée, 0 pour une absence non-justifiée Pour annuler l'enregistrement d'une présence/absence, refaire un appel avec l'attribut presence de la même valeur que son état actuel (1 pour présence, 0 pour absence).

Évaluations des Participants

Les Évaluations se font à 2 niveaux : - au niveau de chaque Module auquel le Participant est inscrit pour une ADF (Lmp) - au niveau des Compétences de chaque Module auquel le Participant est inscrit pour une ADF

Lister les Évaluations des Modules

Vous pouvez filtrer les résultats en fonction des paramètres suivants :

id, id_lmp, id_action_de_formation, id_participant, id_module

Il est possible d'ajouter à la réponse les informations du Participant via le paramètre include=participant.

Exemple : GET https://pro.dendreo.com/demo/api/evaluations?id_action_de_formation=330&include=participant

Il est également possible d'afficher les évaluations liées aux compétences :

Exemple : GET https://pro.dendreo.com/demo/api/evaluations.php?id_action_de_formation=293&include=competences,participant

[
    {
        "id_lmp": "1369",
        "id_action_de_formation": "293",
        "id_module": "15",
        "id_participant": "113",
        "id": "107",
        "evaluator_type": "Models\\Formateur",
        "evaluator_id": "6",
        "note": "12.00",
        "amplitude_notation": "20",
        "appreciation": "qsdqsd",
        "validated": "1",
        "created_at": "2022-12-02 10:40:07",
        "created_by_type": "",
        "created_by_id": "",
        "updated_at": "2022-12-02 10:40:19",
        "updated_by_type": "Models\\SuperAdministrateur",
        "updated_by_id": "18",
        "deleted_at": "",
        "deleted_by_type": "",
        "deleted_by_id": "",
        "competences": [
            {
                "id": "16",
                "label": "Comp A",
                "evaluation": {
                    "id": "61",
                    "evaluator_type": "Models\\Formateur",
                    "evaluator_id": "6",
                    "note": "14.00",
                    "amplitude_notation": "20",
                    "appreciation": "qsdqsd",
                    "status": "non-acquis",
                    "created_at": "2022-12-02T09:40:10.000000Z",
                    "created_by_type": "Models\\SuperAdministrateur",
                    "created_by_id": "18",
                    "updated_at": "2022-12-02T09:40:16.000000Z",
                    "updated_by_type": "Models\\SuperAdministrateur",
                    "updated_by_id": "18"
                }
            },
            {
                "id": "17",
                "label": "Comp B",
                "evaluation": {
                    "id": "62",
                    "evaluator_type": "Models\\Formateur",
                    "evaluator_id": "6",
                    "note": "",
                    "amplitude_notation": "20",
                    "appreciation": "",
                    "status": "en-cours",
                    "created_at": "2022-12-02T09:40:17.000000Z",
                    "created_by_type": "Models\\SuperAdministrateur",
                    "created_by_id": "18",
                    "updated_at": "2022-12-02T09:40:17.000000Z",
                    "updated_by_type": "Models\\SuperAdministrateur",
                    "updated_by_id": "18"
                }
            }
        ],
        "participant": {
            "id_participant": "113",
            "date_add": "2021-12-24 15:16:11",
            "id_add": "0",
            "date_edit": "2022-12-13 09:51:17",
            "id_edit": "0",
            "civilite": "M.",
            "nom": "Adama",
            "prenom": "Lee",
            "email": "lee@adama.com",
            "commentaires": "",
            "infos_adf": "rddfg",
            "portable": "0102030405",
            "fonction": "CEO",
            "statut_bpf": "salarie",
            "niveau_diplome": "",
            "date_de_naissance": "",
            "ville_naissance": "",
            "departement_naissance": "",
            "adresse": "",
            "code_postal": "",
            "ville": "",
            "pays": "",
            "id_entreprise": "34",
            "particulier": "0",
            "catalogue_entreprise": "",
            "catalogue_entreprise_adresse": "",
            "catalogue_entreprise_cp": "",
            "catalogue_entreprise_ville": "",
            "ogdpc_adeli": "",
            "ogdpc_rpps": "",
            "id_externe": "",
            "moodle_user_id": "",
            "thinkific_user_id": "",
            "dokeos_user_id": "1234",
            "ogdpc_id_specialite": "0",
            "mode_dexercice_dominant": "",
            "global_visible": "1",
            "id_contact": "0",
            "responsable_type": "",
            "responsable_id": "",
            "newsletter_optin": "0",
            "message_extranet": "",
            "nom_naissance": "",
            "pays_naissance": "",
            "num_forprev": "",
            "language_code": "en"
        }
    }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/evaluations.php?id_action_de_formation=293

Ajouter l'Évaluation d'un Participant sur un Module ou sur une Compétence

{
    "id_lmp": "3931",
    "id_action_de_formation": "293",
    "id_module": "25",
    "id_participant": "9",
    "id": "111",
    "evaluator_type": "",
    "evaluator_id": "",
    "note": "33.00",
    "amplitude_notation": "38",
    "appreciation": "Appréciation",
    "validated": "1",
    "created_at": "2022-12-29 11:56:27",
    "created_by_type": "",
    "created_by_id": "",
    "updated_at": "2022-12-29 11:56:27",
    "updated_by_type": "",
    "updated_by_id": "",
    "deleted_at": "",
    "deleted_by_type": "",
    "deleted_by_id": ""
}

Paramètres

Intitulé Obligatoire Description
id_lmp oui ID du lien Participant <-> Module au sein d'une ADF (Lmp)
id_action_de_formation oui si id_lmp n'est pas fourni ID de l'ADF concernée par l'évaluation
id_module oui si id_lmp n'est pas fourni ID du Module à évaluer
id_participant oui si id_lmp n'est pas fourni ID du Participant à évaluer
id_competence non entier, ID de la Compétence, si renseigné, l'évaluation se fera sur la Compétence sinon, sur le Module
id_formateur non entier, ID du formateur en charge de l'ADF ayant attribué l'évaluation
validated non 0 ou 1 pour la réussite ou non d'un Participant à un Module (Lmp)
status non "non-acquis", "acquis" ou "en-cours" pour l'acquisition ou non d'une Compétence
note non entier
amplitude_notation non entier
appreciation non text

Requête HTTP

POST https://pro.dendreo.com/demo/api/evaluations

Modifier l'évaluation d'un participant sur un module ou sur une compétence

{
    "id_lmp": "1370",
    "id_action_de_formation": "293",
    "id_module": "15",
    "id_participant": "9",
    "id": "110",
    "evaluator_type": "",
    "evaluator_id": "",
    "note": "33.00",
    "amplitude_notation": "38",
    "appreciation": "Appréciation",
    "validated": "1",
    "created_at": "2022-12-29 10:38:11",
    "created_by_type": "",
    "created_by_id": "",
    "updated_at": "2022-12-29 11:47:37",
    "updated_by_type": "Models\\SuperAdministrateur",
    "updated_by_id": "27",
    "deleted_at": "",
    "deleted_by_type": "",
    "deleted_by_id": ""
}

Paramètres

Intitulé Obligatoire Description
id_lmp oui ID du lien Participant <-> Module au sein d'une Action De Formation
id_action_de_formation oui si id_lmp n'est pas fourni ID de l'ADF concernée par l'évaluation
id_module oui si id_lmp n'est pas fourni ID du Module à évaluer
id_participant oui si id_lmp n'est pas fourni ID du Participant à évaluer
id_competence non ID de la Compétence, si renseigné, l'évaluation se fera sur la Compétence sinon, sur le Module
id_formateur non ID du formateur en charge de l'ADF ayant attribué l'évaluation
validated non 0 ou 1 pour la réussite ou non d'un Participant à un Module (Lmp)
status non "non-acquis", "acquis" ou "en-cours" pour l'acquisition ou non d'une Compétence
note non
amplitude_notation non
appreciation non

Requête HTTP

POST https://pro.dendreo.com/demo/api/evaluations

Souhaits des Participants

Un Souhait est l'expression du désir ou du besoin d'un Participant (de sa part ou de la part de son Entreprise) de réaliser un Module de Formation. Il s'agit donc d'associer des Participants à des Modules de Formation, en notant éventuellement une date d'échéance avant laquelle la formation souhaitée doit être réalisée.

Lister les Souhaits

[
  {
    "id": "2",
    "participant_id": "1491",
    "module_id": "55",
    "deadline_at": "2021-04-17 23:59:59",
    "created_at": "2021-03-19 14:25:48",
    "wished_at": "2021-03-19 14:25:48",
    "created_by_id": "2",
    "created_by_type": "administrateur",
    "updated_at": "2021-03-19 14:26:57",
    "commentaire": "",
    "lmp_ids": "",
    "participant": {
      "id_participant": "1491",
      "nom": "Sabot",
      "prenom": "Ludovic",
      "adresse": "",
      "code_postal": "",
      "ville": "",
      "portable": "",
      "email": "sabot.ludovic@gmail.com",
      "id_entreprise": "219",
      "entreprise": {
        "id_entreprise": "219",
        "raison_sociale": "Bouygues Telecom"
      }
    },
    "module": {
      "id_module": "55",
      "intitule": "Allemand",
      "intitule_court": "",
      "numero_complet": "MOD_2015007",
      "id_categorie_module": "9",
      "categorie": {
        "id_categorie_module": "9",
        "intitule": "Secourisme"
      }
    }
  }
]

Vous pouvez filtrer les résultats en fonction des paramètres suivants :

Intitulé Description
id IDs des souhaits séparés par une virgule et sans espace
participant_id ID de participant
module_id ID du Module
commentaire Extrait du commentaire
deadline_before Date (YYYY-MM-DD), souhaité avant
deadline_after Date (YYYY-MM-DD), souhaité après
date_add_before Date (YYYY-MM-DD), souhaits créés avant
date_add_after Date (YYYY-MM-DD), souhaits créés après
date_edit_before Date (YYYY-MM-DD), souhaits édités avant
date_edit_after Date (YYYY-MM-DD), souhaits édités après
created_by_id Obligatoire si created_by_type
created_by_type {'administrateur'}, Obligatoire si created_by_id

Il est possible d'ajouter à la réponse les informations du Module, du Participant et/ou des formations suivies exauçant le Souhait, via le paramètre include avec respectivement pour valeur module, participant, formation et/ou module_compose, séparée par une virgule et sans espace.

S'il y a des champs personnalisés sur les Souhaits, ainsi que sur les Modules, les Participants et les Formations, alors ceux-ci seront inclus dans la réponse.

Requête HTTP

GET https://pro.dendreo.com/demo/api/souhaits.php?module_id=55&include=participant,module

Ajouter le Souhait d'un Participant pour un Module de formation

{
  "participant_id": 1723,
  "module_id": 6,
  "commentaire": "Aurait besoin de renforcer ses compétences en langue anglaise. Souhaite s'inscrire sur une session en 2023, à distance.",
  "deadline_at": "2023-12-31"
}

Paramètres

Intitulé Obligatoire Description
participant_id oui ID du Participant
module_id oui ID du Module
commentaire non Texte
deadline_at non Date (YYY-MM-DD) avant laquelle le souhait devrait être exaucé
decompose_mc non true ou false pour décomposer le module en plusieurs souhaits

Il est possible de renseigner les Champs Personnalisés qui sont configurés sur les Souhaits.

Requête HTTP

POST https://pro.dendreo.com/demo/api/souhaits

Modifier un Souhait

{
  "id": "3",
  "module_id": "7",
  "commentaire": "Aurait besoin de renforcer ses compétences en langue allemande. Souhaite s'inscrire sur une session en 2023, à distance.",
  "deadline_at": "2023-10-01"
}

Paramètres

Intitulé Obligatoire Description
id oui ID du Souhait
participant_id non ID du Participant
module_id non ID du Module
commentaire non Texte
deadline_at non Date (YYY-MM-DD) avant laquelle le souhait devrait être exaucé
decompose_mc non true ou false pour décomposer le module en plusieurs souhaits

Il est possible de modifier les Champs Personnalisés qui sont configurés sur les Souhaits.

Requête HTTP

POST https://pro.dendreo.com/demo/api/souhaits

Supprimer un Souhait

{
  "id": "2,3"
}

Paramètres

Intitulé Obligatoire Description
id oui IDs des souhaits séparés par une virgule et sans espace

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/souhaits

Financeurs (externes)

Lister tous les financeurs

Il est possible de filtrer les financeurs sur l'attribut raison_sociale en GET.

Exemple : GET https://pro.dendreo.com/demo/api/financeurs.php?raison_sociale=anfa

[
  {
      "id_opca": "2",
      "opca": "1",
      "raison_sociale": "AGEFOS-PME PACA",
      "description": "FAF des petites et moyennes entreprises",
      "cible": "",
      "site_internet": "http://www.agefos-pme.org",
      "adresse": "146 RUE PARADIS\r\nCS 30002",
      "code_postal": "13294",
      "ville": "MARSEILLE CEDEX 06",
      "telephone": "0488445160",
      "pays": "France"
  }
]

Requête HTTP

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

Afficher un financeur

[
  {
      "id_opca": "2",
      "opca": "1",
      "raison_sociale": "AGEFOS-PME PACA",
      "description": "FAF des petites et moyennes entreprises",
      "cible": "",
      "site_internet": "http://www.agefos-pme.org",
      "adresse": "146 RUE PARADIS\r\nCS 30002",
      "code_postal": "13294",
      "ville": "MARSEILLE CEDEX 06",
      "telephone": "0488445160",
      "pays": "France"
  }
]

Requête HTTP

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

Financements

Lister toutes les Financements

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

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

En ajoutant entreprise (Entreprise bénéficiaire du Financement = lié à id_finance), financeur (Financeur du Financement = lié à id_financeur), factures (toutes les Factures liées à ce Financement), lfps (LFP = Lien Financement Participant), vous pouvez obtenir directement des informations supplémentaires sur les Financements.

La paramètre lfps vous donnera à la fois les LFPs, les LAPs liés à ces LFPs, et les Participants liés à ces LAPs.

Exemple : GET https://pro.dendreo.com/demo/api/financements.php?include=entreprise,financeur,factures,lfps

[
  {
    "id_financement": "790",
    "id_add": "0",
    "id_edit": "0",
    "id_delete": "0",
    "id_action_de_formation": "39",
    "type": "opca",
    "categorie": "",
    "id_finance": "522",
    "id_financeur": "1",
    "montant_finance": "2000",
    "id_categorie_produit": "1",
    "montant_finance_hors_formation": "0",
    "montant_refacture": "0",
    "numero_dossier": "",
    "montant_total_finance": "2000",
    "montant_total_facture": "2000",
    "montant_total_paye": "0"
  }
]

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id_action_de_formation non Filtrer sur les Financements d'une Action de Formation
id_facture non Filtrer sur les Financements liés à une Facture
id_lap non Filtrer sur les Financements liés à un LAP
id_participant non Filtrer sur les les Financements liés à un Participant
id_entreprise non Filtrer sur les Financements financés pour cette Entreprise
id_financeur non Filtrer sur les Financements à destination de ce Financeur (si type est également fourni
type non, oui si id_financeur Un type est obligatoire pour rechercher par Financeur : entreprise (Entreprise, Particulier, Sous-traitance, Financeur public client) ou financeur_externe (OPCA ou Financeur public externe)

Afficher un Financement

  {
    "id_financement": "790",
    "id_add": "0",
    "id_edit": "0",
    "id_delete": "0",
    "id_action_de_formation": "39",
    "type": "opca",
    "categorie": "",
    "id_finance": "522",
    "id_financeur": "1",
    "montant_finance": "2000",
    "id_categorie_produit": "1",
    "montant_finance_hors_formation": "0",
    "montant_refacture": "0",
    "numero_dossier": "",
    "montant_total_finance": "2000",
    "montant_total_facture": "2000",
    "montant_total_paye": "0"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/financements.php?id=790

Ajouter / Editer un Financement

  {
    "id_financement": "790",
    "id_add": "0",
    "id_edit": "0",
    "id_delete": "0",
    "id_action_de_formation": "39",
    "type": "opca",
    "categorie": "",
    "id_finance": "522",
    "id_financeur": "1",
    "montant_finance": "2000",
    "id_categorie_produit": "1",
    "montant_finance_hors_formation": "0",
    "montant_refacture": "0",
    "numero_dossier": "",
    "montant_total_finance": "2000",
    "montant_total_facture": "2000",
    "montant_total_paye": "0"
}

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id_financement non ID du Financement (si vide -> création d'un nouveau Financement, sinon -> édition du Finacement existant)
id_financeur oui ID Financeur Entreprise ou Opca
id_action_de_formation oui ID Action de Formation INTRA (existence vérifiée)
type oui Type de financement (valeurs acceptées : entreprise, participant, particulier, particulier_hors_bpf, opca, public, public_client, sous_traitance, entreprise_particulier)
id_categorie_produit non ID Produit financé (par défaut: 1 - Formation)
categorie oui si type = opca, public, public_client Catégorie BPF (valeurs acceptées pour type opca : apprenti, contrat, promo, cif, cpf, dispositif_recherche_emploi, fonds, autres; Pour type public ou public_client : agents, europe, etat, conseils_generaux, assedics, autre)
montant_total_finance oui Montant financé (Inférieur ou égal au restant à financer)
numero_dossier non Numéro de dossier CPF

Supprimer un Financement

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/financements.php

Paramètres

Intitulé Obligatoire Description
id_financement oui ID Financement (existence vérifiée)

Factures

Lister toutes les Factures émises

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

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

En ajoutant financements vous pouvez obtenir tous les financements associés à cette facture, et si vous avez ajouté ce paramètre vous pouvez aussi ajouter les paramètres entreprise (Entreprise bénéficiaire du Financement = lié à id_finance), financeur (Financeur du Financement = lié à id_financeur), lfps (LFP = Lien Financement Participant) pour obtenir des informations additionnels sur ces Financements, details pour avoir les différentes lignes composant la facture.

Exemple : GET https://pro.dendreo.com/demo/api/factures.php?include=financements,entreprise,financeur,factures,lfps,details

Il est possible de filtrer les factures via le paramètre suivant :

numero_complet : Le numéro complet de la facture

Exemple : GET https://pro.dendreo.com/demo/api/factures.php?numero_complet=FA_2019001

[
  {
    "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",
    "montant_total_ttc": "1044",
    "raison_sociale": "EDF",
    "adresse": "28 rue Bigleuil",
    "code_postal": "75006",
    "ville": "Paris",
    "pays": "FRANCE",
    "remarque": "",
    "id_parent": "0",
    "id_avoir": "0",
    "id_centre_de_formation": "0",
    "pourcentage_paiement": "100",
    "public_url": "https://public.dendreo.com/xxxxx/facture/...",
    "date_export_vente": ""
  }
]

Il est aussi possible de récupérer toutes les factures d'une Action de formation via le paramètre suivant :

id_action_de_formation : L'ID d'une Action de formation

Exemple : GET https://pro.dendreo.com/demo/api/factures.php?id_action_de_formation=566

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 (opca ou financeur public)
emission_after non Filtrer sur les dates d'émission supérieures ou égales à la date indiquée (format vérifié : "AAAA-MM-JJ")
emission_before non Filtrer sur les dates d'émission inférieures ou égales à la date indiquée (format vérifié : "AAAA-MM-JJ")
paiement_after non Filtrer sur les dates de paiement supérieures ou égales à la date indiquée (format vérifié : "AAAA-MM-JJ")
paiement_before non Filtrer sur les dates de paiement inférieures ou égales à la date indiquée (format vérifié : "AAAA-MM-JJ")

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",
    "montant_total_ttc": "744",
    "raison_sociale": "EDF",
    "adresse": "28 rue Bigleuil",
    "code_postal": "75006",
    "ville": "Paris",
    "pays": "FRANCE",
    "remarque": "",
    "id_parent": "0",
    "id_avoir": "0",
    "id_centre_de_formation": "0",
    "pourcentage_paiement": "100",
    "public_url": "https://public.dendreo.com/demo/facture/...",
    "date_export_vente": ""
  }
]

Requête HTTP

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

Pour télécharger la facture, utilisez le lien contenu dans la propriété 'public_url'.

Vous pouvez ajouter les paramètres suivants à cette URL :

Exemple : GET https://public.dendreo.com/demo/facture/82wr61vkha?pdf=1&inline=1

Règlements

Lister tous les Règlements

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

Exemple : GET https://pro.dendreo.com/demo/api/reglements.php

[
    {
        "id": "372",
        "facture_id": "3",
        "date": "2021-05-27 00:00:00",
        "exported_at": "",
        "method": "",
        "reference": "",
        "amount": "1000.0000",
        "account_id": "1",
        "created_at": "2021-05-19 11:16:02",
        "updated_at": "2021-06-15 15:48:17",
        "deleted_at": ""
    }
]

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id non ID du règlement
facture_id non Filter sur un ID de Facture
date_before non Filtrer sur les dates de règlement inférieures ou égales à la date indiquée (format vérifié : "Y-m-d")
date_after non Filtrer sur les dates de règlement supérieures ou égales à la date indiquée (format vérifié : "Y-m-d")

Afficher un Règlement

[
  [
    {
        "id": "372",
        "facture_id": "3",
        "date": "2021-05-27 00:00:00",
        "exported_at": "",
        "method": "",
        "reference": "",
        "amount": "1000.0000",
        "account_id": "1",
        "created_at": "2021-05-19 11:16:02",
        "updated_at": "2021-06-15 15:48:17",
        "deleted_at": ""
    }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/reglements.php?id=372

Ajouter un Règlement

[
  {
        "id": "372",
        "facture_id": "3",
        "date": "2021-05-27 00:00:00",
        "exported_at": "",
        "method": "",
        "reference": "",
        "amount": "1000.0000",
        "account_id": "1",
        "created_at": "2021-05-19 11:16:02",
        "updated_at": "2021-06-15 15:48:17",
        "deleted_at": ""
    }
]

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
facture_id oui ID Facture (existence vérifiée)
date oui Date du règlement (format vérifié : “AAAA-MM-JJ”)
amount oui Montant du règlement. (numeric et différent de 0)
reference non Référence du règlement.
method non Moyen de règlement (virement, cheque, prelevement, cb, paypal, especes, stripe, cheque_formation (Belgique uniquement)
account_id non ID Compte bancaire (existence vérifiée)

Modifier un Règlement

[
  {
        "id": "372",
        "facture_id": "3",
        "date": "2021-05-27 00:00:00",
        "exported_at": "",
        "method": "",
        "reference": "",
        "amount": "1000.0000",
        "account_id": "1",
        "created_at": "2021-05-19 11:16:02",
        "updated_at": "2021-06-15 15:48:17",
        "deleted_at": ""
    }
]

Seuls les Règlements non exportés sont modifiables

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id oui ID Règlement (existence vérifiée)
facture_id oui ID Facture (existence vérifiée)
date oui Date du règlement (format vérifié : “AAAA-MM-JJ”)
amount oui Montant du règlement. (numeric et différent de 0)
reference non Référence du règlement.
method non Moyen de règlement (virement, cheque, prelevement, cb, paypal, especes, stripe, cheque_formation (Belgique uniquement)
account_id non ID Compte bancaire (existence vérifiée)

Supprimer un Règlement

Seuls les Règlements non exportés sont supprimables

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/reglements.php

Paramètres

Intitulé Obligatoire Description
id oui ID Règlement (existence vérifiée)

Export Comptable

Télécharger un export comptable

Ce lien vous permet de déclencher le téléchargement automatique d'un fichier "export comptable" au format demandé en paramètre.

Paramètres disponibles

Intitulé Obligatoire Description
format_export oui Correspond au format du fichier de sortie (formats disponibles : "ebp", "ebp_v2", "ebp_v3", "ebp_aux", "ebp_aux_txt", "generique", "generique_txt", "sage_pnm", "cegid", "quadra", "winbiz", "winfic", "louty", "cador_dorac")
journal oui Correspond au type d'export comptable : "ventes" pour le journal des ventes
factures oui Liste des factures à exporter. Indiquez l'ID de chaque facture séparé par une virgule.

Exemple de Requête HTTP

GET https://pro.dendreo.com/demo/api/export_comptable.php?format_export=sage_pnm&journal=ventes&factures=614,615,616

Les IDs des factures sont récupérables via l'API des factures.

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": "0",
        "date_add": "0000-00-00 00:00:00",
        "from_email": "nom@domaine.fr",
        "domain": "dendreo.com",
        "title": "Intitule",
        "http_response_code": "200",
        "http_error_msg": "",
        "destinataires": [
            {
                "id": "1",
                "id_mail": "1",
                "email": "nom@domaine.fr",
                "type_destinataire": "to",
                "event": "",
                "code": "0",
                "error": "",
                "notification": "",
                "reason": "",
                "description": ""
            },
            {
                "id": "2",
                "id_mail": "1",
                "email": "nom@domaine.fr",
                "type_destinataire": "cc",
                "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

Un email contient les données qui lui sont propre, ainsi qu'un tableau de destinataires.

Le champ http_response_code d'un email, définit s'il est bien parvenu à la plateforme d'emailing.

Ses valeurs possibles sont :

Le champs destinataires contient un tableau de destinataires.

Chaque destinataire possède un email, un type de destinataire ('to', 'cc' ou 'bcc'), ainsi que des informations de statut.

Les valeurs possibles de event sont :

Un destinataire ayant correctement reçu l'email doit donc associer un http_response_code à 200 et un event à delivered.

En cas d'erreur, les champs 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
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)

Checklists

Lister les Checklists suivant un type de cible

Pour les checklists de type action_de_formation_inter, action_de_formation_intra, action_de_formation , lap, laf, n'affiche que celles dont l'action de formation n'a pas été supprimée.

[
    {
        "id_checklist": "4",
        "id_add": "0",
        "id_edit": "0",
        "type_cible": "formateur",
        "id_cible": "65",
        "remarque": "Exemple de remarque",
        "checks_total": "2",
        "checks_done": "1",
        "checks": [
            {
                "id_check": "7",
                "id_add": "0",
                "id_edit": "0",
                "intitule": "première étape",
                "done": "0"
            },
            {
                "id_check": "8",
                "id_add": "0",
                "id_edit": "0",
                "intitule": "deuxième étape",
                "done": "1"
            }
        ]
    }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/checklists.php?cible=formateur

Paramètres

Intitulé Obligatoire Description
cible oui Afficher toutes les checklists d'un type de cible (formateur, action_de_formation_inter, action_de_formation_intra, action_de_formation (inter et intra), lap, laf)
id_cible non Filtrer sur une ou plusieurs cibles particulières (id_cible=44,45,47)
include_deleted non Inclut les checklists des actions de formation supprimées.

Afficher une Checklist

[
    {
        "id_checklist": "4",
        "id_add": "0",
        "id_edit": "0",
        "type_cible": "formateur",
        "id_cible": "65",
        "remarque": "Exemple de remarque",
        "checks_total": "2",
        "checks_done": "1",
        "checks": [
            {
                "id_check": "7",
                "id_add": "0",
                "id_edit": "0",
                "intitule": "première étape",
                "done": "0"
            },
            {
                "id_check": "8",
                "id_add": "0",
                "id_edit": "0",
                "intitule": "deuxième étape",
                "done": "1"
            }
        ]
    }
]

Requête HTTP

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

Checks

Modifier un check existant

{
    "id_check": "7",
    "id_add": "0",
    "id_edit": "0",
    "id_checklist": "4",
    "intitule": "première étape",
    "done": "1"
}

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id_check oui L'id du check à modifier
intitule non L'intitule du check
done non Le status du check (0,1)

Créer un check pour une checklist existante

{
    "id_check": "8",
    "id_add": "0",
    "id_edit": "0",
    "id_checklist": "4",
    "intitule": "seconde étape",
    "done": "0"
}

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id_checklist oui L'id de la checklist
intitule oui L'intitule du check
done non Le status du check (0,1)

Administrateurs

Lister tous les administrateurs

[
  {
      "id_administrateur": "1",
      "id_add": "0",
      "id_edit": "0",
      "id_delete": "1",
      "nom": "DUPONT",
      "prenom": "Mathieu",
      "email": "dupont@dendreo.com",
      "login": "mdupont",
      "date_derniere_connexion": "2017-06-26 14:33:21",
      "niveau": "40",
      "fonction": "",
      "telephone": "",
      "use_email": "0",
      "use_signature": "0",
      "photo": "https://public.dendreo.com/njsx266nmvpw4ylnnfxg4/media/l27tk4k5j8sc9qlfgffA9wstjvth24cr4j7ts9txl3zf1zkp3fyg4pj8",
      "nom_complet": "Mathieu DUPONT"
  }
]

Requête HTTP

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

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

Exemple : GET https://pro.dendreo.com/demo/api/administrateurs.php?include=photo

Afficher un administrateur

[
  {
      "id_administrateur": "1",
      "id_add": "0",
      "id_edit": "0",
      "id_delete": "1",
      "nom": "DUPONT",
      "prenom": "Mathieu",
      "email": "dupont@dendreo.com",
      "login": "mdupont",
      "date_derniere_connexion": "2017-06-26 14:33:21",
      "niveau": "40",
      "fonction": "",
      "telephone": "",
      "use_email": "0",
      "use_signature": "0",
      "photo": "https://public.dendreo.com/njsx266nmvpw4ylnnfxg4/media/l27tk4k5j8sc9qlfgffA9wstjvth24cr4j7ts9txl3zf1zkp3fyg4pj8",
      "nom_complet": "Mathieu DUPONT"
  }
]

Requête HTTP

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

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

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

Actions Commerciales

Lister toutes les actions commerciales

[
    {
        "id_action_commerciale": "105",
        "date_add": "2022-04-19 10:53:00",
        "id_add": "0",
        "date_edit": "2022-04-27 10:17:04",
        "id_edit": "0",
        "date_action": "2022-04-19 00:00:00",
        "id_categorie_ac": "1",
        "compte_rendu": "...",
        "date_relance": "2022-04-13 00:00:00",
        "priorite": "1",
        "devis_id": "",
        "id_entreprise": "37",
        "parent_id": "",
        "commerciaux": [
            {
                "id_administrateur": "2",
                "nom": "Ruiz",
                "prenom": "Jose",
                "nom_complet": "Jose Ruiz"
            }
        ],
        "interlocuteurs": [
            {
                "id_entreprise": "37",
                "date_add": "2022-01-31 08:37:33",
                "id_add": "0",
                "date_edit": "2022-09-01 10:42:07",
                "id_edit": "0",
                "entreprise_id": "0",
                "numero": "2",
                "numero_complet": "ENT_2200002",
                ...
            }
        ]
    },
    ...
]

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

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

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

id_categorie_ac : les actions commerciales de la catégorie sélectionnée

Exemple : GET https://pro.dendreo.com/demo/api/actions_commerciales.php?id_categorie_ac=1

commercial_id : les actions commerciales rattachée à l'administrateur sélectionné

Exemple : GET https://pro.dendreo.com/demo/api/actions_commerciales.php?commercial_id=19

relance : les actions commerciales qui ont une relance à venir (Dans ce cas, les actions commerciales seront triées par date de relance les plus anciennes)

Exemple : GET https://pro.dendreo.com/demo/api/actions_commerciales.php?relance=1

Attention, les actions commerciales sont triées par date la plus récente, et retournées par série de 100. Vous devez utiliser le paramètre 'offset' pour récupérer les précédentes actions commerciales

Exemple : GET https://pro.dendreo.com/demo/api/actions_commerciales.php?offset=500

Requête HTTP

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

Afficher une action commerciale

{
    "id_action_commerciale": "105",
    "date_add": "2022-04-19 10:53:00",
    "id_add": "0",
    "date_edit": "2022-04-27 10:17:04",
    "id_edit": "0",
    "date_action": "2022-04-19 00:00:00",
    "id_categorie_ac": "1",
    "intitule_categorie_ac": "Relance simple",
    "compte_rendu": "...",
    "date_relance": "2022-04-13 00:00:00",
    "priorite": "1",
    "devis_id": "",
    "id_entreprise": "37",
    "parent_id": "",
    "commerciaux": [
        {
            "id_administrateur": "2",
            "nom": "Ruiz",
            "prenom": "Jose",
            "nom_complet": "Jose Ruiz"
        }
    ],
    "interlocuteurs": [
        {
            "id_entreprise": "37",
            "date_add": "2022-01-31 08:37:33",
            "id_add": "0",
            "date_edit": "2022-09-01 10:42:07",
            "id_edit": "0",
            "entreprise_id": "0",
            "numero": "2",
            "numero_complet": "ENT_2200002",
            ...
        }
    ]
}

Requête HTTP

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

Ajouter / Editer une action commerciale

{
    "id_action_commerciale": "40",
    "id_add": "1",
    "date_action": "2018-09-26 14:14:42",
    "id_categorie_ac": "2",
    "id_contact": "25,35",
    "participant_prenom_nom": "Michel Blanc",
    "priorite": "3",
    "commercial_id": "21,14",
    "compte_rendu": "En attente du bon de commande pour formation ScrumMaster. A relancer si rien sous une huitaine.",
    "date_relance": "2018-10-20",
}

Paramètres

Intitulé Obligatoire Description
id non ID de l'action commercial (si vide -> ajout d'une nouvelle action commerciale, sinon -> édition)
id_entreprise non IDs des entreprises rattachées à cette action commerciale (possibilité de passer 'entreprise_raison_sociale' au lieu de 'id_entreprise')
id_contact non IDs des contacts rattachés à cette action commerciale (possibilité de passer 'contact_prenom_nom' au lieu de 'id_contact')
id_participant non IDs des participants rattachés à cette action commerciale (possibilité de passer 'participant_prenom_nom' au lieu de 'id_participant')
commercial_id oui IDs des administrateurs auteur de cette action commerciale
date_action non Date au format AAAA-MM-JJ (Si vide prendra la date du jour)
date_relance non Date au format AAAA-MM-JJ
id_categorie_ac non ID de catégorie (Si vide en mode ajout, prendra la valeur de la configuration par défaut)
priorite non Priorité de l'action commerciale (0,1,2)

Une action commerciale DOIT être rattachée à un interlocuteur : entreprise, contact, ou participant. Plusieurs valeurs peuvent être renseignées, celles-ci doivent être séparées par des virgules. Pour ajouter une action commerciale à un particulier, vous devez envoyer l'id_entreprise de celui-ci.

Requête HTTP

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

Supprimer une Action Commerciale

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/actions_commerciales.php?id=1 DELETE https://pro.dendreo.com/demo/api/actions_commerciales.php?id_action_commerciale=1,2,3

Paramètres

Intitulé Obligatoire Description
id ou id_action_commerciale oui ID Action Commerciale (existence vérifiée)

Convertir vers Particulier

Exemple de réponse

{
  "status":"success"
}

Vous pouvez convertir un Participant en Particulier si :

Vous pouvez convertir une Entreprise en Particulier si :

Requête HTTP

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

Paramètres

Intitulé Obligatoire Description
id_entreprise oui (sauf si id_participant fourni) ID Entreprise (existence vérifiée)
id_participant oui (sauf si id_entreprise fourni) ID Participant (existence vérifiée)

Fichiers

Afficher un fichier

{
    "id": "1",
    "collection_name": "avatar",
    "name": "sample",
    "mime_type": "image/jpeg",
    "size": "20461",
    "created_at": "2018-10-26 12:44:49",
    "updated_at": "2018-10-26 12:44:49",
    "deleted_at": "",
    "id_add": "1",
    "id_edit": "0",
    "public_url": "",
    "cible": "formateur",
    "id_cible": "59",
    "entite_liee": {
        "Entreprise": {
            "id_entreprise": "482",
            "id_add": "2",
            "id_edit": "0",
            "numero": "8",
            "numero_complet": "ENT_2018001",
            "...":
        }
    }
}

Requête HTTP

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

Rechercher un fichier

Il est possible de rechercher les fichiers d'une 'collection', au sein d'une 'cible'.

Si le paramètre 'collection_name' est omis, les fichiers de l'espace de stockage seront retournés par défaut (Se reporter au tableau de correspondance cible/collection plus bas).

Exemple : GET https://pro.dendreo.com/demo/api/fichiers.php?cible=action-de-formation&id_cible=1&collection_name=visuel

Il est ensuite possible de filtrer les fichiers via les paramètres suivant :

id_doc_type : les fichiers uploadés via QR Code qui ont été reconnus comme étant ce modèle de document

Exemple : GET https://pro.dendreo.com/demo/api/fichiers.php?cible=action-de-formation&id_cible=1&id_doc_type=2

id_formateur : les fichiers 'liés' à un Formateur au sein d'une Action de formation

Exemple : GET https://pro.dendreo.com/demo/api/fichiers.php?cible=action-de-formation&id_cible=1&id_formateur=2

id_entreprise : les fichiers 'liés' à une Entreprise au sein d'une Action de formation

Exemple : GET https://pro.dendreo.com/demo/api/fichiers.php?cible=action-de-formation&id_cible=1&id_entreprise=2

id_participant : les fichiers 'liés' à un Participant au sein d'une Action de formation

Exemple : GET https://pro.dendreo.com/demo/api/fichiers.php?cible=action-de-formation&id_cible=1&id_participant=2

id_module : les fichiers 'liés' à un Module au sein d'une Action de formation

Exemple : GET https://pro.dendreo.com/demo/api/fichiers.php?cible=action-de-formation&id_cible=1&id_module=2

Pour les entites Entreprise, Formateur, Participant et Module, vous pouvez obtenir la liste de tous les fichiers liés dans les ADFs en utilsant la collection fichiers_lies_adf

Exemple : GET https://pro.dendreo.com/demo/api/fichiers.php?cible=formateur&id_cible=1&collection_name=fichiers_lies_adf

Filtre avancé sur les cibles

Si vous choisissez de lister tous les fichiers d'un type de cible par exemple :

GET https://pro.dendreo.com/demo/api/fichiers.php?cible=participant

Vous pouvez alors filtrer sur un objet relatif à cette cible, exemple, l'Entreprise d'un Participant :

GET https://pro.dendreo.com/demo/api/fichiers.php?cible=participant&filter_cible[entreprise]=1

Ajouter un fichier

{
    "id": "1",
    "collection_name": "avatar",
    "name": "sample",
    "mime_type": "image/jpeg",
    "size": "20461",
    "created_at": "2018-10-30 15:17:06",
    "updated_at": "2018-10-30 15:17:06",
    "deleted_at": "",
    "id_add": "1",
    "id_edit": "0",
    "cible": "formateur",
    "id_cible": "59",
    "chemin": "Répertoire/Sous_repertoire",
    "entite_liee_type": "formateur",
    "entite_liee_id": "1234",
}

Paramètres

Intitulé Obligatoire Description
file oui Fichier à envoyer
cible non Type de la cible à laquelle rattacher le fichier (ex: formateur)
id_cible non ID de la cible à laquelle rattacher le fichier
collection non Le nom de la collection à laquelle associer le fichier (voir tableau ci-dessous)
chemin non Permet de placer le fichier dans un répertoire (voire sous-répertoires). Le(s) répertoire(s) seront créés si besoin.
entite_liee_type non Permet de lier le fichier à un élément de l'ADF, parmi les types suivants : entreprise, participant, formateur et module
entite_liee_id non Permet de lier le fichier à un élément de l'ADF, en conjonction avec entite_liee_type

Si un des paramètres cible, id_cible, ou collection est omis, alors Dendreo tentera de reconnaitre le fichier par l'intermédiaire du QR Code (si disponible avec votre abonnement).

Le paramètre 'chemin' ne peut être utilisé qu'avec la cible 'action-de-formation' et la collection 'docsaved'.

Les paramètres 'entite_liee_type' et 'entite_liee_id' doivent être utilisés ensemble. Ils ne peuvent être utilisés qu'avec la cible 'action-de-formation' et la collection 'docsaved' ou 'signature'. Dand le cas où vous souhaitez ajouter une demande de signature dans une ADF, il faut utiliser la cible 'action-de-formation' ET l'entite liée (cad le signataire)

Requête HTTP

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

Liste des cibles et collection_name correspondants

Voici la liste des correspondances entre cible et collection possibles :

cible collection commentaire
action-de-formation visuel, docssaved, signature
formateur avatar, docssaved, signature
contact avatar, signature
participant avatar, docssaved, signature
module visuel, presentation, docssaved
entreprise logo, docssaved, signature
salle-de-formation image_map, pdf_map
centre-de-formation logo, image_map, pdf_map, header, footer, cgv, reglement_interieur, centre_signature, docssaved, partage_cdf_formateurs, partage_cdf_entreprises, partage_cdf_participants
doctype docstype
expense expense
laf partage_laf à utiliser avec id_cible = id du LAF, permet d'obtenir les fichiers pour 1 Formateur identifié dans 1 ADF
lap partage_lap, partage_lap_prive à utiliser avec id_cible = id du LAP permet d'obtenir les fichiers pour 1 Participant identifié dans 1 ADF
lae partage_lae à utiliser avec id_cible = id du LAE permet d'obtenir les fichiers pour 1 Entreprise identifié dans 1 ADF
action-de-formation partage_adf_participants à utiliser avec id_cible = id ADF, permet d'obtenir les fichiers mis à disposition pour "Tous les Participants"
action-de-formation partage_adf_formateurs à utiliser avec id_cible = id ADF, permet d'obtenir les fichiers mis à disposition pour "Tous les Formateurs"
action-de-formation partage_adf_entreprises à utiliser avec id_cible = id ADF, permet d'obtenir les fichiers mis à disposition pour "Toutes les Entreprises"
module partage_module_public à utiliser avec id_cible = id module, permet d'obtenir les fichiers mis à disposition pour "Public - Participants" d'un Module
module partage_module_formateurs à utiliser avec id_cible = id module, permet d'obtenir les fichiers mis à disposition pour "Privé - Formateurs" d'un Module
salle partage_salle_public à utiliser avec id_cible = id salle_de_formation, permet d'obtenir les fichiers mis à disposition pour "Public - Participants" d'une Salle de Formation

La collection 'docssaved' correspond à l'espace de stockage. Vous pouvez y ajouter plusieurs fichiers.

La collection 'expense' correspond aux justificatifs des notes de frais. Vous pouvez également y ajouter plusieurs fichiers.

Toutes les autres collections sont des fichiers 'uniques' c'est à dire que l'ajout d'un nouveau fichier écrasera celui qui serait déjà présent.

Vous pouvez également avoir d'autres collections relatives aux Champs personnalisés de type fichier. Dans ce cas, le nom de la collection sera le 'Nom technique' du champ personnalisé, disponible dans votre interface d'administration Dendreo

Supprimer un Fichier

Requête HTTP

DELETE https://pro.dendreo.com/demo/api/fichiers.php?id=1 DELETE https://pro.dendreo.com/demo/api/fichiers.php?id_fichier=1,2,3

Paramètres

Intitulé Obligatoire Description
id ou id_fichier oui ID du fichier (existence vérifiée)

Génération de Documents

Cet endpoint vous permet de générer (publiposter) un document à partir d'un modèle de document existant sur Dendreo, et de le télécharger au format natif (.docx, .odt, .xlsx) ou PDF.

Le header 'Content-Disposition' renvoyé est 'attachment'

Action De Formation

GET https://pro.dendreo.com/demo/api/documents.php?m=adf

Paramètres

Intitulé Obligatoire Description
id_doc_type oui ID du Modèle de Document à utiliser
id_adf oui ID de l'Action De Formation
generate non 1 pour génerer les tags, 0 pour télécharger le document brut
pdf non 1 pour la version pdf, 0 pour la version word du document

Entreprises d'une Action De Formation

GET https://pro.dendreo.com/demo/api/documents.php?m=adf_entreprise

Paramètres

Intitulé Obligatoire Description
id_doc_type oui ID du Modèle de Document à utiliser
id_adf oui ID de l'Action De Formation
id_lae oui ID du Lae (Lien entre l'Action De Formation et une Entreprise)
generate non 1 pour génerer les tags, 0 pour télécharger le document brut
pdf non 1 pour la version pdf, 0 pour la version word du document

Participants d'une Action De Formation

GET https://pro.dendreo.com/demo/api/documents.php?m=adf_participant

Paramètres

Intitulé Obligatoire Description
id_doc_type oui ID du Modèle de Document à utiliser
id_adf oui ID de l'Action De Formation
id_lap oui ID du Lap (Lien entre l'Action De Formation et un Participant)
generate non 1 pour génerer les tags, 0 pour télécharger le document brut
pdf non 1 pour la version pdf, 0 pour la version word du document

Formateurs d'une Action De Formation

GET https://pro.dendreo.com/demo/api/documents.php?m=adf_formateur

Paramètres

Intitulé Obligatoire Description
id_doc_type oui ID du Modèle de Document à utiliser
id_adf oui ID de l'Action De Formation
id_laf oui ID du Laf (Lien entre l'Action De Formation et un Formateur)
generate non 1 pour génerer les tags, 0 pour télécharger le document brut
pdf non 1 pour la version pdf, 0 pour la version word du document

Modules d'une Action De Formation

GET https://pro.dendreo.com/demo/api/documents.php?m=adf_module

Paramètres

Intitulé Obligatoire Description
id_doc_type oui ID du Modèle de Document à utiliser
id_adf oui ID de l'Action De Formation
id_lam oui ID du Lam (Lien entre l'Action De Formation et un Module)
generate non 1 pour génerer les tags, 0 pour télécharger le document brut
pdf non 1 pour la version pdf, 0 pour la version word du document

Modules + Participants d'une Action De Formation

GET https://pro.dendreo.com/demo/api/documents.php?m=adf_module_participant

Paramètres

Intitulé Obligatoire Description
id_doc_type oui ID du Modèle de Document à utiliser
id_adf oui ID de l'Action De Formation
id_lmp oui ID du Lmp (Lien entre le Module et le Participant au sein de cette Action de Formation)
generate non 1 pour génerer les tags, 0 pour télécharger le document brut
pdf non 1 pour la version pdf, 0 pour la version word du document

Facture

GET https://pro.dendreo.com/demo/api/documents.php?m=facture

Paramètres

Intitulé Obligatoire Description
id_doc_type oui ID du Modèle de Document à utiliser
id_facture oui ID de la Facture
generate non 1 pour génerer les tags, 0 pour télécharger le document brut
pdf non 1 pour la version pdf, 0 pour la version word du document

Module (hors contexte d'une ADF)

GET https://pro.dendreo.com/demo/api/documents.php?m=module

Paramètres

Intitulé Obligatoire Description
id_doc_type oui ID du Modèle de Document à utiliser
id_module oui ID du Module
generate non 1 pour génerer les tags, 0 pour télécharger le document brut
pdf non 1 pour la version pdf, 0 pour la version word du document

Entreprise (hors contexte d'une ADF)

GET https://pro.dendreo.com/demo/api/documents.php?m=entreprise

Paramètres

Intitulé Obligatoire Description
id_doc_type oui ID du Modèle de Document à utiliser
id_entreprise oui ID de l'Entreprise
generate non 1 pour génerer les tags, 0 pour télécharger le document brut
pdf non 1 pour la version pdf, 0 pour la version word du document

Participant (hors contexte d'une ADF)

GET https://pro.dendreo.com/demo/api/documents.php?m=participant

Paramètres

Intitulé Obligatoire Description
id_doc_type oui ID du Modèle de Document à utiliser
id_participant oui ID du Participant
generate non 1 pour génerer les tags, 0 pour télécharger le document brut
pdf non 1 pour la version pdf, 0 pour la version word du document

Formateur (hors contexte d'une ADF)

GET https://pro.dendreo.com/demo/api/documents.php?m=formateur

Paramètres

Intitulé Obligatoire Description
id_doc_type oui ID du Modèle de Document à utiliser
id_formateur oui ID du Formateur
generate non 1 pour génerer les tags, 0 pour télécharger le document brut
pdf non 1 pour la version pdf, 0 pour la version word du document

Devis

GET https://pro.dendreo.com/demo/api/documents.php?m=devis

Paramètres

Intitulé Obligatoire Description
id_doc_type oui ID du Modèle de Document à utiliser
id_devis oui ID du Devis
generate non 1 pour génerer les tags, 0 pour télécharger le document brut
pdf non 1 pour la version pdf, 0 pour la version word du document

Catalogue en ligne - Prochaines sessions

Cliquez ici

Opportunités

Lister toutes les Opportunités

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

Il est possible de filtrer sur certaines opportunités si l'on connait leur id.

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

Vous pouvez egalement filter sur un id de devis

Exemple : GET https://pro.dendreo.com/demo/api/opportunites.php?id_devis=2

Il est possible d'afficher la liste des Devis par Opportunité en renseignant le paramètre include sur la valeur devis.

Exemple : GET https://pro.dendreo.com/demo/api/opportunites.php?include=devis

Il est aussi possible d'afficher les devis avec les modules rattachés à ces derniers en renseignant le paramètre include sur la valeur devis_modules.

Exemple : GET https://pro.dendreo.com/demo/api/opportunites.php?include=devis_modules

{
  "id": "1",
  "opportunite_etape_id": "4",
  "numero": "1",
  "numero_complet": "OPP_2020001",
  "numero_perso": "0",
  "entreprise_id": "570",
  "assigned_to": "26",
  "contact_id": "393",
  "created_by": "",
  "edited_by": "",
  "commentaires_internes": "",
  "description": "test",
  "closed_at": "",
  "lost_at": "",
  "deleted_at": "",
  "created_at": "2020-02-04 11:48:36",
  "updated_at": "2020-02-04 11:58:58",
  "id_centre_de_formation": "1",
  "source_id": "1",
  "devis": [
    {
      "id": "1",
      "opportunite_id": "1",
      "parent_id": "",
      "numero_complet": "DEVIS_2020001",
      "numero_perso": "0",
      "numero": "1",
      "numero_auto": "1",
      "locked_at": "2020-02-04 11:58:58",
      "sent_at": "",
      "accepted_at": "2020-02-04 11:58:58",
      "declined_at": "",
      "created_by": "",
      "edited_by": "",
      "doc_type_id": "70",
      "linked": "",
      "formation_id": "",
      "type": "inter",
      "pricing": "par_participant",
      "participants": "1",
      "mode_participants": "global",
      "remarques": "",
      "commentaires_internes": "",
      "deleted_at": "",
      "created_at": "2020-02-04 11:48:36",
      "updated_at": "2020-02-04 11:58:58",
      "modules": [
        {
            "id_module": "233",
            "intitule": "Test",
            "numero_complet": "MOD_2020011",
            "id_externe": "",
            "id_categorie_module": "117"
        }
      ]
    }
  ]
}

Ajouter une Opportunité

{
    "id": "65",
    "opportunite_etape_id": "2",
    "numero": "9",
    "numero_complet": "OPP_2020009",
    "numero_perso": "0",
    "entreprise_id": "600",
    "assigned_to": "33",
    "contact_id": "425",
    "created_by": "0",
    "edited_by": "0",
    "commentaires_internes": "",
    "description": "",
    "closed_at": "",
    "lost_at": "",
    "deleted_at": "",
    "created_at": "2020-03-17 14:02:43",
    "updated_at": "2020-03-17 14:02:43",
    "id_centre_de_formation": "1",
    "devis": [
        {
            "id": "85",
            "opportunite_id": "65",
            "parent_id": "",
            "numero_complet": "DEVIS_2020009",
            "numero_perso": "0",
            "numero": "9",
            "numero_auto": "1",
            "locked_at": "",
            "sent_at": "",
            "accepted_at": "",
            "declined_at": "",
            "created_by": "0",
            "edited_by": "0",
            "doc_type_id": "70",
            "linked": "",
            "formation_id": "",
            "type": "inter",
            "pricing": "par_participant",
            "participants": "1",
            "mode_participants": "global",
            "remarques": "",
            "commentaires_internes": "",
            "deleted_at": "",
            "created_at": "2020-03-17 14:02:43",
            "updated_at": "2020-03-17 14:02:43"
        }
    ]
}

Paramètres

Intitulé Obligatoire Description
id_entreprise oui ID de l'entreprise pour cette opportunité
id_administrateur non ID du Commercial
id_contact non ID du contact dans l'entreprise
id_etape non ID de l'étape initiale pour cette opportunité (Probabilité de succès)
id_source non ID de la source
description non Champ texte de description
commentaires_internes non Champ texte de commentaires internes
id_centre_de_formation non Obligatoire si vous avez l'option multi-centres

Requête HTTP

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

Etapes d'opportunité

Lister toutes les étapes des opportunités

[
    "id": "1",
    "name": "Lead",
    "order": "0",
    "success_chance": "25",
    "deleted_at": "",
    "created_at": "2018-05-17 12:24:20",
    "updated_at": "2022-08-03 06:25:46",
    "color": "f9c98f",
    "status": "1"
]

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

Requête HTTP

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

Afficher une étape d'opportunité

{
    "id": "2",
    "name": "Négociation",
    "order": "1",
    "success_chance": "50",
    "deleted_at": "",
    "created_at": "2018-05-17 12:24:20",
    "updated_at": "2018-11-26 09:21:29",
    "color": "f6e67d",
    "status": "1"
}

Requête HTTP

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

Sources

Lister toutes les sources

[
    {
        "id": "1",
        "name": "Campagne Marketing",
        "status": "1",
        "order": "0"
    },
    {
        "id": "2",
        "name": "Salons",
        "status": "1",
        "order": "3"
    }
]

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

Requête HTTP

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

Afficher une source

{
    "id": "1",
    "name": "Campagne Marketing",
    "status": "1",
    "order": "0"
}

Requête HTTP

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

Afficher plusieurs sources

[
    {
        "id": "1",
        "name": "Campagne Marketing",
        "status": "1",
        "order": "0"
    },
    {
        "id": "2",
        "name": "Salons",
        "status": "1",
        "order": "3"
    }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/sources.php?id=1,2

Exports

Télécharger un Export

Ce lien vous permet de déclencher le téléchargement automatique d'un fichier d'Export Dendreo au format demandé en paramètre.

Requête HTTP

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

Paramètres disponibles

Intitulé Obligatoire Description
nom_export oui Correspond au nom de l'export à télécharger (slug)
date_debut oui Date de début des données à exporter (format vérifié : "AAAA-MM-JJ")
date_fin oui Date de fin des données à exporter (format vérifié : "AAAA-MM-JJ")
type non Correspond au type du fichier de sortie (formats disponibles : "csv", "xls"). Fichier XLS par défaut

Exemple : GET https://pro.dendreo.com/demo/api/exports.php?nom_export=creneaux&date_debut=2021-01-01&date_fin=2021-12-31&type=csv