English
Español
Web service Com.senior.g5.co.ger.db
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.
Campos numéricos
Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.
Campos que representam valores monetários, quantidade e percentual e estão declarados como String
- Envio no formato ZZZZ,ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com vírgula, e não com ponto
- Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
Exemplo:
number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
Campos que representam valores monetários, quantidade e percentual e não estão declarados como String
- Envio no formato ZZZZ.ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com ponto, e não com vírgula
Exemplo:
- number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
- number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
- number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
WSDL
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_ger_db?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_ger_db?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_ger_db?wsdl
Portas
GetDBDate
Ao utilizar esta porta, o serviço retornará, por meio do parâmetro pmReturnGetDbDateTime, a data atual do banco de dados. O valor retornado será formatado da seguinte forma: DD/MM/AAAA.
Esta porta não possui parâmetros de entrada. Caso seja chamada por meio de uma regra, o valor retornado será um alfanumérico que representa a data atual do banco de dados.
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:GetDBDate>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters/>
</ser:GetDBDate>
</soapenv:Body>
</soapenv:Envelope>
"Parameters" não possui atributos.
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:GetDBDateResponse>
<result>
<pmReturnGetDateTime>String</pmReturnGetDateTime>
<erroExecucao>String</erroExecucao>
</result>
</ser:GetDBDateResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
| pmReturnGetDateTime | String |
GetDBTime
Ao utilizar esta porta, o serviço retornará, por meio do parâmetro pmReturnGetDbDateTime, a hora atual do banco de dados. O valor retornado será formatado da seguinte forma: hh:mm:ss.
Esta porta não possui parâmetros de entrada.
Caso seja chamada por meio de uma regra, o valor retornado será um alfanumérico que representa o horário atual do banco de dados.
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:GetDBTime>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters/>
</ser:GetDBTime>
</soapenv:Body>
</soapenv:Envelope>
"Parameters" não possui atributos.
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:GetDBTimeResponse>
<result>
<pmReturnGetDateTime>String</pmReturnGetDateTime>
<erroExecucao>String</erroExecucao>
</result>
</ser:GetDBTimeResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
| pmReturnGetDateTime | String |
GetDBInfo
Esta porta do serviço MCDBServices é utilizada para retornar dados do banco de dados através de SQL, ou seja esta rotina apenas executa comando de pesquisa. Os parametros desta porta devem ser informados da seguinte forma:
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:GetDBInfo>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<pmSQL>String</pmSQL>
<pmParams>String</pmParams>
</parameters>
</ser:GetDBInfo>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| pmSQL | String | Comando SQL que será executado no Banco de dados. |
| pmParams | String | Definições e valores dos parâmetros do comando SQL. |
pmSQL
Este parâmetro é o que receberá o SQL que se deseja enviar para pesquisar no banco de dados.
Exemplo de SQL
SELECT * FROM R999USU WHERE CODUSU=:CodUsu AND NOMUSU=:NomUsu
pmParams
Este parametro recebe um XML contendo os parâmetros que foram informados no SQL do pmSQL. Este XML de Parâmetros deve conter as seguintes informações:
Uma tag PARAMS que será o nó pai do parametros informados no XML.
Para cada parâmetro informado deve existir um nó PARAM
2.1 - Para cada nó PARAM deve existir três nós filhos com os seguintes nomes e valores:
- NAME - que representa o nome do parâmetro utilizado no SQL
- TYPE - que representa o tipo de dado no banco de dados. Estes tipos podem ser:
- String
- Integer
- Float
- DateTime
- Boolean
- VALUE - Que é o valor do parâmetro do SQL
Exemplo de XML de parâmetros.
<?xml version="1.0" encoding="ISO-8859-1"?>
<params>
<param>
<name>codusu</name>
<type>Integer</type>
<value>5</value>
</param>
<param>
<name>nomusu</name>
<type>String</type>
<value>teste</value>
</param>
</params>
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:GetDBInfoResponse>
<result>
<pmReturnGetDBInfo>String</pmReturnGetDBInfo>
<erroExecucao>String</erroExecucao>
</result>
</ser:GetDBInfoResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
| pmReturnGetDBInfo | Blob | Este parâmetro é o parâmetro de serviço que retornará os dados solicitados para o serviço. |
pmReturnGetDBInfo
Este parâmetro é o parâmetro de serviço que retornará os dados solicitados para o serviço. Este retorno será um uma string XML, da seguinte forma:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<table>
<line>
<CODUSU>5</CODUSU>
<NOMUSU>teste</NOMUSU>
<TIPCOL />
<NUMEMP />
<CODFIL />
<CODLOC />
<NUMCAD />
</line>
<line>
<CODUSU>5</CODUSU>
<NOMUSU>teste</NOMUSU>
<TIPCOL />
<NUMEMP />
<CODFIL />
<CODLOC />
<NUMCAD />
</line>
</table>
Onde para cada linha retornada pelo SQL será gerado um nó LINE, e para cada coluna do retorno é gerado uma TAG com o nome da coluna, e o valor desta tag será o valor de retorno da coluna.
Observação
Mesmo que o SQL que será enviado para o Banco de dados não contenha nenhum parâmetro, deve-se informar o XML de parâmetros para o serviço. Apenas não conterá nenhuma tag PARAM. Este SQL deve ser SQLSenior2.
English
Español
