Web service Com.senior.g5.co.int.varejo.ComissaoRepresentante
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.
- 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
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.
- 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
- 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_int_varejo_ComissaoRepresentante?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_ComissaoRepresentante?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_ComissaoRepresentante?wsdl
Porta
Integrações - Varejo - Gestão de Contas a Pagar - Consultar Comissão Representante
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Consultar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <codEmp>String</codEmp> <codRep>String</codRep> <cptPco>String</cptPco> <sistemaIntegracao>String</sistemaIntegracao> </parameters> </ser:Consultar> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
codEmp | String | |
codRep | String | |
cptPco | String | |
sistemaIntegracao | String | (Obrigatório) - String(15) - Identificação do sistema integrado |
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:ConsultarResponse> <result> <comissao> <codRep>String</codRep> <nomRep>String</nomRep> <varSer>String</varSer> <vlrRea>String</vlrRea> <vlrCom>String</vlrCom> <codFil>String</codFil> </comissao> <tipoRetorno>Integer</tipoRetorno> <mensagemRetorno>String</mensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ConsultarResponse> </soapenv:Body> </soapenv:Envelope>
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" |
comissao | Set | |
comissao.codRep | String | (Obrigatório) - CodRep - Number(009) - Código do representante. |
comissao.nomRep | String | (Obrigatório) - NomRep - String(100) - Nome do representante. |
comissao.varSer | String | (Obrigatório) - VarSer - String(050) - Descrição do tipo agrupamento/serviço. |
comissao.vlrRea | String | (Obrigatório) - VlrRea - Number(013,2) - Valor realizado. |
comissao.vlrCom | String | (Obrigatório) - VlrCom - Number(013,2) - Valor da comissão. |
comissao.codFil | String | (Opcional) - CodFil - Number(005) - Código da Filial. |
tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |