Rechercher par critères
Présentation
Cette ressource permet de réaliser une recherche d'offres à partir de critères de sélection.
La liste des offres retournées est paginée.
Dans le cas où la liste des valeurs possible est listée dans un référentiel, c'est toujours le code correspondant au libellé recherché qu'il faut envoyer.
Si au niveau de la cardinalité, la valeur "n" est précisée, cela veut dire qu'il est possible de spécifier toutes les valeurs au niveau du filtre.
Description de la requête
Point d'accès
GET https://api.emploi-store.fr/partenaire/offresdemploi/v2/offres/search
Paramètres d'entrée
En-tête(s) | Valeur |
---|---|
Content-Type |
application/json |
Accept |
application/json |
Code | Cardinalité | Format | Description |
---|---|---|---|
range | 0..1 | String |
Pagination des données. La plage de résultats est limitée à 150. Format : -
Exemples :
|
sort | 0..1 | Integer 1 |
Tri des données Valeurs possibles :
|
domaine | 0..1 | String 3 |
Code du domaine professionnel |
codeROME | 0..3 | String 5 |
Code ROME du métier |
theme | 0..1 | String 2 |
Thème du métier |
appellation | 0..1 | String 5 |
Code de l'appellation |
secteurActivite | 0..2 | String 2 |
Codes NAF des secteurs d’activités. Il est possible de spécifier deux codes NAF en les séparant par une virgule dans la chaîne de caractères. Exemple : 01,02 |
experience |
0..1 | String 1 |
Niveau d’expérience demandé Valeurs possibles :
|
typeContrat |
0..10 | String 3 |
Code du type de contrat Remarque : L'opérateur utilisé entre les filtres typeContrat et natureContrat est un OU, c'est-à-dire que pour la recherche "typeContrat=CDI,CDD" avec "natureContrat=E1" alors les résultats contiendront toutes les offres en type de contrat CDI ou CDD (peu importe la nature) mais également toutes les offres de nature E1 (sans prendre en compte le type de contrat). |
natureContrat |
0..n | String 2 |
Code de la nature de contrat Remarque : Voir la remarque sur le filtre typeContrat dans le cas où les filtres typeContrat et natureContrat sont utilisés ensemble. |
origineOffre |
0..1 | Integer 1 |
Origine de l'offre Valeurs possibles :
|
qualification |
0..1 | Integer 1 |
Code de la qualification Valeurs possibles :
|
tempsPlein |
0..1 | Integer 1 |
Valeurs possibles :
Si le paramètre n'est pas renseigné, alors toutes les offres sont remontés |
commune | 0..5 | String 5 |
Code INSEE de la commune Le comportement de recherche permet de remonter les offres pour lesquelles la distance entre la commune recherchée et la commune de l’offre est inférieure ou égale à la distance maximum demandée, ainsi que les offres pour lesquelles cette distance est marginalement plus élevée (jusqu’à + 30% de la distance maximum demandée).
Spécificité de la ville de Lyon, l’ensemble des offres de Lyon sont remontées dès que le centre de Lyon est atteint par le rayon de distance recherché. Remarque : pour obtenir seulement les offres d'une commune spécifique, alors il faut renseigner le paramètre "distance=0" |
distance | 0..1 Conditionné | Integer |
Distance kilométrique du rayon de recherche Valeur par défaut : Remarque : pour obtenir seulement les offres d'une commune spécifique, alors il faut renseigner le paramètre "distance=0" |
departement |
0..5 | String 3 |
Code INSEE du département |
inclureLimitrophes |
0..1 | Booléen | Inclure les départements limitrophes dans la recherche |
region |
0..1 | String 2 |
Code de la région de l'offre |
paysContinent |
0..1 | String 2 |
Code du pays ou du continent de l'offre |
niveauFormation |
0..1 | String 3 |
Niveau de formation demandé |
permis |
0..1 | String 3 |
Code du permis demandé |
motsCles | 0..7 | String |
Recherche par mot clé Chaque mot clé (ou expression) comprend au moins 2 caractères et doit être séparé par une virgule. La recherche de mots clés peut permettre de rechercher sur :
Caractères autorisés : |
salaireMin |
0..1 | Decimal |
Salaire minimum, exprimé en Euro. Si cette donnée est renseignée, le code du type de salaire minimum est obligatoire. |
periodeSalaire |
0..1 | String 1 |
Période pour le calcul du salaire minimum. Si cette donnée est renseignée, le salaire minimum est obligatoire. Valeurs possibles :
|
accesTravailleurHandicape |
0..1 | Booléen | Permet de rechercher des offres pour lesquelles l'employeur est handi friendly |
offresMRS |
0..1 | Booléen | Permet de rechercher des offres proposant la méthode de recrutement par simulation |
grandDomaine |
0..n | String |
Code du grand domaine de l'offre Valeurs possibles :
|
experienceExigence |
0..1 | String |
Filtre les offres selon le niveau d'expérience. Valeurs possibles :
|
publieeDepuis |
0..1 | Integer |
Nombre de jours maximal depuis la publication de l'offre Valeurs possibles : |
minCreationDate |
0..1 | Date |
Date de création d'offre minimum. Si cette donnée est renseignée, le date de création d'offre maximum est obligatoire. Norme ISO-8601 (YYYY-MM-DDTHH:MM:SSZ) |
maxCreationDate |
0..1 | Date |
Date de création d'offre maximum. Si cette donnée est renseignée, le date de création d'offre minimum est obligatoire. Norme ISO-8601 (YYYY-MM-DDTHH:MM:SSZ) |
modeSelectionPartenaires |
0..1 | Enum |
Mode de sélection des offres partenaires. Ce filtre fonctionne avec le critère partenaires et à une dépendance avec celui origineOffre. Valeurs possibles avec les résultats obtenus en fonction des deux autres filtres :
Remarque : Dans tous les cas, si origineOffre = 1, alors uniquement les offres Pole Emploi seront retournées |
partenaires |
0..20 | String |
Liste des codes partenaires à inclure ou exclure en fonction de la sélection faite dans le filtre modeSelectionPartenaires |
Exemple d'appel
GET https://api.emploi-store.fr/partenaire/offresdemploi/v2/offres/search?qualification=0&motsCles=informatique&commune=51069,76322,46083,12172,28117&origineOffre=2
Authorization: Bearer [Access token]
Description de la réponse
Données retournées
Lorsque la requête s’exécute sans erreur, en cas de succès il y a 2 codes retour possible :
- si le nombre d'offres issu de la recherche est inférieur au nombre maximal d'offres que le service peut remonter en une requête, un code HTTP 200 OK est renvoyé
- si le nombre d'offres issu de la recherche est supérieur au nombre maximal d'offres que le service peut remonter en une requête ou supérieur à 150, un code 206 PARTIAL est renvoyé
En-tête(s) | Valeur |
---|---|
Content-Type | application/json |
Content-Range |
offres - où :
|
Accept-Range |
offres où |
Code | Cardinalité | Format | Description |
---|---|---|---|
resultats | 0..n | Offre (cf. Consulter une offre) | Liste des offres. Les données retournées sont identiques à Consulter une offre |
filtresPossibles | 0..n | Sous-balise | Liste des filtres supplémentaires possibles |
filtresPossibles.agregation | 0..n | Sous-balise | Liste des valeurs possibles du filtre avec le nombre de résultats correspondants |
filtresPossibles.agregation.nbResultats | 1 | Integer | Nombre de résultats pour la valeur du filtre |
filtresPossibles.agregation.valeurPossible | 1 | String | Valeur du filtre pour obtenir le nombre de résultats |
filtresPossibles.filtre | 1 | String | Nom du filtre |
Exemple de retour
HTTP 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache
{
"resultats": [
{..}, {..}
],
"filtresPossibles": [
{
"agregation": [
{
"nbResultats": 3,
"valeurPossible": "LIB"
}
],
"filtre": "typeContrat"
},
{
"agregation": [
{
"nbResultats": 3,
"valeurPossible": "0"
}
],
"filtre": "experience"
},
{
"agregation": [
{
"nbResultats": 1,
"valeurPossible": "0"
},
{
"nbResultats": 2,
"valeurPossible": "X"
}
],
"filtre": "qualification"
},
{
"agregation": [
{
"nbResultats": 1,
"valeurPossible": "E1"
},
{
"nbResultats": 2,
"valeurPossible": "NS"
}
],
"filtre": "natureContrat"
}
]
}
Cas d'erreurs possibles
Syntaxe de la requête erronée :
HTTP 400 Bad request
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache
{
"codeErreur": "1493122545781",
"codeHttp": 400,
"message": "La donnée keywords doit être une chaîne comprise entre 2 et 99 caractères."
}
Range demandé trop important :
HTTP 400 Bad request
Content-Type: application/json
Accept-Range: 150
{
"codeErreur": "1538053509877",
"codeHttp": 400,
"message": "La plage de résultats demandée est trop importante."
}
Message |
---|
La plage de résultats demandée est trop importante. |
Valeur du paramètre « [code] » incorrect. |
"Format du paramètre « [code] » incorrect. « [type] »attendu." |