Rechercher des organismes formateurs et leurs notes

Présentation

Cette ressource permet d’obtenir la liste de tous les organismes formateurs contenus dans l’intercarif avec pour chacun d’eux leur score.

Le score est calculé en prenant en compte l’intégralité des avis recueillis pour cet organisme.

 

Description de la requête

Point d'accès

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

 

Paramètres d'entrée

Code Cardinalité Format Description

numero

0..1 String Permet de limiter la recherche à un ou plusieurs identifiant d’organisme. L’identifiant d’un organisme correspond à son numéro de SIRET
lieu_de_formation 0..1 String

Permet de limiter la recherche en filtrant les organismes ayant des formations dans des lieux de formation spécifiques

Un lieu de formation peut être identifié par son code postal ou par sa région.

nb_avis

0..1 Integer Permet de limiter la recherche renvoyant uniquement les organismes ayant un nombre d'avis égal ou supérieur à la valeur spécifiée

fields

0..1 String

Permet de limiter les éléments renvoyés par la recherche sur les organismes.

Exemple : "-lieux_de_formation,-siret" permet de ne pas avoir les éléments lieux_de_formation et siret dans la réponse

page

0..1 Integer

Numéro de la page

Par défaut : 0


items_par_page
 
0..1 Integer

Nombre d'organismes formateurs par page

Par défaut : 50

 

Exemple d'appel

GET https://api.emploi-store.fr/partenaire/anotea/v1/organismes-formateurs?page=2&items_par_page=50&fields=-lieux_de_formation,-siret

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/api/anotea/v1/organismes-formateurs vers le domaine https://anotea.pole-emploi.fr/api/v1/organismes-formateurs.

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
organismes_formateurs 0..n Liste des Organismes Formateurs Liste des Organismes Formateurs
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 Nombre 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

{
    "organismes_formateurs": [
        {...},
        {
            "_id": "string",
            "siret": "string",
            "raison_sociale": "string",
            "score": {
                "nbAvis": 0,
                "notes": {
                    "accueil": 0,
                    "contenu_formation": 0,
                    "equipe_formateurs": 0,
                    "moyen_materiel": 0,
                    "accompagnement": 0,
                    "global": 0
                }
            },
            "lieux_de_formation": [
                {
                    "adresse": {
                        "code_postal": "string",
                        "ville": "string",
                        "region": "string"
                    }
                }
            ]
        },
        {...}
    ],
    "meta": {
        "pagination": {
            "page": 0,
            "per_page": 50,
            "total_items": 0,
            "total_pages": 0
        }
    }
}

 

Cas d'erreurs possibles

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