Récupérer le détail d'une aide

Présentation

Cette ressource permet de récupérer le détail d'une aide.

 

Description de la requête

Point d'accès

GET https://api.emploi-store.fr/partenaire/clara/v1/aids/detail/{aidSlug}

 

Paramètres d'entrée

Code Cardinalité Format Description
aidSlug 1 String Identifiant de l'aide

 

Exemple d'appel

GET https://api.emploi-store.fr/partenaire/clara/v1/aids/detail/vi-volontariat-international

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/detail/{aidSlug} vers le domaine https://clara.pole-emploi.fr/api/v1/aids/detail/{aidSlug}.

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
aid 1 Sous-balise Détail de l'aide
aid.name 1 String Nom de l'aide
aid.what 0..1 String Descriptif complet de l'aide (format HTML)
aid.slug 1 String Identifiant de l'aide
aid.short_description 0..1 String Courte description de l'aide
aid.how_much 0..1 String Couverture des frais et indemnisations de l'aide (format HTML)
aid.additionnal_conditions 0..1 String Conditions additionnelles de l'aide (format HTML)
aid.how_and_when 0..1 String Procédure d'obtention de l'aide (format HTML)
aid.limitations 0..1 String Limitations de l'aide (format HTML)

 

Exemple de retour

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

{
    "aid": {
        "name": "Volontariat international (VI)",
        "what": "<p>La mission peut &ecirc;tre effectu&eacute;e en VIE (volontariat international en entreprise) ou en VIA (volontariat international en administration), au sein de diff&eacute;rentes structures (ambassades, universit&eacute;s et laboratoires, centres culturels, organisations non gouvernementales, ...).</p>",
        "slug": "vi-volontariat-international",
        "short_description": "Mission rémunérée qui permet d'avoir une première expérience à l'international",
        "how_much": "<p>Vous percevez une indemnit&eacute; d&#39;un montant pouvant aller de 1432 euros &agrave; 4784 euros nets.</p>",
        "additionnal_conditions": "<p>Vous devez &nbsp;:</p>\r\n\r\n<ul>\r\n\t<li>&ecirc;tre de nationalit&eacute; fran&ccedil;aise ou ressortissant(e) d&#39;un pays de l&#39;espace &eacute;conomique europ&eacute;en (EEE)</li>\r\n\t<li>&ecirc;tre en r&egrave;gle avec les obligations de service national du pays dont vous &ecirc;tes ressortissant(e)</li>\r\n\t<li>jouir de vos droits civiques et avoir un casier judiciaire vierge</li>\r\n</ul>",
        "how_and_when": "<p>Vous devez enregistrer votre candidature par internet sur le site <a href=\"http://www.civiweb.com\" rel=\"noopener\" target=\"_blank\">Civiweb</a>.</p>",
        "limitations": "<p>* La dur&eacute;e moyenne observ&eacute;e est de 17 mois.</p>\r\n\r\n<p>** L&#39;indemnit&eacute; est fix&eacute;e par d&eacute;cret et varie selon le pays d&#39;affectation.</p>"
    }
}

 

Cas d'erreurs possibles

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