app-checkin-survey's Introduction

TJF Checkin Survey :: Pesquisa de Satisfação

Fornece o serviço para envio das Pesquisas de satisfação.

Modo de uso

Incluir a biblioteca como dependência no pom.xml da aplicação:

<dependency>
    <groupId>com.totvs.tjf</groupId>
    <artifactId>tjf-checkin-survey</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

Configurações (application.yml)

No arquivo de configurações src/main/resources/application.yml teremos configurado as informações do banco de dados (PostgreSQL):

spring:
  datasource:
    driver-class-name: org.postgresql.Driver
    url: jdbc:postgresql://localhost:5432/checkin
    username: checkin
    password: checkin!123

OBS: Deve ser alterado de acordo com o banco criado.

Subindo o Serviço

Para subirmos o serviço, basta executar como Spring Boot App.

Enviando para o Endpoint

De acordo com as configurações, o serviço será exposto na URL http://localhost:8180/api/v1/survey, sendo necessário enviar um POST, conforme exemplo a seguir:

{
	"email":"[email protected]",
	"code_event":"Palestra",
	"note":5,
	"description":"Sugestão/critica da palestra"
}

Os campos email e code___event são do tipo texto (String) e são obrigatórios.
O campo note deve conter um número inteiro entre 0 e 5 e não pode ser nulo.
Por ultimo, o campo description também é do tipo texto (String) com no máximo 400 caracteres.

Validações

O serviço valida caso o mesmo Email já tenha informado uma nota em algum Evento, ou seja, o mesmo email não poderá responder a mesma pesquisa mais de uma vez.