Vehículo

El endpoint PostAddVehicle es responsable de registrar un nuevo vehículo en el sistema MIMS y puede ser visualizado en la pantalla CAD056.

---

Cómo registrar un vehículo

HTTP POST Request

Tipo de Solicitud	URL Ejemplo
POST	{{url_base}}/PostAddVehicle
Ejemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddVehicle"

Parámetros de Entrada

Parámetro	Tipo	Obligatorio	Descripción
VehicleNo	String(10)	No	Código externo del vehículo
VehiclePlateNo	String(8)	Sí	Placa del vehículo
Name	String(40)	Sí	Descripción del vehículo
ShortName	String(15)	No	Descripción reducida del vehículo
TransporterNo	String(25)	Sí	Código externo del Transportista
DriverNo	String(25)	Sí	Código externo del Conductor
VehicleTypeNo	String(15)	No	Código externo del Tipo de Vehículo
StandardTare	Float	No	Tara Estándar del Vehículo
TareTolerance	Float	No	Tolerancia de Tara
FreightFactor	Float	No	Factor de Flete Sacrificado
KmValue	Float	No	Valor por Km
KgValue	Float	No	Valor por Kg
LoadCapacity	Float	No	Capacidad de Carga
StateInitials	String(10)	Sí	Siglas del estado del vehículo
SealQty	Integer	No	Cantidad de sellos
VehicleIdentification	String(15)	No	Identificación del vehículo
IsInactiveVehicle	Boolean	No	Flag que indica que el vehículo está inactivo
TruckType	TruckType	No	Enumerador con los posibles valores para Tipo de Carrocería (MDFe): ttNotApplicable (No Aplicable), ttOpening (Abierto), ttClosedOrBoxTrust (Cerrado/Baú), ttTrailerTruck (Graneleiro), ttContainerDoor (Porta Container) o ttSider (Sider)
LogisticsTypeNo	String(25)	No	Tipo de Logística
IsLoadWithInsurance	Boolean	No	Flag que indica que la carga está asegurada
IsNotReleasedLoading	Boolean	No	Flag que indica que el vehículo NO está liberado para carga (true = no liberado, false = liberado)
IsNotAvailable	Boolean	No	Flag que indica que el vehículo NO está disponible (true = no disponible, false = disponible)
TransportTypeNo	String(25)	No	Código externo del Tipo de Transporte
OwnVehicle	Boolean	No	Flag que indica que es un vehículo propio
OverwriteIfExists	Boolean	No	Flag que indica que los datos deben ser sobrescritos si el registro ya existe

Observación

• La obligatoriedad del parámetro StateInitials se define por configuración. Por defecto, este parámetro es obligatorio. Para cambiar este comportamiento, consulte al consultor responsable.

---

Retorno

Parámetro	Tipo	Obligatorio	Descripción
WebServiceReturn	WebServiceReturn	Sí	Informaciones estándar de respuesta del WebService en la ejecución del método
VehicleCode	Integer	Sí	Código interno del vehículo generado en el sistema MIMS

---

Ejemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddVehicle"' \
--header 'Content-Type: application/json' \
--data '{
    "VehicleNo": "VEH12345",
    "VehiclePlateNo": "ABC1234",
    "Name": "Caminhão Beta",
    "ShortName": "CamBeta",
    "TransporterNo": "TRANS001",
    "DriverNo": "DRV5678",
    "VehicleTypeNo": "TRK001",
    "StandardTare": 7800.5,
    "TareTolerance": 300.0,
    "FreightFactor": 1.2,
    "KmValue": 2.5,
    "KgValue": 0.45,
    "LoadCapacity": 15000,
    "StateInitials": "SP",
    "SealQty": 4,
    "VehicleIdentification": "ID98765",
    "IsInactiveVehicle": false,
    "TruckType": "ttClosedOrBoxTrust",
    "LogisticsTypeNo": "LOG987",
    "IsLoadWithInsurance": true,
    "IsNotReleasedLoading": false,
    "IsNotAvailable": false,
    "TransportTypeNo": "TP001",
    "OwnVehicle": true,
    "OverwriteIfExists": true
}'

---

Ejemplo de Response

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    },
    "VehicleCode": 202
}

---

🐞 Posibles Errores

Código	Mensaje
AVH‑001	El parámetro Código Externo de Transportista (TransporterNo) pertenece a un proveedor que no es de tipo "Transportista". Operación no permitida!
AVH‑002	El parámetro Placa del Vehículo (VehiclePlateNo) informado ya existe!
AVH‑003	No hay Transportista por defecto para la placa informada ([valor enviado en la solicitud])!
AVH‑004	No hay Conductor por defecto para la placa informada ([valor enviado en la solicitud])!

---