esup-multi

Arborescence des pages

Comparaison des versions

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

Connecteur (optionnel) appelé par le module module map. Il doit retourner :

  • La liste des campus
  • La liste des Les catégories des de points d'intérêtLa
  • des Les points d'intérêt

...

Paramètres d'appels

URL en méthode GET :

Bloc de code
<host>/<uri>/campuses
  • host : adresse du serveur
  • uri : chemin éventuel vers le service

Format de retour

Format attendu

Bloc de code
languagejsjavascript
{
  "id"	categories: NumberCategories,
   "sort" campuses: NumberCampuses,
    pois: FeatureCollections
}


Categories

Format
Bloc de code
languagejs
[
 "name": String,
  "initial": {
    "latid": FloatString,
    "lnglabel": Float[
  },
   "southwest": {
    "lat": Float,
    "lnglangcode": FloatString,
  },
  "northeast": {
    "latvalue": Float,String
    "lng": Float
  },
   "photo": String]
  }
]
  • id : identifiant
  • du campus
  • sort : valeur de tri pour l'affichage des campus
  • name : nom du campus affiché
  • initial : position initiale sur le campus
  • southwest : coordonnées sud-ouest de la limite du campus
  • northeast : coordonnées nord-est de la limite du campus
  • photo : une miniature à afficher à côté du nom du campus

Cas d'erreur

  • Erreur HTTP 4xx ou 5xx : En cas de problème ou erreur
  • de la catégorie (tel qu'utilisé par les POIs)
  • label : les libellés de la catégorie dans les différentes langues supportées
    • langcode : code à deux lettres de la langue
    • value : valeur du libellé dans la langue associée
Exemple
Bloc de code
languagejs
linenumberstrue
[
  {
    "id": 1"library",
    "sortlabel": 1,[
    "name": "Campus du Saulcy",
    { "initiallangcode": { "latfr": 49.1199607, "lngvalue": 6.1620494"Bibliothèques" },
    "southwest":  { "latlangcode": 49.1184275, "lng": 6.150897 },
    "northeast": { "lat": 49.1216008, "lng": 6.1641432 },en", "value": "Libraries" }
    "photo": "..."]
  },
  {
    "id": 2"restaurants",
    "sortlabel": 2,[
    "name": "Campus de{ Bridoux",
    "initial": { "lat": 49.1173805"langcode": "fr", "lngvalue": 6.2097276"Restaurants" },
    "southwest":  { "latlangcode": 49.1138715, "lng": 6.2097391 },
    "northeast": { "lat": 49.1157185, "lng": 6.2123033 },en", "value": "Restaurants" }
    "photo": "..."]
  }
]

Liste des catégories des points d'intérêt

Paramètres d'appels

URL en méthode GET :

Bloc de code
<host>/<uri>/categories
  • host : adresse du serveur
  • uri : chemin éventuel vers le service

Format de retour

...


Campuses

Format
Bloc de code
languagejs
[{
   {"id": Number,
  "name": String,
  "idinitial": String,{
    "sortlat": NumberFloat,
    "labellng": [Float
  },
   "southwest": {
    "lat": Float,
    "langcodelng": Float
 String },
    "northeast": {
    "valuelat": StringFloat,
    "lng": Float
  },
    ]
  }
"photo": String
}]
  • id : identifiant
  • de la catégorie (tel qu'utilisé via l'URL retournant les points d'intérêt)
  • sort : la valeur de tri pour l'affichage des catégories
  • label : les libellés de la catégorie dans les différentes langues supportées
    • langcode : code à deux lettres de la langue
    • value : valeur du libellé dans la langue associée

Cas d'erreur

  • du campus
  • name : nom du campus affiché
  • initial : position initiale sur le campus
  • southwest : coordonnées sud-ouest de la limite du campus
  • northeast : coordonnées nord-est de la limite du campus
  • photo : une miniature à afficher à côté du nom du campus
  • Erreur HTTP 4xx ou 5xx : En cas de problème ou erreur
Exemple
Bloc de code
languagejs
linenumberstrue
[
  {
    "id": "library"1,
    "sortname": 1"Campus du Saulcy",
    "initial": { "labellat": [
   49.1199607, "lng": 6.1620494 },
   { "langcodesouthwest": { "frlat": 49.1184275, "valuelng": "Bibliothèques"6.150897 },
     "northeast": { "langcodelat": "en"49.1216008, "valuelng": "Libraries"6.1641432 },
    ]"photo": "..."
  },
  {
    "id": "restaurants"2,
    "sortname": 2"Campus de Bridoux",
    "initial": { "labellat": [
   49.1173805, "lng": 6.2097276 },
   { "langcodesouthwest": { "frlat": 49.1138715, "valuelng": "Restaurants"6.2097391 },
    "northeast":  { "langcodelat": "en"49.1157185, "valuelng": "Restaurants"6.2123033 },
     ]"photo": "..."
  }
]

Liste des points d'intérêt

Paramètres d'appels

URL en méthode GET :

Bloc de code
<host>/<uri>/pois
  • host : adresse du serveur
  • uri : chemin éventuel vers le service

Format de retour

...


FeatureCollections

Bloc de code
languagejs
{
  "idCategorie<idCategorie>": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "properties": {
          "nomname": [
            {
              "value": String,
              "langcode": String
            }
          ],
          "description": [
            {
              "value": String,
              "langcode": String
            }
          ],
          "icon": {
            "svg": String,
            "width": Number,
            "height": Number,
            "x": Number,
            "y": Number
          }
        },
        "geometry": {
          "type": "Point",
          "coordinates": [Float, Float]
        }
      }
    ]
  }
}
  • idCategorie <idCategorie> : l'identifiant de la catégorie (tel que renseigné via l'URL des catégories des points d'intérêtdans un item de Categories)
  • features.properties.nomname : le nom du point d'intérêt (titre de l'info-bulle au clique clic sur le marqueur de la carte)
  • features.properties.description : la description du point d'intérêt (texte de l'info-bulle au clique sur le marqueur de la carte)
  • features.properties.icon : l'icône du marqueur sur la carte
    • Les propriétés x et y permettent de spécifier le point d'ancrage de l'icône du marqueur.