diff --git a/.gitignore b/.gitignore index a086d74..010493a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +#Qr Codes +qrCodes + # Compiled class file *.class diff --git a/README.md b/README.md index 8d02255..e1f18c7 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,150 @@ O servidor fica em modo handler, aguardando requisições. As requisições resu Os serviços estarão listados no fim deste documento, porém também estão disponíveis pelo [PROJETO](https://github.com/Duzz-Clean/DuzzClean-API/projects/1), ou pelo [Escopo de Desenvolvimento](https://github.com/Duzz-Clean/DuzzClean-API/issues/1) -##### Rotas:: - -Rota: "/novo_veiculo" = encaminhar para fazer o cadastramento de um novo veículo; -Rota: "/novo_usuario" = encaminhar para fazer o cadastramento de um novo usuário; -Rota: "/nova_limpeza" = encaminha para fazer o cadastramento de uma nova limpeza; -Rota: "/nova_avaliacao" = encaminha para fazer o cadastramento de uma nova avaliação; -Rota: "/recusa_notificacao" = encaminha para salvar a recusa de notificação de limpeza do veículo; -Rota: "/grava_envio_notificao" = encaminha para gravar no bd do veículo as notificações que ele recebeu; -Rota: "/solicitar_limpeza" = encaminha o usuário para mandar notificação ao veículo solicitando nova limpeza; -Rota: "/autenticar_usuario" = encaminha onde o usuário será autenticado para entrar no app; -Rota: "/buscar_notificacoes" = encaminha para busca as notificações recebidas; -Rota: "/buscar_limpezas_veiculo" = encaminha para mostrar as limpezas do veículo; -Rota: "/buscar_resumo_veiculo" = encaminha para mostra ao cliente o resumo de um veículo; -Rota: "/buscar_ultima_limpeza_veiculo" = encaminha para mostrar quando foi a última limpeza do veículo. +##### Rotas: + +*__/novo_veiculo__* + + Função : Encaminhar para fazer o cadastramento de um novo veículo + Método : POST + Entrada: + JSON: + ["LicensePlate"] = Placa do carro; + ["Username] = Usuário do motorista; + Retorno: + JSON: + ["Message"] = "OK" ou Descrição de erro + +*__/novo_usuario__* + + Função : Encaminhar para fazer o cadastramento de um novo usuário; + Método : POST + Entrada: + JSON: + ["Username"] = Nome de usuário ou email; + ["Password"] = Senha digitada pelo usuário + ["FirstName"] = Primeiro nome do usuário + ["SecondName"] = Segundo nome do usuário + ["UserType"] = Tipo de usuário (1, 2, 3) + Retorno: + JSON: + ["Message"] = "OK" ou Descrição de erro + +*__/nova_limpeza__* + + Função: Encaminha para fazer o cadastramento de uma nova limpeza + Método: POST + Entrada: + JSON: + ["LicensePlate"] = Placa do carro + ["Date"] = Data e hora e segundos realização + Retorno: + JSON: + ["Message"] = "OK" ou Descrição de erro + + + +*__/nova_avaliacao__* + + Função : Encaminha para fazer o cadastramento de uma nova avaliação; + Método : POST + Entrada: + JSON: + ["LicensePlate"] = Placa do carro + ["Rating"] = Nota de 0 a 5 + ["Comment"] = Comentários do usuário + Retorno: + JSON: + ["Message"] = "OK" ou Descrição de erro + +*__/recusa_notificacao__* + + Função : Encaminha para salvar a recusa de notificação de limpeza do veículo; + Método : POST + Entrada: + JSON: + ["LicensePlate"] = Placa do carro + ["Date"] = Data hora e segundos da recusa + ["NotificationId"] = ID da notificação recusada + Retorno: + JSON: + ["Message"] = "OK" ou Descrição de erro + +*__/grava_envio_notificao__* + + Função : Encaminha para gravar no bd do veículo as notificações que ele recebeu; + Método : POST + Entrada: + JSON: + ["NotificationId"] = ID da notificação enviada + Retorno: + JSON: + ["Message"] = "OK" ou Descrição de erro + + +*__/solicitar_limpeza__* + + Função : Encaminha o usuário para mandar notificação ao veículo solicitando nova limpeza; + Método : POST + Entrada: + JSON: + ["LicensePlate"] = Placa do carro + ["Username"] = Nome de usuário ou email + Retorno: + JSON: + ["Message"] = "OK" ou Descrição de erro + +*__/autenticar_usuario__* + + Função : Encaminha onde o usuário será autenticado para entrar no app; + Método : GET + Entrada: + JSON: + ["Username"] = Nome de usuário ou email + ["Password"] = Senha digitada pelo usuário + Retorno: + JSON: + ["Message"] = "OK" ou Descrição de erro + +*__/buscar_notificacoes__ + + Função : Encaminha para busca as notificações recebidas; + Método : GET + Entrada: + Variável: + username = Nome de usuário ou email + Retorno: + JSON: + ["Message"] = Chave valor de Notificações ou Descrição de erro + +*__/buscar_limpezas_veiculo__* + + Função : Encaminha para mostrar as limpezas do veículo; + Método : GET + Entrada: + Variável: + license_plate = Placa do carro + Retorno: + JSON: + ["Message"] = Chave valor de limpezas ou Descrição de erro + +*__/buscar_resumo_veiculo__* + + Função : Encaminha para mostra ao cliente o resumo de um veículo; + Método : GET + Entrada: + Variável: + license_plate = Placa do carro + Retorno: + JSON: + ["Message"] = Chave valor do resumo ou Descrição de erro +*__/buscar_ultima_limpeza_veiculo__* + + Função : Encaminha para mostrar quando foi a última limpeza do veículo. + Método : GET + Entrada: + Variável: + license_plate = Placa do carro + Retorno: + JSON: + ["Message"] = Chave valor de limpeza ou Descrição de erro diff --git a/model.py b/model.py index 81318d7..123d017 100644 --- a/model.py +++ b/model.py @@ -211,11 +211,11 @@ def recusa_notificacao(self, data): try: license_plate = data['LicensePlate'] date = data['Date'] - km = data['Km'] + notificacao_id = data["NotificationId"] columns = self.database.return_columns('notificacoes_recusas') car_id = self.database.return_car_id(license_plate) - values = ['Null', car_id, date, km] + values = ['Null', notificacao_id, 1, car_id, date] query = self.gera_query.inserir_na_tabela('notificacoes_recusadas', columns, values) self.database.commit_without_return(query) @@ -266,11 +266,12 @@ def nova_avaliacao(self, data): def solicitar_limpeza(self, data): try: license_plate = data['LicensePlate'] - user = data['User'] + username = data['Username'] + user_id = self.database.return_user_id(username) car_id = self.database.return_car_id(license_plate) - query = self.gera_query.inserir_na_tabela('notificacoes', ['carro', 'tipo', 'usuario'], [car_id, 0, user]) + query = self.gera_query.inserir_na_tabela('notificacoes', ['carro', 'tipo', 'usuario'], [car_id, 0, username]) self.database.commit_without_return(query)