institutotim / zup-api Goto Github PK

Documentando aqui o processo de notificação. É necessário pegar essa documentação e agregar junto ao conjunto geral de documentações em: https://zeladoriaurbana.zendesk.com

O que é uma Notificação?
É um documento escrito, em formato carta com timbrado da prefeitura, que pode ser configurado no sistema vinculado a uma ou mais categorias. Uma vez configurada uma Notificação, órgãos responsáveis de determinadas secretarias podem dar entrada em relatos no sistema que geram uma notificação. A Notificação então pode ser impressa ou enviada por email para o destinatário desta.

Exemplo de uso de uma Notificação

No Municipio de Kyoto existe uma lei que diz que é proibido colocar mesas e cadeiras de bar em calçadas públicas. Caso algum bar ou estabelecimento comercial infrinja essa lei, um fiscal do serviço de Passeios e Iluminação da Secretaria de Serviços da prefeitura deve emitir uma Notificação em formato carta avisando o proprietário sobre a infração, exigindo a adequação (retirada do uso indevido do espaço público) e cobrando-lhe uma multa. Usando o sistema ZUP, por meio do aplicativo ZUP Técnico ou pelo ZUP Gestão (painel de controle da ferramenta), o fiscal preenche um Novo Relato com a referida categoria, iniciando assim a emissão da carta (Notificação).

Como configurar uma notificação?

1. Logado como administrador do sistema ZUP, no painel, vá em:

Relatos > Gerenciar Categorias > Escolha uma categoria ou abra uma nova. 

2 - Preencha as informações necessárias e/ou edite as informações já existentes caso precise mudar o comportamento da categoria e depois vá na sessão “Configurações de Notificações” e habilite a exibição (altere a chave de não para sim).

3 - Depois de ativar as notificações para a categoria, você pode configurar um tipo de notificação, definir um prazo e escolher um estado para vinculação.

4 - É necessário também editar um layout de notificação, com texto e logomarcas adequadas. Veja:

Bom dia, senhores(as)!

Eu gostaria de saber se há alguma possobilidade de alguém me passar uma visão geral sobre essa API, sou novo com o sinatra e o fato da api não estar no padrão MVC está me confundindo um pouco, eu gostaria de fazer algumas perguntas com relação as rotas, poderiam me ajudar?