Web service com.senior.g5.rh.fp.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 identificado o tipo no parâmetro <encryption>, conforme seus valores possíveis.
WSDL
- Síncrono: http://example.com/g5-senior-services/rubi_Synccom_senior_g5_rh_fp_db?wsdl
- Assíncrono: http://example.com/g5-senior-services/rubi_Asynccom_senior_g5_rh_fp_db?wsdl
- Agendado: http://example.com/g5-senior-services/rubi_Scheduledcom_senior_g5_rh_fp_db?wsdl
Portas
GetDBDate
Serviço que retorna a data do sistema/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 | Preenchimento | Tipo | Descrição |
---|---|---|---|
erroExecucao | Opcional | 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 sucesso; - A mensagem do erro ocorrido no servidor. |
pmReturnGetDateTime | Opcional | String |
GetDBTime
Serviço que retorna a hora do sistema/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 | Preenchimento | Tipo | Descrição |
---|---|---|---|
erroExecucao | Opcional | 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 sucesso; - A mensagem do erro ocorrido no servidor. |
pmReturnGetDateTime | Opcional | String |
GetDBInfo
Serviço que retorna informações 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: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 | Preenchimento | Tipo | Descrição |
---|---|---|---|
pmSQL | Obrigatório | String | |
pmParams | Obrigatório | String |
Nota
Para maiores informações sobre o uso dos parâmetros mencionados acima, consulte a documentação sobre Serviço pesquisa em banco de dados via regra.
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 | Preenchimento | Tipo | Descrição |
---|---|---|---|
erroExecucao | Opcional | 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 sucesso; - A mensagem do erro ocorrido no servidor. |
pmReturnGetDBInfo | Opcional | Blob |