TBC - Exemplo Web Service Consulta SQL

Introdução

Este serviço disponibiliza acesso direto as consultas SQL do sistema.

Como funciona

1) Para o uso deste serviço, é necessário uma consulta SQL. Neste exemplo teremos uma consulta simples que é necessário dois parâmetros para execução da mesma, como mostra abaixo. Para mais informações como criar uma consulta SQL no RM clique aqui.

SQL

SELECT *
FROM GSISTEMA (NOLOCK)
WHERE CODSISTEMA =:CODSISTEMA
  AND NOMESISTEMA =:NOMESISTEMA

2) Logo após selecionarmos a consulta SQL, devemos configurar o serviço em um aplicativo para que possamos consumir o mesmo. Após configurado, é necessário passarmos os parâmetros para termos acesso ao resultado da consulta, como mostra abaixo.

XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:RealizarConsultaSQL>
         <!--Optional:-->
         <tot:codSentenca>wsConsultaSQL</tot:codSentenca>
         <!--Optional:-->
         <tot:codColigada>1</tot:codColigada>
         <!--Optional:-->
         <tot:codSistema>G</tot:codSistema>
         <!--Optional:-->
         <tot:parameters>CODSISTEMA=G;NOMESISTEMA=RM BIS;</tot:parameters>
      </tot:RealizarConsultaSQL>
   </soapenv:Body>
</soapenv:Envelope>

Observações: Conforme no Bloco de Código acima temos de informar os dados da consulta. Onde "CodSentenca" é o código da consulta SQL, "codColigada" é o código da coligada onde está a consulta, "codSistema" é o contexto de onde a consulta foi criada, "parameters" são os parâmetros da consulta(se a consulta possuir).

Informando os Parâmetros Corretamente

Ao informar um parâmetro tem que respeitar a ordem do nome e dos valores de acordo com o SQL criado para que possa trazer os dados corretamente do retorno SQL.

SELECT *
FROM GSISTEMA (NOLOCK)
WHERE CODSISTEMA =:CODSISTEMA //Primeiro parâmetro
AND NOMESISTEMA =:NOMESISTEMA //Segundo parâmetro

//Primeiro parâmetro

Nome	Valor
CODSISTEMA	G

//Segundo parâmetro

Nome	Valor
NOMESISTEMA	RM BIS

<tot:parameters>CODSISTEMA=G;NOMESISTEMA=RM BIS;</tot:parameters>

ATENÇÃO

Caso seja informado a ordem invertida dos campos e valor terá erros no retorno da consulta.

Se conter Espaços na Frente dos Parâmetros também retornara erro no retorno da consulta.

3) Após ser configurado e passado todos os parâmetros necessários, temos enfim o resultado da consultaSQL, como mostra no código abaixo.

RAW

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <RealizarConsultaSQLResponse xmlns="http://www.totvs.com/">
         <RealizarConsultaSQLResult><![CDATA[<NewDataSet>
  <Resultado>
    <CODSISTCOMERCIAL>RB</CODSISTCOMERCIAL>
    <NOMESISTEMA>RM BIS</NOMESISTEMA>
    <CODCOLIGADAMASTER>1</CODCOLIGADAMASTER>
    <NUMMAXCOLIGADAS>9999</NUMMAXCOLIGADAS>
    <CONTROLE>-32305</CONTROLE>
    <CODSISTEMA>G</CODSISTEMA>
    <VERSAOEXIGIDA>11.0.0.7</VERSAOEXIGIDA>
    <VERSAOMINIMA>12.1.2302.0</VERSAOMINIMA>
    <DESCRICAO>TOTVS Inteligência de Negócios</DESCRICAO>
    <LICENCESERVERSLOT>507</LICENCESERVERSLOT>
    <NUMLICENCASLIGHT>0</NUMLICENCASLIGHT>
    <RECCREATEDBY>RM</RECCREATEDBY>
    <RECCREATEDON>2014-07-07T15:32:15</RECCREATEDON>
    <RECMODIFIEDBY>totvs-upg</RECMODIFIEDBY>
    <RECMODIFIEDON>2023-01-04T04:24:06</RECMODIFIEDON>
  </Resultado>
</NewDataSet>]]></RealizarConsultaSQLResult>
      </RealizarConsultaSQLResponse>
   </s:Body>
</s:Envelope>

Para utilização dos Web Services através do aplicativo "Totvs Web Service Test", clique aqui.

Para maiores informações:

@FRAMEWORK

Canais de Atendimento

Chamado: Através do Portal TOTVS - www.suporte.totvs.com.br

Telefônico: 4003-0015 Escolhendo as opções 2-2-3-9-5 (Framework) ou 2-2-3-9-4 (BI)

Produto	Framework
Versão	12.1.2302
Processo	Web Services
Subprocesso	Utilizando WsConsultaSQL

Status do Documento:	Finalizado
Data:	17/01/2023
Versão:	12.1.2302
Versão Anterior:	12.1.34
Autores:	Diego Henrique Pener Fábio Augusto Amaral Melo Nunes Welbert Marques Silva Wesley Avelino De Carvalho Usuário desconhecido (anderson.migloranza)

Atalhos

Páginas filhas