◼️5. Lista

5.1.GET/api/Lista/GetListas

O objetivo deste método é permitir que o usuário busque as listas do cliente.

Entrada

Não se aplica.

Validações

O sistema valida:

• A permissão do usuário autenticado.

Saída/Retorno

O sistema retorna todas as listas que o usuário autenticado possui acesso.

Code 200 OK

Response

[
    {
        "IdLista": "guid", //id da lista
        "NomeLista": "string", //nome da lista
        "IdListaPai": null, //id da lista pai, se houver
        "NomeListaPai": null, //nome da lista pai se houver
        "IdCliente": "guid", //id do cliente dono da lista
        "NomeCliente": "string", //nome do cliente
        "TipoLista": "C", //tipo da lista: C = consolidação, A = autocomplete
        "PermiteAlteracao": false //permite inclusão de dados durante a indexação
    },
    {
        "IdLista": "guid", 
        "NomeLista": "string", 
        "IdListaPai": null, 
        "NomeListaPai": null, 
        "IdCliente": "guid", 
        "NomeCliente": "string", 
        "TipoLista": "C", 
        "PermiteAlteracao": false 
    }
]

---

5.2.GET/api/Lista/GetCamposDaLista

O objetivo deste método é permitir que o usuário busque campos da lista informada.

Entrada

Neste serviço o usuário deve informar o id do cliente e o id da lista que deseja buscar os campos.

• idCliente

• idLista

Validações

O sistema valida:

• A permissão do usuário autenticado.

• Se a lista pertence ao cliente informado.

Saída/Retorno

O sistema retorna os campos da lista informada.

Code 200 OK

Response

[
    {
        "IdLista": "guid", //id da lista
        "NomeLista": "string", //nome da lista
        "IdCampo": "guid", //id do campo da lista
        "NomeCampo": "string", //nome do campo da lista
        "IdDefinicaoCampos": 864, //id definição do campo da lista
        "DefinicaoCampo": "Numérico", //definição do campo da lista
        "CampoChave": true, //informação se o campo é chave ou não
        "Obrigatorio": true, //informação se o campo é obrigatório ou não
        "TamanhoMax": null, //definição de tamanho máximo do campo, se houver
        "TamanhoMin": null, //definição de tamanho mínimo do campo, se houver
        "OpcoesLista": null,
        "Valores": null, //valores do campo do tipo lista
        "ValoresSeparador": "|@#",//separadores dos valores do campo do tipo lista
        "ProibirEdicaoAposValor": false
    },
    {
        "IdLista": "guid",
        "NomeLista": "string",
        "IdCampo": "guid",
        "NomeCampo": "string",
        "IdDefinicaoCampos": 883,
        "DefinicaoCampo": "string",
        "CampoChave": false,
        "Obrigatorio": false,
        "TamanhoMax": null,
        "TamanhoMin": null,
        "OpcoesLista": null,
        "Valores": "string",
        "ValoresSeparador": "|@#",
        "ProibirEdicaoAposValor": false
    }
]

---

5.3.GET/api/Lista/GetLinhaLista

O objetivo deste método é permitir que o usuário busque os ids linha lista da lista informada.

Entrada

Neste serviço o usuário deve informar o id do cliente e o id da lista que deseja buscar os IdLinhaLista.

• idCliente

• idLista

Validações

O sistema valida:

• A permissão do usuário autenticado.

• Se a lista pertence ao cliente informado.

Saída/Retorno

O sistema retorna os idLinhaLista da lista informada.

Response

[
    {
        "IdCampo": "guid",//id campo dada lista
        "IdLinhaLista": "guid",//id linha lista da lista
        "Valor": "string",//valos do campo da lista
        "Chave": false, //informação se o campo da lista é chave        
        "Obrigatorio": true //informação se o campo da lista é obrigatório
    },
    {
        "IdCampo": "guid",
        "IdLinhaLista": "guid",
        "Valor": "string",
        "Chave": true, //true ou false
        "Obrigatorio": true //true ou false
    },
    {
        "IdCampo": "guid",
        "IdLinhaLista": "guid",
        "Valor": "string",
        "Chave": true, //true ou false
        "Obrigatorio": true //true ou false
    }
]

---

5.4.PUT/api/Lista/{idLista}/Cliente/{idCliente}/LinhaLista/{idLinhaLista}

O objetivo deste método é permitir que o usuário altere um item da lista informada.

Entrada

Neste serviço o usuário deve informar o id do cliente, o id da lista, id da linha lista e o JSON com os campos que deseja alterar.

• idLista

• idCliente

• idLinhaLista

• JSON com os campos que serão alterados

Request body

[
  {
    "idCampo": "guid", // id do campo da lista
    "valorCampo": "string" // novo valor para o campo da lista para busca
  }
]

Validações

O sistema valida:

• A permissão do usuário autenticado.

• A lista pertence ao cliente informado.

• Se o idLinhaLista informado pertence a lista informada.

• Se o campo informado pertence a lista informada.

• Se o valor informado para o campo está compatível com a configuração do campo em questão.

Saída/Retorno

O sistema retorna o Code 200 OK

---

5.5.POST/api/AdicionarItemLista/Post

O objetivo deste método é permitir que o usuário adicione itens na lista informada.

Entrada

Neste serviço o usuário deve informar o id do cliente, o id da lista e o JSON com os campos que deseja adicionar na lista.

• idCliente

• idLista

• JSON com os campos que serão inseridos na lista.

Request body

[
  {
    "idCampo": "guid", // id do campo da lista
    "valorCampo": "string" // novo valor para o campo da lista para busca
  }
]

Validações

O sistema valida:

• A permissão do usuário autenticado.

• A lista pertence ao cliente informado.

• Se o campo informado pertence a lista informada.

• Duplicidade de campo chave.

Saída/Retorno

O sistema retorna o idLinhaLista adicionado.

Code 201 Created

Response

"Item adicionado: '93cf3091-25a7-48e5-821c-8a45f27a2c76'!"

---

5.6.POST/api/Lista/RetornaLinhaListasPorCampoValor/{idLista}/{idUnidade}/{idCliente}

O objetivo deste método é permitir que o usuário busque dados da lista informada baseado no valor de um campo da lista.

Entrada

Neste serviço o usuário deve informar o id da unidade, o id do cliente, o id da lista, o JSON com os dados que que deseja pesquisar.

• idUnidade

• idCliente

• idLista

• JSON com os dados de filtro.

Request body

[
  {
    "idCampo": "guid", // id do campo da lista
    "valorCampo": "string" // valor do campo da lista para busca
  }
]

Validações

O sistema valida:

• A permissão do usuário autenticado.

Saída/Retorno

O sistema retorna os campos da lista informado.

Response

[
  {
    "IdLista": "Guid",// id da lista
    "IdLinhaLista": "guid",// id linha lista da lista
    "LinhaLista": [// dados do idLinhaLista da lista
      {
        "IdCampo": "guid",// id do campo
        "Valor": "string",// valor do campo
        "Chave": true // informação se o campo da lista é chave ou não
      },
      {
        "IdCampo": "guid",
        "Valor": "string ,
        "Chave": false // true = é chave, false = não é chave
      },
      {
        "IdCampo": "guid",
        "Valor": "string",
        "Chave": false
      }
    ]
  }
]