Consultation des évolutions des inscriptions en cours

Présentation

Ce service permet de tester la consultation des évolutions des inscriptions en cours d'une session de formation.

Description de la requête

Point d'accès

GET https://api.emploi-store.fr/partenaire/parcoursformationtest/v1/inscriptions/session/{numero-session}/action/{numero-action}/formation/{numero-formation}

 

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
numero-session 1 String 25 Numéro InterCarif de la session de formation
numero-action 1 String 25 Numéro InterCarif de l'action de formation
numero-formation 1 String 25 Numéro InterCarif de la formation
date-debut-statut 0..1 Date

AIS dont la date de changement de statut est >= date-debut-statut. L'heure au format "hh:mm:ss" est optionnelle. Recherche du dernier statut dans la période saisie.

Format YYYY-MM-DD HH:MM:SS

date-fin-statut 0..1 Date

AIS dont la date de changement de statut est < date-fin-statut. L'heure au format "hh:mm:ss" est optionnelle. Recherche du dernier statut dans la période saisie.

Format YYYY-MM-DD HH:MM:SS

code-statut 0..n String 3

Statut de l'inscription

Liste des valeurs possibles

pagination 0..1 String 10

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 attestations d'inscription en stage (AIS)
apercuSessionFormationPartenaire 1   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
idInscription 1 Integer 10 Identifiant technique de l'inscription
idNationalDE 1 String 255 Identifiant national crypté de l'individu
codeStatutInscription 1 String 3

Statut de l'inscription

Liste des valeurs possibles

listeModuleFormation 0..n   Sous-balise
numeroPeriode 1 Integer 10 Identifiant du numéro de module
dateDebutPeriode 1 Date

Date de début du module de formation

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

dateFinPeriode 1 Date

Date de fin du module de formation

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

dateDebutPlan 0..1 Date

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

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

dateFinPlan 0..1 Date

Date de fin du plan de formation de l'individu

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

 

Exemples

Cas OK – Consultation des évolutions des AIS

Appel

GET /parcoursformationtest/v1/inscriptions/session/1330305/action/20_1330305/formation/20_1262663?date-debut-statut=2018-10-15%2000:00:00&date-fin-statut=2018-10-31%2000:00:00&code-statut=AIS&code-statut=AIE&pagination=0-19 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

[
    {...},
    {                                    
        "apercuSessionFormationPartenaire": {                                
            "numeroSession": "1330305",                            
            "numeroAction": "20_1330305",                            
            "numeroFormation": "20_1262663"                            
        },                                
        "idInscription": 6483162,                            
        "idNationalDE": "zU8ushUdRt8PxHuaOEoWFV8A8UCXg6vXM_WKkx5j8UQ",                            
        "codeStatutInscription": "AIS",                            
        "dateStatutInscription": "2018-10-21T00:00:00+02:00",                            
        "dateDebutPlan": "2018-10-22T00:00:00+02:00",                            
        "dateFinPlan": "2019-06-15T00:00:00+02:00",                            
        "listeModuleFormation": [                                
            {                                
                "dateDebutPeriode": "2018-10-22T00:00:00+02:00",                            
                "dateFinPeriode": "2019-02-28T00:00:00+01:00",                            
                "numeroPeriode": 1                            
            },                                
            {                                
                "dateDebutPeriode": "2019-03-17T00:00:00+01:00",                            
                "dateFinPeriode": "2019-06-15T00:00:00+02:00",                            
                "numeroPeriode": 2                            
            }                                
        ]                                
    },
    {                                    
        "apercuSessionFormationPartenaire": {                                
            "numeroSession": "1330305",                            
            "numeroAction": "20_1330305",                            
            "numeroFormation": "20_1262663"                            
        },                                
        "idInscription": 6483163,                            
        "idNationalDE": "TpqINque4FDkDc3r7LwvxV8A8UCXg6vXM_WKkx5j8UQ",                            
        "codeStatutInscription": "AIE",                            
        "dateStatutInscription": "2018-10-21T00:00:00+02:00",                            
        "dateDebutPlan": "2018-10-22T00:00:00+02:00",                            
        "dateFinPlan": "2019-06-15T00:00:00+02:00",                            
        "listeModuleFormation": [                                
            {                                
                "dateDebutPeriode": "2018-10-22T00:00:00+02:00",                            
                "dateFinPeriode": "2019-02-28T00:00:00+01:00",                            
                "numeroPeriode": 1                            
            },                                
            {                                
                "dateDebutPeriode": "2019-03-17T00:00:00+01:00",                            
                "dateFinPeriode": "2019-06-15T00:00:00+02:00",                            
                "numeroPeriode": 2                            
            }                                
        ]                                
    },
    {...}                                    
]