Remoção da opção Registrar Avaliação

Retirada da opção para registrar avaliação de formulário próprio criado pelo órgão, deixando apenas a opção Obter Link do Formulário para utilizar o formulário do módulo de avaliação.

apresentacao.rst

@@ -9,28 +9,16 @@ Entre as informações mínimas que deverão estar disponíveis no painel para c
 
 Este projeto foi criado para ajudar na coleta destas informações para a disponibilização delas no painel de monitoramento, e para ajudar aos órgãos e entidades da administração pública federal direta, autárquica e fundacional a atenderem disposto no decreto e com isso melhorarem a qualidade do serviço prestado ao cidadão.
 
-Formas de uso
+Como usar
 **************
 
-É possível usar de duas formas:
+Dentro do sistema para prestação do serviço, inclua um botão convidando o cidadão a avaliar o serviço recebido.
 
-* Enviar o link por email
-* Adicionar o formulário na página
+Faça a comunicação com o módulo de avaliação, informando da prestação do serviço e solicite um formulário de avaliação para o serviço recém prestado.
 
-O cidadão ao final da execução do serviço pode receber o link da sua avaliação da prestaçao do serviço conforme figura abaixo.
-
-.. figure:: _imagens/email.png
-   :scale: 100 %
-   :align: center
-   :alt: Exemplo de email recebido com link.
-
-   Exemplo de email recebido com link
-
-.. attention::
-    É **necessário que o próprio serviço** crie o texto e envie o email.
+Abra diretamente o formulário ou envie o link recebido por algum meio de contato que o órgão possua com o cidadão.
 
 
-Ou pode-se incluir na página do serviço o formulário já pronto e fornecido pela API de avaliação conforme imagem abaixo.
 
 .. figure:: _imagens/formulario.PNG
    :scale: 100 %

avaliacao.rst

@@ -3,128 +3,8 @@
 
 A avaliação dos serviços prestados permitirá que o governo tenha uma visão da opinião do cidadão sobre os serviços disponíveis podendo assim melhora-los até que atendam, de fato, ao que a população espera.
 
-Duas formas estão disponíveis para o registro da opinião do cidadão.
-
-Na primeira, um órgão de governo implementa o formulário de avaliação em seu próprio sistema e faz a chamada ao método Registrar Avaliação, o qual se encarregará em registrar o resultado da avaliação na base nacional de serviços e registrará a informação no e-OUV.
-
-Na segunda, o órgão quer avaliar seu serviço, mas não quer desenvolver uma interface de avaliação, nesse caso ele deverá fazer a chamada ao método Obter Link do formulário de avaliação, que lhe fornecerá um endereço de um formulário que poderá ser embutido em seu sistema, usando um <iframe>, ou encaminhar o link recebido diretamente ao cidadão, seja por e-mail, seja por SMS.
-
-
-
-Registrar Avaliação
----------------------
-
-O método Registrar Avaliação permite que sejam registradas as informações da avaliação de um serviço prestado ao cidadão e o registro de uma manifestação junto ao e-OUV.
-
-.. note::
-   Para registrar uma avaliação é necessário ter cadastrado previamente o acompanhamento da prestação do serviço. Você deve solicitar o formulário de avaliação para a etapa 'Final'.
-
-
-Parâmetros de Entrada
-++++++++++++++++++++++
-
-.. code-block:: json
-
-   {
-    "avaliacao": {
-    "cpfCidadao": "08254631654",
-    "etapa": "Final",
-    "orgao": "57842",
-    "protocolo": "0001AC.20171212",
-    "servico": "12014"
-  },
-  "avaliarComoAnonimo": "false",
-  "comentarioAvaliacao": "Atendimento rápido, pessoa qualificada e prestativa.",
-  "criteriosAvaliados": [
-    "1"
-  ],
-  "emailUsuario": "jose.silva@email.com.br",
-  "nomeUsuario": "José da Silva",
-  "outroCriterio": "Pontualidade",
-  "tipoAvaliacao": "4",
-  "tipoNota": "4"
-   }
-
-
-cpfCidadao (string)
-   CPF do cidadão sem formatação.
-
-etapa (string)
-   Descrição da etapa do Serviço.
-
-orgao (string)
-   Identificador do Orgão.
-
-protocolo (string)
-   Protocolo para identificar o serviço.
-
-servico (string)
-   Identificador do Serviço do Órgão.
-
-avaliarComoAnonimo (string)
-   Informar se a avaliação deve ser anônimo, true ou false. Caso false, o usuário não terá uma resposta do e-OUV. = ['true', 'false'],
-
-comentarioAvaliacao (string, optional)
-   Descrição de 500 caracteres com comentário do usuário sobre o serviço prestado.
-
-criteriosAvaliados (Array[string])
-   Códigos dos critérios selecionados pelo usuário na Avaliação. Quando Retornado na Consulta, vem com a Descrição e não com ID.
-
-emailUsuario (string, optional)
-   Email do usuário. Utilizado para enviar ao sistema e-OUV. Não armazenado na API.
-
-nomeUsuario (string, optional)
-   Nome do usuário. Utilizado para enviar ao sistema e-OUV. Não armazenado na API.
-
-outroCriterio (string, optional)
-   Descrição de 30 caracteres quando o usuário seleciona o Critério 'Outro'.
-
-tipoAvaliacao (string)
-   Tipo de Avaliação. = ['2 - Avaliar', '3 - Não Avaliar', '4 - Avaliar Depois']
-
-tipoNota (string)
-   Nota do usuário.1 a 5, quanto maior melhor. = ['1', '2', '3', '4', '5']
-
-
-.. note::
-   Para registrar as informações da avaliação o Tipo de Avaliação dever ser  2! As outras opções serão para implementações futuras de melhorias.
-
-
-Veja um exemplo de acesso utilizando o cURL_
-
-.. code-block:: console
-
-    $ curl -v -X POST --header 'Content-Type: application/json;charset=UTF-8' -k \
-    --header 'Authorization: Basic YWxhZGluQGRpc25leS5jb206b3BlbnNlc2FtZQ==' \
-    --header 'Accept: application/json' -d '{ \
-     "cpfCidadao": "08254631654", \
-     "etapa": "Em Processamento.", \
-     "orgao": "57842", \
-     "protocolo": "0001AC.20171212", \
-     "servico": "12014" \
-     }' 'https://api-acompanha-avalia-servicos.dev.nuvem.gov.br/api/avaliacao/'
-
-
-
-Parâmetros de Saída
-++++++++++++++++++++++
-
-.. code-block:: json
-
-    {
-      "message": "Operação realizada com sucessos!",
-      "status": "OK"
-    }
-
-messagem
-   Mensagem que descreve o status da operação.
-
-status
-   Status final da operação. Pode ser **OK** ou **ERROR**
-
-.. warning::
-    Há outras saídas possíveis dependendo se foi feito com sucesso o login ou mesmo se o serviço já existe no `Portal de Serviços`_. Para uma listagem completa da saída por favor `verifique a documentação Swagger`_.
 
+O órgão quer avaliar seu serviço, deve, após cadastrar o acompanhamento da prestação do serviço, fazer a chamada ao método Obter Link do formulário de avaliação, o qual lhe fornecerá um endereço de um formulário que poderá ser embutido em seu sistema apresentando um botão "Avaliar" no seu sistema, ou encaminhar o link recebido diretamente ao cidadão, seja por e-mail, seja por SMS.
 
 
 Formulário de Avaliação
@@ -142,6 +22,8 @@ Parâmetros de Entrada
 .. code-block:: json
 
    {
+  "canalAvaliacao": "1",
+  "canalPrestacao": "8",
   "cpfCidadao": "08254631654",
   "etapa": "Em Processamento.",
   "orgao": "57842",
@@ -156,7 +38,7 @@ etapa (string)
 orgao (string)
    Identificador do órgão.
 protocolo (string)
-   Protocolo para identificar o serviço.
+   Protocolo para identificar o serviço. (O mesmo informado no registro de Acompanhamento!)
 servico (string)
    Identificador do serviço do órgão.
 
@@ -167,7 +49,9 @@ Veja um exemplo de acesso utilizando o cURL_
     $ curl -v -X POST --header 'Content-Type: application/json;charset=UTF-8' -k \
     --header 'Authorization: Basic YXBpQG1wLmdvdi5icjoxMjM0NTY3OA==' \
     --header 'Accept: application/json' -d '{ \
-     "cpfCidadao": "08254631654", \
+     "canalAvaliacao": "1", \
+     "canalPrestacao": "8", \     
+	 "cpfCidadao": "08254631654", \
      "dataEtapa": "10/10/2017", \
      "dataSituacaoEtapa": "10/10/2017", \
      "etapa": "Em Processamento.", \
@@ -212,6 +96,8 @@ Veja um exemplo mínimo de acesso na linguagem Java utilizando o HTTPClient Apac
                 URIBuilder builder = new URIBuilder();
                 builder.setScheme("https").setHost("avaliacao.servicos.gov.br")
                     .setPath("/api/avaliacao/formulario")
+					.setParameter("canalAvaliacao", "1")
+                    .setParameter("canalPrestacao", "8")
                     .setParameter("servico", "47")
                     .setParameter("cpfCidadao", "08254631654")
                     .setParameter("protocolo", "0001AC.20171212")