Integração de Cadastros de Motoristas


Método para integração dos motoristas.


Request


  • ENDPOINT: Motorista/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 DocumentoUsuarioAudit Documento do usuário que está realizando a operação E Caractere 1-1 14 1.0
4 NomeUsuarioAudit Nome do usuário que está realizando a operação E Caractere 1-1 60 1.0
5 CNPJEmpresa CNPJ da empresa vinculada a este motorista E Caractere 1-1 14 1.0
4 Nome Nome do motorista E Caractere 1-1 100 1.0
5 RG Registro geral/Documento de Identidade E Caractere 1-1 100 1.0
6 RGOrgaoExpedidor Órgão de expedição do registro geral E Caractere 1-1 10 1.0
7 CPF CPF do motorista E Caractere 1-1 11 1.0
8 Sexo Sexo: M ou F (Masculino/Feminino) E Caractere 1-1 1 1.0
9 CNH Carteira nacional de habilitação / Número do Registro da CNH E Caractere 1-1 11 1.0
10 CNHCategoria Categoria da carteira nacional de habilitação: A, B, AB, C, D ou E E Caractere 1-1 2 1.0
11 ValidadeCNH Validade da CNH do motorista E Data 1-1 yy-MM-dd 1.0
12 Celular * Número de contato com DDD E Caractere 1-0 11 1.0
13 TipoContrato Tipo do contrato:
1: Frota,
2: Cooperado,
3: Agregado/Terceiro
 E Inteiro 1-1 10 1.0
14 Email E-mail de contato E Caractere 1-0 100 1.0
15 CEP CEP do endereço E Caractere 1-1 100 1.0
16 Endereco Endereço do motorista E Caractere 1-1 100 1.0
17 Complemento Complemento E Caractere 1-0 100 1.0
18 Numero Número da residência E Caractere 1-0 5 1.0
19 Bairro Bairro E Caractere 1-1 50 1.0
20 IBGECidade Código IBGE da cidade E Inteiro 1-1 10 1.0
21 IBGEEstado Código IBGE do estado E Inteiro 1-1 10 1.0
22 BACENPais Código BACEN do país E Inteiro 1-1 10 1.0
23 NomeMae * Nome da mãe do motorista E Caractere 1-0 100 1.1
24 NomePai * Nome do pai do motorista E Caractere 1-0 100 1.1
25 DataNascimento * Data de nascimento do motorista E Data 1-0 yy-MM-dd 1.1

*Campos opcionais para integração do cadastro, mas obrigatórios para vincular cartão.


Modelo de Json - Request


{
  "CNPJAplicacao": "",
  "Token": "",
  "DocumentoUsuarioAudit": "",
  "NomeUsuarioAudit": "",
  "CPFCNPJUsuario": "",
  "CNPJEmpresa": "",
  "Nome": "",
  "RG": "",
  "RGOrgaoExpedidor": "",
  "CPF": "",
  "Sexo": "",
  "CNH": "",
  "CNHCategoria": "",
  "ValidadeCNH": "2024-12-31",
  "Celular": "",
  "TipoContrato": 1,
  "Email": "",
  "CEP": "",
  "Endereco": "",
  "Complemento": "",
  "Numero": "",
  "Bairro": "",
  "IBGECidade": 0,
  "IBGEEstado": 0,
  "BACENPais": 0,
  "NomeMae": "",
  "NomePai": "",
  "DataNascimento": "1990-12-31"
}


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 Elemento pai que contém as informações da filial G 0-1
3.1 IdMotorista Código do motorista integrado E Inteiro 1-1 10 1.0
3.2 IdEmpresa Código da empresa vinculada E Inteiro 1-1 10 1.0
3.3 Nome Nome do motorista E Caractere 1-1 100 1.0
3.4 RG Registro geral/Documento de Identidade E Caractere 1-1 100 1.0
3.5 RGOrgaoExpedidor Órgão de expedição do registro geral E Caractere 1-1 10 1.0
3.6 CPF CPF do motorista E Caractere 1-1 11 1.0
3.7 Sexo Sexo: M ou F (Masculino/Feminino) E Caractere 1-1 1 1.0
3.8 CNH Carteira nacional de habilitação / Número do Registro da CNH E Caractere 1-1 11 1.0
3.9 CNHCategoria Categoria da carteira nacional de habilitação: A, B, AB, C, D ou E E Caractere 1-1 2 1.0
3.10 ValidadeCNH Validade da CNH do motorista E Data 1-1 yyyy-MM-dd 1.0
3.11 Celular Número de contato com DDD, apenas números E Caractere 0-1 11 1.0
3.12 TipoContrato Tipo do contrato:
1: Frota,
2: Cooperado,
3: Agregado/Terceiro
 E Inteiro 1-1 10 1.0
3.13 Email E-mail de contato E Caractere 0-1 100 1.0
3.14 Ativo Se o motorista está ativo ou não no sistema E Booleano 1-1 True/False 1.0
3.15 TipoMotorista Enum de tipo de pessoa, podendo ser eles:
1 - Física;
2 - Juridica;
E Inteiro 1-1 10 1.0
3.16 CEP CEP do endereço E Caractere 1-1 8 1.0
3.17 Endereco Endereço do motorista E Caractere 1-1 50 1.0
3.18 Complemento Complemento E Caractere 0-1 100 1.0
3.19 Numero Número da residência E Caractere 0-1 5 1.0
3.20 Bairro Bairro E Caractere 1-1 50 1.0
3.21 IdCidade Código da cidade E Inteiro 1-1 10 1.0
3.22 IdEstado Código do estado E Inteiro 1-1 10 1.0
3.23 IdPais Código do país E Inteiro 1-1 10 1.0
3.24 Empresa Elemento pai que contém as informações da empresa vinculada G 1-1
3.24.1 IdEmpresa Código da empresa vinculada E Inteiro 1-1 10 1.0
3.24.2 CNPJ CNPJ da empresa vinculada E Caractere 1-1 14 1.0
3.24.3 RazaoSocial Razão da empresa vinculada E Caractere 1-1 100 1.0
3.24.4 NomeFantasia Nome fantasia da empresa vinculada E Caractere 1-1 100 1.0
3.24.5 Ativo Se a empresa vinculada está ativa ou não no sistema E Booleano 1-1 True/False 1.0
3.24.6 Latitude Latitude da empresa vinculada E Decimal 0-1 10,7 1.0
3.24.7 Longitude Longitude da empresa vinculada E Decimal 0-1 10,7 1.0
3.24.8 CEP CEP da empresa vinculada E Caractere 1-1 8 1.0
3.24.9 Endereco Endereço da empresa vinculada E Caractere 1-1 100 1.0
3.24.10 Bairro Bairro da empresa vinculada E Caractere 1-1 50 1.0
3.24.11 IdCidade Código da cidade da empresa vinculada E Inteiro 1-1 10 1.0
3.24.12 IdEstado Código do estado da empresa vinculada E Inteiro 1-1 10 1.0
3.24.13 IdPais Código do país da empresa vinculada E Inteiro 1-1 10 1.0
3.24.14 Telefone Telefone da empresa vinculada E Caractere 0-1 11 1.0
3.24.15 Email E-mail da empresa vinculada E Caractere 0-1 100 1.0
3.25 Pais Elemento pai que contém informações do país G 1-1
3.25.1 IdPais Código do país E Inteiro 1-1 10 1.0
3.25.2 Nome Nome do país E Caractere 1-1 100 1.0
3.25.3 Sigla Sigla do país E Caractere 0-1 3 1.0
3.25.4 BACEN BACEN do país E Inteiro 1-1 10 1.0
3.26 Estado Elemento pai que contém informações do estado G 1-1
3.26.1 IdPais Código do país E Inteiro 1-1 10 1.0
3.26.2 IdEstado Código do estado E Inteiro 1-1 10 1.0
3.26.3 Nome Nome do estado E Caractere 1-1 100 1.0
3.26.4 Sigla Sigla do estado E Caractere 1-1 3 1.0
3.26.5 Regiao Enum de regiões do brasil podendo ser eles:
0 - Não encontrada;
1 - Sul;
2 - Sudeste;
3 - Norte;
4 - Nordeste;
5 - Centro-Oeste;		 E Inteiro 0-1 10 1.0
3.26.6 IBGE IBGE do estado E Inteiro 1-1 10 1.0
3.26.7 Pais Elemento pai que contém informações do país G 1-1
3.26.7.1 IdPais Código do país E Inteiro 1-1 10 1.0
3.26.7.2 Nome Nome do país E Caractere 1-1 100 1.0
3.26.7.3 Sigla Sigla do país E Caractere 0-1 3 1.0
3.26.7.4 BACEN BACEN do país E Inteiro 1-1 10 1.0
3.27 Cidade Elemento pai que contém informações da cidade G 1-1
3.27.1 IdCidade Código da cidade E Inteiro 1-1 10 1.0
3.27.2 IdPais Código do país E Inteiro 1-1 10 1.0
3.27.3 IdEstado Código do estado E Inteiro 1-1 10 1.0
3.27.4 Nome Nome da cidade E Caractere 1-1 100 1.0
3.27.5 IBGE IBGE da cidade E Inteiro 1-1 10 1.0
3.27.6 Latitude Latitude da cidade E Decimal 0-1 10,7 1.0
3.27.7 Longitude Longitude da cidade E Decimal 0-1 10,7 1.0
3.27.8 Estado Elemento pai que contém informações do estado G 1-1
3.27.8.1 IdPais Código do país E Inteiro 1-1 10 1.0
3.27.8.2 IdEstado Código do estado E Inteiro 1-1 10 1.0
3.27.8.3 Nome Nome do estado E Caractere 1-1 100 1.0
3.27.8.4 Sigla Sigla do estado E Caractere 1-1 3 1.0
3.27.8.5 Regiao Enum de regiões do brasil podendo ser eles:
0 - Não encontrada;
1 - Sul;
2 - Sudeste;
3 - Norte;
4 - Nordeste;
5 - Centro-Oeste;		 E Inteiro 0-1 10 1.0
3.27.8.6 IBGE IBGE do estado E Inteiro 1-1 10 1.0
3.27.8.7 Pais Elemento pai que contém informações do país G 1-1
3.27.8.7.1 IdPais Código do país E Inteiro 1-1 10 1.0
3.27.8.7.2 Nome Nome do país E Caractere 1-1 100 1.0
3.27.8.7.3 Sigla Sigla do país E Caractere 0-1 3 1.0
3.27.8.7.4 BACEN BACEN do país E Inteiro 1-1 10 1.0


Modelo de Json - Response


{
  "Sucesso": true,
  "Mensagem": "",
  "Objeto": {
    "IdMotorista": 0,
    "IdEmpresa": 0,
    "Nome": "",
    "RG": "",
    "RGOrgaoExpedidor": "",
    "CPF": "",
    "Sexo": "",
    "CNH": "",
    "ValidadeCNH": "2024-12-31",
    "DataValidadeCNH": null,
    "CNHCategoria": "",
    "Celular": "",
    "TipoContrato": 1,
    "Email": "",
    "Ativo": true,
    "TipoMotorista": 1,
    "CEP": "",
    "Endereco": "",
    "Complemento": "",
    "Numero": "",
    "Bairro": "",
    "IdPais": 0,
    "IdCidade": 0,
    "IdEstado": 0,
    "Empresa": {
      "IdEmpresa": 0,
      "CNPJ": "",
      "RazaoSocial": "",
      "NomeFantasia": "",
      "Ativo": true,
      "Latitude": 0.0,
      "Longitude": 0.0,
      "CEP": "",
      "Endereco": "",
      "Complemento": "",
      "Bairro": "",
      "IdCidade": 0,
      "IdEstado": 0,
      "IdPais": 0,
      "Telefone": "",
      "Email": "",
    },
    "Pais": {
      "IdPais": ,
      "Nome": "",
      "Sigla": null,
      "BACEN": 0
    },
    "Estado": {
      "IdEstado": 0,
      "IdPais": 0,
      "Nome": "",
      "Sigla": "",
      "Regiao": 0,
      "IBGE": 0,
      "Pais": {
        "IdPais": 0,
        "Nome": "",
        "Sigla": null,
        "BACEN": 0
      }
    },
    "Cidade": {
      "IdCidade": 0,
      "IdPais": 0,
      "IdEstado": 0,
      "Nome": "",
      "IBGE": 0,
      "Latitude": 0.0,
      "Longitude": 0.0,
      "Estado": {
        "IdEstado": 0,
        "IdPais": 0,
        "Nome": "",
        "Sigla": "",
        "Regiao": 0,
        "IBGE": 0,
        "Pais": {
          "IdPais": 0,
          "Nome": "",
          "Sigla": null,
          "BACEN": 0
        }
      }
    }
  }
}