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.

...

Os parâmetros serão passados por queryParams e poderão ser utilizados em conjunto. Caso haja mais de um parâmetro enviado, a lógica utilizada deve ser "E".

Parâmetro	Tipo	Descrição	Valor Defaut
page	number	Página inicial que será retornada	1
pageSize	number	Tamanho da página que será retornada	10
fields	string	Lista de campos (separados por vírgula) que devem ser retornados.	-

...

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

Propriedade	Tipo	Descrição	Adicional
operation	string	Nome da operação


hasNext	string	Indica se existe mais uma página de registros


data	Array	Um array de objetos


data[n], desc	string	Descrição do Follow-up


data[n]. pedidos.tipo	string	Tipo de pedido do processo


data[n]. pedidos.valor	number	Valor do pedido do processo


data[n]. pedidos.prog	string	Prog do pedido do processo


data[n]. autor	string	Autor do processo


data[n]. datafu	string	Data do Follow-up


data[n]. acao	string	Tipo de ação do processo


data[n]. foro	string	Foro do processo


data[n]. sigla	string	Sigla do responsável


data[n]. numpro	string	Numero do processo


data[n]. detail	string	Detalhe do

processo

follow up
data[n]. resp.nome	string	Nome do responsável do processo


data[n]. resp.sigla	string	Sigla do responsável do processo


data[n]. resp.email	string	E-mail do responsável do processo


data[n]. resp.fone	string	Telefone do responsável do processo


data[n]. prov	number	Valor de provisão


data[n]. outrosEnvolvidos.Nome	string	Nome dos outros envolvidos


data[n]. outrosEnvolvidos.Telefone	string	Telefone dos outros envolvidos


data[n]. outrosEnvolvidos.TipoEnv	string	Tipo de envolvimento


data[n]. outrosEnvolvidos.Email	string	E-mail dos outros envolvidos


data[n]. tipofu.descri	string	Descrição do tipo do follow-up


data[n]. tipofu.codigo	string	Código do tipo do follow-up


data[n]. preposto.nome	string	Nome do preposto


data[n]. preposto.telefone	string	Telefone do preposto


data[n]. preposto.email	string	E-mail do preposto


data[n]. reu	string	Reu do processo


data[n]. duração	string	Duração do Follow-up


data[n]. endForo	string	Endereço do processo

(REMOVER)
data[n]. partcont	string	Parte contraria


data[n]. documentos.idDoc	string	Id do documento do Follow-up


data[n]. documentos.NomeDoc	string	Nome do documento do Follow-up


data[n]. hora	string	Hora do Follow-up


data[n]. idFu	string	Código do Follow-up


data[n]. vara	string	Vara do processo


data[n]. result	string	Código do resultado


data[n]. pedvaltot	number	Valor total do pedido


length	number	Quantidade de documentos exibidos

Exemplo de retorno da requisição:

...

Este serviço deve retornar somente um follow-up, com os detalhes da mesma. Os atributos retornados seguem o mesmo padrão do serviço que retorna a lista de Follow-up, porém, este serviço somente aceita o parâmetro fields.

Parâmetros aceitos

Parâmetro	Tipo	Descrição	Valor Default
fields	string	Lista de campos (separados por vírgula) que devem ser retornados.	-

...

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

Propriedade	Tipo	Descrição	Adicional
operation	string	Nome da operação


hasNext	string	Indica se existe mais uma página de registros


data	Array	Um array de objetos


data[n], desc	string	Descrição do Follow-up


data[n]. pedidos.tipo	string	Tipo de pedido do processo


data[n]. pedidos.valor	number	Valor do pedido do processo


data[n]. pedidos.prog	string	Prog do pedido do processo


data[n]. autor	string	Autor do processo


data[n]. datafu	string	Data do Follow-up


data[n]. acao	string	Tipo de ação do processo


data[n]. foro	string	Foro do processo


data[n]. sigla	string	Sigla do responsável


data[n]. numpro	string	Numero do processo


data[n]. detail	string	Detalhe do processo


data[n]. resp.nome	string	Nome do responsável do processo


data[n]. resp.sigla	string	Sigla do responsável do processo


data[n]. resp.email	string	E-mail do responsável do processo


data[n]. resp.fone	string	Telefone do responsável do processo


data[n]. prov	number	Valor de provisão


data[n]. outrosEnvolvidos.Nome	string	Nome dos outros envolvidos


data[n]. outrosEnvolvidos.Telefone	string	Telefone dos outros envolvidos


data[n]. outrosEnvolvidos.TipoEnv	string	Tipo de envolvimento


data[n]. outrosEnvolvidos.Email	string	E-mail dos outros envolvidos


data[n]. tipofu.descri	string	Descrição do tipo do follow-up


data[n]. tipofu.codigo	string	Código do tipo do follow-up


data[n]. preposto.nome	string	Nome do preposto


data[n]. preposto.telefone	string	Telefone do preposto


data[n]. preposto.email	string	E-mail do preposto


data[n]. reu	string	Reu do processo


data[n]. duração	string	Duração do Follow-up


data[n]. endForo	string	Endereço do processo


data[n]. partcont	string	Parte contraria


data[n]. documentos.idDoc	string	Id do documento do Follow-up


data[n]. documentos.NomeDoc	string	Nome do documento do Follow-up


data[n]. hora	string	Hora do Follow-up


data[n]. idFu	string	Código do Follow-up


data[n]. vara	string	Vara do processo


data[n]. result	string	Código do resultado


data[n]. pedvaltot	number	Valor total do pedido


length	number	Quantidade de documentos exibidos

O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.

...

Bloco de código

language	js
theme	RDark
title	response.json

{
    "operation": "DetailFup",
    "hasNext": "false",
    "data": [
        {
            "desc": "",
            "pedidos": [
                {
                    "tipo": "Férias",
                    "valor": 1000,
                    "prog": "Provável"
                },
                {
                    "tipo": "Férias",
                    "valor": 50,
                    "prog": "Provável"
                }
            ],
            "autor": "CLIENTE 01",
            "datafu": "2017-08-15",
            "acao": "Abertura, Registro e Cumprimento de Testamento",
            "foro": "Foro Regional I - Santana",
            "sigla": "MAD  ",
            "numpro": "11066208820158260100",
            "detail": ".",
            "resp": [
                {
                    "nome": "MARCELO ARAUJO DENTE",
                    "sigla": "MAD",
                    "email": "",
                    "fone": ""
                },
                {
                    "nome": "WILLIAN",
                    "sigla": "WYK",
                    "email": "",
                    "fone": ""
                }
            ],
            "prov": 0,
            "outrosEnvolvidos": [],
            "tipofu": [
                {
                    "descri": "Acompanhamento",
                    "codigo": "00001"
                }
            ],
            "preposto": [
                {
                    "nome": "",
                    "telefone": "",
                    "email": ""
                }
            ],
            "pedvaltot": 1050,
            "reu": "",
            "duracao": "",
            "endForo": "",
            "partcont": "",
            "documentos": [
                {
                    "idDoc": "0000000010",
                    "NomeDoc": "vc_red.msi"
                },
                {
                    "idDoc": "0000000011",
                    "NomeDoc": "3.txt"
                },
                {
                    "idDoc": "0000000012",
                    "NomeDoc": "3.txt"
                },
                {
                    "idDoc": "0000000013",
                    "NomeDoc": "1.txt"
                },
                {
                    "idDoc": "0000000014",
                    "NomeDoc": "6.txt"
                }
            ],
            "hora": "08:42",
            "idFu": "0000000002",
            "vara": "1ª Vara do Juizado Especial Cível",
            "result": "001"
        }
    ],
    "length": 1
}

GET / JURFWREST /docs/{codDoc} - (ReturnDocsFup)

Este serviço deve retornar as informações dos Documentos de Follow-up, com os detalhes da mesma. Este serviço somente aceita o parâmetro codDoc.

Parâmetros aceitos

Parâmetro	Tipo	Descrição	Valor Default
codDoc	string	Retorno o codigo do documento	-

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

Propriedade	Tipo	Decrição	Adicional
operation	string	Nome da operação


data	Array	Um array de objetos


data[n]. numeroDoc	string	Numero do documento


data[n]. nomeDoc	string	Nome do documento


data[n]. origemDoc	string	Origem do documento


data[n]. filialDoc	string


data[n]. codigoDoc	string	Codigo do documento


data[n]. extDoc	string


data[n] descrDoc	string	Descrição do documento


data[n]. idCod	string	id do documento

Exemplo de retorno da requisição:

...

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

Propriedade	Tipo	Descrição	Adicional
operation	string	Identificação da operação


data	Array	Array com os tipos de Follow-up


data[n]. descriTipoFup	string	Descrição do tipo de Follow-up


data[n]. filialTipoFup	string	Filial do tipo de Follow-up


data[n]. codigoTipoFup	string	Codigo do tipo de Follow-up

Exemplo de retorno de aquisição:

Bloco de código

language	js
theme	RDark
title	response.json

{
    "operation": "ListTypeFup",
    "data": [
        {
            "descriTipoFup": "Acompanhamento",
            "filialTipoFup": "",
            "codigoTipoFup": "00001"
        },
        {
            "descriTipoFup": "Audiência",
            "filialTipoFup": "",
            "codigoTipoFup": "00002"
        },
        {
            "descriTipoFup": "Julgamento",
            "filialTipoFup": "",
            "codigoTipoFup": "00003"
        },
        {
            "descriTipoFup": "Prazo",
            "filialTipoFup": "",
            "codigoTipoFup": "00004"
        },
        {
            "descriTipoFup": "Providências",
            "filialTipoFup": "",
            "codigoTipoFup": "00005"
        },
        {
            "descriTipoFup": "Reunião",
            "filialTipoFup": "",
            "codigoTipoFup": "00006"
        }
    ]
}

...

GET / JURFWREST /status - (ListStatsFup)

...

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

Objetivo

Retorno

Parâmetros aceitos

Retorno

GET / JURFWREST /docs/{codDoc} - (ReturnDocsFup)

Parâmetros aceitos

Retorno

GET / JURFWREST /status - (ListStatsFup)

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

Objetivo

Retorno

Parâmetros aceitos

Retorno

GET / JURFWREST /docs/{codDoc} - (ReturnDocsFup)

Parâmetros aceitos

Retorno

GET / JURFWREST /status - (ListStatsFup)