Consultation du détail d'un rendez-vous (RDV)

Présentation

Ce service permet aux organismes de formation et aux financeurs de consulter le détail d'un rendez-vous d’information (individuel ou collectif).

 

Description de la requête

Point d'accès

GET https://api.emploi-store.fr/partenaire/openformation/v1/rendez-vous/{idRdv}

 

Paramètres d'entrée

En-tête(s) Valeur
Authorization

Bearer [Access token]

Accept application/json
Code Cardinalité Format Description
idRdv 1 Integer 10 Identifiant du rendez-vous

 

Exemple d'appel

GET https://api.emploi-store.fr/partenaire/openformation/v1/rendez-vous/604639
Accept: application/json
Authorization: Bearer [Access token]

 

Description de la réponse

Données retournées

Code Cardinalité Format Description
idRdv 1 Integer 10 Identifiant du rendez-vous
idSession 1 Integer 10 Identifiant technique de la session de formation généré par Pôle emploi
dateDebutRdv 1 Date

Date de début du rendez-vous

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

dateFinRdv 1 Date

Date de fin 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
typeRdv 1 String 3

Valeurs possibles :

  • ICO→ Information collective
  • ICOP→ Information collective de positionnement (marché 2019 et FOAD)
  • RDVI→ Rendez-vous individuel
  • RDVIP→ Rendez-vous individuel de positionnement (marché 2019 et FOAD)
  • RPI→ Entretien suite à une inscription sur candidature
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
commentaire 0..1 String 500 Commentaire
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
  • M→ TMF Mobile
adresse 1 Sous-balise Lieu du RDV
adresseLigne1 1 String Ligne 1 de l'adresse du RDV
adresseLigne2 0..1 String Ligne 2 de l'adresse du RDV
adresseLigne3 0..1 String Ligne 3 de l'adresse du RDV
adresseLigne4 0..1 String Ligne 4 de l'adresse du RDV
codePostal 1 String 5 Code postal de l'adresse du RDV
latitude 0..1 String 16 Latitude de l'adresse du RDV
longitude 0..1 String 16 Longitude de l'adresse du RDV
ville 1 String 50 Ville de l'adresse du RDV
codeDepartement 1 String 3 Département de l'adresse du RDV
codeRegion 1 String 2 Région de l'adresse du RDV
codeINSEEcommune 0..1 String 5 Code INSEE de la commune de l'adresse du RDV
codePays 1 String 2 Pays de l'adresse du RDV
placesReservees 1 Integer 5 Nombre de places réservées
dateCreation 1 Date

Date de création

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

dateModification 0..1 Date

Date de modification

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

etat 1 String 1

Valeurs possibles :

  • A→ actif
  • H→ historisé
correspondantPE 0..1 Sous-balise Correspondant Pôle emploi
id 1 Integer Identifiant du correspondant Pôle emploi
uidLdap 1 String Identifiant dans le LDAP du correspondant Pôle emploi
positionnement 0..1 Booléen Indique si le rendez-vous est de type ICOP ou RDVIP (marché 2019 et FOAD)

 

Exemple de retour

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

{
      "idRdv": 604639,                                
      "dateDebutRdv": "2018-12-05T00:00:00+01:00",                                
      "dateFinRdv": "2018-12-05T00:01:00+01:00",                                
      "dureeMinuteRdv": 1,                                
      "nbTotalPlace": 7,                                
      "typeRdv": "ICO",                                
      "libellePieceJustificative1": "Carte d'identité",                                
      "libellePieceJustificative2": "Permis de conduire",                                
      "libellePieceJustificative3": "Diplôme du BAC",                                
      "commentaire": "Merci de vous munir d'un stylo pour les tests d'entrée.  Vous serez entendu sur vos motivations et sur les arguments vous ayant amené à ce projet de formation. Présentez-vous avec un CV à jour.",                                
      "codeOrigine": "P",                                
      "adresse": {                                
           "adresseLigne1": "Agence pôle emploi de Calais",                            
           "adresseLigne2": "35 rue des sapins",                            
           "adresseLigne3": "quartier de la meinau",                            
           "codePostal": "62100",                            
           "ville": "Calais"                            
           "codeDepartement": "62"                            
           "codeRegion": "32"                            
           "codePays": "FR"                            
      },                                
      "placesReservees": 7,                                
      "dateCreation": "2018-11-08T17:27:14+01:00",                                
      "dateModification": "2018-11-08T17:12:12+01:00",                                
      "etat": "A",                                
      "echue": true                                
}                                       

 

Cas d'erreurs possibles

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