### Dendreo API Request Examples Source: https://developers.dendreo.com/index Provides examples of various GET requests, including fetching multiple objects by comma-separated IDs, using 'id_externe' for specific objects, filtering columns with the 'fields' parameter, including related elements with 'include', and showing hidden fields like 'date_add' with the 'show' parameter. ```APIDOC Request Examples: - Fetch multiple objects by ID: `GET https://pro.dendreo.com/demo/api/contacts.php?id=12,14,16` - Use `id_externe` for specific objects (e.g., Entreprise, Contact): `GET https://pro.dendreo.com/demo/api/entreprises.php?id_externe=externe_12,externe_14,externe_16` - Use `id` or `id_objet` (e.g., `id_contact`): `GET https://pro.dendreo.com/api/contacts.php?id=12` `GET https://pro.dendreo.com/api/contacts.php?id_contact=12` - Filter columns using `fields`: `GET https://pro.dendreo.com/api/entreprises.php?fields=id_entreprise,raison_sociale` - Include related elements using `include`: `GET https://pro.dendreo.com/api/contacts.php?include=entreprise` - Show hidden fields (e.g., `date_add`, `date_edit`) using `show`: `GET https://pro.dendreo.com/api/contacts.php?id=12&show=date_edit,date_delete` ``` -------------------------------- ### File Upload JSON Payload Example Source: https://developers.dendreo.com/index Example JSON structure representing a file upload, including metadata like collection name, MIME type, size, and associated entities. ```JSON { "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" } ``` -------------------------------- ### Dendreo API Product Types - Get Source: https://developers.dendreo.com/index Retrieves a specific Product Type by its ID. Returns the details of the requested product type. ```APIDOC GET https://pro.dendreo.com/demo/api/categories_produit.php?id=2 Response: {"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"} ``` -------------------------------- ### Dendreo API: Retrieve Training Action Modules Source: https://developers.dendreo.com/index Demonstrates how to retrieve training action modules (LAMs) from the Dendreo API. It shows examples of filtering by training action ID or module ID. ```APIDOC GET https://pro.dendreo.com/demo/api/lams.php To display the programs of a training action, select the Training Action via `id_action_de_formation`. Example: GET https://pro.dendreo.com/demo/api/lams.php?id_action_de_formation=882 You can also filter results by Module: Example: GET https://pro.dendreo.com/demo/api/lams.php?id_module=175 ``` ```JSON [ { "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": "" } ] } ] ``` -------------------------------- ### Dendreo API Authentication Source: https://developers.dendreo.com/index Explains how to authenticate with the Dendreo API using tokens. Tokens can be provided as a POST or GET parameter named 'key', or within the 'Authorization' header as 'Token token="YOUR_TOKEN"'. An invalid or missing token results in a 401 Unauthorized error. ```APIDOC Authentication: - Token-based authentication. - Provide token via POST/GET parameter: `?key=YOUR_TOKEN` - Provide token via Authorization header: `Token token="YOUR_TOKEN"` - Invalid/missing token results in 401 Unauthorized error. ``` -------------------------------- ### List All Steps Source: https://developers.dendreo.com/index Retrieves all steps available in Dendreo. Each step has an ID, title, parent ID, status, order, name, and target. ```APIDOC GET https://pro.dendreo.com/demo/api/etapes.php ``` ```JSON [{"id_etape_process":"2","intitule":"Réalisation","id_parent":"0","status":"1","ordre":"2","name":"real","cible":"intra"}] ``` -------------------------------- ### Get Single Participant Registration Source: https://developers.dendreo.com/index Retrieve details for a specific participant registration using its unique ID. ```APIDOC GET https://pro.dendreo.com/demo/api/lmps.php?id=3093 ``` ```JSON {"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":"",...} ``` -------------------------------- ### Module Planning Configuration Source: https://developers.dendreo.com/index Explains how to configure the planning of a training module using parameters like duree_jours, duree_plage_jours, import_jours, and import_duree. ```Markdown ### 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 : * ne renseigner aucun paramètre spécifique et votre Module prendra la durée d'une 'journée type' (définie en configuration) * passer uniquement le paramètre `import_jours` = X et votre Module aura un planning contenant X jours d'une durée égale à la 'journée type' * passer les paramètres `import_jours` = X et `import_duree` = Y et votre Module aura un planning contenant X jours d'une durée de Y heures chacun (en mode durée) * passer les paramètres `import_jours` = X et `import_creneaux` avec la valeur `default_config` et votre Module aura un planning contenant X jours, chaque jour contenant le ou les Créneaux par défaut (définis en configuration) * passer les paramètres `import_jours` = X et `import_creneaux` sous la forme `08:30-11:00;14:30-16:50` et votre Module aura un planning contenant X jours, chaque jour contenant le ou les Créneaux correspondant aux horaires précisés ``` -------------------------------- ### Afficher une Salle de Formation Source: https://developers.dendreo.com/index Récupère les détails d'une salle de formation spécifique en utilisant son identifiant. L'emplacement et le statut 'elearning' sont également décrits. ```APIDOC GET https://pro.dendreo.com/demo/api/salles_de_formation.php?id=4 Exemple de réponse: { "id_salle_de_formation": "4", "intitule": "Salle Amandre", "color": "", "status": "1", "capacite_max": "42", "adresse": "", "code_postal": "", "ville": "", "pays_alpha2": "", "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", "acces_handicapes": "1", "acces_handicapes_desc": "Précisions sur l'accès aux personnes en situation de handicap", "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1" } ``` -------------------------------- ### Get Training Action <-> Company Link Source: https://developers.dendreo.com/index Retrieves a specific link between a training action and a company (Lae) by its ID. ```APIDOC GET https://pro.dendreo.com/demo/api/laes.php?id=877 ``` -------------------------------- ### Dendreo API: Create Training Session Parameters Source: https://developers.dendreo.com/index Defines the parameters required to create a training session (Action de Formation). It specifies mandatory and optional fields like IDs for training actions, modules, trainers, companies, and dates, along with pricing and scheduling details. ```APIDOC POST https://pro.dendreo.com/demo/api/lams.php Parameters: - id_action_de_formation (required): ID of the Training Action (existence verified). - id_module (required): ID of the Module (existence verified). - date_debut (required*): Start date (format verified: 'YYYY-MM-DD'). *Except in Multi-Products if the 'hors_formation_dates' option is disabled on the concerned product. - date_fin (optional*): End date (format verified: 'YYYY-MM-DD'). *Except in Multi-Products if the 'hors_formation_dates' option is enabled on the concerned product. Can also be used for progressive planning or e-learning Modules. - duree (optional): Duration in hours. Used for progressive planning. - id_formateur (optional): ID of the Trainer to staff. If not provided, the default Trainer for the Module will be staffed. Use null or 0 to not staff the default Trainer. - id_entreprise_formateur (optional): ID of the subcontracting Company to staff. If not provided, the default subcontracting Company for the Module will be staffed. Use null or 0 to not staff the default subcontracting Company. - prix (optional): Price. - prix_achat (optional): Purchase price. - quantite (optional*): Quantity. *Unless the 'hors_formation_prix_par_jour' option (daily pricing) is disabled on the concerned module. - id_salle_de_formation (optional): ID of the Room. If empty, the room scheduled for the Training Action will be used, or the default Room for the Module. - intitule (optional): Title overriding the Module's title. - remuneration (optional): Trainer's remuneration price per LAM. Requires 'Rémunération des Formateurs par Module' option to be active on the Training Action and 'id_formateur' and/or 'id_entreprise_formateur' to be provided. ``` -------------------------------- ### Dendreo API Module Categories - Get Source: https://developers.dendreo.com/index Retrieves a specific Module Category by its ID. Returns the details of the requested category. ```APIDOC GET https://pro.dendreo.com/demo/api/categories_module.php?id=8 Response: {"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":""} ``` -------------------------------- ### Advanced Filtering API Source: https://developers.dendreo.com/index Enables advanced filtering on targets when listing all files of a certain type. For example, filtering by the 'entreprise' of a 'participant'. ```APIDOC GET https://pro.dendreo.com/demo/api/fichiers.php?cible=participant GET https://pro.dendreo.com/demo/api/fichiers.php?cible=participant&filter_cible[entreprise]=1 ``` -------------------------------- ### Lister les Salles de Formation Source: https://developers.dendreo.com/index Accède à toutes les salles de formation présentes sur Dendreo. Permet de filtrer par le champ 'inside' (0 ou 1) et par l'emplacement cible ('CentresDeFormation' ou 'Entreprise'). Le champ 'elearning' indique si la salle est une salle d'e-learning. ```APIDOC GET https://pro.dendreo.com/demo/api/salles_de_formation.php Paramètres: - 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') Exemple de réponse: [ { "id_salle_de_formation": "3", "intitule": "Salle Einstein", "color": "", "status": "1", "capacite_max": "20", "adresse": "", "code_postal": "", "ville": "", "pays_alpha2": "", "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", "acces_handicapes": "1", "acces_handicapes_desc": "Précisions sur l'accès aux personnes en situation de handicap", "ical_url": "https://public.dendreo.com/demo/ical/nxlfbn57t75shd1q1h3flzsk5hwctyv77Anfhdxsl4tbhrjz8wb1" } ] ``` -------------------------------- ### Supprimer une Action de Formation Source: https://developers.dendreo.com/index Permet de supprimer une ou plusieurs actions de formation en spécifiant leurs IDs. ```APIDOC 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: - id ou id_action_de_formation (oui): ID de l'Action de Formation (existence vérifiée). ``` -------------------------------- ### Dendreo API: Get Source Source: https://developers.dendreo.com/index Retrieves a specific source by its ID. The details include the source's name, status, and order. ```APIDOC GET https://pro.dendreo.com/demo/api/sources.php?id=2 ``` -------------------------------- ### Dendreo API: Create/Update Module Parameters Source: https://developers.dendreo.com/index Defines the parameters required for creating or updating a training module in the Dendreo API. This includes general information, eligibility, scheduling, pricing, and association with trainers and skills. ```APIDOC POST https://pro.dendreo.com/demo/api/modules.php Parameters: - id (or id_module): Module ID (optional). If empty, a new module is added; otherwise, the existing module is edited. - id_centre_de_formation: Training center ID (optional, comma-separated for multiple centers). - intitule: Module title (required). - intitule_court: Short module title (optional). - include_in_bpf: Module included in BPF (1 or 0, optional). - catalogue: Module displayed on the Catalog (1 or 0, optional). - eligible_cpf: CPF eligibility (1 or 0, optional). - mode_organisation: Organization mode (presentiel, elearning_sync, mixte, elearning_async, stage, optional). - import_creneaux: Module training slots (optional, e.g., '09:00-12:00;14:30-18:00' or 'default_config'). - import_duree: Duration in hours (if import_creneaux is not provided, optional). - duree_heures: Duration in hours (if import_duree is not provided, optional). - duree_plage_jours_elearning: Duration in days for elearning_async mode (optional, defaults to module configuration). - import_jours: Module duration in days (optional). - prix: INTER price (optional). - prix_intra: INTRA price (optional). - prix_inter_category_1: INTER price for members (optional). - prix_intra_category_1: INTRA price for members (optional). - prix_achat: Purchase price (optional). - id_formateur: Trainer ID (optional, defaults to staff). - id_entreprise_formateur: Subcontractor company ID (optional, defaults to staff). - formateurs: Eligible trainer IDs (optional, comma-separated). - orientations_dpc: DPC eligibility (1 or 0, optional). - competences_ids: Skill IDs (optional, comma-separated). - competences_list: Skill titles (optional, semicolon-separated). - competences_requises_ids: Required skill IDs for trainers (optional, comma-separated). - competences_requises: Required skill titles for trainers (optional, semicolon-separated). - id_specialite: Specialty ID (optional, overrides specialite_code). - specialite_code: Specialty code (optional, used if id_specialite is not provided). - id_categorie_module: Module category ID (optional, overrides categorie_module_intitule). - categorie_module_intitule: Module category title (optional, used if id_categorie_module is not provided). - codes_modalites_admission: Admission modalities (optional). - points_forts: Strengths (max 254 characters, optional). - certification_code: Certification code (e.g., 'RS5355', 'CPF5355', optional). - formacode: Formacode (optional). - nb_participants_min: Minimum participants (optional). - nb_participants: Maximum participants (optional). - public_vise: Target audience (optional). - pre_requis: Prerequisites (optional). - infos_admission: Admission information (optional). - modalites_pedagogiques: Pedagogical modalities (optional). - moyens_supports_pedagogiques: Pedagogical means and supports (optional). - modalites_devaluation: Evaluation and monitoring modalities (optional). - accessibilite: Accessibility information (optional). - objectif: Training objectives (optional). - description: Description/content (optional). - profil_formateurs: Trainer profile(s) (optional). - duree_plage_jours_elearning: Period of availability (optional). - num_programme_dpc: DPC program number (optional). - nouveaute: Newness indicator (1 or 0, optional). - catalogue_limited_visibility: Restrict catalog visibility (1 = checked, 0 = unchecked, optional). ``` -------------------------------- ### Get Contact Details Source: https://developers.dendreo.com/index Retrieves the details of a specific contact. An optional 'include=photo' parameter can be added to fetch the contact's profile photo URL. ```APIDOC GET https://pro.dendreo.com/demo/api/contacts.php?id=3 GET https://pro.dendreo.com/demo/api/contacts.php?id=5&include=photo ``` -------------------------------- ### Dendreo API: General Functionality Source: https://developers.dendreo.com/index Overview of general functionalities and concepts for the Dendreo API, including authentication, permissions, data formats, error handling, throttling, caching, request management, editing, deletion, and search/filtering. ```APIDOC Authentification Permissions Formats Erreurs Throttling Cache Requêtes Édition Suppression Recherche/filtre ``` -------------------------------- ### Ajouter une Salle de Formation Source: https://developers.dendreo.com/index Permet d'ajouter une nouvelle salle de formation avec des détails tels que le nom, l'emplacement, la capacité, et les informations d'accès. Des paramètres spécifiques s'appliquent selon le type d'emplacement. ```APIDOC POST https://pro.dendreo.com/demo/api/salles_de_formation.php Paramètres: - intitule (oui): Nom de la salle - emplacement_cible (oui): Emplacement de la salle ('cdf_outside', 'elearning', 'client', 'client_outside', 'interne' 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) - acces_handicapes (non): Accès aux personnes en situation de handicap (0 ou 1) - acces_handicapes_desc (non): Précisions sur l'accès aux personnes en situation de handicap Paramètres spécifiques si emplacement_cible = client_outside ou cdf_outside: - 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. Le libellé doit correspondre à un pays reconnu dans la norme ISO-3166 - pays_alpha2 (non): Code ISO-3166-2 du Pays - 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 Paramètres spécifiques si emplacement_cible = elearning: - url_connexion (non): Url de connexion de la salle Exemple de corps de requête (pour un emplacement client_outside): { "intitule": "Salle Amandre", "emplacement_cible": "client_outside", "id_entreprise": "123", "adresse": "10 Rue de la Paix", "code_postal": "75001", "ville": "Paris", "pays": "France", "telephone": "0123456789", "nom_contact": "M. Dupont" } ``` -------------------------------- ### Dendreo API: Get Opportunity Stage Source: https://developers.dendreo.com/index Retrieves a specific opportunity stage by its ID. The response includes details such as name, order, success chance, and color. ```APIDOC GET https://pro.dendreo.com/demo/api/opportunite_etapes.php?id=2 ``` -------------------------------- ### Get Trainer Details Source: https://developers.dendreo.com/index Retrieves the details of a specific trainer using their ID. The `photo` of the trainer's profile can be included in the response by adding `include=photo` to the request. ```APIDOC GET https://pro.dendreo.com/demo/api/formateurs.php?id=5 Parameters: id: The unique identifier of the trainer. include: Optional. Set to 'photo' to include the trainer's profile picture URL. Example: GET https://pro.dendreo.com/demo/api/formateurs.php?id=5&include=photo ``` -------------------------------- ### Dendreo API: Permanent Sessions Source: https://developers.dendreo.com/index Manage permanent training sessions using the Dendreo API. Includes functionalities for listing, viewing, creating, modifying, and deleting permanent sessions. ```APIDOC Lister toutes les Sessions Permanentes Afficher une Session Permanente Ajouter une Session Permanente Modifier une Session Permanente Supprimer une Session Permanente ``` -------------------------------- ### Dendreo API: List Sources Source: https://developers.dendreo.com/index Retrieves a list of all sources available in Dendreo. Each source has an ID, name, status, and order. ```APIDOC GET https://pro.dendreo.com/demo/api/sources.php ``` -------------------------------- ### Get Formateur Intervention Details Source: https://developers.dendreo.com/index Retrieves the detailed information for a specific Formateur intervention using its unique ID. It's also possible to include related budgets. ```APIDOC GET https://pro.dendreo.com/demo/api/lafs.php?id=62 Parameters: - id: The unique ID of the intervention to retrieve. - include: Optional. Set to 'budgets' to include related budget information. ``` -------------------------------- ### List All Training Modules Source: https://developers.dendreo.com/index Retrieves a list of all training modules available in Dendreo. The response is a JSON array of module objects, each containing detailed information. ```APIDOC GET https://pro.dendreo.com/demo/api/modules.php Response Body Example: [ { "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" } } ] } ] ``` -------------------------------- ### Get Specific Step Source: https://developers.dendreo.com/index Retrieves a specific step in Dendreo by its ID. The step details include its ID, title, parent ID, status, order, name, and target. ```APIDOC GET https://pro.dendreo.com/demo/api/etapes.php?id=2 ``` ```JSON {"id_etape_process":"2","intitule":"Réalisation","id_parent":"0","status":"1","ordre":"2","name":"real","cible":"intra"} ``` -------------------------------- ### Get Specific Training Center Source: https://developers.dendreo.com/index Retrieves a specific training center in Dendreo by its ID. The details include the center's ID, legal company name, and trading name. ```APIDOC GET https://pro.dendreo.com/demo/api/centres_de_formation.php?id=1 ``` ```JSON {"id_centre_de_formation":"1","raison_sociale":"Centre principal","nom_commercial":"Demo Formation"} ``` -------------------------------- ### Dendreo API: Training Modules Source: https://developers.dendreo.com/index Manage training modules (products) via the Dendreo API. Endpoints allow listing all modules, retrieving a specific module, adding/editing modules, and deleting modules. ```APIDOC Lister tous les Modules de formation Afficher un module de formation Ajouter / Editer un Module de formation Supprimer un Module ``` -------------------------------- ### Include Trainers Aptes Source: https://developers.dendreo.com/index Appends `include=formateurs_aptes` to the module retrieval request to include information about trainers qualified for the module. ```APIDOC GET https://pro.dendreo.com/demo/api/modules.php?include=formateurs_aptes ``` -------------------------------- ### Add Programming Entry Source: https://developers.dendreo.com/index Adds a new programming entry to the Dendreo system. Requires essential details like the action de formation, module, quantity, and pricing information. ```APIDOC POST https://pro.dendreo.com/demo/api/lams.php Request Body: { "id_action_de_formation": "{id}", "id_module": "{id}", "quantite": "{quantity}", "prix": "{price}", "prix_achat": "{purchase_price}", "id_shadow_lam": "{shadow_lam_id}" } Example Request Body: { "id_lam": "197", "id_action_de_formation": "330", "id_module": "17", "quantite": "0", "prix": "0.00", "prix_achat": "0.00", "id_shadow_lam": "0" } ``` -------------------------------- ### Dendreo API: List and Get Funders Source: https://developers.dendreo.com/index This section covers the API endpoints for managing 'financeurs' (funders) in Dendreo. It allows listing all funders, with optional filtering by 'raison_sociale' (company name), and retrieving details for a specific funder by its ID. ```APIDOC GET https://pro.dendreo.com/demo/api/financeurs.php List Funders: Optional Filter: raison_sociale (e.g., GET https://pro.dendreo.com/demo/api/financeurs.php?raison_sociale=anfa) Example Response Body: [{"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_alpha2":"fr","pays":"France"}] Get Funder by ID: Parameter: id (required) Example: GET https://pro.dendreo.com/demo/api/financeurs.php?id=1 Example Response Body: [{"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_alpha2":"fr","pays":"France"}] ``` -------------------------------- ### Dendreo API: Manage Module Enrollments (Lmp) Source: https://developers.dendreo.com/index Explains the concept of Lmp (Participant-Module link) within a Training Action (Lap). Lmps are created automatically when a participant is added to a Training Action. The status of Lmp depends on whether the Training Action has a single module or multiple modules, and specific configuration settings. ```APIDOC Manage module enrollments A Lmp represents the link between a Participant and a Module, within a Training Action. In other words, it's a link between a [Lap](https://developers.dendreo.com/#inscription-dun-participant) and a [Lam](https://developers.dendreo.com/#programmation-dun-module). Important note: all Lmps are created at the same time as the Laps. That is, as soon as a Participant is added to a Training Action (Lap), all Lmps related to the Modules (Lam) are created. - When the Training Action has only one Module, the `status` field is automatically set to 1. - When the Training Action has multiple Modules, the `status` field is set according to the following configuration on Dendreo: `Automatically enroll a Participant in all Modules`. ``` -------------------------------- ### Dendreo API Permissions Source: https://developers.dendreo.com/index Details how API key permissions can be managed to grant specific read (GET) and write (POST, PUT, DELETE) rights independently on each endpoint. Lack of permissions for an endpoint will result in a 401 Unauthorized error. ```APIDOC Permissions: - Manage multiple API keys with specific read (GET) and write (POST, PUT, DELETE) permissions. - Permissions can be set independently for each endpoint. - Absence of permissions on an endpoint results in a 401 Unauthorized error. ``` -------------------------------- ### Include Module Visual Source: https://developers.dendreo.com/index Appends `include=visuel` to the module retrieval request to also obtain the URL of the associated visual. ```APIDOC GET https://pro.dendreo.com/demo/api/modules.php?id=4&include=visuel ``` -------------------------------- ### Dendreo API: Trigger Export Source: https://developers.dendreo.com/index Triggers the automatic download of a Dendreo Export file in a requested format. Requires export name, start date, and end date. Optional parameters include file type and delimiter for CSV files. ```APIDOC GET https://pro.dendreo.com/demo/api/exports.php Parameters: - nom_export (required): The name (slug) of the export to download. - date_debut (required): The start date for the data to be exported (format: YYYY-MM-DD). - date_fin (required): The end date for the data to be exported (format: YYYY-MM-DD). - type (optional): The output file type. Available formats: `csv`, `xls`. Defaults to XLS. - delimiter (optional): The delimiter for CSV files. Available formats: `,`, `|`, `:`, `;`. Defaults to `,`. Ignored if type is not `csv`. Example: GET https://pro.dendreo.com/demo/api/exports.php?nom_export=creneaux&date_debut=2021-01-01&date_fin=2021-12-31&type=csv ```