Cet article décrit l'API sur les kilomètres enregistrés.

Requête

La requête vers le service doit avoir la forme :

https://pysae.com/api/v2/groups/<groupe_id>/history/vk?from=<from_date>&to=<to_date>&page=<page> 

Paramètre

Valeur

<group_id>

Identifiant du réseau concerné

<from_date>

Renvoyer les passages à partir de cette date (incluse), format YYYYMMDD

<to_date>

Renvoyer les passages jusqu’à cette date (incluse), format YYYYMMDD

<page >

Optionnel, numéro de pagination

Réponse

La réponse est une liste d’objets contenant les champs suivants :

Champ

Valeur

gtfs_id

Identifiant du fichier GTFS actif au moment de l’enregistrement de l’événement

date

Date de début de la course au format GTFS YYYYMMDD

trip_id

Identifiant de la course

device_id

Identifiant de l’appareil

vk

Nombre de kilomètres commerciaux enregistrés

vk_no_status

Nombre de kilomètres commerciaux enregistrés en déviation (sortie du tracé)

vk_trip_pending

Nombre de kilomètres d’acheminement (haut-le-pied) enregistrés

start_ts

Heure de début de l’enregistrement de la course en timestamp UNIX

end_ts

Heure de fin de l’enregistrement de la course en timestamp UNIX

start_latlng

Coordonnées du début d’enregistrement de la course sous forme d’un tableau [latitude, longitude]

end_latlng

Coordonnées de fin d’enregistrement de la course sous forme d’un tableau [latitude, longitude]

Lorsque la réponse contient plus d’éléments que ne peut contenir une page la réponse contient une header Link avec le lien vers la page suivante.

Exemple

Requête :

Demande des kilomètres enregistrés par course sur le groupe "pysae" entre le 20/10/2020 et le 21/10/2020.

https://pysae.com/api/v2/groups/pysae/history/vk?from=20201020&to=20201020

Réponse :

[ {  date: "20201020",  gtfs_id: "5c3df090d18436050f506b83",  trip_id: "157",  device_id: "3bd8e21dec19a264",  vk: 0.2976492519487247,  start_ts: 1603208815,  end_ts: 1603208868,  start_latlng: [   48.891307,   2.351624  ],  end_latlng: [   48.830192,   2.283363  ] }, {  date: "20201020",  gtfs_id: "5c3df090d18436050f506b83",  trip_id: "127",  device_id: "3bd8e21dec19a264",  vk: 0.7899467844973487,  start_ts: 1603208130,  end_ts: 1603208465,  start_latlng: [   48.893662,   2.354013  ],  end_latlng: [   48.891235,   2.351627  ] },]
Avez-vous trouvé votre réponse?