Les Webservices Océan

Trajets et positions

Cette API permet de récupérer :

  • Les trajets journaliers effectués à titre professionnel pour les véhicules,
  • Les positions de tous les véhicules autorisés pour l’utilisateur,
  • Les dernières positions des véhicules / matériels,
  • Les positions des véhicules / matériels entre 2 dates,
  • La fiche journalière d’un véhicule pour une date donnée.

Récupérer les positions d'un ou plusieurs véhicules entre deux dates : 2

get /restapi/positions/search

Version à utiliser

Authentification préalable nécessaire via votre login et password.

Paramètres de la requête

Nom Description
immatriculation array (of string)

Liste des immatriculations des véhicules

startDate string

La date de début au format DateHeure ISO le plus courant ‘yyyy-MM-dd’T’HH:mm:ss.SSSXXX’ (exemple : “2000-10-30T01:30:00.000Z”). Ne doit pas être plus ancienne que 2 mois.

endDate string

La date de fin doit être au format UTC : "dd/MM/yyyy HH:mm:ss Z". Seul ce format est pris en compte par notre API.

byStorageDate boolean

Permet de rechercher les positions sur les horodates de stockage et non pas les horodates des positions

Réponses

Récupérer les positions d'un ou plusieurs véhicules entre deux dates :

get /restapi/positionsVehicles/betweenDate

Version obsolète

Authentification préalable nécessaire via votre login et password.

Paramètres de la requête

Nom Description
immatsVeh array (of string)

Liste des immatriculations des véhicules

login obligatoire string

Identifiant

password obligatoire string

Mot de passe

dateDebut string

La date de début doit être au format UTC : "dd/MM/yyyy HH:mm:ss Z". Seul ce format est pris en compte par notre API. Elle ne doit pas être plus ancienne que 2 mois.

dateFin string

La date de fin doit être au format UTC : "dd/MM/yyyy HH:mm:ss Z". Seul ce format est pris en compte par notre API.

parDateStockage boolean

Si « vrai », la méthode va chercher les positions sur les horodates des positions.

Réponses

Récupérer la dernière position d'un ou plusieurs véhicules

get /restapi/positionsVehicles/lastPosition

Authentification préalable nécessaire via votre login et password.

Paramètres de la requête

Nom Description
immatsVeh array (of string)

Liste des immatriculations des véhicules (50 maximum)

login obligatoire string

Identifiant

password obligatoire string

Mot de passe

Réponses

Récupérer tous les véhicules autorisés pour l'utilisateur avec leurs positions

get /restapi/mobility/v1/vehiclePositions

Authentification préalable nécessaire et passage du token dans le header X-AUTH-TOKEN

Attention : le token n’est valable que 12 heures. Au-delà de ce délai, il faudra en générer un nouveau.

Aucun paramètre de requête requis

Réponses

Récupérer le trajet d’un véhicule

get /restapi/mobility/v1/trajet

Authentification préalable nécessaire et passage du token dans le header X-AUTH-TOKEN

Attention : le token n’est valable que 12 heures. Au-delà de ce délai, il faudra en générer un nouveau.

Paramètres de la requête

Nom Description
travelId obligatoire integer ($int64)

Identifiant du trajet du véhicule

Réponses

Récupérer la fiche journalière d’un véhicule pour une date donnée

get /restapi/mobility/v1/ficheJour

Authentification préalable nécessaire et passage du token dans le header X-AUTH-TOKEN

Attention : le token n’est valable que 12 heures. Au-delà de ce délai, il faudra en générer un nouveau.

Paramètres de la requête

Nom Description
vehId integer ($int64)

Identifiant du véhicule pour lequel la fiche journalière est récupérée

date string

Date au format UTC : "dd/MM/yyyy". Seul ce format est pris en compte par notre API.

Réponses

Récupérer les positions d'un ou plusieurs matériels entre deux dates

get /restapi/materiel/positionBetween

Authentification préalable nécessaire et passage du token dans le header X-AUTH-TOKEN

Attention : le token n’est valable que 12 heures. Au-delà de ce délai, il faudra en générer un nouveau.

Paramètres de la requête

Nom Description
materielIds array (of int)

Liste des identifiants des matériels (nombre illimité)

dateDebut string

La date de début doit être au format UTC : "dd/MM/yyyy HH:mm:ss Z". Seul ce format est pris en compte par notre API.

dateFin string

La date de fin doit être au format UTC : "dd/MM/yyyy HH:mm:ss Z". Seul ce format est pris en compte par notre API. La période ne doit pas dépasser 1 jour.

Réponses

Récupérer la dernière position d'un ou plusieurs matériels

get /restapi/materiel/lastPosition

Authentification préalable nécessaire et passage du token dans le header X-AUTH-TOKEN

Attention : le token n’est valable que 12 heures. Au-delà de ce délai, il faudra en générer un nouveau.

Paramètres de la requête

Nom Description
materielIds array (of int)

Liste des identifiants des matériels (nombre illimité)

Réponses