Cross Segmentos - Backoffice RM - Integração - API - Consumo API ConsultaSQL – Central de Atendimento TOTVS

Tempo aproximado para leitura: 00:04:42 min

Dúvida
Como consumir uma API ConsultaSQL

Ambiente
Cross Segmentos - Backoffice RM - Integração- Todas as versões

Solução
Esta API irá retornar o resultado de uma consulta SQL cadastrada na base de dados, segue abaixo os passos para o consumo.

1. Métodos
1.1. GET (Retorna todas as colunas da Consulta SQL do sistema)

Máscara de Url:
http://{domínio}:{porta}/api/framework/v1/consultaSQLServer/RealizaConsulta/{codSentenca}/{codColigada}/{codSistema}

Exemplo de Configuração:
Domínio: localhost
Porta: 8051
codSentenca: 1.01
codColigada: 1
codSistema: A

Url Utilizada: http://localhost:8051/api/framework/v1/consultaSQLServer/RealizaConsulta/1.01/1/A

Exemplo de Resultado

[
{
"CHAPA": "00001",
"NOME": "ITAMAR MENDES DA SILVEIRA",
"CODHORARIO": "0020"
},
{
"CHAPA": "00002",
"NOME": "JOAO DA SILVA JORDAM",
"CODHORARIO": "0004"
},
{
"CHAPA": "00003",
"NOME": "MARIA CONCEICAO DE ASSIS",
"CODHORARIO": "0017"
},
{
"CHAPA": "00004",
"NOME": "ADALBERTO DE JESUS LIMA",
"CODHORARIO": "0014"
},
{
"CHAPA": "00005",
"NOME": "ALESSANDRA LOPES DE ABREU",
"CODHORARIO": "0007"
},
{
"CHAPA": "00006",
"NOME": "FERNANDO HENRIQUE VALLE KURTEN",
"CODHORARIO": "0008"
},
{
"CHAPA": "00007",
"NOME": "JOAQUIM FARIAS DAMASCENO",
"CODHORARIO": "0009"
},
{
"CHAPA": "00008",
"NOME": "ZELIA APARECIDA DA SILVA",
"CODHORARIO": "0010"
},
{
"CHAPA": "00009",
"NOME": "BEATRIZ MENGA DA LUZ",
"CODHORARIO": "0011"
},
{
"CHAPA": "00010",
"NOME": "ANTONIO GATES BILL",
"CODHORARIO": "0001"
},
{
"CHAPA": "00011",
"NOME": "MARCELO MATTAR DINIZ",
"CODHORARIO": "0006"
},
{
"CHAPA": "00012",
"NOME": "ANA LUIZA DE SOUZA PRATES",
"CODHORARIO": "0012"
},
{
"CHAPA": "00013",
"NOME": "ALEXANDRE COTTA LEAO",
"CODHORARIO": "0013"
},
{
"CHAPA": "00014",
"NOME": "PEDRO DE ALCANTARA",
"CODHORARIO": "0002"
},
{
"CHAPA": "00015",
"NOME": "LEOPOLDO DOS SANTOS DE OLIVEIRA NETO",
"CODHORARIO": "0015"
},
{
"CHAPA": "00016",
"NOME": "MURICIO DA CRUZ SOUTO",
"CODHORARIO": "0001"
},
{
"CHAPA": "00017",
"NOME": "ENIO DA COSTA ANTUNES",
"CODHORARIO": "0017"
},
{
"CHAPA": "00018",
"NOME": "TEREZA LIMA PEREIRA SOARES",
"CODHORARIO": "0008"
},
{
"CHAPA": "00019",
"NOME": "ADRIANA TEIXEIRA LOBO",
"CODHORARIO": "0002"
},
{
"CHAPA": "00021",
"NOME": "CARLOS ALBERTO MARRONE",
"CODHORARIO": "0004"
},
{
"CHAPA": "00036",
"NOME": "FABIANO FRANCA MOREIRA",
"CODHORARIO": "0001"
}
]

1.2 - Parameters (Parâmetros da sentença SQL):

Parameters: parâmetro responsável pela execução da consulta, deve ser informado como URL encode.

Exemplo: ?parameters=CODCOLIGADA=0;CODCOLIGADA1=10

1.2.1 Order (Asc)

Configuração

Máscara de Url:
http://{domínio}:{porta}/api/framework/v1/consultaSQLServer/RealizaConsulta/1/1/A/?parameters=CODCOLIGADA=0;CODCOLIGADA1=10

Exemplo de Configuração

Domínio: localhost
Porta: 8051
codSentenca: 1
codColigada: 1
codSistema: A

Url Utilizada:
http://localhost:8051/api/framework/v1/consultaSQLServer/RealizaConsulta/1/1/A/?parameters=CODCOLIGADA=0;CODCOLIGADA1=10

Exemplo de Resultado

[
{
"CODCOLIGADA": 0,
"NOMEFANTASIA": "COLIGADA GLOBAL"
},
{
"CODCOLIGADA": 1,
"NOMEFANTASIA": "TOTVS SA"
},
{
"CODCOLIGADA": 6,
"NOMEFANTASIA": "INSTITUTO TOTVS DE ENSINO SA"
},
{
"CODCOLIGADA": 7,
"NOMEFANTASIA": "INSTITUTO TOTVS DE ENSINO SUPERIOR SA"
}
]

Saiba Mais:
API de ConsultaSQL

Olá,

Cross Segmentos - Backoffice RM - Integração - API - Consumo API ConsultaSQL

0 Comentários

Olá ,

Olá ,

Olá ,

Olá,