API Référentiel des agences

Présentation

Ce document décrit la ressource REST « Agences » exposée au travers de l’API « Référentiel des agences Pole Emploi ».

 

Caractéristiques

Mode d'accès public
Fréquence de mise à jour temps réel
Cinématique OAuth client credentials grant
Royaume Pôle Emploi Access Management /partenaire
Scopes nécessaires

 

Description de la requête

Point d'accès

GET https://api.emploi-store.fr/partenaire/referentielagences/v1/agences
Authorization: Bearer [Access token]

 

En-tête(s) Valeur
Accept application/json
Content-Type application/json
pe-fonc-apimode production

 

2 méthodes sont disponibles :

  • Liste des agences. 3 paramètres optionnels gérés
Paramètre Type Obligatoire Commentaire

horaire

Booléen

Non

Booléen permettant de remonter les horaires (Par défaut à faux si non renseigné). Ex : ?horaire=true

zonecompetence 

Booléen

Non

Booléen permettant de remonter les zones
de compétence (Par défaut à faux si non renseigné). Ex : ?zonecompetence=true&horaire=true

commune

String

Non

Permet de filtrer les résultats. Saisie partielle possible (département). Remonte les agences dont la communeImplantation de l'adresse principale commence par le paramètre ou dont la zone de compétence contient la commune INSEE saisie. Ex : ?commune=67&horaire=true

 

 

Besoin Exemple d’appel

Lister l’ensemble des agences Pôle emploi 

GET https://api.emploi-store.fr/partenaire/referentielagences/v1/agences

Lister l’ensemble des agences Pôle emploi et inclure la récupération des horaires d’ouvertures + informations liés à la zone de compétences de l’agence (territoire)

 

GET https://api.emploi-store.fr/partenaire/referentielagences/v1/agences?horaire=true&zonecompetence=true

 

Récupérer l’ensemble des agences Pôle emploi présentes sur un département ou une commune (INSEE) donnée et inclure les zones de compétences

 

GET https://api.emploi-store.fr/partenaire/referentielagences/v1/agences?commune=67&zonecompetence=true

 

 

  • Lecture unitaire et détaillé de l’agence. Le code est obligatoire

 

Paramètre Type Obligatoire Commentaire

code

String

Oui

Codification de type « XXXNNNN ». Codification sur 7 positions.

A passer directement dans l’URI. Ex : /v1/agences/ARA0021

 

Besoin Exemple d’appel

Récupérer les caractéristiques d’une agence en particulier

GET https://api.emploi-store.fr/partenaire/referentielagences/v1/agences/ARA0021

 

 

Description de la réponse

Données exposées / description de la ressource Agence :

 

Données Type Obligatoire Commentaire

code

String

Oui

Le code AURORE de l'agence. Ex : NAQ0165

libelle

String

Oui

Libelle de l'agence. Ex : POITIERS-GARE

type

String

Oui

Type d'agence: peut désigner une agence généraliste (APE) ou une agence spécialisée dans l'accueil de certains publics tels que les Cadres (APES). De nouveaux types pourraient être ajoutés dans le futur.

Ex : APE

typeAccueil

String

Oui

Type d’accueil proposé par l’agence. Ex : 3

Valeurs possibles (code è libellé) :

1 è Site d’accueil en libre-service

2 è Site d’accueil sur RDV

3 è Site d’accueil en libre-service et sur RDV

codeRegionINSEE

String

Oui

Code Insee de la région à laquelle l’unité est rattachée. Ex : 75

dispositifADEDA

Boolean

Oui

Indique si l'agence est équipe d'un dispositif ADEDA / BIM permettant l'accueil des sourds et déficients auditifs. Ex : true

contact

Contact

Non

Information de contact de l'unité (voir descriptif plus bas)

adressePrincipale

Adresse

Oui

Caractéristiques liée à l’adresse postale ou géographique de l’agence

Horaires

list<HoraireAccueil>

Non

Liste des plages horaires d’ouvertures dépendantes du typeAccueil proposée par l’agence hors jour férié.

Jours : 1 = lundi, 2 = mardi, 3 = mercredi, 4 = jeudi, 5=vendredi.

zoneCompétence

list<ZoneCompetence>

Non

Permet de définir l’ensemble des communes pour laquelle l’agence est susceptible d’intervenir.

 

Description de la ressource Contact :

Données Type Obligatoire Commentaire

Email

String

Non

Adresse mail de l’agence. Ex : ape.86009@pole-emploi.fr

telephonePublic

String

Non

Numéro de téléphone public. Ex : 39-49

 

Description de la ressource Adresse :

Données Type Obligatoire Commentaire

ligne3

String

Non

Complément d'identification du point géographique : entrée, tour, bâtiment, immeuble, résidence, zone industrielle. Ex : Immeuble XX

ligne4

String

Non

Numéro et libellé de la voie. Ex : 60 BD DU GRAND CERF

ligne5

String

Non

Mentions spéciales de distribution : Boite postale, tri spécial, …. Ex : CS 60379

ligne6

String

Non

Code postal et bureau distributeur ou code cedex et bureau distributeur. Ex : 86009 POITIERS CEDEX

bureauDistributeur

String

Non

Bureau distributeur. Ex : 86009

communeImplantation

String

Non

Commune d'implantation. Ex : 86194

gpsLat

Double

Non

Coordonné GPS en latitude. Ex : 46.582977

gpsLon

Double

Non

Coordonné GPS en longitude. Ex : 0.334514

 

Description de la ressource HoraireAccueil :

Données Type Obligatoire Commentaire

jour

String

Oui

Liste de 5 jours : 1 = lundi, 2 = mardi, 3 = mercredi, 4 = jeudi, 5=vendredi. Ex : 1

ouvertureMatin

String

Non

Heure d’ouverture de l’agence plage 1. Ex : 08:30

fermetureMatin

String

Non

Heure de fermeture de l’agence plage 1. Ex : 12:30

ouvertureApresMidi

String

Non

Heure d’ouverture de l’agence plage 2. Ex : 

Si l’agence ne ferme pas le midi, cette donnée n’est pas renseignée.

fermetureApresMidi

String

Non

Heure de fermeture de l’agence plage 2. Ex :

Si l’agence ne ferme pas le midi, cette donnée n’est pas renseignée.

horaireFerme

String

Oui

Indique si l’agence est ouverte ce jour-là ou non (O/N). Ex : N

horaireEnContinu

String

Oui

Indique si l’agence est ouverte en continu le midi ou non (O/N). Ex : N

ouvertureMatinRDV

String

Non

Heure d’ouverture de l’agence pour les RDV plage 1. Ex : 

fermetureMatinRDV

String

Non

Heure de fermeture de l’agence pour les RDV plage 1. Ex :

ouvertureApresMidiRDV

String

Non

Heure d’ouverture de l’agence pour les RDV plage 2. Ex : 12:30

Si l’agence ne ferme pas le midi, cette donnée n’est pas renseignée.

fermetureApresMidiRDV

String

Non

Heure de fermeture de l’agence pour les RDV plage 2. Ex : 16:30

Si l’agence ne ferme pas le midi, cette donnée n’est pas renseignée.

horaireFermeRDV

String

Non

Indique si l’agence est ouverte ce jour-là ou non pour les RDV (O/N). Ex : N

horaireEnContinuRDV

String

Non

Indique si l’agence est ouverte en continu le midi ou non pour les RDV (O/N). Ex : N

 

Description de la ressource ZoneCompetence :

Données Type Obligatoire Commentaire

communeInsee

String

Non

Code Insee de la commune. Ex : 86027

 

Exemple de retour


[
      {
      "code": "GRE0181",
      "libelle": "LINGOLSHEIM",
      "type": "APE",
      "typeAccueil": "3",
      "codeRegionINSEE": "44",
      "dispositifADEDA": true,
      "contact":       {
         "telephonePublic": "39-49",
         "email": "lingolsheim@pole-emploi.fr"
      },
      "adressePrincipale":       {
         "ligne4": "14 ALL DES FOULONS",
         "ligne5": "67381 TANNERIES CEDEX",
         "ligne6": "67380 LINGOLSHEIM",
         "gpsLon": 7.694412,
         "gpsLat": 48.557141,
         "communeImplantation": "67267",
         "bureauDistributeur": "67380"
      },
      "horaires":       [
                  {
            "jour": 1,
            "ouvertureMatin": "08:30",
            "fermetureMatin": "12:30",
            "horaireFerme": "N",
            "horaireEnContinu": "N",
            "ouvertureApresMidiRDV": "12:30",
            "fermetureApresMidiRDV": "16:30",
            "horaireFermeRDV": "N",
            "horaireEnContinuRDV": "N"
         },
                  {
            "jour": 2,
            "ouvertureMatin": "08:30",
            "fermetureMatin": "12:30",
            "horaireFerme": "N",
            "horaireEnContinu": "N",
            "ouvertureApresMidiRDV": "12:30",
            "fermetureApresMidiRDV": "16:30",
            "horaireFermeRDV": "N",
            "horaireEnContinuRDV": "N"
         },
                  {
            "jour": 3,
            "ouvertureMatin": "08:30",
            "fermetureMatin": "12:30",
            "horaireFerme": "N",
            "horaireEnContinu": "N",
            "ouvertureApresMidiRDV": "12:30",
            "fermetureApresMidiRDV": "16:30",
            "horaireFermeRDV": "N",
            "horaireEnContinuRDV": "N"
         },
                  {
            "jour": 4,
            "ouvertureMatin": "08:30",
            "fermetureMatin": "12:30",
            "horaireFerme": "N",
            "horaireEnContinu": "N",
            "horaireFermeRDV": "O",
            "horaireEnContinuRDV": "N"
         },
                  {
            "jour": 5,
            "ouvertureMatin": "08:30",
            "fermetureMatin": "12:30",
            "horaireFerme": "N",
            "horaireEnContinu": "N",
            "ouvertureApresMidiRDV": "12:30",
            "fermetureApresMidiRDV": "15:30",
            "horaireFermeRDV": "N",
            "horaireEnContinuRDV": "N"
         }
      ],
      "zoneCompetences":       [
         {"communeInsee": "67001"},
         {"communeInsee": "67049"},
         {"communeInsee": "67054"},
         {"communeInsee": "67065"},
         {"communeInsee": "67108"},
         {"communeInsee": "67118"},
         {"communeInsee": "67124"},
         {"communeInsee": "67152"},
         {"communeInsee": "67182"},
         {"communeInsee": "67197"},
         {"communeInsee": "67212"},
         {"communeInsee": "67247"},
         {"communeInsee": "67266"},
         {"communeInsee": "67267"},
         {"communeInsee": "67268"},
         {"communeInsee": "67363"},
         {"communeInsee": "67365"},
         {"communeInsee": "67438"},
         {"communeInsee": "67501"},
         {"communeInsee": "67526"},
         {"communeInsee": "67086"},
         {"communeInsee": "67364"},
         {"communeInsee": "67200"},
         {"communeInsee": "67130"},
         {"communeInsee": "67131"},
         {"communeInsee": "67154"},
         {"communeInsee": "67378"},
         {"communeInsee": "67137"},
         {"communeInsee": "67336"},
         {"communeInsee": "67338"},
         {"communeInsee": "67217"}
      }
   }