English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.int.varejo.portador
Web service Com.senior.g5.co.int.varejo.portador
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_portador?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_portador?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_portador?wsdl
Porta
Exportar_2
Integrações - Varejo - Cadastros - Exportar Portador
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 2
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Exportar_2>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<codEmp>Integer</codEmp>
<consulta>
<portador>String</portador>
</consulta>
<codFil>Integer</codFil>
<tipoIntegracao>String</tipoIntegracao>
<quantidadeRegistros>Integer</quantidadeRegistros>
<identificacaoSistema>String</identificacaoSistema>
</parameters>
</ser:Exportar_2>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| consulta | Set | (Obrigatório) - Utilizar para informar quais registros devem ser retornados. Utilizar apenas quando o tipo de integração for específico ("E") |
| consulta.portador | String | Código do portador |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| tipoIntegracao | String | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
| 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. |
| identificacaoSistema | String | (Obrigatório) - String(15) - Identificação do sistema integrado |
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:Exportar_2Response>
<result>
<portador>
<seqInt>Integer</seqInt>
<codEmp>Integer</codEmp>
<codPor>String</codPor>
<desPor>String</desPor>
<abrPor>String</abrPor>
<codBan>String</codBan>
<codAge>String</codAge>
<numCco>String</numCco>
<floBan>Integer</floBan>
<codIn1>String</codIn1>
<codIn2>String</codIn2>
<numArb>Integer</numArb>
<expArb>Integer</expArb>
<impArb>Integer</impArb>
<dirCrm>String</dirCrm>
<dirCrt>String</dirCrt>
<indBpc>String</indBpc>
<baiLoj>Integer</baiLoj>
<dirDda>String</dirDda>
<tipJrs>String</tipJrs>
<sisCob>Integer</sisCob>
<exiNma>String</exiNma>
</portador>
<gridErros>
<msgErr>String</msgErr>
</gridErros>
<finalizaramRegistros>String</finalizaramRegistros>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<numeroLote>Integer</numeroLote>
<erroExecucao>String</erroExecucao>
</result>
</ser:Exportar_2Response>
</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" |
| portador | Set | |
| portador.seqInt | Integer | (Obrigatório) - Number(004) - Código Sequencial do Registro |
| portador.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
| portador.codPor | String | (Obrigatório) - String(004) - Código interno do portador (carteira, representante, advogado, bancos, etc..) |
| portador.desPor | String | (Obrigatório) - String(030) - Descrição do portador |
| portador.abrPor | String | (Opcional) - String(010) - Sigla do portador |
| portador.codBan | String | (Opcional) - String(003) - Número do banco na FEBRABAN |
| portador.codAge | String | (Opcional) - String(007) - Número da agência do banco |
| portador.numCco | String | (Opcional) - String(014) - Número da conta interna do portador |
| portador.floBan | Integer | (Opcional) - Number(002) - Float bancário |
| portador.codIn1 | String | (Opcional) - String(003) - Código da primeira instrução padrão para o portador |
| portador.codIn2 | String | (Opcional) - String(003) - Código da segunda instrução padrão para o portador |
| portador.numArb | Integer | (Opcional) - Number(009) - Número de controle do arquivo de remessa para banco |
| portador.expArb | Integer | (Opcional) - Number(005) - Código do layout CNAB de exportação para bancos |
| portador.impArb | Integer | (Opcional) - Number(005) - Código do layout CNAB de importação de bancos |
| portador.dirCrm | String | (Opcional) - String(250) - Diretório padrão para arquivos de remessa para banco |
| portador.dirCrt | String | (Opcional) - String(250) - Diretório padrão para arquivos de retorno para banco |
| portador.indBpc | String | (Opcional) - String(001) - Indicativo se bloqueia envio de títulos para proteção ao crédito |
| portador.baiLoj | Integer | (Opcional) - String(001) - Indicativo se títulos desse portador podem ou não ser baixados na loja (0=Nao, 1 = Sim) |
| portador.dirDda | String | (Opcional) - String(250) - Diretório padrão para arquivos de retorno para banco DDA |
| portador.tipJrs | String | (Opcional) - String(001) - Indicativo se o juros de mora é simples ou composto |
| portador.sisCob | Integer | (Opcional) - Number(001) - Indicativo de qual o sistema de cobrança para impressão do boleto |
| portador.exiNma | String | (Opcional) - String(001) - Exige identificação do número do malote |
| gridErros | Set | Lista dos erro |
| gridErros.msgErr | String | Erros |
| finalizaramRegistros | String | (Opcional) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
| tipoRetorno | Integer | (Opcional) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Opcional) - String(1000) - Mensagem de Retorno de Processamento |
| numeroLote | Integer | (Opcional) - Inteiro - Identificação do Lote de Exportação |
English
Español
