Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  1. Visão Geral
  2. Definição de  serviços
    1. POST /solicitacao
    2. Json requisição
    3. Json resposta
  3. Tabelas utilisadas
  4.  Documento de referência

...

Os serviços especificados neste documento serão consumidos, utilizados na integração de  ocorrências ( SIGAPFS ) x sistemas jurídicos Legal Desk.


02. Definições de Serviços


2.

...

POST /solicitacao


2.2.1  JSON Requisição

 Envia

...

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

Bloco de código
languagejs
themeRDark
titlerequest.json
collapsetrue


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

...

  • 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  serem filtrados
    • valor: valor do campo 

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
languagejs
themeRDark
titleresponse.json
collapsetrue

{
  "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": ""
      }
    ]
  }
}

...

  • 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 do objeto clienteconforme 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 do ato processual  retorno esperado conforme ocorência solicitada (vide dicionário)


Card documentos
InformacaoUse esse box para destacar informações relevantes e/ou de destaque.
TituloIMPORTANTE!

...