Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


Índice

  •  1 Objetivo
  •  2 GET/JURFWREST/fup
    • 2.1  Parâmetros aceitos 
    • 2.2  Retorno
  •  3 GET/JURFWREST/fup/{codFup}
    • 3.1 Parâmetros aceitos
    • 3.2 Retorno
  • 4 GET/JURFWREST/docs/{codDoc}
    • 4.1 Parâmetros aceitos
    • 4.2 Retorno
  • 5 GET/JURFWREST/categories
    • 5.1 Parâmetros aceitos
    • 5.2 Retorno
  • 6 GET/JURFWREST/status
    • 6.1 Parâmetros aceitos
    • 6.2 Retorno
  • 7 POST/JURFWREST/fup/{codFup}/docs
    • 7.1 Parâmetros aceitos 
    • 7.2 Retorno
  • 8 PUT/JURFWREST/fup/{codFup}
    • 8.1 Parâmetros aceitos
    • 8.2 Retorno
  • 9 Mensagens de erro
    • 9.1 Corpo padrão da resposta
    • 9.2 Erro de validação
    • 9.3 Tentativa de acesso á um dado restrito
    • 9.4 Não conseguiu identificar o usuário logado

Objetivo

Os serviços especificados neste documento serão consumidos pelo aplicativo Legal Task e têm por objetivo permitir ao usuário realizar consultas dos Follow-ups através de seu smartphone.

...

Este serviço trata da criação de documentos no Follow-up.

Parâmetros aceitos

ParâmetroTipoDescriçãoValor Default
codFupstringCódigo do FUP (via PathParam)-

Retorno

Campos de payload da requisição:

  • name: nome do arquivo (tipo: áudio, texto ou foto)
  • content: arquivo convertido em base64


Exemplo de retorno da requisição:

...

Alteração de informações do detalhe do Follow-up a partir do Body


Parâmetros aceitos

ParâmetroTipoDescriçãoValor Default
codFupstringCódigo do FUP (via PathParam)-

Retorno

Campos de payload da requisição:

  • status: atualização do status do follow-up para "002 - Concluído"
  • data: data da finalização do follow-up
  • hora: hora da finalização do follow-up
  • text: texto incluído na finalização da tarefa


Exemplo de retorno da requisição:

...