Consultation des financements des stagiaires

Présentation

Ce service permet de tester la consultation des financements des individus inscrits à une session de formation.

Description de la requête

Point d'accès

GET https://api.emploi-store.fr/partenaire/parcoursformationtest/v1/financement-individu

 

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
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
numeroReferenceExterne 0..1 String 255 Référence externe de la session du CARIF du SI partenaire (valeur considérée en lieu et place du triptique intercarif de la session de formation - si renseigné dans le flux intercarif)
idRegionalDE 0..1 String 8 Identifiant régional de l'individu
codeGeoDE 0..1 String 3 Code géographique de l'individu
pagination 0..1 String 12

Pagination des données. La plage de résultats est limitée à 20.

Format :

début-finoù :

  • début → index (débutant à 0) du premier élément demandé

  • fin → index du dernier élément demandé

Exemples :

  • Pour demander les 20 premiers résultats : range=0-19
  • Pour demander les 20 résultats suivants : range=20-39

 

Description de la réponse

Données retournées

En-tête(s) Valeur
Content-Type application/json
Content-Range

début-fin/total, où :

  • début est l’index (débutant à 0) du premier élément renvoyé

  • fin est l’index du dernier élément renvoyé

  • total est le nombre total d’éléments de la recherche
Code Cardinalité Format Description
  0..n Tableau Liste des financements
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
idNationalDE 1 String 255 Identifiant national crypté de l'individu
idInscription 1 Integer 10 Identifiant technique de l'inscription
idProjetAction 1 String 12 Identifiant du projet de formation (EFO)
financement 1   Un individu inscrit à une formation est financé soit par Pôle emploi (voir sous-balise convention), soit par un organisme autre que Pôle emploi (voir sous-balise organismeFinanceur)
convention 0..1   Finanement Pôle emploi
numeroConvention 1 String 12 Numéro de la convention
dispositifFinancement 1  

Dispositif de financement

Liste des valeurs possibles

codeDispositif 1 String 2 Code du dispositif de financement
libelleDispositif 1 String 255 Libelle long du dispositif de financement
typeMarche 0..1  

Type de marché

Valeurs possibles :

  • 1 → Marché 2009
  • 2 → Marché 2014
  • 3 → Marché 2019
  • 4 → FOAD - Marché 2019
codeMarche 1 Integer 2 Code du type du marché
libelleMarche 1 String 255 Libellé du type du marché
zoneGeographique 1  

Zone géographique

Liste des valeurs possibles

codeGeo 1 String 3 Code de la région de rattachement du conventionnement
libelleGeo 1 String 255 Libellé de la région
organismeFinanceur 0..1  

Financement par un organisme financeur autre que Pôle emploi

Liste des valeurs possibles

identifiantFinanceur 1 Integer 2 Code de l'organisme financeur de l'AIS
libelleFinanceur 1 String 255 Libelle long de l'organisme financeur de l'AIS
opca 0..1  

OPCA / OPCO

Liste des valeurs possibles

indentifiantOpca 1 String 2 Code correpondant à l'organisme financeur OPCA/OPCO
libelleOpca 1 String 255 Libelle court correpondant à l'organisme financeur OPCA/OPCO

 

Exemples

Cas OK – Consultation des financements d'un individu sur une session de formation

Appel

GET /parcoursformationtest/v1/financement-individu?numeroSession=1330305&numeroAction=20_1330305&numeroFormation=20_1262663&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

[
    {...},
    {                                    
        "apercuSessionFormation": {                                
            "numeroSession": "1330305",                            
            "numeroAction": "20_1330305",                            
            "numeroFormation": "20_1262663"                            
        },                                
        "financement": {                                
            "convention": {                                
                "dispositifFinancement": {                                
                    "codeDispositif": "02",                            
                    "libelleDispositif": "AFC PE"                            
                },                                
                "numeroConvention": "41C491094387",                            
                "typeMarche": {                                
                    "codeMarche": 3,                            
                    "libelleMarche": "Marche 2019"                            
                },                                
                "zoneGeographique": {                                
                    "codeGeo": 026,                            
                    "libelleGeo": "PAS DE CALAIS"                            
                }                                
            },                                
            "organismeFinanceur": {}                                
        },                                
        "idInscription": 8329974,                            
        "idNationalDE": "DkZNY2zBt1fzydND6YGH_18A8UCXg6vXM_WKkx5j8UQ",                            
        "idProjetAction": "EFO20190813A"                            
    },
    {...}                                    
]