Histórico da Página
CONTEÚDO
- Visão Geral
- Exemplo de utilização
- Tela XXX
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela XXX
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Tabelas utilizadas
- Definição de serviços
- Json requisição
- Json resposta
- Json requisição
- Tabelas utilisadas
- Documento de referência
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ídicos.
...
- 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
Retorna a lista de reqisições disponíveis para consulta, no formato indicado abaixo:
...
- 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.
Card documentos | ||||
---|---|---|---|---|
|
...
03.
...