Liste des plages de candidature d'une formation

Présentation

Ce service permet aux organismes de formation et aux financeurs de lister les plages de candidature d'une session de formation.

 

Description de la requête

Point d'accès

GET https://api.emploi-store.fr/partenaire/openformation/v1/plage-pre-inscription/session/{numero-session}/action/{numero-action}/formation/{numero-formation}

 

Paramètres d'entrée

En-tête(s) Valeur
Authorization

Bearer [Access token]

Accept application/json
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

 

Exemple d'appel

GET https://api.emploi-store.fr/partenaire/openformation/v1/plage-pre-inscription/session/SE_NL_00003835252/action/22_SE_NL_00003835251/formation/22_AF_NL_00000827321
Accept: application/json
Authorization: Bearer [Access token]

 

Description de la réponse

Données retournées

Code Cardinalité Format Description
  0..n Tableau Liste des plages de candidature
idPlagePreInscription 1 Integer 10 Identifiant de la plage de candidature
idSession 1 Integer 10 Identifiant technique de la session de formation généré par Pôle emploi
dateDebut 1 Date

Date de début de la plage de candidature

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

dateFin 1 Date

Date de fin de la plage de candidature

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

placesTotal 1 Integer 5 Nombre de places total
placesDisponibles 1 Integer 5 Nombre de places disponibles au moment de l'appel à l'API
commentaire 0..1 String 500 Commentaire
dateCreation 1 Date

Date de création

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

origine 1 Sous-balise Origine de création de la plage de candidature.

Valeurs possibles :

  • C→ Carif
  • O→ OFAA'
  • P→ Pôle emploi
  • R→ L'organisme de formation
  • I→ Internet - TMF
  • A→ API Formation
  • X→ OuiForm
  • M→ TMF Mobile
codeOrigine 1 String 1 Code de l'origine de création de la plage de candidature
libelleOrigine 1 String 50 Libellé de l'origine de création de la plage de candidature

 

Exemple de retour

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

[
    {...},
    {                                    
        "commentaire": "test commentaire",                                
        "dateCreation": "2020-10-23T14:55:38+02:00",                                
        "dateDebut": "2019-12-12T00:00:00+01:00",                                
        "dateFin": "2021-11-26T23:59:59+01:00",                                
        "idPlagePreInscription": 1007,                                
        "idSession": 4771789,                                
        "origine": {                                
            "codeOrigine": "P",                            
            "libelleOrigine": "Pôle emploi",                            
        },                                
        "placesDisponibles": 9997,                                
        "placesTotal": "9999"                                
    },
    {...}                                    
]                                       

 

Cas d'erreurs possibles

Retrouvez la liste des cas d'erreurs possibles sur la page Erreurs Types.