Connecteur appelé par le module map. Il doit retourner :
- La liste des campus
- La liste des catégories des points d'intérêt
- La des points d'intérêt
Liste des campus
Paramètres d'appels
URL en méthode GET :
<host>/<uri>/campuses
- host : adresse du serveur
- uri : chemin éventuel vers le service
Format de retour
Format attendu
{
"id": Number,
"sort": Number,
"name": String,
"initial": {
"lat": Float,
"lng": Float
},
"southwest": {
"lat": Float,
"lng": Float
},
"northeast": {
"lat": Float,
"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
Exemple
[
{
"id": 1,
"sort": 1,
"name": "Campus du Saulcy",
"initial": { "lat": 49.1199607, "lng": 6.1620494 },
"southwest": { "lat": 49.1184275, "lng": 6.150897 },
"northeast": { "lat": 49.1216008, "lng": 6.1641432 },
"photo": "..."
},
{
"id": 2,
"sort": 2,
"name": "Campus de Bridoux",
"initial": { "lat": 49.1173805, "lng": 6.2097276 },
"southwest": { "lat": 49.1138715, "lng": 6.2097391 },
"northeast": { "lat": 49.1157185, "lng": 6.2123033 },
"photo": "..."
}
]
Liste des catégories des points d'intérêt
Paramètres d'appels
URL en méthode GET :
<host>/<uri>/categories
- host : adresse du serveur
- uri : chemin éventuel vers le service
Format de retour
Format attendu
[
{
"id": String,
"sort": Number,
"label": [
{
"langcode": String,
"value": 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
- Erreur HTTP 4xx ou 5xx : En cas de problème ou erreur
Exemple
[
{
"id": "library",
"sort": 1,
"label": [
{ "langcode": "fr", "value": "Bibliothèques" },
{ "langcode": "en", "value": "Libraries" }
]
},
{
"id": "restaurants",
"sort": 2,
"label": [
{ "langcode": "fr", "value": "Restaurants" },
{ "langcode": "en", "value": "Restaurants" }
]
}
]
Liste des points d'intérêt
Paramètres d'appels
URL en méthode GET :
<host>/<uri>/pois
- host : adresse du serveur
- uri : chemin éventuel vers le service
Format de retour
Format attendu
{
"idCategorie": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"nom": [
{
"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 : l'identifiant de la catégorie (tel que renseigné via l'URL des catégories des points d'intérêt)
- L'objet associé est une
FeatureCollectiontelle que spécifiée dans la RFC 7946 Section 3.3
- L'objet associé est une
- features.properties.nom : le nom du point d'intérêt (titre de l'info-bulle au clique 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
xetypermettent de spécifier le point d'ancrage de l'icône du marqueur.
- Les propriétés