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 Atual

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. (A partir da versão 12.1.2406,)
É 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.

...

.

...

...

languagec#
titleExemplo

...

    [OnlyAuthenticated]
    [Route("lookup")]
    public ApiDataServerResponse GetAllLookup([FromUri] ApiQuery query)
    {
     ....
    }


1 - Métodos

...

      Utilizado um único método implementado:

...

Informações
iconfalse
titleGetAll

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/{rota}/lookup

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Rota: companies

Url Utilizada: localhost:8051/api/framework/v1/companies/lookup

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

...


2.1 -

...

Fields (Retorno de campos específicos no resultado)

...

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 ..Expand: Foi desabilitado para esta Api.

Informações
iconfalse
titleGetOneFields

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8099 8051

Rota: companies

Campo 1: nickname

Campo 2: federalIdId: 6

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

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "id"hasNext": false,
    "items": [
        {
            "nickname": "6TOTVS SA",
            "codefederalId": 6,
 "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"
        }
    ]
}



2.2 - Order (Resultado Ordenado)

Validação

Informações
titleParâmetros

FieldsOrder: parâmetro responsável pela especialização de campos em um ordenação do resultado, ou seja, o usuário define quais campos serão apresentados no resultadopodendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos).

Exemplo 1: ?fields=campo1order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

Múltiplos campos de ordenação: ?fieldsorder=[-]campo1, [-]campo2, [-]campo3 ...

Aviso
title

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
iconfalse
titleFieldsOrder (Asc)

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Rota: companies

Campo 1: nicknameCampo 2: federalId

Tipo de Ordenação: Ascendente

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

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



2.3 - GetOne (Recuperar um único registro pelo identificador)

...

Informações
titleParâmetros

Expand: Foi desabilitado para esta Api.

Informações
iconfalse
titleGetOne

Máscara de Url: http://http://{domínio}:{porta}/api/framework/v1/{rota}/lookup/{id}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8099

Rota: companies

Id: 6

Url Utilizada: localhost:8051/api/framework/v1/companies/lookup/6

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
        }"id": "6",
        {
        "code": 6,
    "nickname": "TesteINSTITUTO coligada"
TOTVS DE ENSINO SA",
     }
    ]"federalId": "25.578.337/0001-01"
}