Récupérer les aides éligibles
Présentation
Cette ressource permet de récupérer les aides éligibles selon les critères définis en paramètres.
Description de la requête
Point d'accès
GET https://api.emploi-store.fr/partenaire/clara/v1/aids/eligible
Paramètres d'entrée
Les différents paramètres d'entrée indique la situation de la personne pour laquelle la recherche d'aide est effectuée.
Code | Cardinalité | Format | Description |
---|---|---|---|
disabled | 0..1 | Booléen |
Indique la personne est bénéficiaire de l'obligation d'emploi (reconnu(e) en situation de handicap) |
spectacle | 0..1 | Booléen |
Indique si la personne est artiste ou technicien du spectacle |
diploma | 0..1 | String |
Indique le niveau de diplome sur lequel porte la recherche. Valeurs possibles :
|
category | 0..1 | String |
Indique la situation de la personne Valeurs possibles :
|
inscription_period | 0..1 | String |
Indique la durée d'inscription de la personne à Pôle emploi Valeurs possibles :
|
allocation_type | 0..1 | String |
Indique le type d'allocation perçu Valeurs possibles :
|
monthly_allocation_value | 0..1 | Integer |
Montant mensuel de l'allocation |
age | 0..1 | Integer |
Age |
location_citycode | 0..1 | String |
Code INSEE de la commune |
filters | 0..1 | String |
Liste de filtres (obtenus par la ressource Récupérer les filtres) séparés par des virgules |
Exemple d'appel
GET https://api.emploi-store.fr/partenaire/clara/v1/aids/eligible?age=24&inscription_period=more_than_a_year
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/clara/v1/aids/eligible
vers le domaine https://clara.pole-emploi.fr/api/v1/aids/eligible
.
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 |
---|---|---|---|
asker | 1 | Sous-balise |
Liste des paramètres d'entrée |
asker.zrr | 0..1 | Booléen |
Indique si la commune est une zone de revitalisation rurale |
aids.aids | 0..n | Sous-balise |
Liste des aides éligibles |
aids.aids.name | 1 | String |
Nom de l'aide |
aids.aids.slug | 1 | String |
Slug de l'aide |
aids.aids.short_description | 0..1 | String |
Courte description de l'aide |
aids.aids.filter | 0..n | String |
Filtres de l'aide |
aids.aids.contract_type | 0.1 | String |
Type de contrat |
Exemple de retour
HTTP 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache
{
"asker": {
"age": "30"
},
"aids": {
"aids": [
{
"name": "Volontariat de solidarité internationale (VSI)",
"slug": "vsi-volontariat-de-solidarite-internationale",
"short_description": "Missions effectuées en dehors de l'espace économique européen et au sein d'associations agréées",
"filters": [
"travailler-a-l-international"
],
"contract_type": "emploi-international"
},
{
"name": "Accompagnement à la mobilité au Québec avec l'OFQJ",
"slug": "accompagnement-a-la-mobilite-au-quebec-avec-l-ofqj",
"short_description": "Accompagnement pour réaliser un stage, une formation ou trouver du travail au Québec",
"filters": [
"travailler-a-l-international"
],
"contract_type": "emploi-international"
}
]
}
}
Cas d'erreurs possibles
Retrouvez la liste des cas d'erreurs possibles sur la page Erreurs Types.
Syntaxe de la requête erroné :
HTTP 400 Bad request
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache
{
"age": [
"doit être supérieur ou égal à 16"
]
}