Veículo

O endpoint PostAddVehicle é responsável pelo cadastro de um novo veículo no sistema MIMS e pode ser visualizado na tela CAD056.

---

Como cadastrar um veículo

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/PostAddVehicle
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddVehicle"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
VehicleNo	String(10)	Não	Código externo do veículo
VehiclePlateNo	String(8)	Sim	Placa do veículo
Name	String(40)	Sim	Descrição do veículo
ShortName	String(15)	Não	Descrição reduzida do veículo
TransporterNo	String(25)	Sim	Código externo do Transportador
DriverNo	String(25)	Sim	Código externo do Motorista
VehicleTypeNo	String(15)	Não	Código externo do Tipo de Veículo
StandardTare	Float	Não	Tara Padrão do Veículo
TareTolerance	Float	Não	Tolerância da Tara
FreightFactor	Float	Não	Fator de Frete do Abatido
KmValue	Float	Não	Valor do Km
KgValue	Float	Não	Valor do Kg
LoadCapacity	Float	Não	Capacidade de Carga
StateInitials	String(10)	Não	Sigla do estado do veículo
SealQty	Integer	Não	Quantidade de Lacres
VehicleIdentification	String(15)	Não	Identificação do Veículo
IsInactiveVehicle	Boolean	Não	Flag que indica que o veículo está inativo
TruckType	TruckType	Não	Enumerador com os possíveis valores para o Tipo de Carroceria (MDFe): ttNotApplicable (Não Aplicável), ttOpening (Aberta), ttClosedOrBoxTrust (Fechada/Baú), ttTrailerTruck (Graneleira), ttContainerDoor (Porta Contêiner) ou ttSider (Sider)
LogisticsTypeNo	String(25)	Não	Tipo de Logística
IsLoadWithInsurance	Boolean	Não	Flag que indica que a carga é assegurada
IsNotReleasedLoading	Boolean	Não	Flag que indica que o veículo NÃO está liberado para carregamento (true = não liberado, false = liberado)
IsNotAvailable	Boolean	Não	Flag que indica que o veículo NÃO está disponível (true = não disponível, false = disponível)
TransportTypeNo	String(25)	Não	Código externo do Tipo de Transporte
OwnVehicle	Boolean	Não	Flag que indica que é veículo próprio
OverwriteIfExists	Boolean	Não	Flag que indica que os dados devem ser sobrescritos caso o registro já exista

---

Retorno

Parâmetro	Tipo	Obrigatório	Descrição
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do WebService na execução do método
VehicleCode	Integer	Sim	Código interno do veículo gerado no sistema MIMS

---

Exemplo 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
}'

---

Exemplo de Response

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

---

🐞 Possíveis Erros

Código	Mensagem
AVH‑001	Parâmetro Código Externo do Transportador (TransporterNo) pertence a um fornecedor que não é do tipo "Transportador". Operação não permitida!
AVH‑002	Parâmetro Placa do Veículo (VehiclePlateNo) informado já existe!
AVH‑003	Não existe Transportador padrão para a placa informada ([valor enviado na requisição])!
AVH‑004	Não existe Motorista padrão para a placa informada ([valor enviado na requisição])!

---