Listando documentos de um cliente ou empresa

Serviço de pesquisa de documentos (SEARCH)

Os serviços de pesquisa abaixo servem exclusivamente para busca desse tipo de conteúdo. Ou seja, registros de Documentos no módulo Documento.

Para esse módulo pressupõe-se a catalogação dos Documentos em uma estrutura de dois níveis: Clientes e Assuntos, onde “Assuntos” podem representar projetos, processos ou mesmo temas de determinado cliente ou empresa.

  • a)      Pesquisando Documentos de um Cliente

Busca documentos no sistema associados à algum cliente específico. Ou seja, cujo campo Cliente/Empresa esteja preenchido com o código de referência do cliente passado como parâmetro na função.

Nome do serviço:

CtrlServicos?cmd=SEARCH

Exemplos de código para referência:

pesquisa_documento.pas

McClasses.pas

Principais parâmetros de entrada:

NOME TIPO DESCRIÇÃO
idSessao Integer Código da sessão válida obtido pela função LOGIN_SESSAO
firstResult Integer Usado para paginação de resultados. Identifica a posição de início da pesquisa, passar valor “0” = primeira página de dados
maxResults Integer Indica o máximo de resultados a serem trazidos pela pesquisa. Se omitido, a pesquisa retornará todos os resultados encontrados, sem limitação, o que pode ser lento em casos de grande volume de documentos a serem retornados
level Integer Obrigatório. Passar valor fixo “3”
treeID Integer Obrigatório. Passar valor fixo “5”
fatherID Integer Inteiro, passar o código interno do cliente pesquisado. Os códigos podem ser pegos pela função de integração ou através de uma chamada específica. <ver>
filter String Texto com conteúdo para um filtro do estilo “pesquisa simples”, ou seja, filtrando os documentos que contenham o conteúdo desejado em seus metadados.
count Boolean (1 ou 0) Indica que a chamada deve retonar apenas a quantidade de resultados encontrados (e não os resultados em si).
Atenção: Se passar o valor “1” nesse parâmetro, o resultado não será um JSON, será apenas um número inteiro (ou vazio se não houverem resultados). Os parâmetros “firstResult” e “maxResults” não são considerados nesse caso.

Retorno:

JSON com a lista de documentos retornada da pesquisa. A sequência abaixo pode repetir dentro do JSON de retorno quantas vezes quantos forem os registros retornados.

Atenção: Se for passado o valor “1” no parâmetro "count", o resultado não será um JSON, será apenas um número inteiro. Vide acima.

Descrição do JSON:

NOME TIPO DESCRICAO
codigo Integer Código interno de referência do documento
campos Array de TCampo Array dos campos e seus conteúdo. Contém dois campos em cada objeto: valor e rótulo. Abaixo os principais rótulos para listagem do conteúdo:
  •          CODIGO_REGISTRO: número do documento para o usuário
  •          DESCRICAO: descrição do documento
  •          TIPOLOGIA: tipo do documento
  •          DEPARTAMENTO: “reservado”
  •          DATA_CADASTRO: data
  •          CLIENTE: cliente ou empresa
  •          CASO: assunto ou projeto