Sumário
...
Objetivo
...
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.
1 - Métodos
...
Utilizado um único método implementado:
2 - GET
...
Informações |
---|
|
Máscara de Url: http://{domínio}:{porta}/api/framework/v1/{rota}/lookup Informações |
---|
icon | false |
---|
title | Exemplo de Configuração |
---|
| Domínio: localhost Porta: 8051 Rota: companies Url Utilizada: localhost:8051/api/framework/v1/companies/lookup |
Informações |
---|
icon | false |
---|
title | Exemplo de Resultado |
---|
| Expandir |
---|
title | Ver resultado JSON... |
---|
| Bloco de código |
---|
language | js |
---|
firstline | 1 |
---|
title | Resultado (JSON) |
---|
linenumbers | true |
---|
| {
"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çõeswarning |
---|
|
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 ... |
Informações |
---|
|
Máscara de Url: http://{domínio}:{porta}/api/framework/v1/{rota}/lookup?fields={campos} Informações |
---|
icon | false |
---|
title | Exemplo de Resultado |
---|
| Expandir |
---|
title | Ver resultado JSON... |
---|
| Bloco de código |
---|
language | js |
---|
firstline | 1 |
---|
title | Resultado (JSON) |
---|
linenumbers | true |
---|
| {
"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"
}
]
} |
|
|
|
2.2 - Order (Resultado Ordenado)
Informações |
---|
|
Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos). Exemplo 1: ?order=campo1 (Ascendente) Exemplo 2: ?order=-campo1 (Descendente) Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ... |
Informações |
---|
icon | false |
---|
title | Order (Asc) |
---|
|
Máscara de Url: http://{domínio}:{porta}/api/framework/v1/{rota}/lookup?order={campo} Informações |
---|
icon | false |
---|
title | Exemplo de Resultado |
---|
| Expandir |
---|
title | Ver resultado JSON... |
---|
| Bloco de código |
---|
language | js |
---|
firstline | 1 |
---|
title | Resultado (JSON) |
---|
linenumbers | true |
---|
| {
"hasNext": false,
"items": [
{
"id": "6",
"code": 6,
"nickname": "INSTITUTO TOTVS DE ENSINO SA"
},
{
"id": "7",
"code": 7,
"nickname": "INSTITUTO TOTVS DE ENSINO SUPERIOR SA"
},
{
"id": "1",
"code": 1,
"nickname": "TOTVS SA"
}
]
} |
|
|
|
2.3 - GetOne (Recuperar um único registro pelo identificador)
...
Informações |
---|
|
Expand: Foi desabilitado para esta Api. |
Informações |
---|
|
Máscara de Url: http://http://{domínio}:{porta}/api/framework/v1/{rota}/lookup/{id} Informações |
---|
icon | false |
---|
title | Exemplo de Configuração |
---|
| Domínio: localhost Porta: 8099 Rota: companies Id: 6 Url Utilizada: localhost:8051/api/framework/v1/companies/lookup/6 |
Informações |
---|
icon | false |
---|
title | Exemplo de Resultado |
---|
| Expandir |
---|
title | Ver resultado JSON... |
---|
| Bloco de código |
---|
language | js |
---|
firstline | 1 |
---|
title | Resultado (JSON) |
---|
linenumbers | true |
---|
| {
"id": "6",
"code": 6,
"nickname": "INSTITUTO TOTVS DE ENSINO SA",
"federalId": "25.578.337/0001-01"
|
|
|
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 |
---|
| [OnlyAuthenticated]
[Route("lookup")]
public ApiDataServerResponse GetAllLookup([FromUri] ApiQuery query)
{
....
|
|