...
- 2.1 Parâmetros aceitos
- 2.2 Retorno
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
...
- 4.1 Parâmetros aceitos
- 4.2 Retorno
...
- 5.1 Parâmetros aceitos
- 5.2 Retorno
...
- 6.1 Parâmetros aceitos
- 6.2 Retorno
...
- 7.1 Parâmetros aceitos
- 7.2 Retorno
...
- 8.1 Parâmetros aceitos
- 8.2 Retorno
...
- 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
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
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. | - |
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 principal do processo |
|
|
data[n]. autorCpfCnpj | string | Cpf/Cnpj do autor principal |
|
data[n]. datafu | string | Data do Follow-up |
| acao Tipo de ação do processo | Assunto jurídico origem |
|
data[n]. |
foroForo do processo | Status da situação do Follow-up |
|
data[n]. reagendado | boolean | Follow-up foi reagendado? .T. para sim e .F. para não. |
sigla Sigla do responsável | Código do participante do FUP. |
|
data[n]. |
numprostring | Numero do processo | | boolean | O follow-up é do usuário logado? .T. para sim e .F. para não |
|
data[n]. |
detailDetalhe | resp.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 |
duração Duração do Follow-up | | data[n]. endForo | string | Endereço do processo | Cpf/Cnpj do réu principal do processo |
|
data[n]. |
partcontParte contraria | | 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 |
| length | number | Quantidade de documentos exibidos | |
Exemplo de retorno da requisição:
|
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:
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | response.json |
---|
|
{ |
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | response.json |
---|
|
{
"operation": "ListFup",
"hasNext": "false",
"data": [
{
"descacao": "Vinculo empregaticio",
"pedidoshora": [":",
"vara": "3a Camara do {
Tribunal de Justica do Estado de SP",
"tipocajuri": "Férias0000000064",
"autorCpfCnpj": "",
"valornumpro": 1000"0010039742016503013",
"foro": "Tribunal de Justica",
"progdesc": "Provável",
"usrLogged": true,
},"pedidos": [
{
"tipovalor": "Férias"0,
"valortipo": "Horas 50extras",
"prog": "ProvávelProvavel"
}
],
"autorduracao": "CLIENTE 01",
"datafuresp": "2017-08-15",
[
{
"acao": "Abertura, Registro e Cumprimento de Testamento",
"forosigla": "Foro Regional I - Santana",
"WYK",
"siglafone": "MAD ",
"numpronome": "11066208820158260100WILLIAN KAZAHAYA",
"detailemail": "WILLIAN.KAZAHAYA@TOTVS.COM.BR",
"resp": [
}
{],
"sigla": "WYK "nome",
"tipoStatus": "MARCELO ARAUJO DENTE1",
"siglaresult": "MAD001",
"email"dtfup": "20170904",
"fonedocumentos": ""[
},{
{
"NomeDoc": "2018-12-11_10-25-38.png",
"nomeidDoc": "WILLIAN0000000177",
"sigla": "WYK",
}
"email": "",
],
"fonereu": "CLIENTE NOVO ANDREA",
"tipoAsjOrig": " ",
}
]"pedvaltot": 0,
"providFu": 0"1000000015",
"outrosEnvolvidosdatafu": []"2017-09-04",
"tipofu": [
{
"descri": "AcompanhamentoPROVIDENCIA",
"codigo": "0000100004"
}
],
"situacao": "1",
"reagendado": false,
"preposto": [
{
"nometelefone": "",
"telefonenome": "",
"email": ""
}
],
"pedvaltotautor": 1050"",
"reuoutrosEnvolvidos": "",[
"duracao": "",
{
"endForo": "",
"partcontTelefone": "",
"documentos": [
"TipoEnv": "TERCEIRO INTERESSADO",
{
"idDoc"CpfCnpj": "000000001087114413927025",
"NomeDocNome": "vc_red.msi"FORNECEDOR TODOS IMPOSTOS NA BAIXA",
},
"Email": ""
{
}
],
"idDoc": "0000000011",
"prov": 500,
"NomeDoctipoasj": "3.txt001",
"endForo": "Patio do Colegio, }73",
"codPart": "002183",
"reuCpfCnpj": "95818900670551",
{
"descresul": "Em aberto",
"idDocfilial": "0000000012",
",
"NomeDocdetail": "3.txt"
},
{
{
"acao": "Vinculo empregaticio",
"idDochora": "0000000013:",
"vara": "3a Camara do Tribunal de Justica do Estado "NomeDoc":de SP"1.txt",
}"cajuri": "0000000063",
{
"autorCpfCnpj": "",
"idDoc"numpro": "0000000014090807060504030201",
"NomeDoc"foro": "6.txt"Tribunal de Justica",
"desc": "",
}
"pedidos": [],
"horaduracao": "08:42",
"idFuresp": "0000000002",[
"vara": "1ª Vara do Juizado Especial Cível",
{
"sigla": "WYK",
"resultfone": "001",
}
"nome": "WILLIAN ]KAZAHAYA",
"lengthemail": 1
} |
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 | 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.
Exemplo de retorno da requisição:
"[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 | 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]. 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:
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | response.json |
---|
|
{
"data": [
{
"acao": "Vinculo empregaticio",
|
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": ""
},
{
"nomehora": "WILLIAN:",
"siglavara": "WYK",
3a Camara do Tribunal de Justica do Estado de SP",
"emailcajuri": "0000000064",
"fone"autorCpfCnpj": "",
"numpro": "0010039742016503013",
}
"foro": "Tribunal de ]Justica",
"provdesc": 0"",
"usrLogged": true,
"outrosEnvolvidospedidos": [],
"tipofu": [{
{ "valor": 0,
"descritipo": "AcompanhamentoHoras extras",
"codigoprog": "00001Provavel"
}
],
"prepostoduracao": "",
"resp": [
{
"nomesigla": "WYK",
"telefonefone": "",
"emailnome": "WILLIAN KAZAHAYA",
}
"email": "[email protected]"
}
],
"pedvaltot"sigla": "WYK ",
"tipoStatus": 1050"1",
"reuresult": "001",
"duracaodtfup": "20170904",
"endForodocumentos": "",
[
{
"partcont": "",
"documentos": [
{
"idDoc": "0000000010",
"NomeDoc": "vc_red.msi"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 | 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:
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | 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:
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | 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 | 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 da requisiçã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)
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 | Adicional |
---|
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:
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | response.json |
---|
|
{
"operation": "ListStatsFups",
"data": [
},{
{
"tipoResultFup": "1",
"idDoc"descriResultFup": "0000000011Em aberto",
"NomeDocfilialResultFup": "3.txt"
",
},
"codigoResultFup": "001"
{},
{
"idDoctipoResultFup": "00000000122",
"NomeDoc"descriResultFup": "3.txtConcluido",
"filialResultFup": "",
},
"codigoResultFup": "002"
{},
{
"idDoctipoResultFup": "00000000133",
"NomeDocdescriResultFup": "1.txtCancelado",
"filialResultFup": "",
},
"codigoResultFup": "003"
{},
{
"idDoctipoResultFup": "00000000141",
"descriResultFup": "Pendente",
"NomeDocfilialResultFup": "6.txt",
"codigoResultFup": "004"
}
},
],{
"horatipoResultFup": "08:425",
"idFudescriResultFup": "0000000002Em andamento",
"varafilialResultFup": "1ª Vara do Juizado Especial Cível",
"resultcodigoResultFup": "001005"
}
],}
"length": 1]
}
|
...
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 |
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:
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | response.json |
---|
|
{
"operation": "ReturnDocsFup",
"dataexport": [
{
"numeroDocnamefile": "20191212135703_Exportacao_000000.xls",
"nomeDocfiledata": "1319;1000PGh0bWwgeG1sbnM6dj0ndXJuOnNjaGVtYXMtb",
"origemDoc": "NTA",}
"filialDoc": "01",
"codigoDoc": "0000000349",
],
"extDocoperation": "",
"descrDoc": "dtpr006.prt",
"idCod": "0000000065"
}
]
}
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çãoEm caso de erro, o retorno deve ser:
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | response.json |
---|
|
{
"operationpauta": "ListFup",
"messages": [
{
"detailnamefile": "Não foram encontrados registros.",
"code": "1001",
"type": "Error"
20191212135703_Exportacao_000000.xls",
}
],
"hasNextfiledata": "falsePGh0bWwgeG1sbnM6dj0ndXJuOnNjaGVtYXMtbW",
"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 | 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 | |
...
],
"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
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | response.json | request.json |
---|
|
{
"name{
"operation": "ListTypeFup",
"data": [
{
"descriTipoFup": "Acompanhamento1000000026-1519666379712.txt",
"filialTipoFup"content": "dGVzdGUgUE9TVCBGVVA="
} |
Exemplo: .../rest/JURFWREST/fup/1000000032/docs
Response
Exemplo de retorno da requisição:
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | response.json |
---|
|
{,
"codigoTipoFup": "00001"
},"messages": [
{
"descriTipoFupdetail": "Audiência",
"filialTipoFupcode": "1000",
"codigoTipoFuptype": "00002"
Documento criado com sucesso },
{
"descriTipoFup": "Julgamento",
"filialTipoFup": "",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
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | 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:
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | response.json |
---|
|
{
"operation": "UpdateFup",
"messages": [
"codigoTipoFup": "00003"
},
{
"descriTipoFup": "Prazo",
"filialTipoFup": "",
"codigoTipoFup": "00004"
},
{
"descriTipoFup": "Providências",
"filialTipoFup": "",
"codigoTipoFup": "00005"
},
{
"descriTipoFupdetail": "Reunião",
"filialTipoFupcode": "1000",
"codigoTipoFuptype": "00006Success"
}
]
}
|
GET / JURFWREST /status - (ListStatsFup)
...