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

02. Definições

...

2.1  POST /solicitacao

2.2.1  JSON Requisição

...

do serviço (api/{codigoT}/solicitacao) 

Esse método é responsável pela solicitação de ocorrências do sistema LegalDesk para calcular o faturamento das ocorrências.

• • codigoT: CódigoT recebido pela configuração do Protheus

02.1 Método POST 

02.2.1 Body JSON da requisição

A seguir, segue exemplo de um body de requisição 

{
  "id": "c74142a6-5146-11ed-bdc3-0242ac120002",
  "solicitante": "<nome_solicitante>",
  "emailSolicitante": "[email protected]",
  "dataInclusao": "20221021",
  "dataProcessamento": null,
  "dataConclusao": null,
  "entidade": "1",
  "contrato": "000001",
  "clienteCaso": [
    {
      "cliente": "000001",
      "loja": "01",
      "caso": "000000"
    },
    {
      "cliente": "000001",
      "loja": "01",
      "caso": "000000"
    }
  ],
  "dataReferencia": {
    "dataRefInicial": "20221001",
    "dataRefFinal": "20221031"
  },
  "filtros": [
    { "campo": "STATUS_PROCESSO", "valor": "1" }
  ]
}

Descrição

...

das propriedades da solicitação.

• • id: identificador universal  da solicitação(uuid).
  • solicitante: nome 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 (vide dicionário)
  • contrato: código docontrato vinculado a solicitação
  • dataReferencia: objeto data de referência
 
• • • dataRefInicial: data inicial de referência 
    • dataRefinal: data final de referência 
  • clienteCaso: array de objeto cliente/caso
    • cliente: cliente do caso relacionado ao contrato
    • loja: loja do cliente 
    • caso: caso do cliente
  • filtros: array de objetos (vide dicionário)
    
    • campo: campos
a 
• • • a serem filtrados
    • valor: valor do campo 

...

02.2.2 JSON Resposta 

...

  Body de resposta da requisição preenchendo o objeto resultado  conforme a entidade solicitada no formato abaixo:

{
  "id": "c74142a6-5146-11ed-bdc3-0242ac120002",
  "solicitante": "<nome_solicitante>",
  "emailSolicitante": "[email protected]",
  "dataInclusao": "20221021",
  "dataProcessamento": null,
  "dataConclusao": null,
  "entidade": "1",
  "contrato": "000001",
  "clienteCaso": [
    {
      "cliente": "000001",
      "loja": "01",
      "caso": "000000"
    },
    {
      "cliente": "000001",
      "loja": "01",
      "caso": "000001"
    }
  ],
  "dataReferencia": {
    "dataRefInicial": "20221001",
    "dataRefFinal": "20221031"
  },
  "filtros": [{ "campo": "STATUS_PROCESSO", "valor": "1" }],
  "resultado": {
    "processos": [
      {
        "cliente": "000001",
        "loja": "01",
        "caso": "000000",
        "processo": "5345345345345345",
        "retorno": ""
      },
      {
        "cliente": "000001",
        "loja": "01",
        "caso": "000001",
        "processo": "123123123123123",
        "retorno": ""
      }
    ],
    "atoprocessual": [
      {
        "cliente": "000001",
        "loja": "01",
        "caso": "000001",
        "processo": "123123123123123",
        "descricao": "descrição do caso processual",
        "retorno": ""
      }
    ]
  }
}

Descrição dos Campos:

• • resultado: objeto de resultado (possíveis resultados)
    • 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
• • • retorno esperado conforme
ocorência
• • • ocorrência solicitada (vide dicionário)

...

03. TABELAS UTILIZADAS

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

04. Documentos de Referência

...