Web service com.senior.g5.rh.jr.email
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/jr_Synccom_senior_g5_rh_jr_email?wsdl
- Assíncrono: http://example.com/g5-senior-services/jr_Asynccom_senior_g5_rh_jr_email?wsdl
- Agendado: http://example.com/g5-senior-services/jr_Scheduledcom_senior_g5_rh_jr_email?wsdl
Portas
SendMail
Serviço para envio de e-mail utilizando configurações do sistema
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:SendMail> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <pmCCAddress>String</pmCCAddress> <pmSubject>String</pmSubject> <pmBody>String</pmBody> <pmToAddress>String</pmToAddress> <pmCCOAddress>String</pmCCOAddress> <pmIsHtml>String</pmIsHtml> <pmAttachFile>String</pmAttachFile> <pmAttachName>String</pmAttachName> </parameters> </ser:SendMail> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
pmCCAddress | Opcional | String | |
pmSubject | Opcional | String | |
pmBody | Opcional | String | |
pmToAddress | Opcional | String | |
pmCCOAddress | Opcional | String | |
pmIsHtml | Opcional | String | |
pmAttachFile | Opcional | Blob | |
pmAttachName | Opcional | String |
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:SendMailResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:SendMailResponse>
</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. |
UsuarioEmail
Este web service retorna o email de um determinado usuário.
Necessita autenticação: Não
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:UsuarioEmail> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <nomUsu>String</nomUsu> </parameters> </ser:UsuarioEmail> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
nomUsu | Obrigatório | String | Informar o usuário cujo e-mail deseja ser retornado. |
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:UsuarioEmailResponse> <result> <emaCom>String</emaCom> <erroExecucao>String</erroExecucao> </result> </ser:UsuarioEmailResponse> </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. |
emaCom | Opcional | String | E-mail do usuário informado. |