Histórico da Página
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
objeto solicitação { "id":uuid string "c74142a6-5146-11ed-bdc3-0242ac120002", "solicitante": string"<nome_solicitante>", "emailSolicitante": string"[email protected]", "dataInclusao": date"20221021", "dataProcessamento": datenull, "dataConclusao": datenull, "entidade": string"1", "contrato": string"000001", "clienteCaso":[array], [ { dataReferencia:[objeto], "cliente": "000001", filtros:[array]"loja": "01", resultado:[objeto] } objeto dataReferencia "caso": "000000" }, { dataRefInicial "cliente": date"000001", dataRefFinal "loja": date"01", "caso": "000000" } array clienteCaso ], "dataReferencia": { cliente:string."dataRefInicial": "20221001", loja: string, caso:string } |
Descrição dos Campos:
...
"dataRefFinal": "20221031"
},
"filtros": [
{ "campo": "STATUS_PROCESSO", "valor": "1" }
]
} |
Descrição dos campos da solicitação.
- id: identificador universal da solicitação(uuid).
- solicitante: descrição 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: entidade jurídica a realizar a solicitação (vide dicionário)
- contrato: código docontrato 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: array de objeto cliente/caso
- cliente: cliente do caso relacionado a solicitaçãoao contrato
- loja: loja do cliente
- caso: caso do cliente
- filtros: filtros a seram aplicados na solicitaçãoresultado: resultado final da solicitaçãoarray de objetos (vide dicionário)
- campo: campos a serem filtrados
- valor: valor do campo
2.2 JSON Resposta
Retorna a lista de reqisições disponíveis para consulta, no formato indicado o body da requisição preenchendo o objeto resultado conforme a entidade solicitada no formato abaixo:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
array filtros
{
campo:string,
valor:string
}
objeto resultado
[
processos: [array],
atoprocessual: [array]
]
array processos
{
cliente:string,
loja: string,
caso:string,
processo:string,
retorno:string
}
array atoprocessual
{
cliente:string,
loja: string,
caso:string,
processo:string,
descricao:string,
retorno:string
} |
Descrição dos Campos:
{
"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
- processos: array de processos
- atoprocessual array de atos processuais
- processos: array de processos
- cliente: código do cliente
- 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 processos(Indica todos os campos referentes ao item processo)
- cliente: array de clientes (Indica todos os campos referentes ao item cliente)
- loja: loja do cliente
- caso: código do caso vinculado ao cliente
- processo: id do processo vinculado ao cliente
- retorno: retorno esperado do objeto cliente
...
- atoprocessual: array de ato processual(Indica todos os campos referentes ao item atro processual)processua
- cliente: array de clientes (Indica todos os campos referentes ao item cliente)código do cliente
- loja: loja do cliente referente ao ato processual
- retorno: retorno esperado do objeto cliente no ato processual
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.
- cliente
- caso: código do caso
- processo: id do processo
- descricao: descrição do ato processual
- retorno: retorno do ato processual
Card documentos | ||||
---|---|---|---|---|
|
...
04. Documentos de Referência
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas