Histórico da Página

...

• 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].companyStatus: Status da empresa (COMO SÃO DEFINIDOS? SÃO CONFIGURÁVEIS OU HARDCODED? COMO DESCOBRIR QUAL É?).
• processes[n].folder: Pasta (ou caso).
• processes[n].folderDescription: Descrição da pasta (ou caso).
• processes[n].area: Área do processo.
• processes[n].subArea: Subárea do processo.
• processes[n].status: Status do processo.
• processes[n].processNumber: Número do processo.
• processes[n].entryDate: Data de entrada, no formato Protheus YYYYMMDD.
• processes[n].distributionDate: Data de distribuição, no formato Protheus YYYYMMDD.
• processes[n].originInstance: Objeto da Instância de Origem.
• processes[n].originInstance.id: Identificador único da instância de origem.
• processes[n].originInstance.displayName: Nome da Instãncia de Origem.
• processes[n].originInstance.branch: Vara da Instância de Origem.
• processes[n].originInstance.local: Local da Instância de Origem (É CIDADE OU ESTADO? NÃO PODE SER ENDEREÇO?).
• processes[n].responsables: Array com os envolvidos do jurídico no processo.
• processes[n].responsables[m].position: Cargo do envolvido.
• processes[n].responsables[m].name: Nome do envolvido.
• processes[n].responsables[m].initials: Iniciais do envolvido.
• processes[n].related: Array com as partes envolvidas no processo.
• processes[n].related[k].position: Cargo do envolvido.
• processes[n].related[k].name: Nome do envolvido.
• processes[n].related[k].role: Papél do envolvido.
• processes[n].related[k].details: Objeto com os detalhes adicionais (O QUE SERÁ EXIBIDO?).
• processes[n].detailing: Array com os detalhamentos do processo.
• processes[n].detailing[j].section: Seção do detalhamento.
• processes[n].detailing[j].value: Texto do detalhamento (É MUITO GRANDE? FAZ SENTIDO DIVIIDIR?).
• processes[n].values_and_contingency: Objeto de Valores e Contigência.
• processes[n].values_and_contingency.justification: Justificativa.
• processes[n].values_and_contingency.probability_of_losing: Objeto que indica a probabilidade de perder a ação.
• processes[n].values_and_contingency.probability_of_losing.grade: Grau da probabilidade de perder (quanto mais alto, mais provável), até 5.
• processes[n].values_and_contingency.probability_of_losing.description: Descrição do grau (ex: 5=PROVÁVEL) É ISSO MESMO? VALIDAR.
• processes[n].values_and_contingency.values: Array de valores.
• processes[n].values_and_contingency.values[y].description: Descrição do valor.
• processes[n].values_and_contingency.values[y].currency: Símbolo da moeda do valor.
• processes[n].values_and_contingency.values[y].value: Valor.
• processes[n].decisions: Array de decisões prévias do processo. Os dados serão apresentados na ordem que forem retornados.
• processes[n].decisions[t].title: Título do parecer.
• processes[n].decisions[t].date: Data do parecer, no formato protheus YYYYMMDD.
• processes[n].decisions[t].sentenceResult: Resultado do parecer, 0 -> desfavorável, 1 -> favorável.
• processes[n].decisions[t].sentence: Texto do parecer (SE FOR MUITO GRANDE SEPARAR).
• processes[n].decisions[t].instance: Instância.
• processes[n].injunctions: Array com liminares do processo.
• processes[n].injunctions[w].title: Título da liminar.
• processes[n].injunctions[w].date: Data da liminar.
• processes[n].injunctions[w].sentence: Texto da liminar.
• processes[n].courses: Array de andamentos do processo.
• processes[n].courses[q].date: Data do andamento.
• processes[n].courses[q].title: Título do andamento.
• processes[n].courses[q].description: Descrição do andamento.
• processes[n].fups: Array de Follow Ups do processo. Trazer somente os últimos 4 (ver parâmetro abaixo).
• processes[n].fups[e].id: Identificador único do FUP.
• processes[n].fups[e].date: Data do FollowUp no formato YYYYMMDD.
• processes[n].fups[e].hour:  Hora do follow up no formato HH:mm.
• processes[n].fups[e].status: Status do follow up: 0->Pendente, 1->Concluído, 2->em andamento.
• processes[n].fups[e].title: Título do follow up.
• processes[n].fups[e].responsable: Responsável pelo Follow up (iniciais + nome).
• processes[n].guarantees: Array com as garantias do processo.
• processes[n].guarantees[z].identifier: Identificador do tipo de garantia (G, A, etc).
• processes[n].guarantees[z].operation: Indica se a garantia é um débito (0) ou um crédito (1).
• processes[n].guarantees[z].description: Descrição da garantia.
• processes[n].guarantees[z].date: Data da garantia.
• processes[n].guarantees[z].value: Valor da garantia.
• processes[n].expenses: Array com as despesas do processo.
• processes[n].expenses[g].identifier: Identificador do tipo de despesa (D, 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.
• processes[n].expenses[g].date: Data da despesa.
• processes[n].expenses[g].value: Valor da despesa.
• processes[n].closure: Objeto do encerramento do processo.
• processes[n].closure.result: Objeto com o resultado do encerramento.
• processes[n].closure.result.type: Indica se foi uma vitória (1) ou derrota (0).
• processes[n].closure.result.description: Descrição do resultado do processo.
• processes[n].closure.date: Data do encerramento.
• processes[n].closure.finalValue: Valor final do processo.
• 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)

                - companyStatus: Filtra pelo status da empresa, 00001 é ativo, por exemplo

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

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

                - related.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.

1.1.1            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.