Recherche d'adresses dans les services RVA et/ou BAN

Format de réponse

[
  {
    "citycode":"35238",
    "name":"71 rue Dupont des Loges",
    "geometry":{
      "type":"Point",
      "coordinates":[
        -1.6670818096251,
        48.108148722181
      ]
    },
    "idaddress":"60626",
    "idlane":null,
    "idcom":null,
    "city":"Rennes",
    "postcode":[
      "35000",
      "35200",
      "35700"
    ],
    "source":"[RVA]"
  }
]

Recherche inverse à partir d'une position x,y.

Ce service retourne le même format que le service de recherche d'adresses.

Recherche de l'adresse associée à la localisation d'un site.

Ce service retourne le même format que le service de recherche d'adresses.

S'il s'agit d'une adresse hors RVA, une recherche inverse dans la BAN est effectuée à partir de la localisation x,y du site.

Retourne un contact

Retourne tous les organismes associés à un contact

Retourne tous les sites associés à un contact

Retourne la liste des définitions de plugins de données métiers pour un type donné (organisme ou site).

Dépend des droits par plugin de l'utilisateur connecté.

Format de retour (exemple)

{
  "pluginUsageOrganisme":{
    "name":"Usage",
    "fields":{
      "nbClasses":{
        "fieldName":"nbClasses",
        "type":"integer",
        "nullable":true,
        "label":"Nombre de classes",
        "help":"Nombre de classes de l\u0027\u00e9tablissement scolaire concern\u00e9",
        "placeholder":"",
        "rules":{
          "visible":[
            {
              "ifField":"typeUsagers",
              "ifValue":"Scolaires"
            }
          ]
        }
      },
      "typeUsagers":{
        "fieldName":"typeUsagers",
        "type":"choice",
        "nullable":true,
        "label":"Type d\u0027usagers",
        "help":"Typologie du public qui fr\u00e9quente l\u0027organisme",
        "placeholder":"",
        "choices":[
          {
            "value":"Scolaire"
          }
        ]
      }
    }
  }
}

Retourne les valeurs de données métiers d'un type particulier (organisme ou site).

Format de retour (exemple)

{
  "typeUsagers":"Scolaire",
  "nbClasses":3,
}

ou dans le cas d'un plugin de données métiers non actif, réponse HTTP 204 NO CONTENT

Retourne la liste des mots clés (et leurs organismes associés)

Format de réponse

[
  {
    "idMotCle":3,
    "libMotCle":"Culture bretonne",
    "organismes":[<Organisme>]
  },
  {
    "idMotCle":1,
    "libMotCle":"Urgences",
    "organismes":[<Organisme>]
  }
]

Recherche des mots clés à partir d'un terme

Format de réponse

GET /v1/motscles/recherche?query=u

[
  {
    "idMotCle":3,
    "libMotCle":"Culture bretonne"
  },
  {
    "idMotCle":1,
    "libMotCle":"Urgences"
  }
]

Retourne un mot clé

Format de réponse

{
  "idMotCle":12,
  "libMotCle":"Exemple",
  "organismes":[<Organisme>]
}

Retourne tous les organismes associés à un mot clé

Format de réponse

[
  <Organisme>
]

Retourne un (si niveauOrganismeId n'est pas vide) ou tous les niveaux d'organisme

Format de réponse

si niveauOrganismeId est différent de vide :

{
  "idNiveauOrganisme":1,
  "libNiveau":"Niveau 1",
  "indiceNiveau":1
}

si niveauOrganismeId est vide :

[<NiveauOrganisme>]

Retourne un (si niveauSiteId n'est pas vide) ou tous les niveaux du site

Format de réponse

si niveauSiteId est différent de vide :

{
  "idNiveauSite":1,
  "libNiveau":"Niveau 1",
  "indiceNiveau":1
}

si niveauSiteId est vide :

[<NiveauSite>]

Retourne un nom (d'un organisme ou d'un site)

Format de réponse

{
  "idNom":1,
  "libNom":"Exemple",
  "idSite":null ou <Organisme>,
  "idOrganisme":null <Site>,
  "idTypeNom":<TypeNom>
}

• idSite est différent de null s'il s'agit d'un nom de site (idOrganisme est alors null)
• idOrganisme est différent de null s'il s'agit d'un nom d'organisme (idSite est alors null)

Rechercher des nomenclatures.

Retourne une arborescence complète (si query vide) ou incomplète des nomenclatures.

Format de réponse

GET /v1/nomenclatures/recherche?query=rennes

[
  {
    "idTheme":1,
    "libTheme":"Administration démarches",
    "flagActif":true,
    "code":"1"
    "activites":[
      {
        "idActivite":1,
        "libActivite":"Commune",
        "flagActif":true,
        "code":"1.1"
        "idTheme":null,
        "specialites":[
          {
            "idSpecialite":108,
            "libSpecialite":"Commune hors Rennes - administratif",
            "flagActif":true,
            "idActivite":null,
            "code":"1.1.2"
          },
          {
            ...
          }
        ] 
      }, 
      {
        ...
      }
    ]
  }
]

Retourne une activité

Format de réponse

{
  "idActivite":1,
  "libActivite":"Commune",
  "flagActif":true,
  "code":"1.1"
  "idTheme":null,
  "specialites":[<Specialite>]
}

Retourne tous les organismes associés à une activité

Format de réponse

[<Organisme>]

Retourne une spécialité

Format de réponse

{
  "idSpecialite":1,
  "libSpecialite":"Commune hors Rennes - administratif",
  "flagActif":true,
  "idActivite":null,
  "code":"1.1.2"
}

Retourne tous les organismes associés à une spécialité

Format de réponse

[<Organisme>]

Retourne un thème

Format de réponse

{
  "idTheme": 1,
  "libTheme": "Exemple",
  "flagActif": true,
  "code":"1",
  "activites": [<Activite>]
}

Retourne tous les organismes associés à un thème

Format de réponse

[<Organisme>]

Retourne un organisme

Format de réponse

{
  "idOrganisme":1,
  "nomUsage":"Exemple",
  "etatOrganisme":"actif",  # actif | inactif | projet
  "url1":null,              # non renseigné
  "url2":null,              # non renseigné
  "url3":null,              # non renseigné
  "descriptif":"Descriptif long de l'organisme",
  "commentaire":null,
  "idOrganismePere":null ou <Organisme>,
  "fils":[<Organisme>],
  "idNiveauOrganisme":<NiveauOrganisme>,
  "denominations":[<Nom>],
  "flagPublic":true,
  "sites":[
    {
      "idOrganismeSite":5356,
      "flagOrganismePrincipal":true,
      "flagSitePrincipal":true,
      "adressePostaleAdr":"71 rue dupont des loges",
      "adressePostaleBpCs":null,
      "adressePostaleCp":"35000",
      "adressePostaleComm":"Rennes",
      "adressePostaleCedex":null,
      "idOrganisme":null,
      "idSite":<Site>
    }
  ],
  "nomenclatures":[
    {
      "idOrgNomenclature":5933,
      "flagPrincipal":true,
      "idOrganisme":null,
      "idActivite":{
        "idActivite":3,
        "libActivite":"Département",
        "flagActif":true,
        "code":"1.3"
        "idTheme":<Theme>,
      },
      "idSpecialite":null
    }
  ],
  "contacts":[
    {
      "idContactOrg":3550,
      "flagReferent":true,
      "idOrg":null,
      "idContact":<Contact>
    }
  ],
  "motscles":[<MotCle>],
  "joursFermes":{
    "idJoursFermes":5249,
    "gestionJours":true,
    "variationCongesScolaires":true,
    "commentaireVariationCongesScolaires":null,
    "fermeJourAn":true,
    "fermeLundiPaques":true,
    "fermeFeteTravail":false,
    "fermeVictoire1945":false,
    "fermeAscension":false,
    "fermeLundiPentecote":false,
    "fermeFeteNationale":true,
    "fermeAssomption":true,
    "fermeToussaint":false,
    "fermeArmistice1918":false,
    "fermeNoel":true,
    "fermeVacancesToussaint":false,
    "fermeVacancesNoel":true,
    "fermeVacancesHiver":false,
    "fermeVacancesPrintemps":false,
    "fermeVacancesEte":true,
    "commentaire":null,
    "joursExcept":"[{"dateDebut": "31/05/2017", "dateFin": "02/06/2017", "commentaire": "commentaire"}]
  },
  "horairesOuvertures":[
    {
      "idHorairePeriode":5251,
      "dateDebut":"2017-01-01T00:00:00+0100",
      "dateFin":"2017-01-31T00:00:00+0100",
      "horaires":[
        {
          "libJour":"Lundi",
          "idHoraireJour":36751,
          "jour":1,
          "ouvert24": false,
          "ouvert1":"1970-01-01T08:30:00+0100",
          "ferme1":"1970-01-01T12:00:00+0100",
          "ouvert2":null,
          "ferme2":null,
          "ouvert3":null,
          "ferme3":null
        },
        {
          "libJour":"Mardi",
          "idHoraireJour":36752,
          "jour":2,
          "ouvert24": true, 
          "ouvert1":null,
          "ferme1":null,
          "ouvert2":null,
          "ferme2":null,
          "ouvert3":null,
          "ferme3":null
        },
        {
          ...
        }
      ]
    }
  ]
}

Suggestions de résultat

Format de réponse

GET /v1/recherche/suggest?q=univ

[
  {
    "item":"Bibliothèque universitaire Santé - Université de Rennes 1",
    "score":0.7
  },
  {
    "item":"Institut universitaire de technologie (IUT) - Université de Rennes 1 Contact générique",
    "score":0.6
  },
  {
    ...
  }
]

Effectue une recherche sur des organismes et/ou sites et/ou contacts.

Les résultats retournés sont triés par défaut par score (desc) puis nom (asc).

La recherche spatiale (sites dans un rayon de geodist km autour d'un point x,y) n'est effective que pour les sites exclusivement (via les filtres geodist, x, y).

Le retour peut se faire au format JSON ou CSV.

Format de retour

GET /v1/recherche?termes=Appart'city&offset=0&limit=20&types[]=organisme&types[]=site&types[]=contact&offset=0&limit=20 (ou range=0-19)

206 Partial Content
Content-Range: 0-19/11673/20
Link: <url?range=m-M>; rel="first",<url?range=m-M>; rel="prev",<url?range=m-M>; rel="next",<url?range=m-M>; rel="last"

[
   {
      "type": "organisme",
      "id": "6820",
      "nom": "Appart'city Rennes Beauregard",
      "libelle": "6820 - Appart'city Rennes Beauregard",
      "etat": "actif",
      "autres": [
          "Localisation : Rennes",
          "Site principal : Appart'city Rennes Beauregard"
      ],
      "org_descriptif": "LE CONCEPT APPART’CITY : LIBRE DE FAIRE COMME CHEZ VOUS<br/><br/>Chez Appart’City vous êtes libre de vivre à votre rythme, de faire ce que vous voulez même en déplacement. Notre concept est unique puisqu’il réunit le meilleur des deux mondes entre la location d’appartement et l’hôtel. Vous avez envie de profiter de nos services, laverie, parking souterrain, petit déjeuner… alors n’hésitez pas. Quelque soit votre envie de séjour qu’il soit personnel ou professionnel, vivez comme vous l’entendez chez Appart’City, en toute liberté. <br/>Tous nos appartements, de 2 à 6 personnes, sont meublés et équipés, avec une connexion wifi haut débit gratuite. Vous pourrez y séjourner pour une nuit, une semaine et plus…",
      "org_nomenclature": "Logement/Urbanisme | Hébergement temporaire ou d'urgence | Offre d'hébergement temporaire",
      "site_adresse": "1 rue Aurelie Nemours",
      "site_nomenclature": null,
      "contact_civilite": null,
      "contact_nom": "VARANE",
      "contact_prenom": "Stéphanie",
      "contact_fonction": "Directrice de Résidence",
      "contact_tel1": "02 23 48 47 13",
      "contact_tel2": "07 86 18 76 58",
      "contact_fax": null,
      "contact_mail1": "rennes-beauregard-direction@appartcity.com",
      "contact_mail2": null,
      "score": 5.2954664,
      "_distance_": null
  },
  {
      "type": "site",
      "id": "5443",
      "nom": "Appart'city Rennes Beauregard",
      "libelle": "5443 - Appart'city Rennes Beauregard",
      "etat": "actif",
      "autres": [
          "Localisation : Rennes"
      ],
      "org_descriptif": null,
      "org_nomenclature": null,
      "site_adresse": "1 rue Aurelie Nemours ",
      "site_nomenclature": "Logement/Urbanisme | Hébergement temporaire ou d'urgence | Offre d'hébergement temporaire",
      "contact_civilite": null,
      "contact_nom": null,
      "contact_prenom": null,
      "contact_fonction": null,
      "contact_tel1": null,
      "contact_tel2": null,
      "contact_fax": null,
      "contact_mail1": null,
      "contact_mail2": null,
      "score": 3.1954668,
      "_distance_": null
  },
  {
      "type": "contact",
      "id": "4049",
      "nom": "APPART'CITY RENNES BEAUREGARD Contact public",
      "libelle": "4049 - APPART'CITY RENNES BEAUREGARD Contact public",
      "etat": "__EMPTY__",
      "autres": [
          "Organisme(s) associé(s) : Appart'city Rennes Beauregard (Rennes) "
      ],
      "org_descriptif": null,
      "org_nomenclature": null,
      "site_adresse": null,
      "site_nomenclature": null,
      "contact_civilite": null,
      "contact_nom": "APPART'CITY RENNES BEAUREGARD",
      "contact_prenom": "Contact public",
      "contact_fonction": null,
      "contact_tel1": "02 23 48 47 10",
      "contact_tel2": null,
      "contact_fax": null,
      "contact_mail1": null,
      "contact_mail2": null,
      "score": 3.1954668,
      "_distance_": null
  },
  .....
]

Retourne une liste de sites au format GeoJson

Format de réponse

{
  "type":"FeatureCollection",
  "crs":{
    "type":"name",
    "properties":{
      "name":"urn:ogc:def:crs:OGC:1.3:CRS84"
    }
  },
  "features":[
    {
      "type":"Feature",
      "properties":{
        "id_site":12,
        "etat_site":"actif",
        "nom_usage":"Bibliothèque universitaire Santé - Université de Rennes 1"
      },
      "geometry":{
        "type":"Point",
        "coordinates":[
          -1.702315674399384,
          48.116762682007028
        ]
      }
    },
    {
      ...
    }
  ]
}

Retourne un site

Format de réponse

{
  "nomUsage":"Exemple",
  "idSite":23,
  "etatSite":"actif",
  "commentaire":null,
  "idSitePere":null ou <Site>,
  "fils":[<Site>],
  "idNiveauSite":<NiveauSite>,
  "denominations":[<Nom>],
  "organismes":[
    {
      "idOrganismeSite":5356,
      "flagOrganismePrincipal":true,
      "flagSitePrincipal":true,
      "adressePostaleAdr":"71 rue dupont des loges",
      "adressePostaleBpCs":null,
      "adressePostaleCp":"35000",
      "adressePostaleComm":"Rennes",
      "adressePostaleCedex":null,
      "idOrganisme":<Organisme>,
      "idSite":null
    }
  ],
  "contacts":[
    {
      "idContactSite":11,
      "idContact":<Contact>,
      "idSite":null
    }
  ],
  "sitePt":{
    "idSitePt":4342,
    "quartier":null,
    "x":1362447.1205184,
    "y":7222529.2690382,
    "flagHorsRva":true,
    "shape":{
      "srid":3948,
      "x":1362447.1205184,
      "y":7222529.2690382
    }
  },
  "lienRvaSite":{
    "idLienRvaSite":4342,
    "idRvaAdr":60626,
    "idRvaCom":null,
    "idRvaLane":null
  },
  "adresse":"71 rue dupont des logs 35000 Rennes"
}

Retourne le site, son site parent, ses sites frères ainsi que tous les autres sites au format GeoJson

Format de réponse

La propriété type peut prendre la valeur : 1. "site" : le site demandé, 2. "parent" : le site parent du site demandé, 3. "sibling" : les sites frères du site demandé, 4. "other" : tous les autres sites

{
  "type":"FeatureCollection",
  "crs":{
    "type":"name",
    "properties":{
      "name":"urn:ogc:def:crs:OGC:1.3:CRS84"
    }
  },
  "features":[
    {
      "type":"Feature",
      "properties":{
        "id_site":145,
        "etat_site":"actif",
        "nom_usage":"Bibliothèque - Université Rennes 2"
        "type":"site"
      },
      "geometry":{
        "type":"Point",
        "coordinates":[
          -1.702315674399384,
          48.116762682007028
        ]
      }
    },
    {
      "type":"Feature",
      "properties":{
        "id_site":135,
        "etat_site":"actif",
        "nom_usage":"Université Rennes 2"
        "type":"parent"
      },
      "geometry":{
        "type":"Point",
        "coordinates":[
          -1.702315674399384,
          48.116762682007028
        ]
      }
    },
    {
      "type":"Feature",
      "properties":{
        "id_site":128,
        "etat_site":"actif",
        "nom_usage":"Auditorium Le Tambour - Université Rennes 2"
        "type":"sibling"
      },
      "geometry":{
        "type":"Point",
        "coordinates":[
          -1.702315674399384,
          48.116762682007028
        ]
      }
    },
    {
      "type":"Feature",
      "properties":{
        "type":"other"
      }
    }
  ]
}

Retourne tous les types des noms

Format de réponse

[
  {
    "idTypeNom":0,
    "libTypeNom":"Nom d'usage"
  },
  {
    "idTypeNom":1,
    "libTypeNom":"Sigle"
  },
  {
    "idTypeNom":2,
    "libTypeNom":"URL"
  },
  {
    "idTypeNom":3,
    "libTypeNom":"Nom officiel"
  }
]