Subir una inspección anual

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

Sube un reporte de inspección anual federal (FHWA), también llamado smart upload. DPB lee el reporte con IA, lo archiva en el vehículo o remolque correcto y fija la fecha de vencimiento a partir de la fecha de inspección impresa en él. Este endpoint solo maneja inspecciones anuales. Para otros documentos, use Crear un documento.

Si envía solo el archivo, DPB encuentra la unidad y la fecha de inspección en el reporte y fija el vencimiento un año después de esa fecha. Envíe unit_no para elegir la unidad usted mismo; el reporte se sigue leyendo para obtener la fecha de inspección. Envíe expiry_frame para usar otro plazo de vencimiento.

La fecha propia del documento siempre es el día de la carga. Si el reporte no se puede leer, el archivo se guarda igual y la respuesta lo indica, para que lo complete en el panel.

Autorización

X-API-KEYstring · encabezadoobligatorio

La clave de API de su empresa.

Cuerpo de la solicitud

multipart/form-data · obligatorio

filefileobligatorio

El reporte de inspección: PDF, PNG, JPG, JPEG, TIFF o TIF.

descriptionstring

Descripción del documento. Por defecto Annual Inspection.

unit_nostring

Número de unidad en la que se archiva el reporte. Si se envía, la unidad no se lee del reporte. Debe coincidir exactamente con el número de unidad en DPB, incluidas mayúsculas y minúsculas. Si ninguna unidad activa tiene ese número, la solicitud se rechaza y no se guarda nada.

unit_typeenum

Úselo con unit_no cuando un vehículo y un remolque comparten el mismo número de unidad.

Uno de: Vehicle Trailer

expiry_frameenum

Plazo de vencimiento contado desde la fecha de inspección impresa en el reporte. Por defecto 1 yr.

Uno de: 3 mo 6 mo 1 yr 2 yr 3 yr 4 yr 5 yr

Respuesta

201El registro

successboolean

document_idinteger

El ID del nuevo documento.

equipment_unit_nostring

Número de unidad del vehículo o remolque en el que se archivó el reporte.

equipment_typeenum

Uno de: Vehicle Trailer

vin_numberstring

VIN de la unidad.

unit_nostring

extracted_datestring (date)

Fecha de inspección leída del reporte.

expiry_datestring (date)

Fecha de inspección más el plazo de vencimiento.

messagestring

Un breve resumen de lo que pasó.

detailsstring

Cómo se identificó la unidad y se fijó el vencimiento.

errorstring

Solo cuando el reporte se guardó pero no se pudo leer, por ejemplo Analysis timeout.

Otras respuestas

201Guardado, pero el reporte no se pudo leer. Abra el documento en el panel para indicar la unidad y las fechas.

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

400El tipo de archivo no es compatible.

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

400Ninguna unidad activa tiene ese unit_no. No se guardó nada.

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

400Un campo tiene un valor no permitido.

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

500Algo falló de nuestro lado. Inténtelo de nuevo o contacte a soporte si sigue pasando.

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