Modification d'un Plan Individuel de Formation (PIF) pour les formations à distance (FOAD)

Présentation

Ce service permet de tester la modification des plans individuels de formation (PIF) des individus financés par Pôle emploi dans le cadre des marchés FOAD (Formations à distance).

 

Description de la requête

Point d'accès

PUT https://api.emploi-store.fr/partenaire/zerosaisietest/v1/inscriptions/pif

 

Paramètres d'entrée

En-tête(s) Valeur
Accept application/json
Content-Type application/json
Authorization Bearer {{token_authentification}}
pe-fonc-apimode production
Code Cardinalité Format Exemple Description
idRegionalDE 1 String 8 5160124F Identifiant régional de l'individu
codeGeoDE 1 String 3 Caractères autorisés : [0-9]3

Code géographique de l'individu

Liste des valeurs possibles

numeroConvention 1 String 12 41C26D119936 Le numéro de convention est obligatoire
dateDebutPlanFormation 1 Date Format YYYY-MM-DD Les bornes du plan de formation transmises par l'appelant doivent être comprises (ou égales) aux bornes de la session de formation.
dateFinPlanFormation 1 Date Format YYYY-MM-DD Les bornes du plan de formation transmises par l'appelant doivent être comprises (ou égales) aux bornes de la session de formation.
codeTypeParcours 1 String 1 6

Liste des valeurs possibles :

  • 6 → temps plein
  • 7 → temps partiel
dureeHebdo 1 Integer 20 Intensité hebdomadaire de la formation pour l'individu (en heures)
dureeFormationEntreprise 0..1 Integer 20 La durée de la formation en situation de travail en entreprise, facultative, 9999h max
dureeFormationPrincipale 1 Integer 50 La durée de la formation professionnelle, obligatoire, 9999h max
dureeHebdoEntreprise 0..1 Integer 10 Intensité hebdomadaire du stage en entreprise
nbLivrables 1 Integer 1 Nombre de livrables, 99 max
listeStages 0..n Sous-balise   Périodes de stage en entreprise
dateDebut 1 Date Norme ISO-8601 (YYYY-MM-DDTHH:MM:SSZ) Date de début de la période de stage en entreprise
dateFin 1 Date Norme ISO-8601 (YYYY-MM-DDTHH:MM:SSZ) Date de fin de la période de stage en entreprise
apercuSessionFormation 1 Sous-balise    
numeroFormation 1 String 25 22_AF_NL_00000827321 Numéro InterCarif de la formation
numeroAction 1 String 25 22_SE_NL_00003835251 Numéro InterCarif de l'action de formation
numeroSession 1 String 25 SE_NL_00003835252 Numéro InterCarif de la session de formation

 

Description de la réponse

Données retournées

Code Cardinalité Format Description
apercuSessionFormation     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
idPif 1 Integer Identifiant technique du Plan Individuel de Formation modifié
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 – Modification d'un Plan Individuel de Formation (PIF) pour une formation à distance

Appel

PUT /zerosaisietest/v1/inscriptions/pif HTTP/1.1
Host: https://api.emploi-store.fr/partenaire
Accept: application/json
Authorization: Bearer {{token}}
Content-Type: application/json
pe-fonc-apimode: production

{
  "idRegionalDE" : "5160124F",
  "codeGeoDE" : "049",
  "numeroConvention": "41C26D119936",
  "dateDebutPlanFormation": "2020-11-09",
  "dateFinPlanFormation": "2020-12-11",
  "codeTypeParcours": 6,
  "dureeHebdo": 20,
  "dureeFormationEntreprise": 20,
  "dureeFormationPrincipale": 50,
  "dureeHebdoEntreprise": 10,
  "nbLivrables": 1,
  "listeStages": [
    {
      "dateDebut": "2020-11-30T00:00:00+01:00"
      "dateFin": "2020-12-11T00:00:00+01:00"
    }
  ]
  "apercuSessionFormation": {
    "numeroFormation": "22_AF_NL_00000827321"
    "numeroAction": "22_SE_NL_00003835251",
    "numeroSession": "SE_NL_00003835252"
  }
}

 

Retour : HTTP 200 OK

{
  "apercuSessionFormation": {
    "numeroAction": "22_SE_NL_00003835251",
    "numeroFormation": "22_AF_NL_00000827321"
    "numeroSession": "SE_NL_00003835252",
  },
  "idPif": 66164,
  "idNationalDE": "DkZNY2zBt1fzydND6YGH_18A8UCXg6vXM_WKkx5j8UQ",
  "idProjetAction": "EFO20201026A",
  "numeroConvention": "41C26D119936",
  "dateDebutPlanFormation": "2020-11-09",
  "dateFinPlanFormation": "2020-12-11",
  "codeTypeParcours": 6,
  "dureeHebdo": 20,
  "dureeTotale": 70,
  "dureeFormationPrincipale": 50,
  "dureeFormationEntreprise": 20,
  "nbLivrables": 1,
  "dureeHebdoEntreprise": 10,
  "listeStages": [
    {
      "dateDebut": "2020-11-30T00:00:00+01:00"
      "dateFin": "2020-12-11T00:00:00+01:00"
    }
  ],
  "estFoad": true,
  "etatPIF": {
    "code": "E",
    "libelle": "En attente de validation"
    "libelleLong": "En attente de validation",
  }
}