CONTEÚDO

Índice

exclude	CONTEÚDO

01. VISÃO GERAL

Os serviços especificados neste documento serão consumidos , utilizados na integração de ocorrências SIGAPFS x Legal Deskde Ocorrências do Jurídico com o SIGAPFS.

02.

...

2.1 POST /solicitacao

2.2.1 JSON Requisição

...

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.

Bloco de código

language	js
theme	RDark
title	request.json
collapse	true

{
    "response": [
        {
            "id": "c74142a61a4b5ffe-5146448d-11ed4d11-bdc3-0242ac120002",
  bbdf-b88584fbcf74",
            "entidade": "1",
            "campoRetorno": "1",
            "solicitante": "<nome_solicitante>",
  "emailSolicitante{
                "nome": "Administrador",
                "email": "solicitante@dominiowellington.machado@totvs.com.br"
            },
            "dataLog": {
          "dataInclusao      "inclusao": "202210212023-01-05 22:05:01.193688",
                "dataProcessamentoprocessamento": null"",
                "dataConclusaoconclusao": null ""
            },
  "entidade          "contrato": {
                "codigo": "1000323",
         "contrato       "cliente": "000001WYKPFS",
                "clienteCasoloja": [
 "01"
            },
            "ocorrencia": {
       "cliente         "codigo": "000001",
                "descricao": "Novos processos no periodo"
            },
            "dataReferencia": {
                "lojainicial": "0120200201",
                "casofinal": "00000020200301"
            },
            "filtros": [
                {
           "cliente         "campo": "000001DATA_ENTRADA",
                    "lojatipo": "011",
            "caso        "valor": "000000"
                },
                ],
  "dataReferencia": {
{
                    "campo": "STATUS_PROCESSO",
              "dataRefInicial      "tipo": "202210012",
                    "dataRefFinalvalor": "202210311"
                }
            ],
   "filtros         "casos": [
                {
          "campo          "cliente": "STATUS_PROCESSO", "valorWYKPFS",
                    "loja": "01",
                    "caso": "1" }
000003"
                }
            ]
        }
    ]
}

Descrição dos campos das propriedades da solicitação.

...

dataRefInicial: data inicial de referência
dataRefinal: data final de referência

...

cliente: cliente do caso relacionado ao contrato
loja: loja do cliente
caso: caso do cliente

...

campo: campos a serem filtrados
valor: valor do campo

:

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.

Bloco de código

language	js
theme	RDark
title	Response - 401
collapse	true

{
	"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

2.2.2 JSON Resposta

Retorna o body da requisição preenchendo o objeto resultado conforme a entidade solicitada no formato abaixo:

Bloco de código

language	js
theme	RDark
title	response.jsonResponse - 200
collapse	true

{
  	"idmensagem": "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.

Bloco de código

language	js
theme	RDark
title	Response - 401
collapse	true

{
	"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.

Bloco de código

language	js
theme	RDark
title	Response - 404
collapse	true

{
    "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

Bloco de código

language	js
theme	RDark
title	Body Processos
collapse	true

{
    "resposta": {
        "processos": [
            {
                "id": "84098e43-da2a-4816-b249-ef67f3e61476",
          "c74142a6-5146-11ed-bdc3-0242ac120002",
  "solicitante": "<nome_solicitante>",
  "emailSolicitante": "[email protected]",
  "dataInclusao": "20221021",
  "dataProcessamento": null,
  "dataConclusao": null,
  "entidade": "1",
  "contrato": "000001",
  "clienteCaso": [
    {
      "cliente": "000001JLP001",
                "loja": "01",
                "caso": "000000000044",
          },
      "processo": {
         "cliente           "autor": "000001TOTVS SA",
                    "lojareu": "01João da Silva",
                    "casoprocesso": "000001"
0014332-49.2011.4.01.4000"
                }, 
            ],
    "dataReferencia"<CAMPO_RETORNO>: {100000
    "dataRefInicial": "20221001",
    "dataRefFinal": "20221031"
  },
        ]
    }
}

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

Bloco de código

language	js
theme	RDark
title	Body Atos Processuais
collapse	true

{
    "resposta"filtros": [{ "campo": "STATUS_PROCESSO", "valor": "1" }],
  "resultado": {
        "processosatosProcessuais": [
            {
        "cliente        "id": "00000184098e43-da2a-4816-b249-ef67f3e61476",
         "loja       "cliente": "01JLP001",
                "casoloja": "00000001",
                "processocaso": "5345345345345345000044",
                "retornoprocesso": ""{
      },
      {
        "clienteautor": "000001TOTVS SA",
                    "lojareu": "01João da Silva",
           "caso": "000001",
        "processo": "123123123123123",0014332-49.2011.4.01.4000"
        "retorno": ""
        },
    ],
      "atoprocessual": [
     "ato": {
          "cliente": "000001",
          "lojadescricao": "01Petição inicial",
          "caso": "000001",
          "processodata": "12312312312312320230223",
        "descricao": "descrição do caso processual",
        }
     "retorno": ""
      }
        ]
    }
}

Descrição dos Camposdas propriedades da solicitação:

resultado: objeto de resultado
- processos: array de processos
- atoprocessual array de atos processuais

processos: array de processos
- cliente: código do cliente
- loja: loja do cliente
- caso: código do caso
- processo: id do processo
- retorno: retorno esperado conforme ocorência solicitada (vide dicionário)

atoprocessual: array de ato processua
- cliente: código do cliente
- loja: loja do cliente
- caso: código do caso
- processo: id do processo
- descricao: descrição do ato processual
- retorno: retorno esperado conforme ocorência solicitada (vide dicionário)

...

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

Bloco de código

language	js
theme	RDark
title	Response - 200
collapse	true

{
	"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.

Bloco de código

language	js
theme	RDark
title	Response - 401
collapse	true

{
	"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.

Bloco de código

language	js
theme	RDark
title	Response - 400
collapse	true

{
	"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.

Bloco de código

language	js
theme	RDark
title	Response - 404
collapse	true

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

Árvore de páginas

Versões comparadas

Versão antiga 11

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL

02.

2.1 POST /solicitacao

2.2.1 JSON Requisição

DEFINIÇÕES DO SERVIÇO

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

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

02.1.1 Parâmetros da requisição

02.1.2 Response da requisição

02.1.2.1 Sucesso - 200

02.1.2.2 Erro Autenticação - 401

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

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

02.2.1 Parâmetros da requisição

02.2.2 Body da requisição

02.2.3 Response da requisição

02.2.3.1 Sucesso - 200

2.2.2 JSON Resposta

02.2.3.2 Erro Autenticação - 401

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

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

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

02.3.1 Parâmetros da requisição

02.3.2 Body da requisição

02.3.2.1 Body da requisição - Processos

02.3.2.2 Body da requisição - Atos Processuais

02.3.3 Response da requisição

02.3.3.1 Sucesso - 200

02.3.3.2 Erro Autenticação - 401

02.3.3.3Erro no Body da Requisição- 400

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

03. TABELAS UTILIZADAS

04.

DOCUMENTOS DE REFERÊNCIA

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 11

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL

02.

2.1 POST /solicitacao

2.2.1 JSON Requisição

DEFINIÇÕES DO SERVIÇO

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

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

02.1.1 Parâmetros da requisição

02.1.2 Response da requisição

02.1.2.1 Sucesso - 200

02.1.2.2 Erro Autenticação - 401

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

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

02.2.1 Parâmetros da requisição

02.2.2 Body da requisição

02.2.3 Response da requisição

02.2.3.1 Sucesso - 200

2.2.2 JSON Resposta

02.2.3.2 Erro Autenticação - 401

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

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

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

02.3.1 Parâmetros da requisição

02.3.2 Body da requisição

02.3.2.1 Body da requisição - Processos

02.3.2.2 Body da requisição - Atos Processuais

02.3.3 Response da requisição

02.3.3.1 Sucesso - 200

02.3.3.2 Erro Autenticação - 401

02.3.3.3Erro no Body da Requisição- 400

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

03. TABELAS UTILIZADAS

04.

DOCUMENTOS DE REFERÊNCIA