API QWS — Gestion 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/management

GET /vehicles/management

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

Récupère les données de gestion des véhicules que l'utilisateur autorisé est habilité à consulter, filtrées selon les paramètres transmis.

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,
      "ServiceDueDate": "2016-07-05",
      "ServiceDueOdometerKm": 0.5,
      "InsuranceDueDate": "2016-07-05",
      "TaxDueDate": "2016-07-05",
      "TestDueDate": "2016-07-05",
      "Milestone1Name": "",
      "Milestone1Date": "2016-07-05",
      "Milestone2Name": "",
      "Milestone2OdoKm": 0.5,
      "OvernightLocationID": 0,
      "VehicleCategory": ""
    }
  ]
}

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

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

Met à jour les données de gestion pour les véhicules spécifiés. Les paramètres consistent en une ou plusieurs valeurs ; au moins une doit être présente, sinon une erreur est renvoyée. Seuls les éléments présents dans l'appel seront mis à jour. Si Milestone1Date est spécifié, Milestone1Name doit déjà exister en base, ou être défini dans le même appel. Si Milestone2Odo est spécifié, Milestone2Name doit déjà exister en base, ou être défini dans le même appel. 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.

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
`VehicleManagementUpdate`	Corps de la requête : `{ "VehicleID": 0, "ServiceDueDate": "2016-07-05", "ServiceDueOdometerKm": 0.5, "InsuranceDueDate": "2016-07-05", "TaxDueDate": "2016-07-05", "TestDueDate": "2016-07-05", "Milestone1Name": "", "Milestone1Date": "2016-07-05", "Milestone2Name": "", "Milestone2OdoKm": 0.5, "OvernightLocationID": 0, "VehicleCategory": "" }`	objet	body

Réponses

200 — Réponse réussie.

{
  "Succeeded": [
    {
      "VehicleID": 0,
      "ServiceDueDate": "2016-07-05",
      "ServiceDueOdometerKm": 0.5,
      "InsuranceDueDate": "2016-07-05",
      "TaxDueDate": "2016-07-05",
      "TestDueDate": "2016-07-05",
      "Milestone1Name": "",
      "Milestone1Date": "2016-07-05",
      "Milestone2Name": "",
      "Milestone2OdoKm": 0.5,
      "OvernightLocationID": 0,
      "VehicleCategory": ""
    }
  ],
  "Failed": [
    {
      "Request": {
        "VehicleID": 0,
        "ServiceDueDate": "2016-07-05",
        "ServiceDueOdometerKm": 0.5,
        "InsuranceDueDate": "2016-07-05",
        "TaxDueDate": "2016-07-05",
        "TestDueDate": "2016-07-05",
        "Milestone1Name": "",
        "Milestone1Date": "2016-07-05",
        "Milestone2Name": "",
        "Milestone2OdoKm": 0.5,
        "OvernightLocationID": 0,
        "VehicleCategory": ""
      },
      "Response": {
        "ResponseCode": 0,
        "ResponseMessage": ""
      }
    }
  ]
}

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

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

403 — Valeurs à mettre à jour invalides.

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

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

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

« Kilométrage Lieux personnalisés »