Changer l'équipement du chauffeur

POST/app/v1/drivers/change-equipment/

Définit le véhicule ou la remorque affecté à un ou plusieurs chauffeurs, par nom d'utilisateur et numéro d'unité. Si un chauffeur a un co-chauffeur, le changement est aussi synchronisé avec lui.

Chaque changement est vérifié séparément. La réponse est 200 quand tous réussissent, 207 quand seulement certains réussissent (réussites dans results, échecs dans errors) et 400 quand aucun ne réussit. L'unité doit être active.

Autorisation

X-API-KEYstring · en-têteobligatoire

La clé API de votre entreprise.

Corps de la requête

application/json · obligatoire

updatesliste de objectobligatoire

Une entrée par changement. Au moins une.

Voir les champs

usernamestringobligatoire

Le nom d'utilisateur du chauffeur dans DPB.

unit_nostringobligatoire

Numéro d'unité d'un véhicule ou d'une remorque actif.

typeenumobligatoire

Indique si l'unité est le véhicule ou la remorque du chauffeur.

Valeurs possibles : Vehicle Trailer

Réponse

200L'enregistrement

resultsliste de object

Changements réussis.

Voir les champs

usernamestring

unit_nostring

typeenum

Valeurs possibles : Vehicle Trailer

statusenum

Valeurs possibles : success error

messagestring

Ce qui s'est passé pour ce changement.

errorsliste de object

Changements échoués, avec la raison. Seulement quand certains ou tous ont échoué.

Voir les champs

usernamestring

unit_nostring

typeenum

Valeurs possibles : Vehicle Trailer

statusenum

Valeurs possibles : success error

messagestring

Ce qui s'est passé pour ce changement.

Autres réponses

207Certains changements ont réussi et d'autres ont échoué.

{
  "results": [
    {
      "username": "driver1",
      "unit_no": "1001",
      "type": "Vehicle",
      "status": "success",
      "message": "Successfully updated default vehicle for driver1 to 1001"
    }
  ],
  "errors": [
    {
      "username": "driver2",
      "unit_no": "9999",
      "type": "Vehicle",
      "status": "error",
      "message": "Active equipment with unit_no '9999' and type 'Vehicle' not found."
    }
  ]
}

400Aucun changement n'a réussi. Causes habituelles : le nom d'utilisateur n'existe pas dans votre entreprise, ou le numéro d'unité n'est pas un véhicule ou une remorque actif de ce type.

{
  "results": [],
  "errors": [
    {
      "username": "nonexistent_driver",
      "unit_no": "1001",
      "type": "Vehicle",
      "status": "error",
      "message": "Driver with username 'nonexistent_driver' not found."
    }
  ]
}