CONTEÚDO

1. Visão Geral
2. Exemplo de utilização
3. Tela XXX
   1. Outras Ações / Ações relacionadas
      
4. Tela XXX
   1. Principais Campos e Parâmetros
      
5. Tabelas utilizadas

01. VISÃO GERAL

Os serviços especificados neste documento serão consumidos pelo aplicativo Legal Process, utilizados na integração de  ocorrências (SIGAPFS) x sistemas jurídicosde Ocorrências do Jurídico com o SIGAPFS.

02. 

...

2.1 JSON Requisições

...

DEFINIÇÕES DO SERVIÇO

Os serviços demonstrados nesta documentação serão consumidos pelo Sistema Jurídico.

...

02.1 Método de Busca Solicitações Aguardando Processamento

GET - /api/ocorrencia/pending/{codigoT} 

Retorna uma lista com os dados das Solicitações que estão aguardando processamento.

02.1.1 Parâmetros da requisição

• codigoT: Código da Configuração do Cliente Encodado em Base64. (vide configuração).

02.1.2 Response da requisição

Abaixo seguem as possíveis respostas do serviço:

02.1.2.1 Sucesso - 200

A requisição irá retornar uma lista com os dados da Solicitação para que o Sistema Jurídico comece a coletar as informações.

objeto solicitação
{
{
    "response": [
        {
            "id:uuid string,
": "1a4b5ffe-448d-4d11-bbdf-b88584fbcf74",
            "entidade": "1",
            "campoRetorno": "1",
            "solicitante: string,
    emailSolicitante: string": {
                "nome": "Administrador",
                "email": "[email protected]"
            },
            "dataLog": {
                "inclusao": "2023-01-05 22:05:01.193688",
                "processamento": "",
    dataInclusao: date,
            "conclusao": ""
            },
            "contrato": {
              dataProcessamento  "codigo": date"000323",
         dataConclusao       "cliente": date"WYKPFS",
       entidade: string,
    contrato: string         "loja": "01"
            },
            "ocorrencia": {
                "codigo": "000001",
    clienteCaso:[array],
            "descricao": "Novos processos no periodo"
            },
            "dataReferencia:[objeto],
": {
                "inicial": "20200201",
                "final": "20200301"
            },
            "filtros":[array] [
                {
                    "campo": "DATA_ENTRADA",
                    "tipo": "1",
    resultado:[objeto]
}

objeto dataReferencia
                "valor": ""
                },
                {
    dataRefInicial: date                "campo": "STATUS_PROCESSO",
    dataRefFinal: date    
}

array clienteCaso
{
    cliente:string.
    loja: string,
    caso:string
}   

Descrição dos Campos:

• solicitação: array de solicitação (Indica todos os campos referentes ao item solicitações).
• id: identificador da solicitação.
• solicitante: descrição do solicitante
• emailSolicitante: e-mail do solicitante
• dataInclusao: data de inclusão da solicitação
• dataProcessamento: data a qual solicitação foi processada
• dataConclusao: data a qual solicitação foi concluída
• entidade entidade jurídica a realizar a solicitação
• contrato tipo de contrato vinculado a solicitação
• dataReferencia: objeto data de referência 
• dataRefInicial: data inicial de referência 
• dataRefinal: data final de referência 
• clienteCaso: objeto cliente caso
• cliente: cliente do caso relacionado a solicitação
• loja: loja do cliente 
• caso: caso do cliente
• filtros: filtros a seram aplicados na solicitação
• resultado: resultado final da solicitação

2.2 JSON Resposta Jurídico

  Retorna a lista de reqisições disponíveis para consulta, no formato indicado abaixo:

                "tipo": "2",
                    "valor": "1"
                }
            ],
            "casos": [
                {
                    "cliente": "WYKPFS",
                    "loja": "01",
                    "caso": "000003"
                }
            ]
        }
    ]
}

Descrição das propriedades da solicitação:

• response: Array com os dados das Solicitações;
• response[n].id: Identificação da Solicitação (Formato UUIDv4);
• response[n].entidade: Entidade jurídica da Solicitação (vide dicionário);
• response[n].campoRetorno: Tag para o cálculo de valor para faturamento (vide dicionário);
• response[n].solicitante: Agrupamento de dados do Solicitante;
• response[n].solicitante.nome: Nome do Solicitante;
• response[n].solicitante.email: E-mail do Solicitante;
  
• response[n].dataLog: Agrupamento de Log da Solicitação;
  
• response[n].dataLog.inclusao: Data/Hora da inclusão da Solicitação;
  
• response[n].dataLog.processamento: Data/Hora da resposta de processamento da Solicitação;
  
• response[n].dataLog.conclusao: Data/Hora da conclusão da Solicitação;
  
• response[n].contrato: Agrupamento dos dados do Contrato;
  
• response[n].contrato.codigo: Código do Contrato;
  
• response[n].contrato.cliente: Código do Cliente do Contrato;
  
• response[n].contrato.loja: Loja do Cliente do Contrato;
  
• response[n].ocorrencia: Agrupamento da Ocorrência;
  
• response[n].ocorrencia.codigo: Código da Ocorrência;
  
• response[n].ocorrencia.descricao: Descrição da Ocorrência;
  
• response[n].dataReferencia: Agrupamento da Data de Referência;
  
• response[n].dataReferencia.inicial: Data inicial para filtro dos registros;
  
• response[n].dataReferencia.final: Data final para filtro dos registros;
  
• response[n].filtros: Array de filtros adicionais;
  
• response[n].filtros[i].campo: Campo a ser filtrado (vide dicionário);
• response[n].filtros[i].tipo: Tipo do Filtro (vide dicionário);
• response[n].filtros[i].valor: Valor a ser filtrado;
  
• response[n].casos: Array de Casos do Contrato;
  
• response[n].casos[i].cliente: Código do Cliente do Caso;
  
• response[n].casos[i].loja: Loja do Cliente do Caso;
  
• response[n].casos[i].caso: Código do Caso;

02.1.2.2 Erro Autenticação - 401

Retornará este erro quando o header de Authorization não for válido.

{
	"mensagem": "Falha na autenticação!"
}

...

02.2 Método de Movimentação da Solicitação para "Em Processamento"

PUT -  /api/ocorrencia/pending/{codigoT}/{codigoSolicitacao}/progress

Movimenta a solicitação que está em "aguardando processamento" para "em processamento". 

Ao realizar a chamada deste endpoint o sistema irá atualizar o status da solicitação, evitando que a Solicitação apareça em uma próxima consulta da Busca de Solicitações Aguardando Processamento

02.2.1 Parâmetros da requisição

• codigoT: Código da Configuração do Cliente Encodado em Base64. (vide configuração);
• codigoSolicitacao: ID da Solicitação a ser atualizada;

02.2.2 Body da requisição

Não há body para esta requisição no momento

02.2.3 Response da requisição

Abaixo seguem as possíveis respostas do serviço:

02.2.3.1 Sucesso - 200

{
	"mensagem": "A solicitação <id_solicitação> foi atualizada com sucesso!"
}

02.2.3.2 Erro Autenticação - 401

Retornará este erro quando o header de Authorization não for válido.

{
	"mensagem": "Falha na autenticação!"
}

02.2.3.3 Erro na atualização da solicitação - 404

Retornará este erro quando ocorrer erro na atualização dos dados da Solicitação.

array filtros
{
    campo:string,"mensagem": "Arquivo não foi encontrado!"
}

...

02.3 Método de Atualização da Solicitação com dados Jurídicos

PUT - /api/ocorrencia/progress/{codigoT}/{codigoSolicitacao}

Atualiza a Solicitação com os dados internos do Sistema Jurídico.

Obs: A solicitação precisa ter sido movimentada pelo método 'Movimentação da Solicitação para "Em Processamento"'. 

02.3.1 Parâmetros da requisição

• codigoT: Código da Configuração do Cliente Encodado em Base64. (vide configuração);
• codigoSolicitacao: ID da Solicitação a ser atualizada;

02.3.2 Body da requisição

O Body deve conter os registros que serão contabilizados para a geração da Fatura, respeitando a Entidade informada na Solicitação.

02.3.2.1 Body da requisição - Processos

{
    valor:string  
}

objeto resultado
[
"resposta": {
        "processos": [array],

            {
          atoprocessual: [array]
]

array processos
{
      "id": "84098e43-da2a-4816-b249-ef67f3e61476",
                "cliente":string "JLP001",
                "loja": string"01",
                "caso":string "000044",
                "processo":string, {
      retorno:string
}

array atoprocessual
{
              cliente:string,
"autor": "TOTVS SA",
               loja: string     "reu": "João da Silva",
    caso:string,
                "processo:string,": "0014332-49.2011.4.01.4000"
    descricao:string,
            }, 
                retorno:string
} 

Descrição dos Campos:

• filtros: array de filtros(Indica todos os campos referentes ao item filtros).
• campo: descrição do campo a ser apresentado no filtro
• valor: valor contido no campo(podendo ser numérico ou texto)
• resultado: array de resultados(Indica todos os campos referentes ao item resultado)
• processos: array de resultados(Indica todos os campos referentes ao item resultado)
• cliente: array de clientes (Indica todos os campos referentes ao item cliente)
• loja: loja do cliente 
• caso: caso vinculado ao cliente
• processo: processo vinculado ao cliente
• retorno: retorno esperado do objeto cliente

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.

<CAMPO_RETORNO>: 100000
            }
        ]
    }
}

Descrição das propriedades da solicitação:

• resposta: Agrupador da resposta;
• resposta.processos: Array com os dados dos Processos a serem processados;
• resposta.processos[n].id: Código do Processo;
• resposta.processos[n].cliente: Código do Cliente;
• resposta.processos[n].loja: Loja do Cliente;
• resposta.processos[n].caso: Caso em que o Processo está vinculado;
• resposta.processos[n].processo: Agrupamento do Processo;
• resposta.processos[n].processo.autor: Autor do Processo;
• resposta.processos[n].processo.reu: Réu do Processo;
• resposta.processos[n].processo.processo: Numero do Processo;
• * resposta.processos[n].<CAMPO_RETORNO>: Valor do campo de retorno (vide dicionário);

* Obs: Campo só será necessário se na Solicitação a chave "campoRetorno" estiver preenchido, caso contrário não deve ser enviado.

02.3.2.2 Body da requisição - Atos Processuais

{
    "resposta": {
        "atosProcessuais": [
            {
                "id": "84098e43-da2a-4816-b249-ef67f3e61476",
                "cliente": "JLP001",
                "loja": "01",
                "caso": "000044",
                "processo": {
                    "autor": "TOTVS SA",
                    "reu": "João da Silva",
                    "processo": "0014332-49.2011.4.01.4000"
                },
                "ato": {
                    "descricao": "Petição inicial",
                    "data": "20230223"
                }
            }
        ]
    }
}

Descrição das propriedades da solicitação:

• resposta: Agrupador da resposta;
• resposta.atosProcessuais: Array com os dados dos Atos Processuais a serem processados;
• resposta.atosProcessuais[n].id: Código do Ato Processual;
• resposta.atosProcessuais[n].cliente: Código do Cliente;
• resposta.atosProcessuais[n].loja: Loja do Cliente;
• resposta.atosProcessuais[n].caso: Caso em que o Ato Processual está vinculado;
• resposta.atosProcessuais[n].processo: Agrupamento do Processo;
• resposta.atosProcessuais[n].processo.autor: Autor do Processo;
• resposta.atosProcessuais[n].processo.reu: Réu do Processo;
• resposta.atosProcessuais[n].processo.processo: Numero do Processo;
• resposta.atosProcessuais[n].ato: Agrupamento do Ato processual;
• resposta.atosProcessuais[n].ato.descricao: Descrição do Ato Processual;
• resposta.atosProcessuais[n].ato.data: Data do Ato Processual;

02.3.3 Response da requisição

Abaixo seguem as possíveis respostas do serviço:

02.3.3.1 Sucesso - 200

{
	"mensagem": "A solicitação <id_solicitação> foi atualizada com sucesso!"
}

02.3.3.2 Erro Autenticação - 401

Retornará este erro quando o header de Authorization não for válido.

{
	"mensagem": "Falha na autenticação!"
}

02.3.3.3Erro no Body da Requisição- 400

Retornará este erro quando o Body passado para a requisição contiver erros de Encode ou não respeitar a estrutura esperada.

{
	"mensagem": "Body não encontrado!"
}

02.3.3.4Erro na atualização da solicitação - 404

Retornará este erro quando ocorrer erro na atualização dos dados da Solicitação.

{
	"mensagem": "Erro na atualização do arquivo da solicitação!"
}

...

03.

TABELAS UTILIZADAS

• OI2 - Tipos de Ocorrências
• OI3 - Filtros de Ocorrências

04. DOCUMENTOS DE REFERÊNCIA

• Ocorrências - JURA301
• Configuração da integração
• Dicionário para integração de ocorrências (SIGAPFS) x sistemas jurídicos