Índice

1.

...

Informações Gerais

2.

...

Objetivo

Os serviços especificados neste serão consumidos pelo aplicativo “Legal Process” (nome a ser definido) Legal Process e tem por objetivo permitir ao usuário consultar os processos cadastrados na base Protheus de um smartphone ou tablet.

3.

...

Definições de Serviços

3.1.

...

GET/

...

JURLEGALPROCESS/process

Retorna a lista de processos disponíveis para consulta, no formato indicado abaixo:

{
    "operation": "ListProcess",
    "userName" : "Claudio KojiTotvers",
    "hasNext": truefalse,
    "processes" : [
        {
            "processIdassJurDesc": "00000001Contencioso",
            "companyassJur" : "3031001",
            "companyNameentryDate" : "ZEI CONSULTORIA20170928",
            "matterprocessId" : "12550000000062",
            "matterDescriptionprovisionValue" : "Caio e Tício"10000,
            "areaoppositeParty": "TRABALHISTAMarcelo Araujo Dente",
            "subareaarea": "CONTENCIOSO",[
            "status"   : {
                    "codedescription" : "0000002Trabalhista".,
 (Este código não fica no banco, fica no dicionário. É uma lista de opções. 1 – Em Andamento, 2 – Encerrado)"code": "000001",
                "description": "Em andamento"}
            }],
            "entryDateinstance" : "20170101",[
            "originInstance":     {
                   "id      "processNumber": "00000184939439843924",'
                "displayName": "FORO REGIONAL DE SÃO PAULO",
 }
            ],
             "branchcompany": "5ª Vara Cível", [
                {
                    "localname": "SÃOLEGALTASK PAULO001",
                    "processNumbercode": "0004310-87.1996.5.21.002JLT001-01",
                "distributionDate" : "20161230",}
            }],
            "staff" : [
                {
                    "position": "COORDENADORResponsável",
                    "nameinitials": "SEMPRONIO DA SILVA ANTUNESWYK",
                    "initialsname" : "SSAWILLIAN KAZAHAYA",
                },
            ],
    {
        "party" : [
                {"position": "Advogado",
                    "nameinitials": "CAIO MARIO DA SILVA DO AMARAL",
                    "rolename": "RECLAMENTE",
                },
      "details"  :“texto concatenado de acordo com a entidade da parte”{
                }
    "position": "Estagiário",
       ],
             "sectioninitials": "JUDICIAL",
            "detailing" : [
      "name": "",
         {
       }
             "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."],
            "matter": [
                {
                    "description": "LEGALTASK 001//090807060504030201",
                    "code": "000001",
                }
            ],
            "values_and_contingencysubarea": :[
                {
                    "probability_of_losingdescription": :"CONTENCIOSO",
               {
     "code": "000001",
               "grade": 5,
 }
            ],
            "descriptionstatus": "PROVÁVEL"[
                },{
                    "justificationdescription" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
                "values": [
                    {
                        “description”: "VALOR DA CAUSA ATUAL",
                        "currency": "R$",
                        "value": 10000.00
                    }
                ]
      Em andamento",
                    "code": "1",
                }
            ]
        }

Descrição dos Campos:

• userName: Nome do usuário logado.
• operation: Qual tipo de operação.
• hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).
• processes: Array de processos.
• processes[n].processId: Identificador único do processo.
• processes[n].oppositeParty: Nome da outra parte.
• processes[n].assJurDesc: Descrição Assunto.
• processes[n].assJur: Código Assunto.
• processes[n].entryDate: Data de entrada, no formato Protheus YYYYMMDD.
• processes[n].provisionValue: Valor total do processo (somatória dos valores e contingência)
• processes[n].area: Array com as Áreas do processo.
• processes[n].area[i].description: Descrição da área do processo.
• processes[n].area[i].code: Código da área do processo.
• processes[n].company: Array que indica dados da empresa.
• processes[n].company[x].code: Código da empresa.
• processes[n].staff: Array com os participantes do jurídico no processo.
• processes[n].staff[m].position: Cargo do participante.
• processes[n].staff[m].initials: Sigla do participante.
• processes[n].staff[m].name: Nome do participante.
• processes[n].matter: Array da Pasta (ou caso) do processo.
• processes[n].matter[x]:code: Código do caso.
• processes[n].matter[x]:Description: Descrição da pasta (ou caso).
• processes[n].subArea: Array com as Subáreas do processo.
• processes[n].subArea[i].description: Descrição da Subárea do processo.
• processes[n].subArea[i].code: Código da Subárea do processo.
• processes[n].status: Array com Status do processo. (Em Andamento, Encerrado)
• processes[n].status.description: Descrição do Status.
• processes[n].status.code: Código do Status.
• processes[n].instance: Array com as Instâncias.
• processes[n].instance[a].processNumber: Número do processo da Instância.
  
  

Parâmetros aceitos:

• language - Indica o idioma que os labels devem retornar. Todos os labels que podem ser traduzidos devem ser traduzidos. Os seguintes idiomas podem ser selecionados pelo app: "en"=Inglês, "pt"="Português", "es"="Espanhol. Qualquer valor diferente dos citados (ou a omissão do parâmetro) deve considerar como padrão o "pt".              

• order - Ordem padrão.

• page e pageSize - Utilizados para fazer paginação.

             A primeira página é a 1

             Se não for enviado um page, considerar a página 1.

             Se não for passado um pageSize, considerar o tamanho de página como 10.

             TODA requisição de lista deve retornar um atributo hasNext indicando se atingiu a última página ou não.

             Exemplos: (supondo que existam 32 registros na base):

             GET /processes -> Retorna a página padrão (1) com tamanho padrão (10) (registro do 1 ao 10, hasNext = true)

                GET /processes?page=1 -> Retorna a página 1 com tamanho padrão (10) (registro de 1 ao 10, hasNext = true)

                GET /processes?pageSize=3 -> Retorna a página padrão (1) com tamanho 3 (registro de 1 ao 3, hasNext = true)

                GET /processes?page=2&pageSize=4 -> Retorna a página (2) com tamanho (4) (registro do 5 ao 8, hasNext = true)

                GET /processes?page=4&pageSize=10 -> Retorna a página (4) com tamanho (10) (registro do 31 ao 40 -> irá retornar só o 31 e o 32, hasNext = false)

                etc.   

• fields

            Informa quais campos devem ser retornados na requisição.

            Se o fields não for informado, trazer todos os campos disponíveis.

            Exemplos:

            GET /processess?fields=processId,client -> Retorna somente os campos ID do processo e Cliente.

              GET /processes -> Retorna todos os campos disponíveis.

• Filtros

            Deve suportar filtrar os resultados de acordo com alguns parâmetros:

                - searchKey: Filtro chave, capaz de filtrar em diversos campos diferentes do processo (número do processo, Nome das Partes, detalhamento do Processo (este campo não é exibido no App).

Exemplos: party.name, processes[n].instance[a].processNumber)

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

3.2. Get/JURLEGALPROCESS/processes/{processID}

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

{
    "operation": "ListProcess",
    "userName": "Totvers",
    "length": 11,
    "processes": [
        {
  			"processId": "0000000063",
            "fup": [
                               {
                    "tipFup": "1",
                    "id": "1000000017",
                    "status": "001",
                    "responsable": [
                        {
                            "id": "002183",
                            "acronym": "WYK",
                            "email": "[email protected]",
                            "name": "WILLIAN KAZAHAYA",
                            "fone": ""
                        }
                    ],
                    "tipFupDesc": "Pendente",
                    "title": "PROVIDENCIA",
                    "date": "20170928",
                    "hour": ":"
                }
            ],
            "injuctions": [
			           {
                            "id": "0000000001",
							"title": "Liminar Revogada", 
							"date": "20170322",
							"sentence": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."}],			
            "assJurDesc": "Contencioso",
            "status": [
                {
                    "description": "Em andamento",
                    "code": "1"
                }
            ],
            "values_and_contingency": [
                {
                    "values": [
                        {
                            "currency": "R$",
                            "description": "",
                            "value": 1000
                        }
                    ],
                    "description": "CT059-JURA162",
                    "probability_of_winning": ""
                }
            ],
            "party": [
                {
                    "position": "",
                    "id": "0000000066",
                    "relationName": "Reclamante",
                    "relationCode": "01",
                    "name": "LEGALTASK 001",
                    "main": "1",
                    "entity": "JLT00101",
                    "sourceEntity": "SA1",
                    "code": "JLT001-01",
                    "positionCode": ""
                }
            ],
            "oppositeParty": "Cliente Juridico",         
            "provisionValue": 10000, 
            "expenses": [
                {
                    "identifier": "Taxi",
                    "description": "CT-007",
                    "date": "20161208",
                    "value": ""
                },
                {
                    "identifier": "TIPO DE DESPESA EXCLUSIVO P/ CT013 (JURA099)",
                    "description": "CT013-JURA099",
                    "date": "20161208",
                    "value": ""
                },
            ],
				    "area": [
                {
                    "description": "Trabalhista",
                    "code": "001"
                }
            ],
            "subarea": [
                {
                    "description": "CONTENCIOSO",
                    "code": "000001"
                }
            ],
            "assJur": "001",
            "assJurDesc": "Contencioso",
            "instance": [
                {
                    "districtCourt": "Tribunal de Justica",
                    "distribution": "",
                    "processNumber": "090807060504030201",
                    "branch": "3a Camara do Tribunal de Justica do Estado de SP",
                    "id": "0000000063",
                    "instaAtual": "1",
                    "city": "",
                    "cityCode": "",
                    "numInstance": "1",
                    "natureCode": "001",
                    "local": "Sao Paulo",
                    "displayName": "1a Instancia",
                    "nature": "Judicial"
                }
            ],
            "decisions" : [
                {
					"id": "0000000001",
                    "title": "Setença Procedente",
                    "date": "20170222",
                    "sentence" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo 							                                   
						Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
                    "instance": "1ª"
                }
            ],
            "guarantees" : [
                {
                    "identifier": "G",
                    "description": "Depósito Recursal",
                    "date": "20170222",
                    "value": 10000.00
                }
            ],
            "matter": [
                {
                    "description": "LEGALTASK 001//090807060504030201",
                    "code": "000001"
                }
            ],
            "entryDate": "20170928",
            "staff": [
                {
                    "position": "Responsável",
                    "initials": "WYK",
                    "name": "WILLIAN KAZAHAYA"
                },
                {
                    "position": "Advogado",
                    "initials": "",
                    "name": ""
                },
                {
                    "position": "Estagiário",
                    "initials": "",
                    "name": ""
                }
            ],
            "closure": [      },
            "decisions" : [
                {
                    "title": "Setença Procedente",
                    "date": "20170222",
                    "sentenceResult": 0,
                    "sentence" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
                    "instance": "1ª"
                }
            ],
            "injunctions" : [
                {
                    "title": "Liminar Revogada",
                    "date": "20170322",
                    "sentence" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
                }
            ],
            "courses" : [
                {
                    "date": "20160823",
                    "title" "Acompanhamento Decisória",
                    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
                }
{
                    "veredict": "Lorem ipsum dolor sit amet, consectetur adipiscing  ],
       elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
     "fups" : [
                {
         consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse "id": "0000001",
                    "date": "20160823"cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
                    "hourfinalValue":  "14:00"1000.00,,
                     "statusdescription" : 0"VITÓRIA",
                     "titledate" : "Reunião de NegóciosYYYYMMDD",
                    "responsabletype": "JPB - João Pereira Bittencourt1"
                }
            ],
            "guaranteescompany" : [
                {
                    "identifiername": "GLEGALTASK 001",
                    "operationcode": 1,"JLT001-01"
                }
    "description": "Depósito Recursal",
        ],
            "history": [
              "date": "20170222",  {
                    "valueid": 10000.00
"0000000010",
                 }
   "title": "Acompanhamento Decisória",
        ],
            "expensesdate" : ["20171017"
                {},
                    "identifier": "D", {
                    "operationid": 1"0000000013",
                    "descriptiontitle": "GuiaAcompanhamento de RecolhimentoDecisória",
                    "date": "2017022220171023",
                 }
   "value": 10000.00
        ]
        }
            ],
            "closure": {
                "result": {
                    "type": 1, -- Neste caso temos cadastro tabelado no banco.
                    “id”: “001”,
                    "description": "VITÓRIA"
                },
                "date": "YYYYMMDD",
                "finalValue": 1000.00,
                "veredict": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
            }
        }
    ]
}

Descrição dos Campos:

]
}

Descrição dos Campos:

• userName: Nome do usuário logado.

• hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).

• processes: Array de processos.

• processes[n].processId: Identificador único do processo.

• operation: Qual tipo de operação.

• processes[n].oppositeParty: Nome da parte contraria.

• processes[n].provisionValue: Valor total do processo (somatória dos valores e contingência)

• processes[n].fups: Array de Follow Ups do processo. Trazer somente os últimos 4 (ver parâmetro abaixo).

• processes[n].fups[e].id: Id do Follow-up

• processes[n].fups[e].status: Código do resultado do Follow-up .

• processes[n].fups[e].tipFup: Código do tipo do resultado do Follow-up.

• processes[n].fups[e].tipFupDesc: Descritivo do tipo do resultado do Follow-up.

• processes[n].fups[e].responsable: Array de Responsável pelo Follow-up.

• processes[n].fups[e].responsable[x].id: Id do responsável do Follow-up.

• processes[n].fups[e].responsable[x].acronym: Acrónimo do responsável do Follow-up.

• processes[n].fups[e].responsable[x].email: E-mail do responsável do Follow-up.

• processes[n].fups[e].responsable[x].name: Nome do responsável do Follow-up.

• processes[n].fups[e].responsable[x].fone: Fone do responsável do Follow-up.

• processes[n].fups[e].title: Tipo do follow-up.

• processes[n].fups[e].date: Data do Follow-up no formato YYYYMMDD.

• processes[n].fups[e].hour: Hora do follow-up no formato HH:mm.

• processes[n].injuctions: Array com liminares

• userName: Nome do usuário logado.
• hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).
• processes: Array de processos.
• processes[n].processId: Identificador único do processo.
• processes[n].company: Código da empresa.
• processes[n].companyName: Nome da empresa.
• processes[n].matter: Pasta (ou caso)
• processes[n].matterDescription: Descrição da pasta (ou caso)
• processes[n].area: Área

  do processo.

• processes[n].

  subArea: Subárea do processo

  injuctions[w].id: Código da liminar.
  

• processes[n].

  status: Objeto com Status do processo. ( Em Andamento,  Encerrado

  injuctions[w].title: Título da liminar.

• processes[n].

  entryDate: Data de entrada, no formato Protheus YYYYMMDD

  injuctions[w].date: Data da liminar.

• processes[n].injuctions[w].

  originInstance

  sentence:

  Objeto

   Texto da

  Instância de Origem

  liminar.

• processes[n].

  originInstance.id: Identificador único da instância de origem.

  status: Array com Status do processo. (Em Andamento, Encerrado)

• processes[n].

  originInstance

  status.

  displayName: Nome da Instãncia de Origem

  description: Descrição do Status.

• processes[n].

  originInstance

  status.

  branch: Vara da Instância de Origem

  code: Código do Status.

• processes[n].

  originInstance.local: Local da Instância de Origem é um lugar, não é endereço

  values_and_contingency: Array de Objetos.

• processes[n].

  originInstance.processNumber: Número do processo

  values_and_contingency.values: Array de valores do Objeto.

• processes[n].

  originInstance.distributionDate: Data de distribuição, no formato Protheus YYYYMMDD

  values_and_contingency.values[y].currency: Descrição do valor.

• processes[n].values_and_contingency.values[y].

  staff: Array com os envolvidos do jurídico no processo

  description: Símbolo da moeda do valor.

• processes[n]

  .staff[m

  .values_and_contingency.values[y].

  position: Cargo do envolvido

  value: Valor.

• processes[n].

  staff[m].name: Nome do envolvido

  values_and_contingency.description: Descrição 

• processes[n].

  staff[m].initials: Iniciais do envolvido

  values_and_contingency.probability_of_winning: probabilidade de vitória

• processes[n].party:

  Array

   Array com as partes envolvidas no processo.

• processes[n].party[k].position:

  Cargo

   Cargo do envolvido.

• processes[n].party[k].

  name

  id:

  Nome

   ID do envolvido.

• processes[n].party[k].

  role

  relationName:

  Papél

   Nome da relação do envolvido.

• processes[n].party[k]

  .details: Objeto com os detalhes adicionais. Campo texto que será preenchido pelo Protheus, de acordo com a entidade do envolvido.
• processes[n].detailing: Texto do detalhamento.O texto e muito longo.
• processes[n].values_and_contingency: Objeto de Valores e Contigência.
• processes[n].values_and_contingency.justification: Justificativa

  .relationCode: Código da relação do envolvido.

• processes[n].

  values_and_contingency.probability_of_losing: Objeto que indica a probabilidade de perder a ação

  party[k].name: Nome do envolvido.

• processes[n].

  values_and_contingency.probability_of_losing.grade: Grau da probabilidade de perder (quanto mais alto, mais provável), até 5

  party[k].main: Main do envolvido.

• processes[n].

  values_and_contingency.probability_of_losing.description: Descrição do grau (ex: 5=PROVÁVEL) É ISSO MESMO? VALIDAR

  party[k].entity: Entidade do envolvido.

• processes[n].

  values_and_contingency.values: Array de valores

  party[k].sourceEntity: Tabela do envolvido.

• processes[n].

  values_and_contingency.values[y

  party[k].

  description

  code:

  Descrição

   Código do

  valor

  envolvido.

• processes[n].

  values_and_contingency.values[y

  party[k].

  currency

  positionCode:

  Símbolo

   Código da

  moeda

  posição do

  valor

  envolvido.

• processes[n].

  values_and_contingency.values[y].value: Valor

  expenses: Array com as despesas do processo.

• processes[n].

  decisions: Array de decisões prévias do processo. Os dados serão apresentados na ordem que forem retornados

  expenses[g].identifier: Identificador do tipo de despesa (D, etc).

• processes[n].

  decisions

  expenses[

  t

  g].

  title: Título do parecer

  description: Descrição da despesa.

• processes[n].

  decisions

  expenses[

  t

  g].date:

  Data do parecer, no formato protheus YYYYMMDD

   Data da despesa.

• processes[n]

  .decisions[t].sentenceResult: Resultado do parecer, 0 -> desfavorável, 1 -> favorável

  .expenses[g].value: Valor da despesa.

• processes[n].subArea: Array com as Subáreas do processo.

• processes[n].

  decisions

  subArea[

  t

  i].

  sentence

  description:

  Texto do parecer (SE FOR MUITO GRANDE SEPARAR)

   Descrição da Subárea do processo.

• processes[n].

  decisions[t].instance

  subArea[i].code: Código da Subárea do processo.

• processes[n].assJur: Código Assunto

  : Instância

  .

• processes[n].

  injunctions: Array com liminares do processo

  assJurDesc: Descrição Assunto.

• processes[n].

  injunctions[w].title: Título da liminar

  instance: Array com as Instâncias.

• processes[n].

  injunctions

  instance[

  w

  a].

  date

  districtCourt:

  Data

  Tipo do tribunal da

  liminar

  Instância.

• processes[n].

  injunctions

  instance[

  w

  a].

  sentence

  distribution:

  Texto

   Distribuição da

  liminar

  Instância.

• processes[n].

  history: Array de andamentos

  instance[a].processNumber: Número do processo da Instância.

• processes[n].

  history

  instance[

  q

  a].

  date: Data do andamento

  branch: Ramo da Instância.

• processes[n].

  history

  instance[

  q

  a].

  title: Título do andamento

  id:Id da Instância.

• processes[n].

  history

  instance[

  q

  a].

  description: Descrição do andamento.

  instaAtual: Instância atual do processo (1=Sim; 2=Não)

• processes[n].

  fups: Array de Follow Ups do processo. Trazer somente os últimos 4 (ver parâmetro abaixo)

  instance[a].city: Cidade da Instância.

• processes[n].

  fups

  instance[

  e

  a].

  id: Identificador único do FUP

  cityCode: Código da cidade da Instância.

• processes[n].

  fups

  instance[

  e

  a].

  date: Data do FollowUp no formato YYYYMMDD

  numInstance: Número da Instância.

• processes[n].

  fups

  instance[

  e

  a].

  hour:  Hora do follow up no formato HH:mm

  natureCode: Código da natureza da Instância.

• processes[n].

  fups

  instance[

  e

  a].

  status: Status do follow up: 0->Pendente, 1->Concluído, 2->em andamento

  local: Local da Instância.

• processes[n].

  fups

  instance[

  e

  a].

  title: Título do follow up

  displayName: Nome da Instância.

• processes[n].

  fups

  instance[

  e

  a].

  responsable: Responsável pelo Follow up (iniciais + nome)

  nature: Natureza da Instância.

• processes[n].

  guarantees: Array com as garantias

  decisions: Array de decisões prévias do processo.

• processes[n].

  guarantees

  decisions[

  z

  t].

  identifier

  id:

  Identificador do tipo de garantia (G, A, etc)

   Código do parecer.
  

• processes[n].

  guarantees

  decisions[

  z

  t].

  operation: Indica se a garantia é um débito (0) ou um crédito (1)

  title: Título do parecer.

• processes[n].

  guarantees

  decisions[

  z].description: Descrição da garantia

  t].date: Data do parecer, no formato Protheus YYYYMMDD.

• processes[n].

  guarantees

  decisions[

  z

  t].

  date: Data da garantia

  sentence: Texto do parecer (SE FOR MUITO GRANDE SEPARAR).

• processes[n].

  guarantees

  decisions[

  z

  t].

  value

  instance:

  Valor da garantia

   Instância.

• processes[n].

  expenses

  guarantees:

  Array

   Array com as

  despesas

  garantias do processo.

• processes[n].

  expenses

  guarantees[

  g

  z].identifier:

  Identificador

   Identificador do tipo de

  despesa

  garantia (

  D

  G,

  etc).
• processes[n].expenses[g].operation: Indica se a despesa é um débito (0) ou um crédito (1).
• processes[n].expenses[g].description: Descrição da despesa

  A).

• processes[n].

  expenses

  guarantees[

  g

  z].

  date

  description:

  Data

   Descrição da

  despesa

  garantia.

• processes[n].

  expenses

  guarantees[

  g

  z].

  value

  date:

  Valor

   Data da

  despesa

  garantia.

• processes[n].

  closure: Objeto do encerramento do processo.processes[n].closure.result: Objeto com o resultado do encerramento

  guarantees[z].value: Valor da garantia.

• processes[n].

  closure.result.type: Indica se foi uma vitória (1) ou derrota (0)

  matter: Array da Pasta (ou caso) do processo.

• processes[n].

  closure.result.description: Descrição do resultado do processo

  matter[x]:code: Código do caso.

• processes[n].

  closure.result.id: Id do resultado.processes[n].closure.date: Data do encerramento

  matter[x]:Description: Descrição da pasta (ou caso).

• processes[n].

  closure.finalValue: Valor final do processo

  entryDate: Data de entrada, no formato Protheus YYYYMMDD.

• processes[n].

  closure.veredict: Texto do encerramento do processo.
  

Parâmetros aceitos:

• language

            - Indica o idioma que os labels deverão ser retornados. Todos os labels que puderem ser traduzidos devem ser traduzidos. Os seguintes idiomas poderão ser selecionados pelo app: "en"=Inglês, "pt"="Português", "es"="Espanhol. Qualquer valor diferente dos citados (ou a omissão do parâmetro) deve considerar como padrão o "pt".           

• order 
  Diz como os resultados podem ser ordenados. Pode receber um ou mais campos, com ou sem o sinal de negativo (indicando se é crescente ou não) 

             Exemplos:

             GET /processes?order=processId -> Orderna pelo ID do processo de forma crescente.

               GET /processes?order=-entry_date -> Ordena pela Data de Entrada de forma decrescente.

               GET /processes?order=case,-entry_date,processId -> Ordena pelo caso (crescente), depois data de entrada (decrescente) e por fim número do processo (crescente)

             Campos aceitos no order: companyName, folderDescription, area, subarea, processNumber, entryDate, distributionDate

• page e pageSize

            Utilizados para fazer paginação.

             A primeira página é a 1

             Se não for enviado um page, considerar a página 1.

             Se não for passado um pageSize, considerar o tamanho de página como 10.

             TODA requisição de lista deve retornar um atributo hasNext indicando se atingiu a última página ou não.

             Exemplos (Supondo que existam 32 registros na base):

             GET /processes -> Retorna a página padrão (1) com tamanho padrão (10) (registro do 1 ao 10, hasNext = true)

                GET /processes?page=1 -> Retorna a página 1 com tamanho padrão (10) (registro de 1 ao 10, hasNext = true)

                GET /processes?pageSize=3 -> Retorna a página padrão (1) com tamanho 3 (registro de 1 ao 3, hasNext = true)

                GET /processes?page=2&pageSize=4 -> Retorna a página (2) com tamanho (4) (registro do 5 ao 8, hasNext = true)

                GET /processes?page=4&pageSize=10 -> Retorna a página (4) com tamanho (10) (registro do 31 ao 40 -> irá retornar só o 31 e o 32, hasNext = false)

                etc.

• fields

            Informa quais campos devem ser retornados na requisição.

            Se o fields não for informado, trazer todos os campos disponíveis.

            Exemplos:

            GET /processess?fields=processId,client,detailing -> Retorna somente os campos ID do processo, Cliente e Detalhamento.

              GET /processes -> Retorna todos os campos disponíveis.

• Filtros

            Deve suportar filtrar os resultados de acordo com alguns parâmetros:

                - searchKey: Filtro chave, capaz de filtrar em diversos campos diferentes do processo (máximo de lugares possível)

                - processId: Filtra pelo identificador único do processo (like)

                - company: Filtra pelo código da empresa, será enviado o código da empresa

                - companyName: Filtra pelo nome da empresa (like)

                - matterDescription: Filtra pela parte contrária (like)

                - area: Filtra pela área

                - subarea: Filtra pela subarea

                - status: Filtra pelo status do processo

                - processNumber: Filtra pelo número do processo

                - entryDateStart: Filtra pela data de entrada do processo, datas maiores ou iguais às informadas

                - entryDateEnd: Filtra pela data de entrada do processo, datas menores ou iguais às informadas

                - distributionDateStart: Filtra pela data de distribuição do processo, datas maiores ou iguais às informadas

                - distributionDateEnd: Filtra pela data de distribuição do processo, datas menores ou iguais às informadas

                - originInstance: Filtra pela instância de origem, será enviado o código da instância de origem

                - staff.name: Filtra pelos nomes dos responsáveis do processo

                - party.name: Filtra pelos nomes dos envolvidos do processo

                - closure.type: Filtra pelo resultado do encerramento. 1->Vitórias, 0->Derrotas (Traz somente processos encerrados)

                - closed: Filtra pelo resultado do processo: true->Somente processos encerrados, false->Somente processos em aberto

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

3.2.            Get/jur/processes/{processID}

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

• staff: Array com os participantes do jurídico no processo.

• processes[n].staff[m].position: Cargo do participante.

• processes[n].staff[m].initials: Sigla do participante.

• processes[n].staff[m].name: Nome do participante.

• processes[n].closure: Array que indica dados do encerramento.

• processes[n].closure[a].veredict: Texto do encerramento do processo.

• processes[n].closure[a].finalValue: Valor final do processo.

• processes[n].closure[a].Description: Indica a descrição do motivo do encerramento, campo tabelado.

• processes[n].closure[a].date: Data do encerramento.

• processes[n].closure[a].Type: Indica o código do motivo do encerramento, campo tabelado.

• processes[n].company: Array que indica dados da empresa.

• processes[n].company[x].name: Nome da empresa.

• processes[n].company[x].code: Código da empresa.

• processes[n].area: Array com as Áreas do processo.

• processes[n].area[i].description: Descrição da área do processo.

• processes[n].area[i].code: Código da área do processo.

• processes[n].history: Array de andamentos do processo.

• processes[n].history[q].id: Id do andamento.

• processes[n].history[q].title: Título do andamento.

• processes[n].history[q].date: Data do andamento.

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

3.3. GET /JURLEGALPROCESS/processes/{processID}/fups

Retorna os Follow Ups dos Processos, no seguinte formato:

{
    "hasNext": true,
    "fup": [
		{
        "tipFup": "1",
        "id": "1000000012",
        "status": "001",
        "responsable": [
		{
            "id": "001509",
            "acronym": "JUR",
            "email": "",
            "name": "JURI1000",
            "fone": ""
        }
    ],
        "title": "Em aberto",
        "date": "20171012",
        "hour": "15:00"
    }
   ]
}

Descrição dos Campos:

• hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).

• fups: Array de fups.

• fups[n].id: Identificador do Fup.

• fups[n].tipfup: tipo do Fup.

• fups[n].date: Data do Fup.

• fups[n].hour: Hora do Fup.

• fups[n].status: Status do Fup.

• fups[n].title: Titulo do Fup.

• fups[n].responsable: Array de responsável do Fup.

• fups[n].responsable[m].id: id do responsável.

• fups[n].responsable[m].acronym: Sigla do responsável

• fups[n].responsable[m].email: Email do responsável

• fups[n].responsable[m].name: Nome do responsável

• fups[n].responsable[m].fone: telefone do responsável

Os parâmetros aceitos serão: fields, searchKey, page e pageSize

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

3.4. GET /JURLEGALPROCESS/areas

Retorna as áreas disponíveis, no seguinte formato:

{
    "hasNext": true,
    "areas": [

         "status" : 0,
                     "title" : "Reunião de Negócios",
                    "responsable": "JPB - João Pereira Bittencourt"
                }
            ],
            "guarantees" : [
                {
                    "identifier": "G",
                    "operation": 1,
        {
            "descriptionsubarea": "Depósito Recursal",[
                    "date": "20170222",{
                    "valuedescriptionSub": 10000.00"SUBAREA TRABALHISTA",
                }
    "idSub": "00000"
       ],
            "expenses" : [},
                {
                    "identifierdescriptionSub": "Dsub trab",
                    "operationidSub": 1,"00001"
                }
    "description": "Guia de Recolhimento",
       ],
             "dateid": "20170222001",
                    "valuedescription": 10000.00"Trabalhista"
        }
        }
            ],
            "closure": {
                "result": {
                    "type": 1, -- Neste caso temos cadastro tabelado no banco.
                    “id”: “001”,
                    "description": "VITÓRIA"
                },
                "date": "YYYYMMDD",
                "finalValue": 1000.00,
    ]
}

Descrição dos Campos:

• hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).

• areas: Array das areas.

• areas[n].id: Id da area.

• areas[n].description: Descrição da area.

• areas[n].subareas: Array das subareas.

• areas[n].subareas[n].idSub: Id da subarea.

• areas[n].subareas[n].descriptionSub: Descrição da subarea.

Os  parâmetros aceitos serão: searchKey, page e pageSize.

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

3.5. GET /JURLEGALPROCESS/tlprocess/grupoAprv

Retorna os grupos de aprovação, no seguinte formato:

{
    "groupApprover": [
        {
            "veredictfilial": "LoremD MG ipsum01 dolor",
 sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.""id": "0000001",
            "codResp": "123456",
            "approver": "João da Silva",
            "minLimit": 1000,
            "maxLimit": 1500000
        }
    }
        }

]
}

Descrição dos Campos:

• groupApprover: Array das grupo de aprovador.

• groupApprover[n].id: Id do aprovador na tabela de Aprovadores.

• groupApprover[n].codResp: Id do responsável vinculado ao Aprovador.

• groupApprover[n].approver: Nome do responsável.

• groupApprover[n].minLimit: Valor minimo do aprovador.

• groupApprover[n].maxLimit: Valor máximo do aprovador.

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

3.

...

6. GET /

...

JURLEGALPROCESS/tlprocess/

...

tabGen/{

...

codTabela}

...

Retorna dados da tabela genérica (SX5), filtrando pelo código da tabela informadoRetorna os Follow Ups dos Processos, no seguinte formato:

Bloco de código
language js theme RDark title response.json collapse true
{ "hasNext": true, "fups" "result": [ { "idfilial": "000001D MG 01 ", "datetabela": "2016082305", "hourchave": "14:00BOL", "statusdescricao": 0"Boleto", "titledescrispa": "Reunião de NegóciosBoleta", "responsabledescrieng": "JPB - João Pereira BittencourtDocket" } ] }

Descrição dos Campos:

• result: Array de resultado.

• result

• hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).
• fups: Array de fups.
• fups

  [n].

  id: Identificador do Fup

  filial: Filial da tabela.

  fups

• result[n].

  date: Data do Fup

  tabela: Código da tabela.

• fups

  result[n].

  hour

  chave:

  Hora

  Chave do

  Fup

  registro.

  fups

• result[n].

  status: Status do Fup

  descricao: Descrição em Português.

• fups

  result[n].

  title: Titulo do Fup

  descrispa: Descrição em Espanhol.

  fups

• result[n].

  responsable: Responsavel do Fup

  descrieng: Descrição em Inglês.

Os parâmetros Os  parâmetros aceitos serão: fields, searchKey, page e pageSizechaveTab.

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

3.

...

7. GET /JURLEGALPROCESS/tlprocess/sysParam/{codParam}

Retorna o valor do parâmetro informadoRetorna as áreas disponíveis, no seguinte formato:

{
    "hasNextsysParam": true,
    "areas" : [
        {
            "id": "000001",
            "description": "TRABALHISTA"
        }
    ]{
		"name":"MV_JGERDES",
		"value":"2"
	}
}

Descrição dos Campos:

...

• sysParam: Array de dados do parâmetro.
• sysParam.name: nome do parâmetro
• sysParam.value: valor do parâmetro

...

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

3.

...

8. GET /

...

JURLEGALPROCESS/fields

Retorna a lista de campos disponíveis para pesquisaRetorna as subareas disponíveis da área informada no parâmetro {areaId}, no seguinte formato:

{
"result": [{"codigo":   "hasNext"000000867"
"field": "NSY_COD",
"table": true"NSYT10",
"title": "Codigo OBJETO",
"type": "C","f3fields": "subareas" : [
        {
            "id": "000001",
            "description": "CONTENCIOSO"
        }
    ]
}"NSP_COD-NSP_DESC","comboOptions": [[ "1","Sim"],
["2","Não"]]
}]}

Descrição dos Campos:

...

• codigo: Código do registro na tabela NVH.
• field: Nome do campo
• table: Nome da Tabela
• title: Título do campo
• type: Tipo de dado do campo que pode ser: ("C"aracter, "N"umérico, "D"ata, "COMBO" ou "F3" Tabelado)
• f3fields: Traz o nome do campo chave e do campo Label para montagem do como F3. Só é exibido caso o tipo for F3
• comboOptions: Array com as opções do

...

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

3.

...

9. GET /JURLEGALPROCESS/f3list/{campof3}

Retorna a lista de ítens do campo tabelado requisitadoRetorna as instâncias de origem disponíveis, no seguinte formato:

{
    "hasNext": true,
    "originInstances" : [
        {
            "id": "000001",
      {
      "displayNamef3Options": "FORO[
  REGIONAL DE SÃO PAULO",
   [
         "branch": "5ª Vara Cível"0001",
            "local": "SÃO PAULOHoras extras"
        }
    ]
}

Descrição dos Campos:

...

    ]
    ]
}

Descrição dos Campos:

• f3Options: Array trazendo as opções para o campo F3

...

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

...

4. Mensagens de Erro

As mensagens de erro deveram obedecer um padrão único, independente do serviço solicitado, de acordo com a ocorrência.

4.1.

...

Corpo padrão da resposta

Todas as mensagens de erro devem possuir a mesma estrutura de campos na resposta:

{
    "code": "Código do Erro", 
    "message": "Título da mensagem de erro",
    "detalMessagedetailMessage": "Mensagem de erro detalhada"
}

4.2.

...

Tentativa de acesso à um dado restrito

Deve retornar um status http 403 FORBIDDEN.

...

{
    "code": "403", 
    "message": "Acesso Negado",
    "detalMessagedetailMessage": "O usuário informado não tem acesso à informação solicitada"
}

4.3.

...

Não conseguiu identificar o usuário logado

Deve retornar um status http 400 UNAUTHORIZED.

...