Consultation des inscriptions sur candidature

Présentation

Ce service permet de tester la consultation des inscriptions sur candidature d'une plage de candidatures.

Description de la requête

Point d'accès

GET https://api.emploi-store.fr/partenaire/parcoursformationtest/v1/pre-inscription/plage/{id-plage}

 

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
id-plage 1 Integer 10 L'identifiant technique de la plage de candidature. A récupérer depuis l'API Open formation.
pagination 0..1 String 10

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

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 50 premiers résultats : range=0-49
  • Pour demander les 50 résultats suivants : range=50-99

 

Description de la réponse

Données retournées

sortie
Code Cardinalité Format Description
0..n Tableau Liste des inscriptions sur candidature
idInscription 1 Integer 10 Identifiant technique de l'inscription sur candidature de l'individu
idIndividu 1 String 255 Identifiant national crypté de l'individu
datePreInscription 1 Date

Date du positionnement du candidat sur la session de formation

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

dateContact 0..1 Date

Si le contact a été pris avec l'individu, la date de la prise de contact avec l'individu

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

statut 1 String 3

Statut d'inscription de l'individu

Liste des valeurs possibles

infoContact 0..1  

Détail de la prise de contact

Valeurs possibles :

  • C→ Contacté
  • AC→ A contacter
code 1 String 3 Code de la prise de contact
codeElement 1 String 3 Code de la prise de contact
libelleLong 1 String 70 Libellé de la prise de contact
rendezVous 0..1   L'entretien réalisé avec l'individu
idRdv 1 Integer 10 Identifiant technique du rendez-vous

 

Exemples

Cas 1 – Lister les inscriptions sur candidature avec pagination

Appel

GET /parcoursformationtest/v1/pre-inscription/plage/1007?pagination=0-49 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

[
    {...},
    {                                    
        "dateContact": "2020-10-23T16:01:44+02:00",                            
        "datePreInscription": "2020-10-23T15:55:49+02:00",                            
        "idIndividu": "DkZNY2zBt1fzydND6YGH_18A8UCXg6vXM_WKkx5j8UQ",                            
        "idInscription": 9009966,                            
        "infoContact": {                                
            "code": "C",                            
            "codeElement": "C",                            
            "libelleLong": "contacté"                            
        },                                
        "rendezVous": {                                
            "idRdv": "892090"                            
        },                                
        "statut": "ICI"                            
    },
    {                                    
        "datePreInscription": "2020-10-23T15:50:48+02:00",                            
        "idIndividu": "q6g6YSXYY_ZM6gK9tpnqXl8A8UCXg6vXM_WKkx5j8UQ",                            
        "idInscription": 9009965,                            
        "infoContact": {                                
            "code": "AC",                            
            "codeElement": "AC",                            
            "libelleLong": "à contacter"                            
        },                                
        "rendezVous": {},                                
        "statut": "PPS"                            
    },
    {...}                                    
]                                       

 

Cas 2 – Lister les inscriptions sur candidature sans pagination

Appel

GET /parcoursformationtest/v1/pre-inscription/plage/1007 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

[
    {...},
    {                                    
        "dateContact": "2020-10-23T16:01:44+02:00",                            
        "datePreInscription": "2020-10-23T15:55:49+02:00",                            
        "idIndividu": "DkZNY2zBt1fzydND6YGH_18A8UCXg6vXM_WKkx5j8UQ",                            
        "idInscription": 9009966,                            
        "infoContact": {                                
            "code": "C",                            
            "codeElement": "C",                            
            "libelleLong": "contacté"                            
        },                                
        "rendezVous": {                                
            "idRdv": "892090"                            
        },                                
        "statut": "ICI"                            
    },
    {                                    
        "datePreInscription": "2020-10-23T15:50:48+02:00",                            
        "idIndividu": "q6g6YSXYY_ZM6gK9tpnqXl8A8UCXg6vXM_WKkx5j8UQ",                            
        "idInscription": 9009965,                            
        "infoContact": {                                
            "code": "AC",                            
            "codeElement": "AC",                            
            "libelleLong": "à contacter"                            
        },                                
        "rendezVous": {},                                
        "statut": "PPS"                            
    },
    {...}                                    
]