API QWS — Résumés de trajets

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/tripsummary

GET /vehicles/tripsummary

https://qws.quartix.net/api/v2/vehicles/tripsummary?RegionID=0&SiteID=0&GroupID=0&VehicleIDList=[0]&StartDay=2016-07-05&EndDay=2016-07-05&GroupBy=day|month|site|vehicle&Include=drivingStyle

Récupère les informations résumées des trajets (distance, temps de trajet, etc.) pour le ou les véhicules filtrés selon les paramètres transmis. En fonction des jours de début et de fin fournis (qui peuvent être identiques), l'heure de début de service et le fuseau horaire de chaque véhicule sont utilisés individuellement pour déterminer les dates/heures de début et de fin de la période concernée. Les trajets résumés sont ceux dont la date/heure de début se situe entre le début du service qui démarre le jour de début et la fin du service qui démarre le jour de fin. Le paramètre optionnel GroupBy modifie le mode de calcul du résumé. Demander les informations de style de conduite (driving style) augmentera le temps d'exécution de la requête.

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
`StartDay`	Le jour de début de la période de reporting.	date	query
`EndDay`	Le jour de fin de la période de reporting.	date	query
`GroupBy`	Options de regroupement pour les rapports de résumé de trajets des véhicules.	string	query
`Include`	Inclut des champs supplémentaires tels que spécifiés dans la liste « include ».	string	query

Réponses

200 — Réponse réussie

{
  "Meta": {
    "Code": 0,
    "Message": ""
  },
  "Data": [
    {
      "SiteID": 0,
      "VehicleID": 0,
      "DriverID": 0,
      "Date": "2016-07-05",
      "NumberOfTrips": 0,
      "TravelTime": 0.5,
      "IdlingTime": 0.5,
      "Distance": 0.5,
      "PrivacyDistance": 0.5,
      "MaxSpeed": 0.5,
      "DrivingStyle": {
        "Braking": {
          "Level1Count": 0,
          "Level2Count": 0,
          "Level3Count": 0,
          "Level4Count": 0,
          "Level5Count": 0,
          "Score": 0.5
        },
        "Accel": {
          "Level1Count": 0,
          "Level2Count": 0,
          "Level3Count": 0,
          "Level4Count": 0,
          "Level5Count": 0,
          "Score": 0.5
        },
        "RelativeSpeed": {
          "Level1Count": 0,
          "Level2Count": 0,
          "Level3Count": 0,
          "Level4Count": 0,
          "Level5Count": 0,
          "Score": 0.5
        },
        "Score": 0.5
      }
    }
  ]
}

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": ""
  }
}

/drivers/tripsummary

GET /drivers/tripsummary

https://qws.quartix.net/api/v2/drivers/tripsummary?RegionID=0&SiteID=0&GroupID=0&DriverIDList=[0]&StartDay=2016-07-05&EndDay=2016-07-05&GroupBy=day|month|site|driver&Include=drivingStyle

Récupère les informations résumées des trajets (distance, temps de trajet, etc.) pour le ou les chauffeurs filtrés selon les paramètres transmis. En fonction des jours de début et de fin fournis (qui peuvent être identiques), l'heure de début de service et le fuseau horaire de chaque chauffeur sont utilisés individuellement pour déterminer les dates/heures de début et de fin de la période concernée. Les trajets résumés sont ceux dont la date/heure de début se situe entre le début du service qui démarre le jour de début et la fin du service qui démarre le jour de fin. Le paramètre optionnel GroupBy modifie le mode de calcul du résumé. Demander les informations de style de conduite augmentera le temps d'exécution de la requête.