Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 26

changes.mady.by.user Daniel Fernandes Rodrigues

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Usuário desconhecido (jacomo.fernandes)

Gravado em

Chave

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

...

ParâmetroTipoDescriçãoValor Defaut
pagenumberPágina inicial que será retornada1
pageSizenumberTamanho da página que será retornada10
fieldsstringLista de campos (separados por vírgula) que devem ser retornados.-
periFiltstringPerí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
cateFiltstringCategoria do Follow-up. Caso deseje pesquisar mais que uma, separar os valores por vírgula.-
dataInistringFiltro da data inicial que ignora o parametro periFilt.-
dataFimstringFiltro da data final que ignora o parametro periFilt.-
numProstringFiltra pelo numero do processo.-
searchKeystringSerá feito uma busca nos campos de “Descrição do Follow-up”, “Tipo de Follow-up”, "Número do Processo e o "Nome das partes".-
lWSTLegalBooleanA 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.

acaoTipo de ação do processo foroForo do processo siglaSigla do responsável numproNumero do processo detailstringDetalhe do up
PropriedadeTipoDescriçãoAdicional
operationstringNome da operação
hasNextstringIndica se existe mais uma página de registros
dataArrayUm array de objetos
data[n], descstringDescrição do Follow-up
data[n]. pedidos.tipostringTipo de pedido do processo
data[n]. pedidos.valornumberValor do pedido do processo
data[n]. pedidos.progstringProg do pedido do processo
data[n]. autorstringAutor principal do processo
data[n]. autorCpfCnpjstringCpf/Cnpj do autor principal
data[n]. datafustringData do Follow-up
data[n]. tipoAsjOrigstringAssunto jurídico origem
data[n]. tipoStatusstringStatus da situação do Follow-up
data[n]. reagendadostringbooleanFollow-up foi reagendado? .T. para sim e .F. para não.
data[n]. codPartstringCódigo do participante do FUP.
data[n]. usrLoggedbooleanO follow-up é do usuário logado? .T. para sim e .F. para não
data[n]. acaostringTipo de ação do processo
data[n]. forostringForo do processo
data[n]. siglastringSigla do responsável
data[n]. numprostringNumero do processo
data[n]. detailstringDetalhe do follow up
data[n]. resp.nomestringdata[n]. resp.nomestringNome do responsável do processo
data[n]. resp.siglastringSigla do responsável do processo
data[n]. resp.emailstringE-mail do responsável do processo

data[n]. resp.fone

stringTelefone do responsável do processo
data[n]. provnumberValor de provisão
data[n]. outrosEnvolvidos.NomestringNome dos outros envolvidos
data[n]. outrosEnvolvidos.TelefonestringTelefone dos outros envolvidos
data[n]. outrosEnvolvidos.TipoEnvstringTipo de envolvimento
data[n]. outrosEnvolvidos.EmailstringE-mail dos outros envolvidos
data[n]. outrosEnvolvidos.CpfCnpjstringCpf/Cnpj do envolvido
data[n]. tipofu.descristringDescrição do tipo do follow-up
data[n]. tipofu.codigostringCódigo do tipo do follow-up
data[n].situacaostringSituação do processo (1 = Em andamento, 2 = Encerrado)
data[n]. preposto.nomestringNome do preposto
data[n]. preposto.telefonestringTelefone do preposto
data[n]. preposto.emailstringE-mail do preposto
data[n]. reustringReu principal do processo
data[n]. reuCpfCnpjstringCpf/Cnpj do réu principal do processo
data[n]. duraçãostringDuração do Follow-updata[n]. partcontstringParte contraria
data[n]. documentos.idDocstringId do documento do Follow-up
data[n]. documentos.NomeDocstringNome do documento do Follow-up
data[n]. horastringHora do Follow-up
data[n]. idFustringCódigo do Follow-up
data[n]. varastringVara do processo
data[n]. resultstringCódigo do resultado
data[n]. pedvaltotnumberValor total do pedido
data[n]. cajuristringCódigo do assunto jurídico
data[n]. tipoasjstringCódigo do tipo de assunto jurídico
data[n]. partcontCpfCnpjendForostringCpf/Cnpj da parte contráriadata[n]. endForostringEndereço do Foro
data[n]. descresulstringDescrição do Status do Follow-Up
data[n]. filialstringFilial do processo
data[n]. solicitantestringSolicitante da consulta
data[n]. tipoSolicitacaostringTipo de solicitação informado
lengthnumberQuantidade de documentos exibidos

...

Bloco de código
languagejs
themeRDark
titleresponse.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  ",
            "partcont			"tipoStatus": "1",
            "result": "001",
            "dtfup": "20170904",
            "documentos": [],
            "reu": "CLIENTE NOVO ANDREA",    {
            "pedvaltot": 0,
            "idFu": "1000000015"NomeDoc": "2018-12-11_10-25-38.png",
            "datafu": "2017-09-04",
            "tipofuidDoc": ["0000000177"
                {}
            ],
            "descrireu": "PROVIDENCIACLIENTE NOVO ANDREA",
			"tipoAsjOrig": "       ",
            "codigopedvaltot": "00004"0,
            "idFu": "1000000015",
   }
            ],
            "situacao"datafu": "12017-09-04",
            "prepostotipofu": [
                {
                    "telefonedescri": "PROVIDENCIA",
                    "nomecodigo": "00004",
                    "email": ""
                }
            ],
            "autorsituacao": "1",
			"reagendado": false,
            "outrosEnvolvidospreposto": [
                {
                    "Telefonetelefone": "",
                    "TipoEnvnome": "TERCEIRO INTERESSADO",
                    "CpfCnpjemail": "87114413927025",
                }
     "Nome": "FORNECEDOR TODOS IMPOSTOS NA BAIXA",
        ],
                   "Email"autor": "",
                }
 "outrosEnvolvidos": [
           ],
     {
       "prov": 500,
            "tipoasjTelefone": "001",
            "partcontCpfCnpj": "",
            "endForoTipoEnv": "Patio do Colegio, 73TERCEIRO INTERESSADO",
            "reuCpfCnpj": "95818900670551",
            "descresulCpfCnpj": "Em aberto87114413927025",
            "filial": "        "Nome": "FORNECEDOR TODOS IMPOSTOS NA BAIXA",
                    "detailEmail": ""
                }
            ],
            "lengthprov": 1500,
            "hasNexttipoasj": "true001",
            "operationendForo": "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

...

Retorno

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

...

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
languagejs
themeRDark
titleresponse.json
{
    "operation": "DetailFup",
    "hasNext": "false",
    "data": [
        {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",
            "descreuCpfCnpj": "",
            "pedidosdescresul": [ "Em aberto",
            "filial": "   {
     ",
			"solicitante": "Daniel",
			"tipoSolicitacao": "Solicitação de informação",
            "tipodetail": "Férias",
        }
    ],
    "length": 2,
    "valorhasNext": 1000"true",
                    "prog"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âmetroTipoDescriçãoValor Default
fieldsstringLista 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.

PropriedadeTipoDescriçãoAdicional
operationstringNome da operação
hasNextstringIndica se existe mais uma página de registros
dataArrayUm array de objetos
data[n], descstringDescrição do Follow-up
data[n]. pedidos.tipostringTipo de pedido do processo
data[n]. pedidos.valornumberValor do pedido do processo
data[n]. pedidos.progstringProg do pedido do processo
data[n]. autorstringAutor do processo
data[n]. datafustringData do Follow-up
data[n]. tipoAsjOrigstringAssunto jurídico origem
data[n]. tipoStatusstringStatus da situação do Follow-up
data[n]. reagendadobooleanFollow-up foi reagendado? .T. para sim e .F. para não.
data[n]. codPartstringCódigo do participante do FUP.

data[n]. usrLogged

booleanO follow-up é do usuário logado? .T. para sim e .F. para não
data[n]. acaostringTipo de ação do processo
data[n]. forostringForo do processo
data[n]. siglastringSigla do responsável
data[n]. numprostringNumero do processo
data[n]. detailstringDetalhe do processo
data[n]. resp.nomestringNome do responsável do processo
data[n]. resp.siglastringSigla do responsável do processo
data[n]. resp.emailstringE-mail do responsável do processo

data[n]. resp.fone

stringTelefone do responsável do processo
data[n]. provnumberValor de provisão
data[n]. outrosEnvolvidos.NomestringNome dos outros envolvidos
data[n]. outrosEnvolvidos.TelefonestringTelefone dos outros envolvidos
data[n]. outrosEnvolvidos.TipoEnvstringTipo de envolvimento
data[n]. outrosEnvolvidos.EmailstringE-mail dos outros envolvidos
data[n]. tipofu.descristringDescrição do tipo do follow-up
data[n]. tipofu.codigostringCódigo do tipo do follow-up
data[n].situacaostringSituação do processo (1 = Em andamento, 2 = Encerrado)
data[n]. preposto.nomestringNome do preposto
data[n]. preposto.telefonestringTelefone do preposto
data[n]. preposto.emailstringE-mail do preposto
data[n]. reustringReu do processo
data[n]. duraçãostringDuração do Follow-up
data[n]. endForostringEndereço do processo
data[n]. documentos.idDocstringId do documento do Follow-up
data[n]. documentos.NomeDocstringNome do documento do Follow-up
data[n]. horastringHora do Follow-up
data[n]. idFustringCódigo do Follow-up
data[n]. varastringVara do processo
data[n]. resultstringCódigo do resultado
data[n]. pedvaltotnumberValor total do pedido
data[n]. cajuristringCódigo do assunto jurídico
data[n]. tipoasjstringCódigo do tipo de assunto jurídico
data[n]. endForostringEndereço do Foro
data[n]. descresulstringDescrição do Status do Follow-Up
data[n]. filialstringFilial do processo
data[n]. solicitantestringSolicitante da consulta
data[n]. tipoSolicitacaostringTipo de solicitação da consulta
lengthnumberQuantidade 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
languagejs
themeRDark
titleresponse.json
{
    "data": [
Provável"
                },
                {
                    "tipo": "Férias",
                    "valor": 50,
                    "prog": "Provável"
                }
            ],{
            "autoracao": "CLIENTEVinculo 01empregaticio",
            "datafuhora": "2017-08-15:",
            "acaovara": "Abertura, Registro e Cumprimento3a Camara do Tribunal de Justica do Estado de TestamentoSP",
            "forocajuri": "Foro Regional I - Santana"0000000064",
            "autorCpfCnpj": "",
            "siglanumpro": "MAD  0010039742016503013",
            "numproforo": "11066208820158260100Tribunal de Justica",
            "detaildesc": ".""",
			"usrLogged": true,
            "resppedidos": [
                {
                    "nomevalor": "MARCELO ARAUJO DENTE"0,
                    "siglatipo": "MADHoras extras",
                    "emailprog": "",
Provavel"
                }
            ],
            "foneduracao": "",
                },"resp": [
                {
                    "nomesigla": "WILLIANWYK",
                    "siglafone": "WYK",
                    "emailnome": "WILLIAN KAZAHAYA",
                    "foneemail": "[email protected]"
                }
            ],
            "prov": 0,
         "sigla": "WYK  "outrosEnvolvidos,
			"tipoStatus": []"1",
            "tipofuresult": ["001",
                {
        "dtfup": "20170904",
            "descridocumentos": "Acompanhamento",[
                {
    "codigo": "00001"
                }
    "NomeDoc": "2018-12-11_10-25-38.png",
        ],
            "situacaoidDoc": "10000000177",
            "preposto": [
   }
             {],
            "reu": "CLIENTE       "nomeNOVO ANDREA",
			"tipoAsjOrig": "   ",
            "pedvaltot": 0,
            "telefoneidFu": "1000000015",
            "datafu": "2017-09-04",
            "emailtipofu": ""[
                }{
               ],
     "descri": "PROVIDENCIA",
      "pedvaltot": 1050,
              "reucodigo": "00004",
            "duracao": "",    }
            "endForo": ""],
            "partcontsituacao": "1",
			"reagendado": false,
            "documentospreposto": [
                {
                    "idDoctelefone": "0000000010",
                    "NomeDocnome": "vc_red.msi",
                },
    "email": ""
           {
     }
               "idDoc": "0000000011",
        ],
            "NomeDocautor": "3.txt",
                },"outrosEnvolvidos": [
                {
                    "idDocTelefone": "0000000012",
                    "NomeDocTipoEnv": "3.txt"TERCEIRO INTERESSADO",
                },
                {"CpfCnpj": "87114413927025",
                    "idDocNome": "0000000013FORNECEDOR TODOS IMPOSTOS NA BAIXA",
                    "NomeDocEmail": "1.txt"
                },
            ],
     {
       "prov": 500,
            "idDoctipoasj": "0000000014001",
            "endForo": "Patio do      "NomeDocColegio, 73",
			"codPart": "6.txt002183",
            "reuCpfCnpj": "95818900670551",
   }
         "descresul": "Em  ]aberto",
            "horafilial": "08:42",
            "idFu",
			"solicitante": "Daniel",
			"tipoSolicitacao": "0000000002Solicitação de informação",
            "varadetail": "1ª Vara"
 do Juizado Especial Cível",
    }
    ],
    "resultlength": "001"
        }1,
    ]"hasNext": "false",
    "lengthoperation": 1"DetailFup"
}


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

...

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

...

dataInistringFiltro da data inicial que ignora o parametro periFilt.data atual
dataFimstringFiltro da data final que ignora o parametro periFilt.data atual + 7 dias

Retorno

O serviço deve retornar as propriedades informadas:

...

ParâmetroTipoDescrição
periFiltstring

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

statusstring

Status a ser filtrado:

1 - Pendente

2 - Concluído

3 - Cancelado

4 - Em aprovação

5 - Em andamento

dataInistring

Filtro da data inicial que ignora o parametro periFilt.

Informar no formato AAAAMMDD

dataFimstring

Filtro da data final que ignora o parametro periFilt.

Informar no formato AAAAMMDD

Retorno

O serviço deve retornar as propriedades informadas:

...