Pular para o conteúdo principal

Cadastros

Endpoints de criação/alteração de entidades. A maioria usa POST com body JSON.

Códigos de retorno: Códigos de resposta.

cadcli — Cliente​

POST /api?m=cadcli
Content-Type: application/json

{ "cliente": { ... } }

Body: JSON com objeto cliente (campos espelham entidade Cliente).

Resposta:

{ "status": 100, "message": "Cadastrado com sucesso" }

Erros comuns: cliente duplicado (211), não autorizado (201), nível de bloqueio inválido (213).

cadvei — Veículo​

POST /api?m=cadvei
Content-Type: application/json

{ "veiculo": { ... } }

Body: JSON com objeto veiculo (placa, cliente, equipamento, combustível, etc.).

Validações incluem: equipamento existente e disponível, serial único, veículo duplicado.

cadequi — Equipamento​

POST /api?m=cadequi
Content-Type: application/json

{ "equipamento": { ... } }

Body: JSON com dados do equipamento (número/serial, tipo, operadora, IMEI, etc.).

addpoi — Ponto de interesse​

GET /api?m=addpoi&lat=-23.5&lon=-46.6&name=Depósito&uf=SP&cidade=São Paulo&endereco=Rua X&cep=01000&icone=1
ParâmetroObrigatórioDescrição
lat, lonSimCoordenadas
nameSimNome do POI
ufNãoEstado
cidadeNãoCidade
enderecoNãoEndereço
cepNãoCEP
iconeNãoID do ícone

Se já existir POI com mesmo nome (case insensitive) no cliente, atualiza em vez de criar.

Resposta: ID do ponto criado/atualizado (texto).

addAncora — Âncora​

Ativa âncora na última posição do veículo.

GET /api?m=addAncora&veiculo=123
ParâmetroObrigatórioDescrição
veiculoSimID do veículo

Resposta: código numérico (0 = sucesso, outros = erro).

Notas de implementação​

  • Cadastros registram log de alteração (LogAlteracao) com IP e usuário.
  • cadcli, cadvei, cadequi leem o body via ServletInputStream (stream completo).
  • Permissões de escrita dependem do perfil do usuário logado.