Rechercher les notes et avis de formations

Présentation

Cette ressource permet de récupérer les notes et les avis de formations triés par date et filtrés en fonction des paramètres.

 

Description de la requête

Point d'accès

GET https://api.emploi-store.fr/partenaire/anotea/v1/avis

 

Paramètres d'entrée

Code Cardinalité Format Description
organisme_formateur

0..1

String Le numéro SIRET de l’organisme formateur

formacode

0..1

String

Le formacode de la formation ou un domaine de formation

Vous pouvez consulter la liste des formacodes à l'aide de l'InterCarifOref

certif_info

0..1

String

Le certifinfo de la formation

Vous pouvez consulter la liste des certifinfos à l'aide de l'InterCarifOref

lieu_de_formation

0..1

String Le code postal du lieu de formation

page

0..1

Integer

Le numéro de la page

Par défaut : 0

items_par_page

0..1

Integer

Le nombre d’avis par page

Par défaut : 50

 

Exemple d'appel

GET https://api.emploi-store.fr/partenaire/anotea/v1/avis?page=1&items_par_page=50&certif_info=88141

Authorization: Bearer [Access token]

 

Description de la réponse

Lors de la réponse de l'API, une redirection (code HTTP 302 Found) est réalisée du domaine https://api.emploi-store.fr/partenaire/anotea/v1/avis vers le domaine https://anotea.pole-emploi.fr/api/v1/avis.

Vous devez explicitement indiquer à votre client HTTP de suivre les redirections car il ne le fait probablement pas par défaut. Par exemple pour le client curl, il est nécéssaire d'utiliser curl --location (ou curl -L).

 

Données retournées

Code Cardinalité Format Description
avis 0..n Liste des Avis Liste des Avis
meta 1 Sous-balise Informations complémentaires
meta.pagination 0..1 Sous-balise Informations sur la pagination
meta.pagination.page 1 Integer Numéro de la page
meta.pagination.items_par_page 1 Integer Nombre d'avis par page
meta.pagination.total_items 1 Integer Nombres d'avis au total
meta.pagination.total_pages 1 Integer Nombre de pages au total

 

Exemple de retour

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

{
  "avis": [
    {
      "pseudo": "string",
      "date": "string",
      "commentaire": {
        "titre": "string",
        "texte": "string"
      },
      "notes": {
        "accueil": 0,
        "contenu_formation": 0,
        "equipe_formateurs": 0,
        "moyen_materiel": 0,
        "accompagnement": 0,
        "global": 0
      },
      "formation": {
        "intitule": "string",
        "domaine_formation": {
          "formacodes": [
            "string"
          ]
        },
        "certifications": [
          {
            "certif_info": "string"
          }
        ],
        "action": {
          "lieu_de_formation": {
            "code_postal": "string",
            "ville": "string"
          },
          "organisme_financeurs": [
            "string"
          ],
          "organisme_formateur": {
            "raison_sociale": "string",
            "siret": "string"
          },
          "session": {
            "numero": "string",
            "periode": {
              "debut": "string",
              "fin": "string"
            }
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 0,
      "per_page": 0
      "total_items": 0,
      "total_pages": 0
    }
  }
}

 

Cas d'erreurs possibles

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

Syntaxe de la requête erronnée :

HTTP 400 Bad request
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache

{
    "statusCode": 400,
    "error": "Bad Request",
    "message": "Erreur de validation",
    "details": [
        {
            "message": "\"lieu_de_formation\" with value \"100000\" fails to match the required pattern: /^(([0-8][0-9])|(9[0-5])|(2[ab]))[0-9]{3}$/",
            "path": [
                "lieu_de_formation"
            ],
            "type": "string.regex.base",
            "context": {
                "pattern": {},
                "value": "100000",
                "key": "lieu_de_formation",
                "label": "lieu_de_formation"
            }
        }
    ]
}

La réponse 400 s'accompagne d'un message explicite qui vous indique le problème rencontré par votre requête :

  • lieu_de_formation\" with value \"100000\" fails to match the required pattern: /^(([0-8][0-9])|(9[0-5])|(2[ab]))[0-9]{3}