Téléverser une inspection annuelle

POST/app/v1/documents/smart-upload/

Téléverse un rapport d'inspection annuelle fédérale (FHWA), aussi appelé smart upload. DPB lit le rapport avec l'IA, le classe sur le bon véhicule ou la bonne remorque et fixe la date d'expiration à partir de la date d'inspection imprimée dessus. Cet endpoint ne traite que les inspections annuelles. Pour les autres documents, utilisez Créer un document.

Envoyez seulement le fichier et DPB trouve l'unité et la date d'inspection dans le rapport, et fixe l'expiration un an après cette date. Envoyez unit_no pour choisir l'unité vous-même ; le rapport est quand même lu pour la date d'inspection. Envoyez expiry_frame pour utiliser une autre durée.

La date propre du document est toujours le jour du téléversement. Si le rapport ne peut pas être lu, le fichier est quand même enregistré et la réponse l'indique, pour que vous le complétiez dans le tableau de bord.

Autorisation

X-API-KEYstring · en-têteobligatoire

La clé API de votre entreprise.

Corps de la requête

multipart/form-data · obligatoire

filefileobligatoire

Le rapport d'inspection : PDF, PNG, JPG, JPEG, TIFF ou TIF.

descriptionstring

Description du document. Par défaut Annual Inspection.

unit_nostring

Numéro d'unité sur laquelle classer le rapport. S'il est envoyé, l'unité n'est pas lue dans le rapport. Il doit correspondre exactement au numéro d'unité dans DPB, majuscules et minuscules comprises. Si aucune unité active n'a ce numéro, la requête est refusée et rien n'est enregistré.

unit_typeenum

À utiliser avec unit_no quand un véhicule et une remorque ont le même numéro d'unité.

Valeurs possibles : Vehicle Trailer

expiry_frameenum

Durée d'expiration comptée à partir de la date d'inspection imprimée sur le rapport. Par défaut 1 yr.

Valeurs possibles : 3 mo 6 mo 1 yr 2 yr 3 yr 4 yr 5 yr

Réponse

201L'enregistrement

successboolean

document_idinteger

L'ID du nouveau document.

equipment_unit_nostring

Numéro d'unité du véhicule ou de la remorque sur lequel le rapport a été classé.

equipment_typeenum

Valeurs possibles : Vehicle Trailer

vin_numberstring

VIN de l'unité.

unit_nostring

extracted_datestring (date)

Date d'inspection lue dans le rapport.

expiry_datestring (date)

Date d'inspection plus la durée d'expiration.

messagestring

Un court résumé de ce qui s'est passé.

detailsstring

Comment l'unité a été trouvée et l'expiration fixée.

errorstring

Seulement quand le rapport a été enregistré mais n'a pas pu être lu, par exemple Analysis timeout.

Autres réponses

201Enregistré, mais le rapport n'a pas pu être lu. Ouvrez le document dans le tableau de bord pour indiquer l'unité et les dates.

{
  "success": true,
  "document_id": 12345,
  "message": "Annual Inspection document saved but data extraction failed",
  "error": "Analysis timeout"
}

400Ce type de fichier n'est pas pris en charge.

{
  "file": [
    "Unsupported file format. Supported formats: .png, .jpg, .jpeg, .pdf, .tiff, .tif"
  ]
}

400Aucune unité active n'a ce unit_no. Rien n'a été enregistré.

{
  "error": "No active Trailer found with unit no 'T1001'."
}

400Un champ a une valeur non autorisée.

{
  "expiry_frame": [
    "\"180 days\" is not a valid choice."
  ]
}

500Un problème est survenu de notre côté. Réessayez, ou contactez le support si cela continue.

{
  "error": "Failed to process Annual Inspection document"
}