API QWS — Kilométrage des véhicules

Sommaire de la documentation

Authentification — /auth, /auth/refresh
Régions, sites & groupes — /regions, /sites, /groups
Véhicules & chauffeurs — /vehicles, /drivers
Suivi en temps réel — /vehicles/live, /drivers/live
Résumés de trajets — /vehicles/tripsummary, /drivers/tripsummary
Détail des trajets — /vehicles/trips, /drivers/trips
Itinéraires détaillés — /vehicles/route, /drivers/route
Kilométrage — /vehicles/odometer
Gestion des véhicules — /vehicles/management
Lieux personnalisés — /locations
Paramètres utilisateur — /settings

/vehicles/odometer

GET /vehicles/odometer

https://qws.quartix.net/api/v2/vehicles/odometer?RegionID=0&SiteID=0&GroupID=0&VehicleIDList=[0]

Récupère les données de kilométrage des véhicules que l'utilisateur autorisé est habilité à consulter, filtrées selon les paramètres transmis. Les distances sont renvoyées en kilomètres.

Paramètres

Nom	Description	Type	Emplacement
`AccessToken`	Un jeton web JSON (JWT) contenant les informations nécessaires pour restaurer une session utilisateur. Ce paramètre peut être transmis soit dans l'en-tête (header), soit sous forme de cookie HTTPS uniquement. Une valeur de cookie remplace une valeur d'en-tête (même si elle est invalide) : par exemple, une valeur d'en-tête valide avec un cookie invalide sera ignorée au profit du cookie.	string	header
`RefreshToken`	Le jeton de rafraîchissement fourni lors de l'authentification. Ce jeton a une durée de vie plus longue que l'AccessToken et est utilisé, une fois l'AccessToken expiré, pour poursuivre la session de façon transparente. Les jetons de rafraîchissement peuvent être révoqués. Lorsqu'un jeton de rafraîchissement est utilisé, les droits d'accès de l'utilisateur sont actualisés (en cas de changement de rôle ou de permissions depuis la dernière connexion ou utilisation de l'AccessToken).	string	header
`RegionID`	La région utilisée pour filtrer les résultats.	int32	query
`SiteID`	Le site utilisé pour filtrer les résultats.	int32	query
`GroupID`	Le groupe utilisé pour filtrer les résultats.	int32	query
`VehicleIDList`	Les identifiants des véhicules à récupérer.	array	query

Réponses

200 — Réponse réussie

{
  "Meta": {
    "Code": 0,
    "Message": ""
  },
  "Data": [
    {
      "VehicleID": 0,
      "OdoEstimateKm": 0.5,
      "EstimateDateTime": "2016-07-05T16:20:30.655Z",
      "ManualOdoReadingKm": 0.5,
      "ManualReadingDateTime": "2016-07-05T16:20:30.655Z"
    }
  ]
}

400 — Requête invalide, par exemple une combinaison de paramètres ou de valeurs de paramètres non valide.

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

401 — Aucune information d'authentification n'est présente (ou elle est invalide).

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

403 — Tentative de filtrage par des valeurs non autorisées pour l'utilisateur authentifié.

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

PUT /vehicles/odometer

https://qws.quartix.net/api/v2/vehicles/odometer

Met à jour les valeurs de kilométrage pour les véhicules spécifiés. La réponse répartit les demandes entre celles qui ont réussi et celles qui ont échoué, avec un code et un message d'échec pour ces dernières.

Paramètres

Nom	Description	Type	Emplacement
`AccessToken`	Un jeton web JSON (JWT) contenant les informations nécessaires pour restaurer une session utilisateur. Ce paramètre peut être transmis soit dans l'en-tête (header), soit sous forme de cookie HTTPS uniquement. Une valeur de cookie remplace une valeur d'en-tête (même si elle est invalide) : par exemple, une valeur d'en-tête valide avec un cookie invalide sera ignorée au profit du cookie.	string	header
`RefreshToken`	Le jeton de rafraîchissement fourni lors de l'authentification. Ce jeton a une durée de vie plus longue que l'AccessToken et est utilisé, une fois l'AccessToken expiré, pour poursuivre la session de façon transparente. Les jetons de rafraîchissement peuvent être révoqués. Lorsqu'un jeton de rafraîchissement est utilisé, les droits d'accès de l'utilisateur sont actualisés (en cas de changement de rôle ou de permissions depuis la dernière connexion ou utilisation de l'AccessToken).	string	header
`OdometerUpdate`	Corps de la requête : `{ "VehicleID": 0, "ManualOdoReadingKm": 0.5, "ManualReadingDateTime": "2016-07-05T16:20:30.655Z", "ReadingEnteredBy": "" }`	objet	body

Réponses

200 — Réponse réussie.

{
  "Succeeded": [
    {
      "VehicleID": 0,
      "ManualOdoReadingKm": 0.5,
      "ManualReadingDateTime": "2016-07-05T16:20:30.655Z",
      "ReadingEnteredBy": ""
    }
  ],
  "Failed": [
    {
      "Request": {
        "VehicleID": 0,
        "ManualOdoReadingKm": 0.5,
        "ManualReadingDateTime": "2016-07-05T16:20:30.655Z",
        "ReadingEnteredBy": ""
      },
      "Response": {
        "ResponseCode": 0,
        "ResponseMessage": ""
      }
    }
  ]
}

401 — Aucune information d'authentification n'est présente (ou elle est invalide).

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

404 — Aucun véhicule correspondant à cet identifiant n'a été trouvé.

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

« Itinéraires détaillés Gestion des véhicules »