Integração de Veículos


Método para realizar a integração de um novo veículo (placas de cavalos, carretas ou utilitários).


Request


  • ENDPOINT: Veiculo/Integrar
  • VERBO: POST


Índice Chave Descrição Elem. Tipo Ocor. Tam. Versão
1 CNPJAplicacao CNPJ para autenticação. E Caractere 1-1 14 1.0
2 Token Gerado a partir do CNPJ de autenticação para validar permissões de acesso. E Caractere 1-1 100 1.0
3 CPFCNPJProprietario CPF ou CNPJ do proprietário do veículo, associado a ANTT E Caractere 1-0 14 1.0
4 CPFMotorista CPF do motorista. E Caractere 1-0 11 1.0
5 CNPJEmpresa CNPJ da empresa a qual o veículo pertence. E Caractere 1-1 14 1.0
6 Placa Placa do veículo E Caractere 1-1 7 2.0
7 Chassi Número do chassi E Caractere 1-1 22 1.0
8 RENAVAM Número do RENAVAM E Inteiro 1-1 11 1.0
9 AnoFabricacao Ano de fabricação do veículo E Inteiro 1-0 10 1.0
10 AnoModelo Ano do modelo E Inteiro 1-0 10 1.0
11 Marca Marca do Veículo E Caractere 1-1 20 1.0
12 Modelo Modelo do Veículo E Caractere 1-1 50 1.0
13 ComTracao Se possui tração:
true - Sim: Cavalo/Utilitário
false - Não: Carreta
E Booleano 1-1 True/False 1.0
14 TipoRodagem Enum de tipo de rodagem, podendo ser eles:
1 - Simples;
2 - Duplo.
E Inteiro 1-0 1 1.0
15 IdTipoCarreta Id do tipo de carreta E Inteiro 1-0 10 1.0
16 TipoContrato Tipo de contrato do veículo, podendo ser eles:
1 - Frota;
2 - Cooperado;
3 - Agregado;
E Inteiro 1-1 1 1.0
17 QuantidadeEixos Quantidade de eixos do veículo.
IMPORTANTE enviar a quantidade correta de eixos, pois o calculo de pedágio é baseado nesta quantidade.
E Inteiro 1-1 10 1.0
18 IdTipoCavalo Id do tipo de cavalo E Inteiro 1-0 10 1.0
19 NumeroFrota Número da frota do veículo E Inteiro 1-0 10 1.0
20 CodigoDaOperacao Código da operação que o veículo está vinculado E Inteiro 1-0 10 1.0
21 Município Município do veículo E Caractere 1-0 100 1.0
22 CNPJFilial CNPJ da filial do veículo E Caractere 1-0 14 1.0
23 IdTecnologia Id tecnologia de rastreamento E Inteiro 1-0 10 1.0
24 IBGECidade IBGE da cidade do veículo E Inteiro 1-0 10 1.0
25 CorVeiculo Cor do veículo E Caractere 1-0 100 1.0


Modelo de Json - Request


{
  "CNPJAplicacao": "",
  "Token": "",
  "CPFCNPJProprietario": "",
  "CPFMotorista": "",
  "CNPJEmpresa": "",
  "Placa": "",
  "Chassi": "",
  "RENAVAM": "",
  "AnoFabricacao": "",
  "AnoModelo": "",
  "Marca": "",
  "Modelo": "",
  "ComTracao": 1,
  "TipoRodagem": 1, 
  "IdTipoCarreta": 0,
  "TipoContrato": 1,
  "QuantidadeEixos": 0,
  "IdTipoCavalo": 0,
  "NumeroFrota": 0,
  "CodigoDaOperacao": 1,
  "Municipio": "",
  "CNPJFilial": "",
  "IdTecnologia": 0,
  "IBGECidade": 0,
  "CorVeiculo": ""
}


Response


Índice Chave Descrição Elem. Tipo Ocor. Tam. Versão
1 Sucesso Requisição realizada com sucesso ou não E Booleano 1-1 True/False 1.0
2 Mensagem Mensagem de retorno E Caractere 1-1 100 1.0
3 Objeto Objeto pai que contém o proprietário G 0-1 1.0
3.1 IdEmpresa Código da empresa E Inteiro 1-1 10 1.0
3.2 IdVeiculo Código do veiculo E Inteiro 1-1 10 1.0
3.3 IdFilial Código da filial E Inteiro 0-1 10 1.0
3.4 IdProprietario Código do proprietário E Inteiro 1-1 10 1.0
3.5 IdMotorista Código do motorista E Inteiro 0-1 10 1.0
3.6 Placa Placa E Caractere 1-1 7 1.0
3.7 Chassi Chassi E Caractere 1-1 100 1.0
3.8 AnoFabricacao Ano de fabricação E Inteiro 0-1 10 1.0
3.9 AnoModelo Ano do modelo E Inteiro 0-1 10 1.0
3.10 Marca Marca E Caractere 1-1 100 1.0
3.11 Modelo Modelo E Caractere 1-1 100 1.0
3.12 RENAVAM Número do RENAVAM E Caractere 1-1 100 1.0
3.13 ComTracao Representa se o veículo possui tração ou não E Booleano 1-1 True/False 1.0
3.14 TipoRodagem Enum de tipo de rodagem, podendo ser eles:
1 - Simples;
2 - Duplo.
E Inteiro 0-1 1 1.0
3.15 QuantidadeEixos Quantidade de eixos E Inteiro 0-1 2 1.0
3.16 CodigoDaOperacao Código da operação à qual o veículo está vinculado E Inteiro 0-1 10 1.0
3.17 IdTipoCavalo Código do tipo de cavalo E Inteiro 0-1 10 1.0
3.18 IdTipoCarreta Código do tipo de carreta E Inteiro 0-1 10 1.0
3.19 NumeroFrota Número da frota E Inteiro 0-1 10 1.0
3.20 Ativo Se está ativo ou não E Booleano 1-1 True/False 1.0
3.21 TipoCavalo Objeto pai que contém informações do tipo do cavalo G 0-1 1.0
3.21.1 IdTipoCavalo Código do tipo de cavalo E Inteiro 0-1 10 1.0
3.21.2 Nome Nome do tipo da cavalo E Caractere 0-1 100 1.0
3.21.3 Categoria Enum de categoria de cavalo, podendo ser eles:
1 - Leves;
2 - Médios;
3 - Pesados.
E Inteiro 0-1 1 1.0
3.21.4 CategoriaDescricao Descrição da categoria E Caractere 0-1 100 1.0
3.21.5 NumeroEixos Numero de eixos do tipo de cavalo E Inteiro 0-1 2 1.0
3.21.6 Capacidade Capacidade do tipo do cavalo E Inteiro 0-1 10 1.0
3.21.7 Ativo Se o tipo do cavalo esta ativa no sistema E Booleano 0-1 True/False 1.0
3.22 TipoCarreta Objeto pai que contém informações do tipo da carreta G 0-1 1.0
3.22.1 IdTipoCarreta Código do tipo de carreta E Inteiro 0-1 10 1.0
3.22.2 Nome Nome do tipo da carreta E Caractere 0-1 100 1.0
3.22.3 Categoria Enum de categoria de carreta, podendo ser eles:
1 - Fechada;
2 - Aberta;
3 - Especial.
E Inteiro 0-1 1 1.0
3.22.4 CategoriaDescricao Descrição da categoria E Caractere 0-1 100 1.0
3.22.5 Capacidade Capacidade da carreta E Inteiro 0-1 10 1.0
3.22.6 Ativo Se o tipo da carreta esta ativa no sistema E Booleano 0-1 True/False 1.0


Modelo de Json - Response


{
  "Sucesso": true,
  "Mensagem": null,
  "Objeto": {
    "Placa": "",
    "IdEmpresa": 0,
    "IdVeiculo": 0,
    "IdFilial": 0,
    "IdProprietario": 0,
    "IdMotorista": 0,
    "Placa": "",
    "Chassi": "",
    "AnoFabricacao": 0,
    "AnoModelo": 0,
    "Marca": "",
    "Modelo": "",
    "RENAVAM": "",
    "ComTracao": false,
    "TipoRodagem": 1,
    "QuantidadeEixos": 0,
    "StatusIntegracao": 1,
    "CodigoDaOperacao": null,
    "IdTipoCavalo": 0,
    "IdTipoCarreta": 0,
    "NumeroFrota": null,
    "Ativo": true,
    "TipoCavalo": {
        "IdTipoCavalo": 0,
        "Nome": "",
        "Categoria": 1,
        "CategoriaDescricao": null,
        "NumeroEixos": 0,
        "Capacidade": 0,
        "Ativo": true,
    },
    "TipoCarreta": {
        "IdTipoCarreta": 0,
        "Nome": "",
        "Categoria": 1,
        "CategoriaDescricao": null,
        "Capacidade": 0,
        "Ativo": true,
    }
  }
}