Consultation des plans individuels de formation (PIF) pour les formations à distance (FOAD)

Présentation

Ce service permet de tester la consultation des plans individuels de formation (PIF) des individus positionnés à une formation à distance (FOAD).

Description de la requête

Point d'accès

GET https://api.emploi-store.fr/partenaire/parcoursformationtest/v1/inscriptions/pif

 

Paramètres d'entrée

En-tête(s) Valeur
Accept application/json
Content-Type application/json
Authorization Bearer {{Acces token}}
Code Cardinalité Format Description
numeroFormation 1 String 25 Numéro InterCarif de la formation
numeroAction 1 String 25 Numéro InterCarif de l'action de formation
numeroSession 1 String 25 Numéro InterCarif de la session de formation
idRegionalDE 0..1 String 8 Identifiant régional de l'individu
codeGeoDE 0..1 String 3

Code géographique de l'individu

Liste des valeurs possibles

 

Description de la réponse

Données retournées

Code Cardinalité Format Description
  0..n Tableau Liste des projets individuels de formation (PIF)
apercuSession     Sous-balise
numeroSession 1 String 25 Numéro intercarif de la session de formation
numeroAction 1 String 25 Numéro intercarif de l’action de formation
numeroFormation 1 String 25 Numéro intercarif de la formation
idNationalDE 1 String 255 Identifiant national crypté de l'individu
idProjetAction 1 String 12 Identifiant du projet de formation (EFO)
numeroConvention 1 String 12 Numéro de la convention
dateDebutPlanFormation 1 Date

Date de début du plan de formation de l'individu

Format YYYY-MM-DD

dateFinPlanFormation 1 Date

Date de fin du plan de formation de l'individu

Format YYYY-MM-DD

codeTypeParcours 1 String 1 6 - temps plein ou 7 - temps partiel
dureeHebdo 1 Integer 2 Intensité hebdomadaire de la formation pour l'individu
dureeTotale 1 Integer 4 Durée totale de la formation
dureeFormationEntreprise 0..1 Integer 4 Durée de la formation en entreprise
dureeFormationPrincipale 1 Integer 4 Durée de la formation professionnelle
dureeHebdoEntreprise 0..1 Integer 4 Intensité hebdomadaire du stage en entreprise
nbLivrables 1 Integer 2 Nombre de livrables
listeStages 0..n   Périodes des stages en entreprise
dateDebut 1 Date

Date de début de la période de stage en entreprise

Norme ISO-8601 (YYYY-MM-DDTHH:MM:SSZ)

dateFin 1 Date

Date de fin de la période de stage en entreprise

Norme ISO-8601 (YYYY-MM-DDTHH:MM:SSZ)

estFoad 0..1 Booléen Indique si le PIF est de type FOAD
etatPIF 1  

Etat du PIF

Valeurs possibles :

  • E→ En attente de validation
  • M→ En attente de modification
  • A→ PIF accepté
  • R→ PIF refusé
  • S→ PIF sans suite
code 1 String 1 Code de l'état du PIF
libelle 1 String 100 Libellé court de l'état du PIF
libelleLong 1 String 100 Libellé long de l'état du PIF

 

Exemples

Cas OK – Lister les Plans Individuels de Formation (PIF) d'une formation à distance (FOAD)

Appel

GET /parcoursformationtest/v1/inscriptions/pif?numeroSession=SE_NL_00003835252&numeroAction=22_SE_NL_00003835251&numeroFormation=22_AF_NL_00000827321&idRegionalDE=5160124F&codeGeoDE=049 HTTP/1.1
Host: https://api.emploi-store.fr/partenaire
Accept: application/json
Authorization: Bearer {{token}}
Content-Type: application/json
pe-fonc-apimode: production

 

Retour

HTTP 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache

[
    {...},
    {                                    
        "apercuSession": {                                
            "numeroSession": "SE_NL_00003835252",                            
            "numeroAction": "22_SE_NL_00003835251",                            
            "numeroFormation": "22_AF_NL_00000827321"                            
        },                                
        "planIndividuelFormationPartenaire": [                                
            {                                
                "idNationalDE": "DkZNY2zBt1fzydND6YGH_18A8UCXg6vXM_WKkx5j8UQ",                            
                "idProjetAction": "EFO20201026A",                            
                "numeroConvention": "41C26D119834",                            
                "dateDebutPlanFormation": "2020-11-02",                            
                "dateFinPlanFormation": "2020-12-18",                            
                "codeTypeParcours": 7,                            
                "dureeHebdo": 14,                            
                "dureeTotale": 54,                            
                "dureeFormationPrincipale": 28,                            
                "dureeFormationEntreprise": 26,                            
                "nbLivrables": 3,                            
                "dureeHebdoEntreprise": 7,                            
                "listeStages": [                                
                    {                                
                          "dateDebut": "2020-11-16T00:00:00+01:00",                            
                          "dateFin": "2020-12-18T00:00:00+01:00"                            
                    }                                
                ],                                
                "estFoad": true,                            
                "etatPIF": {                                
                      "code": "E",                            
                      "libelle": "En attente de validation",                            
                      "libelleLong": "En attente de validation"                            
                }                                
            }                                
        ]                                
    },
    {...}                                    
]