API QWS — Itinéraires détaillés

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

GET /vehicles/route

https://qws.quartix.net/api/v2/vehicles/route?VehicleID=0&StartDay=2016-07-05

Récupère la liste des « segments » (hops) individuels pour un seul véhicule sur une seule journée. Le jour de début, ainsi que le fuseau horaire et l'heure de début de service du véhicule, sont utilisés pour déterminer les dates/heures de début et de fin de la période concernée. Les segments renvoyés sont ceux des trajets dont la date/heure de début ou de fin se situe entre le début du service qui démarre le jour de début et la fin du service qui démarre ce même jour.

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
`VehicleID`	L'identifiant du véhicule à récupérer.	int32	query
`StartDay`	Le jour de début de la période de reporting.	date	query

Réponses

200 — Réponse réussie

{
  "Meta": {
    "Code": 0,
    "Message": ""
  },
  "Data": [
    {
      "Summary": {
        "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
        }
      },
      "Trips": [
        {
          "VehicleID": 0,
          "DriverID": 0,
          "Timezone": "",
          "StartDateTime": "2016-07-05T16:20:30.655Z",
          "StartLocation": "",
          "StartLat": 0.5,
          "StartLong": 0.5,
          "EndDateTime": "2016-07-05T16:20:30.655Z",
          "EndLocation": "",
          "EndLat": 0.5,
          "EndLong": 0.5,
          "TravelTime": 0.5,
          "IdlingTime": 0.5,
          "Distance": 0.5,
          "PrivacyDistance": 0.5,
          "AvgSpeed": 0.5,
          "MaxSpeed": 0.5,
          "InProgress": true,
          "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
          },
          "Route": [
            {
              "Latitude": 0.5,
              "Longitude": 0.5,
              "Heading": 0,
              "Distance": 0.5,
              "EventDateTime": "2016-07-05T16:20:30.655Z",
              "EventType": "Distance|Stop|Ignition-On|Ignition-Off",
              "Location": "",
              "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 },
              "SpeedData": {
                "Speed": 0.5,
                "Percentile": 0.5,
                "SpeedLimit": 0,
                "NinetyFivePercentileSpeed": 0.5
              },
              "Status": [
                { "Name": "", "Value": "" }
              ]
            }
          ]
        }
      ]
    }
  ]
}

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

GET /drivers/route

https://qws.quartix.net/api/v2/drivers/route?DriverID=0&StartDay=2016-07-05

Récupère la liste des « segments » (hops) individuels pour un seul chauffeur sur une seule journée. Le jour de début, ainsi que le fuseau horaire et l'heure de début de service du chauffeur, sont utilisés pour déterminer les dates/heures de début et de fin de la période concernée. Les segments renvoyés sont ceux des trajets dont la date/heure de début ou de fin se situe entre le début du service qui démarre le jour de début et la fin du service qui démarre ce même jour.