Consultation d'une formation

Présentation

Ce service permet aux organismes de formation et aux financeurs de consulter les dates de rendez-vous d’information (individuels ou collectifs) sur les sessions à venir.

 

Description de la requête

Point d'accès

GET https://api.emploi-store.fr/partenaire/openformation/v1/sessions/{numeroSession}/{numeroAction}/{numeroFormation}

 

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/sessions/1330305/20_1330305/20_1262663
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 informations collectives
idRdv 1 Integer 10

Identifiant du Rendez-vous
dateDebutRdv 1 Date

Date de début du rendez-vous

Norme ISO-8601 (YYYY-MM-DDTHH:MM:SSZ)
dureeMinuteRdv 1 Integer 10

Durée du rendez-vous en minutes
nbTotalPlaces 1 Integer 5

Nombre de places total
nbPlacesDisponible 0..1 Integer 5

Nombre de places disponibles au moment de l'appel à l'API
typeRdv 1 String 3

Valeurs possibles :

  • COL→ Collectif
  • IND→ Individuel
libellePieceJustificative1 0..1 String 110

Libellé de la première pièce justificative
libellePieceJustificative2 0..1 String 110

Libellé de la seconde pièce justificative
libellePieceJustificative3 0..1 String 110

Libellé de la troisième pièce justificative
codeOrigine 1

String 1

Valeurs possibles :

  • C→ Carif
  • O→ OFAA'
  • P→ Pôle emploi
  • R→ L'organisme de formation
  • I→ Internet - TMF
  • A→ API Formation
  • X→ OuiForm
adresse 1 Sous-balise

Lieu du RDV
adresse.adresseLigne1 0..1 String

Ligne 1 de l'adresse du RDV
adresse.adresseLigne2 1 String

Ligne 2 de l'adresse du RDV
adresse.adresseLigne3 0..1 String

Ligne 3 de l'adresse du RDV
adresse.adresseLigne4 0..1 String

Ligne 4 de l'adresse du RDV
adresse.codePostal 1 String 5

Code postal de l'adresse du RDV
adresse.latitude 0..1 String 16

Latitude de l'adresse du RDV
adresse.longitude 0..1 String 16

Longitude de l'adresse du RDV
adresse.ville 1 String 50

Ville de l'adresse du RDV
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
placesReservees 1 Integer 5

Nombre de places réservées
libelleOrigine 1

String 50

Libellé de l'origine du rendez-vous

Valeurs possibles :

  • Carif
  • OFAA'
  • Pôle emploi
  • L'organisme de formation
  • Internet - TMF
  • API Formation
  • OuiForm
dateCreation 1

String

 Date de création
dateModification 0..1

String

 Date de modification
etat 1 String 1

Valeurs possibles :

  • A→ actif
  • H→ historisé
correspondantPE 0..1

Sous-balise

 Correspondant Pôle emploi
correspondantPE.id 1

Integer

 Identifiant du correspondant Pôle emploi
correspondantPE.uidLdap 1

String

 Identifiant dans le LDAP du correspondant Pôle emploi
echue 1

Booléen

 Indique si la formation est échue

 

Exemple de retour

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

[
    {...},
    {                                    
        idRdv: 604659,                                
        dateDebutRdv: "2018-11-09T17:55:00+01:00",                                
        dureeMinuteRdv: 3,                                
        nbTotalPlace: 3,                                
        nbPlacesDisponible: 1,                                
        typeRdv: "COL",                                
        libellePieceJustificative1: "Carte d'identité",                                
        libellePieceJustificative2: "Permis de conduire",                                
        libellePieceJustificative3: "Diplôme du BAC",                                
        codeOrigine: "P",                                
        adresse: {                                
            adresseLigne1: "Agence pôle emploi de Calais",                            
            adresseLigne2: "35 rue des sapins",                            
            adresseLigne3: "quartier de la meinau",                            
            codePostal: "62500",                            
            ville: "Calais"                            
        },                                
        numeroSession: "1330305",                                
        numeroAction: "20_1330305",                                
        numeroFormation: "20_1262663",                                
        placesReservees: 2,                                
        libelleOrigine: "Pôle emploi",                                
        dateCreation: "2018-11-08T17:27:14+01:00",                                
        etat: "A",                                
        echue: true                                
    },
    {...}                                    
]                                       

 

Cas d'erreurs possibles

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