Linha RM

Atalhos

Páginas filhas
  • API de Lookup

Versões comparadas

Versão antiga 6

changes.mady.by.user Adriano Diniz Agrizzi

Gravado em

comparado com

Nova versão 7

changes.mady.by.user Adriano Diniz Agrizzi

Gravado em

Chave

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

...

A API de Lookup é uma API com intuito de trazer apenas dados para identificação de registros.
É implementada a partir da rota da API principal, e é apartada do sistema de permissionamento do RM.

...

titleAtenção

Como o Lookup pode ser utilizado em diversas telas, não é necessário que o usuário possua permissão na funcionalidade para utiliza-lo é necessário apenas ter um usuário válido para login.

As rotas de Lookup devem utilizar o atributo de autorização OnlyAuthenticatedAttribute pois é este atributo que permite um usuário AUTENTICADO ter acesso as rotas.

Bloco de código
languagec#
titleExemplo 
    [OnlyAuthenticated]
    [Route("lookup")]
    public ApiDataServerResponse GetAllLookup([FromUri] ApiQuery query)
    {
     ....
    }


1 - Métodos

...

      Utilizado um único método implementado:

...

Os campos informados em Fields devem ser validados para retornar apenas as colunas esperadas do lookup

.


Esta validação deve ser realizada pelo produto

.

Informações
titleParâmetros

Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado.

Exemplo: ?fields=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 .. .

Aviso
titleValidação
Informações
iconfalse
titleFields

Máscara de Url: http http://{domínio}:{porta}/api/framework/v1/companies{rota}/lookup?fields={campos}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Rota: companies

Campo 1: nickname

Campo 2: federalId

Url Utilizada: http://localhost:8051/api/framework/v1/companies/lookup?fields=nickname,federalId

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
            "nickname": "TOTVS SA",
            "federalId": "21.867.387/0001-58"
        },
        {
            "nickname": "INSTITUTO TOTVS DE ENSINO SA",
            "federalId": "25.578.337/0001-01"
        },
        {
            "nickname": "INSTITUTO TOTVS DE ENSINO SUPERIOR SA",
            "federalId": "05.295.401/0001-30"
        },
        {
            "nickname": "Teste"
        },
        {
            "nickname": "Teste PUT",
            "federalId": "82.122.163/0001-01"
        },
        {
            "nickname": "Colligada",
            "federalId": "38.737.259/0001-92"
        },
        {
            "nickname": "Teste coligada"
        }
    ]
}