Récupérer les filtres
Présentation
Cette ressource permet de récupérer les filtres associés à une recherche : nombre de résultats par secteurs d’activité, effectif, types de contrat et distance.
Description de la requête
Point d'accès
GET https://api.emploi-store.fr/partenaire/labonneboite/v1/filter/
Paramètres d'entrée
Code | Cardinalité | Format | Description |
---|---|---|---|
commune_id |
0,1 Conditionné |
String |
Code INSEE de la commune à proximité de laquelle on recherche des entreprises à fort potentiel d’embauche. Si ce paramètre n'est pas renseigné, il est nécessaire d'indiquer la latitude et la longitude. Référentiel : Géographie administrative de l'Insee |
contract | 0,1 | String |
Type de contrat Valeurs possibles :
|
latitude |
0,1 Conditionné |
Float |
Latitude du point géographique à proximité duquel on recherche des entreprises à fort potentiel d’embauche. Si ce paramètre n'est pas renseigné, il est nécessaire d'indiquer le code INSEE de la commune. |
longitude |
0,1 Conditionné |
Float |
Longitude du point géographique à proximité duquel on recherche des entreprises à fort potentiel d’embauche. Si ce paramètre n'est pas renseigné, il est nécessaire d'indiquer le code INSEE de la commune. |
distance | 0,n | Integer |
Périmètre du rayon de recherche (en kilomètres) autour du point géographique défini par le couple longitude / latitude ou le code INSEE de la commune. Par défaut, cette distance est de 10 km. |
rome_codes |
0,n Conditionné |
String |
Codes métiers ROME (exemple : "A1501") pour lesquels des entreprises embauchent potentiellement. Vous devez utiliser soit `rome_codes`, soit `rome_codes_keyword_search`. Il est fortement recommandé d'utiliser `romes_codes` qui donnera en général des résultats de meilleure qualité. Référentiel : Répertoire Opérationnel des Métiers et des Emplois |
rome_codes_keyword_search |
0,1 Conditionné |
String |
Mots clé (exemple : "boucher" ou "animateur vente") utilisés pour déterminer automatiquement un code ROME. Vous devez utiliser soit `rome_codes_keyword_search`, soit `rome_codes`. Il est fortement recommandé d'utiliser `romes_codes` qui donnera en général des résultats de meilleure qualité. Attention : réponse 400 si aucun ROME ne matche les mots clés demandés. |
naf_codes | 0,n | String |
Liste de codes métier NAF (exemple : "9499Z,5610C") ou simplement un seul code métier (exemple : "9499Z") associés aux entreprises. Ce champ est optionnel, par défaut la recherche s'étendra automatiquement à tous les codes NAF pertinents pour le code ROME demandé. Référentiel : Nomenclature d'activités française de l'Insee (rév. 2, 2008 - Niveau 2 - Liste des divisions) |
headcount | 0,1 | String |
Taille de l'entreprise Valeurs possibles :
|
Exemple d'appel
GET https://api.emploi-store.fr/partenaire/labonneboite/v1/filter/?distance=30&latitude=49.119146&longitude=6.17602&rome_codes=M1607
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/lbb/v1/company
vers le domaine https://labonneboite.pole-emploi.fr/api/v1/company/
.
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 |
---|---|---|---|
filters | 0,4 | Object | Liste des filtres disponibles |
filters.contract | 2,2 | Object | Liste des filtres relatifs au secteur d’activité des entreprises |
filters.contract.all | 1,1 | Integer | Nombre d’entreprises acceptant tous les types de contrat |
filters.contract.alternance | 1,1 | Integer | Nombre d’entreprises où les contrats en alternance sont possibles |
filters.distance | 5,5 | Object | Liste des filtres relatifs à la distance entre le point d'origine et l'emplacement des entreprises |
filters.distance.less_10_km | 1,1 | Integer | Nombre d’entreprises entre 0 et 10 kilomètres |
filters.distance.less_30_km | 1,1 | Integer | Nombre d’entreprises entre 0 et 30 kilomètres |
filters.distance.less_50_km | 1,1 | Integer | Nombre d’entreprises entre 0 et 50 kilomètres |
filters.distance.less_100_km | 1,1 | Integer | Nombre d’entreprises entre 0 et 100 kilomètres |
filters.distance.france | 1,1 | Integer | Nombre d’entreprises en France métropolitaine |
filters.headcount | 2,2 | Object | Liste des filtres relatifs à la taille de l’entreprise |
filters.headcount.small | 1,1 | Integer | Nombre d’entreprises de moins de 50 salariés |
filters.headcount.big | 1,1 | Integer | Nombre d’entreprises de plus de 50 salariés |
filters.naf | 1,n | Object | Liste des filtres relatifs au secteur d’activité des entreprises |
filters.naf.count | 1,1 | Integer | Nombre d’entreprises dans ce secteur d’activité |
filters.naf.code | 1,1 | String | Code du secteur d’activité |
filters.naf.label | 1,1 | String | Libellé du secteur d’activité |
Exemple de retour
HTTP 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache
{
"filters": {
"contract": {
"all": 649,
"alternance": 173
},
"distance": {
"france": 70781,
"less_100_km": 1813,
"less_10_km": 353,
"less_30_km": 649,
"less_50_km": 1091
},
"headcount": {
"big": 165,
"small": 470
},
"naf": [
{
"code": "8411Z",
"count": 31,
"label": "Administration publique générale"
},
{
"code": "8810A",
"count": 30,
"label": "Aide à domicile"
},
{
"code": "8610Z",
"count": 13,
"label": "Activités hospitalières"
}
]
},
"rome_code": "M1607",
"rome_label": "Secrétariat"
}
Cas d'erreurs possibles
Retrouvez la liste des cas d'erreurs possibles sur la page Erreurs Types.
API en cours de maintenance :
HTTP 502 Bad gateway
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache
L'API est susceptible de connaitre occasionnellement de brèves indisponibilités (micro-coupures pendant certains déploiements).
Par conséquent, votre application doit contrôler le code retour de l'API. Le code HTTP 502 signifie que l'API est temporairement indisponible. Vous pourrez retenter l'appel quelques secondes plus tard.
Syntaxe de la requête erronnée :
HTTP 400 Bad request
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache
{
"codeErreur": "1493122545783",
"codeHttp": 400,
"message": "Aucun code_rome trouvé"
}
La réponse 400 s'accompagne d'un message explicite qui vous indique le problème rencontré par votre requête :
- code_commune inconnu
- Aucun code_rome trouvé (uniquement si vous utilisez rome_code_keyword_search)