English
Español
Web service Com.senior.g5.co.int.varejo.RetornoIntegracao
O webservice de retorno de integração tem o objetivo de retornar, através de uma integração, o resultado do processamento de um webservice executado no ERP.
É importante entender que nem todos os webservices geram um retorno através da integração, pois esse retorno faz parte da camada de negócio. Somente webservices mais recentes geram esse retorno de integração.
Webservices que geram retorno de integração são, garantidamente, os utilizados para a integração com o Gestão de Lojas. Os demais, por padrão, não devem ser considerados como geradores de retorno de integração, pois foram construídos antes do Gestão Empresarial possuir esse conceito.
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_int_varejo_RetornoIntegracao?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_RetornoIntegracao?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_RetornoIntegracao?wsdl
Porta
Exportar
Integrações - Varejo - Informações - Retorno de Integrações
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:Exportar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<CodEmp>Integer</CodEmp>
<CodFil>Integer</CodFil>
<QuantidadeRegistros>Integer</QuantidadeRegistros>
<SistemaIntegracao>String</SistemaIntegracao>
<IdentificadorExterno>Integer</IdentificadorExterno>
<IdentificadorIntegracaoExportacao>Integer</IdentificadorIntegracaoExportacao>
</parameters>
</ser:Exportar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| quantidadeRegistros | Integer | (Opcional) - Number(005) - Quantidade de registros limite para retorno da solicitação. Quando o tipo de integração for "E", este valor não é utilizado. |
| sistemaIntegracao | String | (Obrigatório) - String(15) - Identificação do sistema integrado |
| identificadorExterno | Integer | (Obrigatório) - Inteiro - Número do Identificador externo - Número que identifica o registro no sistema que está integrando. Caso Identificador de integração não for informado, será ignorado |
| identificadorIntegracaoExportacao | Integer | (Obrigatório) - Inteiro - Número do Identificador de integração de exportação |
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:ExportarResponse>
<result>
<Retornos>
<IdeInt>Integer</IdeInt>
<IdeExt>Integer</IdeExt>
<InfRet>String</InfRet>
<SeqInt>Integer</SeqInt>
</Retornos>
<GridErros>
<MsgErr>String</MsgErr>
</GridErros>
<FinalizaramRegistros>String</FinalizaramRegistros>
<TipoRetorno>Integer</TipoRetorno>
<MensagemRetorno>String</MensagemRetorno>
<NumeroLote>Integer</NumeroLote>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExportarResponse>
</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" |
| retornos | Set | Retorno das informações de integração |
| retornos.ideInt | Integer | (Obrigatório) - Number(004) - Identificador do tipo de Integração. |
| retornos.ideExt | Integer | (Obrigatório) - Number(004) - Identificação externa do registro |
| retornos.infRet | String | (Obrigatório) - String - Chave do registro no sistema ERP Exemplos: (valores ilustrativos, apenas para demonstrar a máscara dos campos). |
| retornos.seqInt | Integer | (Obrigatório) - Number(004) - Número sequencial do registro integrado |
| gridErros | Set | (Opcional) - Lista dos erros |
| gridErros.msgErr | String | (Opcional) - String - Erros |
| finalizaramRegistros | String | (Obrigatório) - String(001) - Indicativo se finalizaram os registros a serem exportados. - Lista: S = Sim, N = Não |
| 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 |
| numeroLote | Integer | (Obrigatório) - Inteiro - Identificação do Lote de Exportação |
English
Español
