Skip to content

Latest commit

 

History

History
336 lines (295 loc) · 10.7 KB

documentacao.md

File metadata and controls

336 lines (295 loc) · 10.7 KB
Raw

Solicitação para veiculo.api:

https://localhost:44352/api/



USUARIO



• Url: https://localhost:44352/api/Usuario
o Parâmetros: { "Id" : "0", "Nome":"Carlos", "Email": "Casdfasd@f", "Senha" :"asdfas" };
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Adiciona Valores a base de dados;
o Http: POST;

• Url: https://localhost:44352/api/Usuario/Logar
o Parâmetros: { "Email": "Casdfasd@f", "Senha" :"asdfas" };
o Autenticação: Não Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Autentica acesso;
o Http: POST;

• Url: https://localhost:44352/api/Usuario/{id}
o Parâmetros: Id do usuario passado na url;
o Autenticação: Necessária;
o Retorno: JSON;
o Funcionalidade: Busca o Usuario com o id relacionado na base de dados;
o Http: GET;

RELATÓRIO



• Url: https://localhost:44352/api/Abastecimento/GerarRelatorio/{id_veiculo}/{mes}/{ano}
o Parâmetros: Passados na url;
o Autenticação: Necessária;
o Retorno: JSON;
o Funcionalidade: Busca o relatório relacionado ao veiculo no período de 1 ano;
o Http: GET;

• Url: https://localhost:44352/api/Abastecimento/GerarRelatorio/05/2020
o Parâmetros: Passados na url;
o Autenticação: Necessária;
o Formato de Retorno: JSON;
o Funcionalidade: Busca o relátorio no período de 1 ano para todos os veículos;
o Http: GET;

ABASTECIMENTO



• Url: https://localhost:44352/api/Abastecimento/GravarAbastecimento
o Parâmetros: { "id": 0, "km": 500, "litro": 50.0, "valor": 50.00, "data": "2020-03-02T00:00:00", "posto": "Teste2", "tipoCombustivelId": 1, "veiculoId": 2, "usuarioId": 1 };
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Adiciona Valores a base de dados;
o Http: POST;

• Url: https://localhost:44352/api/Abastecimento/AlterarAbastecimento
o Parâmetros: { "id": 4, "km": 530, "litro": 50.0, "valor": 50.00, "data": "2020-03-02T00:00:00", "posto": "Teste3", "tipoCombustivelId": 1, "veiculoId": 2, "usuarioId": 1 };
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Altera valores a base de dados com base no Id informado;
o Http: PUT;
• Url: https://localhost:44352/api/Abastecimento/BuscarAbastecimento
o Parâmetros: Não necessário;
o Autenticação: Necessária;
o Retorno: JSON;
o Funcionalidade: Busca todos os Abastecimentos cadastrados;
o Http: GET;

• Url: https://localhost:44352/api/Abastecimento/BuscarAbastecimento{id}
o Parâmetros: Id do obastecimento passado na url;
o Autenticação: Necessária;
o Formato de Retorno: JSON;
o Funcionalidade: Busca o Abastecimento relacionado ao Id informado na url;
o Http: GET;

• Url: https://localhost:44352/api/Abastecimento/ExcluirAbastecimento/{id}
o Parâmetros: Id do obastecimento passado na url;
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Exclui o Abastecimento relacionado ao Id informado na url;
o Http: DELETE;

VEÍCULO



• Url: https://localhost:44352/api/Veiculo/GravarVeiculo
o Parâmetros: {"id": 0, "ano": 2008, "placa": "ABCB123", "quilometragem": 750, "foto": null, "modeloVeiculoId": 1, "marcaVeiculoId": 1, "usuarioId": 1, "tipoCombustivelId": 1, "tipoVeiculoId": 1 };
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Adiciona Valores a base de dados;
o Http: POST;

• Url: https://localhost:44352/api/Veiculo/AlterarMarcaVeiculo
o Parâmetros: { "id": 1, "ano": 2009, "placa": "ABC6123", "quilometragem": 790, "foto": null, "modeloVeiculoId": 1, "marcaVeiculoId": 1, "usuarioId": 1, "tipoCombustivelId": 1, "tipoVeiculoId": 1 };
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Altera valores a base de dados com base no Id informado;
o Http: PUT;


• Url: https://localhost:44352/api/Veiculo/BuscarVeiculo
o Parâmetros: Não necessário;
o Autenticação: Necessária;
o Retorno: JSON;
o Funcionalidade: Busca todos os Veiculos cadastrados;
o Http: GET;

• Url: https://localhost:44352/api/Veiculo/BuscarVeiculo/{id}
o Parâmetros: Id do veiculo passada na url;
o Autenticação: Necessária;
o Formato de Retorno: JSON;
o Funcionalidade: Busca o Veiculo relacionado ao Id informado na url;
o Http: GET;

• Url: https://localhost:44352/api/Veiculo/ExcluirVeiculo/{id}
o Parâmetros: Id do veiculo passado na url;
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Exclui Veiculo relacionado ao Id informado na url;
o Http: DELETE;

MARCA VEÍCULO



• Url: https://localhost:44352/api/Veiculo/GravarMarcaVeiculo
o Parâmetros: { "Id" : "0", "Nome":"Honda" };
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Adiciona Valores abase de dados;
o Http: POST;

• Url: https://localhost:44352/api/Veiculo/AlterarMarcaVeiculo
o Parâmetros: { "Id" : "1", "Nome":"Honda" };
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Altera valores a base de dados com base no Id informado;
o Http: PUT;


• Url: https://localhost:44352/api/Veiculo/BuscarMarcaVeiculo
o Parâmetros: Não necessário;
o Autenticação: Necessária;
o Retorno: JSON;
o Funcionalidade: Busca todas as Marcas de Veiculos cadastradas;
o Http: GET;

• Url: https://localhost:44352/api/Veiculo/BuscarMarcaVeiculo/{id}
o Parâmetros: Id da marca do veiculo passada na url;
o Autenticação: Necessária;
o Formato de Retorno: JSON;
o Funcionalidade: Busca a Marca de Veiculo relacionado ao Id informado na url;
o Http: GET;

• Url: https://localhost:44352/api/Veiculo/ExcluirMarcaVeiculo/{id}
o Parâmetros: Id da marca do veiculo passada na url;
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Exclui a Marca de Veiculo relacionado ao Id informado na url;
o Http: DELETE;

MODELO VEÍCULO



• Url: https://localhost:44352/api/Veiculo/GravarModeloVeiculo
o Parâmetros: {"Id" : "0", "Nome":"Fusca"};
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Adiciona Valores abase de dados;
o Http: POST;

• Url: https://localhost:44352/api/Veiculo/AlterarModeloVeiculo
o Parâmetros: {"Id" : "1", "Nome":"Gol"}
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Altera valores a base de dados com base no Id informado;
o Http: PUT;

• Url: https://localhost:44352/api/Veiculo/BuscarModeloVeiculo
o Parâmetros: Não necessário
o Autenticação: Necessária;
o Retorno: JSON;
o Funcionalidade: Busca todos os Modelos de Veiculos cadastrados;
o Http: GET;

• Url: https://localhost:44352/api/Veiculo/BuscarModeloVeiculo/{id}
o Parâmetros: Id da marca do veiculo passada na url
o Autenticação: Necessária;
o Formato de Retorno: JSON;
o Funcionalidade: Busca o Modelo de Veiculo relacionado ao Id informado na url;
o Http: GET;

• Url: https://localhost:44352/api/Veiculo/ExcluirModeloVeiculo/{id}
o Parâmetros: Id da marca do veiculo passada na url;
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Exclui o Modelo de Veiculo relacionado ao Id informado na url;
o Http: DELETE;

TIPO COMBUSTÍVEL



• Url: https://localhost:44352/api/Veiculo/GravarTipoCombustivel o Parametros: {"Id" : "0", "Nome":"Gasolina"} o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Adiciona Valores abase de dados;
o Http: POST;
• Url: https://localhost:44352/api/Veiculo/AlterarModeloVeiculo
o Parâmetros: {"Id" : "1", "Nome":"Alcool"}
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Altera valores a base de dados com base no Id informado;
o Http: PUT;

• Url: https://localhost:44352/api/Veiculo/BuscarTipoCombustivel
o Parâmetros: Não necessário
o Autenticação: Necessária;
o Retorno: JSON;
o Funcionalidade: Busca todos os Tipos de Combustivel cadastrados;
o Http: GET;

• Url: https://localhost:44352/api/Veiculo/BuscarTipoCombustivel/{id}
o Parâmetros: Id do Tipo de Combustivel passada na url
o Autenticação: Necessária;
o Formato de Retorno: JSON;
o Funcionalidade: Busca o Tipo de Combustivel relacionado ao Id informado na url;
o Http: GET;

• Url: https://localhost:44352/api/Veiculo/ExcluirTipoCombustivel/{id}
o Parâmetros: Id do Tipo de Combustivel passado na url;
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Exclui o Tipo de Combustivel relacionado ao Id informado na url;
o Http: DELETE;

TIPO DE VEICULO



• Url: https://localhost:44352/api/Veiculo/GravarTipoVeiculo o Paremetros: {"Id" : "0", "Nome":"Moto"} o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Adiciona Valores abase de dados;
o Http: POST;
• Url: https://localhost:44352/api/Veiculo/AlterarTipoVeiculo
o Parâmetros: {"Id" : "1", "Nome":"Carro"}
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Altera valores a base de dados com base no Id informado;
o Http: PUT;

• Url: https://localhost:44352/api/Veiculo/BuscarTipoVeiculo
o Parâmetros: Não necessário
o Autenticação: Necessária;
o Retorno: JSON;
o Funcionalidade: Busca todos os Tipos de Veiculos cadastrados;
o Http: GET;

• Url: https://localhost:44352/api/Veiculo/BuscarTipoVeiculo/{id}
o Parâmetros: Id do Tipo de Veiculo passada na url
o Autenticação: Necessária;
o Formato de Retorno: JSON;
o Funcionalidade: Busca o Tipo de Veiculo relacionado ao Id informado na url;
o Http: GET;

• Url: https://localhost:44352/api/Veiculo/ExcluirTipoVeiculo/{id}
o Parâmetros: Id do Tipo de Veiculo passado na url;
o Autenticação: Necessária;
o Retorno: Sem retorno;
o Funcionalidade: Exclui o Tipo de Veiculo relacionado ao Id informado na url;
o Http: DELETE;