Histórico da Página
Índice |
---|
...
- 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 |
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) | 1 |
cateFilt | string | Categoria do Follow-up | - |
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". | - |
Retorno
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 | 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]. | datafuautorCpfCnpj | string | Data do Follow-upCpf/Cnpj do autor principal | ||||
data[n]. acaodatafu | stringTipo | de ação do processoData do Follow-up | |||||
data[n]. | forotipoAsjOrig | string | Foro do processoAssunto jurídico origem | ||||
data[n]. | siglatipoStatus | string | Sigla do responsávelStatus da situação do Follow-up | ||||
data[n]. | numproreagendado | string | Numero do processoboolean | Follow-up foi reagendado? .T. para sim e .F. para não. | |||
data[n]. | detailcodPart | string | Detalhe do follow upCódigo do participante do FUP. | ||||
data[n]. | resp.nomeusrLogged | string | Nome do responsável do processoboolean | O follow-up é do usuário logado? .T. para sim e .F. para não | |||
data[n]. resp.siglaacao | string | Sigla do responsável Tipo de ação do processo | |||||
data[n]. resp.emailforo | string | E-mail Foro do responsável do processo | |||||
data[n]. resp.fonesigla | string | Telefone Sigla do responsável do processo | |||||
data[n]. provnumpro | number | string | Numero do processoValor de provisão | ||||
data[n]. | outrosEnvolvidos.Nomedetail | string | Nome dos outros envolvidosDetalhe do follow up | ||||
data[n]. | outrosEnvolvidosresp. | Telefonenome | string | Telefone dos outros envolvidosNome do responsável do processo | |||
data[n]. | outrosEnvolvidosresp. | TipoEnvsigla | string | Tipo de envolvimentoSigla do responsável do processo | |||
data[n]. | outrosEnvolvidosresp. | Emailstring | do responsável do processo | ||||
data[n]. | tipofuresp. | descrifone | string | DescriçãoTelefone do | tiporesponsável do | follow-upprocesso | |
data[n]. | tipofu.codigoprov | string | Código do tipo do follow-upnumber | Valor de provisão | |||
data[n]. prepostooutrosEnvolvidos.nomeNome | string | Nome do prepostodos outros envolvidos | |||||
data[n]. prepostooutrosEnvolvidos.telefoneTelefone | string | Telefone do prepostodos outros envolvidos | |||||
data[n]. prepostooutrosEnvolvidos.emailTipoEnv | stringE-mail do preposto | Tipo de envolvimento | |||||
data[n]. outrosEnvolvidos. reuEmail | stringReu do processo | E-mail dos outros envolvidos | |||||
data[n]. duraçãooutrosEnvolvidos.CpfCnpj | stringDuração | do Follow-upCpf/Cnpj do envolvido | |||||
data[n]. tipofu. partcontdescri | stringParte contraria | Descrição do tipo do follow-up | |||||
data[n]. documentostipofu.idDoccodigo | string | Id Código do documento tipo do Followfollow-up | |||||
data[n]. documentos.NomeDocsituacao | stringNome do documento do Follow-up | Situação do processo (1 = Em andamento, 2 = Encerrado) | |||||
data[n]. preposto. horanome | string | Hora Nome do Follow-uppreposto | |||||
data[n]. preposto. idFutelefone | string | Código Telefone do Follow-uppreposto | |||||
data[n]. varapreposto.email | string | Vara E-mail do processopreposto | |||||
data[n]. resultreu | string | Código Reu principal do resultadoprocesso | |||||
data[n]. pedvaltotreuCpfCnpj | number | Valor total do pedido | length | number | Quantidade de documentos exibidos |
Exemplo de retorno da requisição:
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:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"data": [ | ||||||
Bloco de código | ||||||
| ||||||
{ "operation": "ListFup", "hasNext": "false", "data": [ { "desc": "", "pedidos": [ { "tipo": "Férias", { "valoracao": "Vinculo 1000empregaticio", "proghora": "Provável:", "vara": "3a Camara do }, Tribunal de Justica do Estado de SP", { "cajuri": "0000000064", "tipoautorCpfCnpj": "Férias", "numpro": "0010039742016503013", "valor": 50, "foro": "Tribunal de Justica", "progdesc": "Provável", "usrLogged": true, }"pedidos": [ ], { "autor": "CLIENTE 01", "datafuvalor": "2017-08-15"0, "acao "tipo": "Abertura, Registro e Cumprimento de TestamentoHoras extras", "foro "prog": "Foro Regional I - Santana", Provavel" "sigla": "MAD ",} "numpro": "11066208820158260100"], "detailduracao": ".", "resp": [ { "nomesigla": "MARCELO ARAUJO DENTEWYK", "siglafone": "MAD", "emailnome": "WILLIAN KAZAHAYA", "foneemail": "[email protected]" }, ], { "sigla": "WYK ", "tipoStatus": "1", "nomeresult": "WILLIAN001", "sigladtfup": "WYK20170904", "emaildocumentos": "",[ { "fone": "" } "NomeDoc": "2018-12-11_10-25-38.png", ], "providDoc": 0,"0000000177" "outrosEnvolvidos": [], } "tipofu": [ ], "reu": { "CLIENTE NOVO ANDREA", "tipoAsjOrig": " ", "descripedvaltot": "Acompanhamento"0, "codigoidFu": "000011000000015", } ]"datafu": "2017-09-04", "prepostotipofu": [ { "nomedescri": "PROVIDENCIA", "telefonecodigo": "00004", } "email": "" ], } "situacao": ]"1", "reagendado": false, "pedvaltotpreposto": 1050,[ "reu": "", { "duracao": "", "endForotelefone": "", "partcontnome": "", "documentosemail": ["" {} ], "idDocautor": "0000000010", "outrosEnvolvidos": [ "NomeDoc": "vc_red.msi" { }, {"Telefone": "", "idDocTipoEnv": "0000000011TERCEIRO INTERESSADO", "NomeDocCpfCnpj": "3.txt87114413927025", }, "Nome": "FORNECEDOR TODOS IMPOSTOS {NA BAIXA", "idDocEmail": "0000000012", } "NomeDoc": "3.txt" ], }, "prov": 500, {"tipoasj": "001", "endForo": "Patio do "idDocColegio, 73", "codPart": "0000000013002183", "NomeDocreuCpfCnpj": "1.txt95818900670551", "descresul": }"Em aberto", { "filial": " ", "idDocdetail": "0000000014", }, "NomeDoc": "6.txt"{ "acao": "Vinculo empregaticio", } ]"hora": ":", "horavara": "08:423a Camara do Tribunal de Justica do Estado de SP", "idFucajuri": "00000000020000000063", "varaautorCpfCnpj": "1ª Vara do Juizado Especial Cível"", "numpro": "090807060504030201", "resultforo": "001Tribunal de Justica", } ]"desc": "", "length "pedidos": 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
...
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
...
[],
"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 | 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 | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"data": [
{
|
...
data[n]. resp.fone
...
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "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", "siglaacao": "WYKVinculo empregaticio", "hora": ":", "emailvara": "", 3a Camara do Tribunal de Justica do Estado de SP", "fonecajuri": "0000000064", "autorCpfCnpj": "", } ]"numpro": "0010039742016503013", "provforo": 0 "Tribunal de Justica", "desc": "outrosEnvolvidos"", "usrLogged": []true, "tipofupedidos": [ { "descrivalor": "Acompanhamento"0, "codigotipo": "00001Horas extras", } "prog": "Provavel" ], } "preposto": [ ], { "duracao": "", "nome"resp": "",[ "telefone": "",{ "emailsigla": "WYK", } "fone": "", ], "pedvaltotnome": "WILLIAN 1050KAZAHAYA", "reu": "", "duracaoemail": "[email protected]", "endForo": "", } "partcont": ""], "documentossigla": [ "WYK ", "tipoStatus": "1", { "result": "001", "idDocdtfup": "000000001020170904", "documentos": [ "NomeDoc": "vc_red.msi" { }, {"NomeDoc": "2018-12-11_10-25-38.png", "idDoc": "00000000110000000177", "NomeDoc": "3.txt" }, { "idDoc": "0000000012", "NomeDoc": "3.txt" } ], "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 | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "operation": "ReturnDocsFup", "data": [ },{ { "numeroDoc": "", "idDoc"nomeDoc": "00000000131319;1000", "NomeDoc"origemDoc": "1.txtNTA", "filialDoc": "01", }, "codigoDoc": "0000000349", { "extDoc": "", "idDocdescrDoc": "0000000014dtpr006.prt", "idCod": "0000000065" "NomeDoc": "6.txt" } ] } |
Em caso de erro, o retorno deve ser:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "operation": "ListFup", }"messages": [ ],{ "horadetail": "08:42Não foram encontrados registros.", "idFucode": "00000000021001", "varatype": "1ªError" Vara do Juizado Especial Cível", } ], "resulthasNext": "001false", } "data": [], "length": 10 } |
GET / JURFWREST/
...
categories - (
...
ListTypeFup)
Este serviço deve retornar as informações dos Documentos a lista de Tipo de Follow-up, com os detalhes da mesma. Este serviço somente não aceita o nenhum parâmetro codDoc.
Parâmetros aceitos
...
nenhum
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
Propriedade | Tipo | DecriçãoDescrição | Adicional | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
operation | string | Nome Identificação 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 | stringArray com os tipos de Follow-up | |
data[n]. codigoDocdescriTipoFup | stringCodigo | do documentoDescrição do tipo de Follow-up | ||||||||||||
data[n]. extDocfilialTipoFup | string | data[n] descrDoc | string | Descrição do documentoFilial do tipo de Follow-up | ||||||||||
data[n]. idCodcodigoTipoFup | stringid | do documentoCodigo do tipo de Follow-up |
Exemplo de retorno da requisição:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "operation": "ListTypeFup", "data": [ { "descriTipoFup": "Acompanhamento", "filialTipoFup{ "operation": "ReturnDocsFup", "datacodigoTipoFup": [ "00001" }, { "descriTipoFup": "Audiência", "numeroDocfilialTipoFup": "", "codigoTipoFup": "00002" }, "nomeDoc": "1319;1000", { "origemDocdescriTipoFup": "NTAJulgamento", "filialDocfilialTipoFup": "01", "codigoDoccodigoTipoFup": "000000034900003", }, "extDoc": "", { "descrDocdescriTipoFup": "dtpr006.prtPrazo", "idCodfilialTipoFup": "0000000065", } ] } |
Em caso de erro, o retorno deve ser:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "operation"codigoTipoFup": "ListFup00004", "messages": [ }, { "detaildescriTipoFup": "Não foram encontrados registros.Providências", "codefilialTipoFup": "1001", "typecodigoTipoFup": "Error00005" }, { ], "descriTipoFup": "Reunião", "hasNextfilialTipoFup": "false", "data": [], "codigoTipoFup": "00006" } "length": 0] } |
GET / JURFWREST /
...
status - (
...
ListStatsFup)
Este serviço deve retornar a lista de Tipo status de Followfollow-up, com os detalhes da mesma. Este serviço 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- |
Exemplo de retorno da requisição:
up |
Exemplo de retorno da requisição:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"operation": "ListStatsFups",
"data": [
{
"tipoResultFup": "1",
"descriResultFup": "Em aberto",
"filialResultFup": "",
"codigoResultFup": "001"
},
{
| ||||||
Bloco de código | ||||||
| ||||||
{ "operation": "ListTypeFup", "data": [ {"tipoResultFup": "2", "descriTipoFupdescriResultFup": "AcompanhamentoConcluido", "filialTipoFupfilialResultFup": "", "codigoTipoFupcodigoResultFup": "00001002" }, { "tipoResultFup": "3", "descriTipoFupdescriResultFup": "AudiênciaCancelado", "filialTipoFupfilialResultFup": "", "codigoTipoFupcodigoResultFup": "00002003" }, { "tipoResultFup": "descriTipoFup"1", "descriResultFup": "JulgamentoPendente", "filialTipoFupfilialResultFup": "", "codigoTipoFupcodigoResultFup": "00003"004" }, }, { { "tipoResultFup": "5", "descriTipoFupdescriResultFup": "PrazoEm andamento", "filialTipoFupfilialResultFup": "", "codigoTipoFupcodigoResultFup": "00004005" }, { "descriTipoFup": "Providências", "filialTipoFup": "", "codigoTipoFup": "00005" },] } |
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:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "export": [ { "descriTipoFupnamefile": "Reunião", "filialTipoFup": "20191212135703_Exportacao_000000.xls", "codigoTipoFupfiledata": "00006PGh0bWwgeG1sbnM6dj0ndXJuOnNjaGVtYXMtb" } ] } |
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
,
"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, de acordo com os parâmetros passados na consulta.:
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:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
| ||||||
Bloco de código | ||||||
| ||||||
{ "operation": "ListStatsFups", "data": [ { "tipoResultFuppauta": "1",[ "descriResultFup": "Em aberto",{ "filialResultFupnamefile": "", "codigoResultFup": "001" }, {20191212135703_Exportacao_000000.xls", "tipoResultFupfiledata": "2PGh0bWwgeG1sbnM6dj0ndXJuOnNjaGVtYXMtbW", } ], "descriResultFupoperation": "ConcluidoRelatorioPauta", "filialResultFup": "", "codigoResultFup": "002" }, { "tipoResultFup": "3", } |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"name": "1000000026-1519666379712.txt",
"content": "dGVzdGUgUE9TVCBGVVA="
} |
Exemplo: .../rest/JURFWREST/fup/1000000032/docs
Response
Exemplo de retorno da requisição:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "messages": [ "descriResultFup": "Cancelado", { "filialResultFupdetail": "", "codigoResultFupcode": "003" }, {1000", "tipoResultFuptype": "1", Documento criado com sucesso SIGAJURI 2018-02-26T16:34:53" } "descriResultFup": "Pendente", "filialResultFup": "", "codigoResultFup": "004" }, { "tipoResultFup": "5", "descriResultFup": "Em andamento", "filialResultFup": "", "codigoResultFup": "005" } ] } |
POST / JURFWREST / fup / {codFup} / docs
Este serviço trata da criação de documentos no Follow-up.
Parâmetros aceitos
...
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
...
PUT / JURFWREST /fup / {codFup}
Alteração de informações do detalhe do Follow-up a partir do Body
Parâmetros aceitos
]
} |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"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 | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"operation": "UpdateFup",
"messages": [
{
"detail": "",
"code": "1000",
"type": "Success"
}
]
} |
...
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
...