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.

GET / JURFWREST /fup - {ListFup}

Retorna a lista de follow-ups do usuário logado.

Parâmetros aceitos

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.	-
periFilt	string	Período a ser filtrado: (1 - hoje, 2 - Amanha, 3 - Semana vigente, 4 - Atrasado em aberto, 5 - Periodo de 7 dias a contar com o dia atual)	1
cateFilt	string	Categoria do Follow-up. Caso deseje pesquisar mais que uma, separar os valores por vírgula.	-
dataIni	string	Filtro da data inicial que ignora o parametro periFilt.	-
dataFim	string	Filtro da data final que ignora o parametro periFilt.	-
numPro	string	Filtra pelo numero do processo.	-
searchKey	string	Será feito uma busca nos campos de “Descrição do Follow-up”, “Tipo de Follow-up”, "Número do Processo e o "Nome das partes".	-
lWSTLegal	Boolean	A requisição vem do Totvs Legal? Sim ou não.	.F.

Retorno

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

Propriedade	Tipo	Descrição
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 principal do processo
data[n]. autorCpfCnpj	string	Cpf/Cnpj do autor principal
data[n]. datafu	string	Data do Follow-up
data[n]. tipoAsjOrig	string	Assunto jurídico origem
data[n]. tipoStatus	string	Status da situação do Follow-up
data[n]. reagendado	boolean	Follow-up foi reagendado? .T. para sim e .F. para não.
data[n]. codPart	string	Código do participante do FUP.
data[n]. usrLogged	boolean	O follow-up é do usuário logado? .T. para sim e .F. para não
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 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]. outrosEnvolvidos.CpfCnpj	string	Cpf/Cnpj do envolvido
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].situacao	string	Situação do processo (1 = Em andamento, 2 = Encerrado)
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 principal do processo
data[n]. reuCpfCnpj	string	Cpf/Cnpj do réu principal do processo
data[n]. duração	string	Duração do Follow-up
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
data[n]. cajuri	string	Código do assunto jurídico
data[n]. tipoasj	string	Código do tipo de assunto jurídico
data[n]. endForo	string	Endereço do Foro
data[n]. descresul	string	Descrição do Status do Follow-Up
data[n]. filial	string	Filial do processo
data[n]. solicitante	string	Solicitante da consulta
data[n]. tipoSolicitacao	string	Tipo de solicitação informado
length	number	Quantidade de documentos exibidos

Exemplo de retorno da requisição:

response.json

{
    "data": [
        {
            "acao": "Vinculo empregaticio",
            "hora": ":",
            "vara": "3a Camara do Tribunal de Justica do Estado de SP",
            "cajuri": "0000000064",
            "autorCpfCnpj": "",
            "numpro": "0010039742016503013",
            "foro": "Tribunal de Justica",
            "desc": "",
			"usrLogged": true,
            "pedidos": [
                {
                    "valor": 0,
                    "tipo": "Horas extras",
                    "prog": "Provavel"
                }
            ],
            "duracao": "",
            "resp": [
                {
                    "sigla": "WYK",
                    "fone": "",
                    "nome": "WILLIAN KAZAHAYA",
                    "email": "[email protected]"
                }
            ],
            "sigla": "WYK  ",
			"tipoStatus": "1",
            "result": "001",
            "dtfup": "20170904",
            "documentos": [
                {
                    "NomeDoc": "2018-12-11_10-25-38.png",
                    "idDoc": "0000000177"
                }
            ],
            "reu": "CLIENTE NOVO ANDREA",
			"tipoAsjOrig": "   ",
            "pedvaltot": 0,
            "idFu": "1000000015",
            "datafu": "2017-09-04",
            "tipofu": [
                {
                    "descri": "PROVIDENCIA",
                    "codigo": "00004"
                }
            ],
            "situacao": "1",
			"reagendado": false,
            "preposto": [
                {
                    "telefone": "",
                    "nome": "",
                    "email": ""
                }
            ],
            "autor": "",
            "outrosEnvolvidos": [
                {
                    "Telefone": "",
                    "TipoEnv": "TERCEIRO INTERESSADO",
                    "CpfCnpj": "87114413927025",
                    "Nome": "FORNECEDOR TODOS IMPOSTOS NA BAIXA",
                    "Email": ""
                }
            ],
            "prov": 500,
            "tipoasj": "001",
            "endForo": "Patio do Colegio, 73",
			"codPart": "002183",
            "reuCpfCnpj": "95818900670551",
            "descresul": "Em aberto",
            "filial": "        ",
            "detail": ""
        },
        {
            "acao": "Vinculo empregaticio",
            "hora": ":",
            "vara": "3a Camara do Tribunal de Justica do Estado de SP",
            "cajuri": "0000000063",
            "autorCpfCnpj": "",
            "numpro": "090807060504030201",
            "foro": "Tribunal de Justica",
            "desc": "",
            "pedidos": [],
            "duracao": "",
            "resp": [
                {
                    "sigla": "WYK",
                    "fone": "",
                    "nome": "WILLIAN KAZAHAYA",
                    "email": "[email protected]"
                }
            ],
            "sigla": "WYK  ",
            "result": "001",
            "dtfup": "20170922",
            "documentos": [],
            "reu": "",
            "pedvaltot": 0,
            "idFu": "1000000012",
            "datafu": "2017-09-22",
            "tipofu": [
                {
                    "descri": "Transferencia",
                    "codigo": "00003"
                }
            ],
            "situacao": "1",
            "preposto": [
                {
                    "telefone": "",
                    "nome": "",
                    "email": ""
                }
            ],
            "autor": "LEGALTASK 001",
            "outrosEnvolvidos": [],
            "prov": 500,
            "tipoasj": "001",
            "endForo": "Patio do Colegio, 73",
            "reuCpfCnpj": "",
            "descresul": "Em aberto",
            "filial": "        ",
			"solicitante": "Daniel",
			"tipoSolicitacao": "Solicitação de informação",
            "detail": ""
        }
    ],
    "length": 2,
    "hasNext": "true",
    "operation": "ListFup"
}

GET / JURFWRESTT / fup / {codFup} - (DetailFup)

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
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]. tipoAsjOrig	string	Assunto jurídico origem
data[n]. tipoStatus	string	Status da situação do Follow-up
data[n]. reagendado	boolean	Follow-up foi reagendado? .T. para sim e .F. para não.
data[n]. codPart	string	Código do participante do FUP.
data[n]. usrLogged	boolean	O follow-up é do usuário logado? .T. para sim e .F. para não
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].situacao	string	Situação do processo (1 = Em andamento, 2 = Encerrado)
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]. 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
data[n]. cajuri	string	Código do assunto jurídico
data[n]. tipoasj	string	Código do tipo de assunto jurídico
data[n]. endForo	string	Endereço do Foro
data[n]. descresul	string	Descrição do Status do Follow-Up
data[n]. filial	string	Filial do processo
data[n]. solicitante	string	Solicitante da consulta
data[n]. tipoSolicitacao	string	Tipo de solicitação da consulta
length	number	Quantidade de documentos exibidos

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

Exemplo de retorno da requisição:

response.json

{
    "data": [
        {
            "acao": "Vinculo empregaticio",
            "hora": ":",
            "vara": "3a Camara do Tribunal de Justica do Estado de SP",
            "cajuri": "0000000064",
            "autorCpfCnpj": "",
            "numpro": "0010039742016503013",
            "foro": "Tribunal de Justica",
            "desc": "",
			"usrLogged": true,
            "pedidos": [
                {
                    "valor": 0,
                    "tipo": "Horas extras",
                    "prog": "Provavel"
                }
            ],
            "duracao": "",
            "resp": [
                {
                    "sigla": "WYK",
                    "fone": "",
                    "nome": "WILLIAN KAZAHAYA",
                    "email": "[email protected]"
                }
            ],
            "sigla": "WYK  ",
			"tipoStatus": "1",
            "result": "001",
            "dtfup": "20170904",
            "documentos": [
                {
                    "NomeDoc": "2018-12-11_10-25-38.png",
                    "idDoc": "0000000177"
                }
            ],
            "reu": "CLIENTE NOVO ANDREA",
			"tipoAsjOrig": "   ",
            "pedvaltot": 0,
            "idFu": "1000000015",
            "datafu": "2017-09-04",
            "tipofu": [
                {
                    "descri": "PROVIDENCIA",
                    "codigo": "00004"
                }
            ],
            "situacao": "1",
			"reagendado": false,
            "preposto": [
                {
                    "telefone": "",
                    "nome": "",
                    "email": ""
                }
            ],
            "autor": "",
            "outrosEnvolvidos": [
                {
                    "Telefone": "",
                    "TipoEnv": "TERCEIRO INTERESSADO",
                    "CpfCnpj": "87114413927025",
                    "Nome": "FORNECEDOR TODOS IMPOSTOS NA BAIXA",
                    "Email": ""
                }
            ],
            "prov": 500,
            "tipoasj": "001",
            "endForo": "Patio do Colegio, 73",
			"codPart": "002183",
            "reuCpfCnpj": "95818900670551",
            "descresul": "Em aberto",
            "filial": "        ",
			"solicitante": "Daniel",
			"tipoSolicitacao": "Solicitação de informação",
            "detail": ""
        }
    ],
    "length": 1,
    "hasNext": "false",
    "operation": "DetailFup"
}

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
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:

response.json

{
"operation": "ReturnDocsFup",
    "data": [
        {
            "numeroDoc": "",
            "nomeDoc": "1319;1000",
            "origemDoc": "NTA",
            "filialDoc": "01",
            "codigoDoc": "0000000349",
            "extDoc": "",
            "descrDoc": "dtpr006.prt",
            "idCod": "0000000065"
        }
    ]
}

Em caso de erro, o retorno deve ser:

response.json

{
    "operation": "ListFup",
    "messages": [
        {
            "detail": "Não foram encontrados registros.",
            "code": "1001",
            "type": "Error"
        }
    ],
    "hasNext": "false",
    "data": [],
    "length": 0
}

GET / JURFWREST/categories - (ListTypeFup)

Este serviço deve retornar a lista de Tipo de Follow-up, com os detalhes da mesma. Este serviço não aceita nenhum parâmetro.

Parâmetros aceitos

nenhum

Retorno

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

Propriedade	Tipo	Descrição
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 da requisição:

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)

Este serviço deve retornar a lista de status de follow-up, com os detalhes da mesma. Este seviço não aceita nenhum parâmetro.

Parâmetros aceitos

nenhum

Retorno

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

Propriedade	Tipo	Descrição
operation	string	Identificação da operação
data	Array	Array com a lista de status do Follow-up
data[n].tipoResultFup	string	Código do status do Follow-up
data[n]. descriResultFup	string	Descrição do status do Follow-up
data[n].filialResultFup	string	Filial do status do Follow-up
data[n].codigoResultFup	string	Código do tipo de resultado do Follow-up

Exemplo de retorno da requisição:

response.json

{
    "operation": "ListStatsFups",
    "data": [
        {
            "tipoResultFup": "1",
            "descriResultFup": "Em aberto",
            "filialResultFup": "",
            "codigoResultFup": "001"
        },
        {
            "tipoResultFup": "2",
            "descriResultFup": "Concluido",
            "filialResultFup": "",
            "codigoResultFup": "002"
        },
        {
            "tipoResultFup": "3",
            "descriResultFup": "Cancelado",
            "filialResultFup": "",
            "codigoResultFup": "003"
        },
        {
            "tipoResultFup": "1",
            "descriResultFup": "Pendente",
            "filialResultFup": "",
            "codigoResultFup": "004"
        },
        {
            "tipoResultFup": "5",
            "descriResultFup": "Em andamento",
            "filialResultFup": "",
            "codigoResultFup": "005"
        }
    ]
}

GET / JURFWREST / exportTarefa

Faz geração do relatório em Excel dos Prazos a Vencer do Totvs Legal e retorna nome do relatório que está salvo.

Parâmetros aceitos

dataIni	string	Filtro da data inicial que ignora o parametro periFilt.	data atual
dataFim	string	Filtro da data final que ignora o parametro periFilt.	data atual + 7 dias

Retorno

O serviço deve retornar as propriedades informadas:

Propriedade	Tipo	Descrição
export	array	Array que contém os relatórios exportados
operation	string	Identificação da operação
namefile	string	Nome do arquivo
filedata	string	Local onde o arquivo foi salvo encodado em base 64

Exemplo de retorno da requisição:

response.json

{
    "export": [
        {
            "namefile": "20191212135703_Exportacao_000000.xls",
            "filedata": "PGh0bWwgeG1sbnM6dj0ndXJuOnNjaGVtYXMtb"
        }
    ],
    "operation": "ExportTarefasVencer"
}

GET / JURFWREST / exportPauta

Faz geração do relatório em PDF dos Prazos a Vencer do Totvs Legal e retorna nome do relatório que está salvo.

Parâmetros aceitos

Os parâmetros serão passados por queryParams e poderão ser utilizados em conjunto.

Parâmetro	Tipo	Descrição
periFilt	string	Período a ser filtrado: 1 - hoje 2 - Amanha 3 - Semana vigente 4 - Atrasado em aberto 5 - Período de 7 dias a contar com o dia atual
status	string	Status a ser filtrado: 1 - Pendente 2 - Concluído 3 - Cancelado 4 - Em aprovação 5 - Em andamento
dataIni	string	Filtro da data inicial que ignora o parametro periFilt. Informar no formato AAAAMMDD
dataFim	string	Filtro da data final que ignora o parametro periFilt. Informar no formato AAAAMMDD

Retorno

O serviço deve retornar as propriedades informadas:

Propriedade	Tipo	Descrição
pauta	array	Array que contém os relatórios exportados
operation	string	Identificação da operação
namefile	string	Nome do arquivo
filedata	string	Local onde o arquivo foi salvo encodado em base 64

Exemplo de retorno da requisição:

response.json

{
    "pauta": [
        {
            "namefile": "20191212135703_Exportacao_000000.xls",
            "filedata": "PGh0bWwgeG1sbnM6dj0ndXJuOnNjaGVtYXMtbW"
        }
    ],
    "operation": "RelatorioPauta"
}

POST / JURFWREST / fup / {codFup} / docs

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

Parâmetros aceitos

Parâmetro	Tipo	Descrição	Valor Default
codFup	string	Código do FUP (via PathParam)	-

Request

Campos de payload da requisição:

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

request.json

{
  "name": "1000000026-1519666379712.txt",
  "content": "dGVzdGUgUE9TVCBGVVA="
}

Exemplo: .../rest/JURFWREST/fup/1000000032/docs

Response

Exemplo de retorno da requisição:

response.json

{
    "messages": [
        {
            "detail": "",
            "code": "1000",
            "type": "Documento criado com sucesso SIGAJURI 2018-02-26T16:34:53"
        }
    ]
}

PUT / JURFWREST /fup / {codFup}

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

Parâmetros aceitos

Parâmetro	Tipo	Descrição	Valor Default
codFup	string	Código do FUP (via PathParam)	-

Request

Campos de payload da requisição:

status: status do follow-up
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

request.json

{
  "status":"005",
  "data":"2018-02-26",
  "hora":"14:44",
  "text":"Finalizado FUP após ida ao fórum e verificação do parecer do juiz"
}

Exemplo: .../rest/JURFWREST/fup/1000000032

Response

Exemplo de retorno da requisição:

response.json

{
    "operation": "UpdateFup",
    "messages": [
        {
            "detail": "",
            "code": "1000",
            "type": "Success"
        }
    ]
}

Árvore de páginas

Especificações de Serviços - Legal Task Mobile

Objetivo

GET / JURFWREST /fup - {ListFup}

Parâmetros aceitos

Retorno

GET / JURFWRESTT / fup / {codFup} - (DetailFup)

Parâmetros aceitos

Retorno

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

Parâmetros aceitos

Retorno

GET / JURFWREST/categories - (ListTypeFup)

Parâmetros aceitos

Retorno

GET / JURFWREST /status - (ListStatsFup)

Parâmetros aceitos

Retorno

GET / JURFWREST / exportTarefa

Parâmetros aceitos

Retorno

GET / JURFWREST / exportPauta

Parâmetros aceitos

Retorno

POST / JURFWREST / fup / {codFup} / docs

Parâmetros aceitos

Request

Response

PUT / JURFWREST /fup / {codFup}

Parâmetros aceitos

Request

Response