English
Español
Web service com.senior.g5.co.utils
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_utils?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_utils?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_utils?wsdl
Portas
GetMenuItems
Menus disponíveis no 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:GetMenuItems>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<onlyInvokable>String</onlyInvokable>
<ignoreSeparators>String</ignoreSeparators>
<ignoreSGI>String</ignoreSGI>
</parameters>
</ser:GetMenuItems>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| onlyInvokable | String | Se informados os valores "1" ou "T", retorna apenas menus que chamam telas que podem ser invocadas externamente. |
| ignoreSeparators | String | Se informados os valores "1" ou "T", ignora os ítens separadores. |
| ignoreSGI | String | Se informados os valores "1" ou "T", ignora os ítens que representam telas personalizadas. |
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:GetMenuItemsResponse>
<result>
<xmlResult>String</xmlResult>
<erroExecucao>String</erroExecucao>
</result>
</ser:GetMenuItemsResponse>
</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" |
| xmlResult | Blob | Retorno no formato XML que representa a estrutura de menus disponíveis no sistema. |
GetLeafMenuItemsSet
Conjunto de ítens folha dos menus disponíveis no 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:GetLeafMenuItemsSet>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<onlyInvokable>String</onlyInvokable>
<ignoreSeparators>String</ignoreSeparators>
<ignoreSGI>String</ignoreSGI>
</parameters>
</ser:GetLeafMenuItemsSet>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| onlyInvokable | String | Se informados os valores "1" ou "T", retorna apenas menus que chamam telas que podem ser invocadas externamente. |
| ignoreSeparators | String | Se informados os valores "1" ou "T", ignora os ítens separadores. |
| ignoreSGI | String | Se informados os valores "1" ou "T", ignora os ítens que representam telas personalizadas. |
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:GetLeafMenuItemsSetResponse>
<result>
<leafMenuItemsSet>
<name>String</name>
<kind>String</kind>
<caption>String</caption>
<fullPath>String</fullPath>
</leafMenuItemsSet>
<erroExecucao>String</erroExecucao>
</result>
</ser:GetLeafMenuItemsSetResponse>
</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" |
| leafMenuItemsSet | Set | Conjunto de todos os ítens folha que representam telas que podem ser chamadas externamente no BA e WA. |
| leafMenuItemsSet.name | String | Nome do ítem |
| leafMenuItemsSet.kind | String | Tipo do ítem de menu:
submenu = O ítem é um submenu; separator = Ítem separador; callform = Ítem que executa formulários do sistema; sgi = Ítem que executa formulários do SGI; other = Outros. |
| leafMenuItemsSet.caption | String | Título do ítem, sem caracteres de atalho. |
| leafMenuItemsSet.fullPath | String | Caminho completo do ítem no formato "menu\submenu\submenu". |
English
Español
