Interface IConfiguracaoServico

Esse serviço disponibiliza funcionalidades relacionadas a configuração do eDocs para outros sistemas.

Importante

Por padrão esse serviço será iniciado no caminho SDE/Configuracao. Para maiores informações sobre a composição da URL dos webservices clique aqui

Métodos

ConfigurarFilial(String, String, DadosFilial)

Configura uma nova filial ou realiza alterações em uma filial existente.

  			[OperationContract]
IRetornoRequisicaoSde ConfigurarFilial(string usuario, string senha, DadosFilial dados)
  		
Parâmetros
System.String usuario

Usuário configurado na empresa para acesso ao webservice.

System.String senha

Senha configurado na empresa para acesso ao webservice.

DadosFilial dados

Dados para configuração da filial.

Retorno
IRetornoRequisicaoSde

Sempre retornará uma instância de RetornoIntegracaoGenerico tanto em casos de sucesso quanto erro.

Exemplos
  • Requisição
  • Resposta erro
  • Resposta sucesso

Exemplo da requisição SOAP:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe" xmlns:sen="http://schemas.datacontract.org/2004/07/Senior.SapiensNfe.DataAccess.Domain.Model.Dados.Documento" xmlns:sen1="http://schemas.datacontract.org/2004/07/Senior.Core.Modelo.Serializacao"> 
  <soapenv:Header/>
  <soapenv:Body>
    <nfe:ConfigurarFilial>
      <nfe:usuario>sde</nfe:usuario>
      <nfe:senha>sde</nfe:senha>
      <nfe:dados>
        <sen:Documento>22222222000191</sen:Documento> 
        <sen:TipoDocumento>1</sen:TipoDocumento>
        <sen:Nome>A2</sen:Nome>
        <sen:Codigo>a2</sen:Codigo>
        <sen:InscricaoMunicipal>ISENTO</sen:InscricaoMunicipal>
        <sen:Estado>35</sen:Estado>
        <sen:Municipio>3520509</sen:Municipio>
        <sen:Parametros>
          <sen1:ParChaveValor>
            <sen1:Chave>TIPO_INTEGRACAO_SAIDA</sen1:Chave>
            <sen1:Valor>0</sen1:Valor>
          </sen1:ParChaveValor>
          <sen1:ParChaveValor>
            <sen1:Chave>TIPO_INTEGRACAO_ENTRADA</sen1:Chave>
            <sen1:Valor>D</sen1:Valor>
          </sen1:ParChaveValor>
          <sen1:ParChaveValor>
            <sen1:Chave>PASTA_INTEGRACAO</sen1:Chave>
            <sen1:Valor>c:\umdiretorio</sen1:Valor>
          </sen1:ParChaveValor>
        </sen:Parametros>
      </nfe:dados>
    </nfe:ConfigurarFilial>
  </soapenv:Body>
</soapenv:Envelope>  

Exemplo de uma resposta de erro:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <ConfigurarFilialResponse xmlns="http://www.senior.com.br/nfe">
      <ConfigurarFilialResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <Codigo>999</Codigo>
        <Mensagem>Usuário e/ou senha incorretos.</Mensagem>
        <Sucesso>false</Sucesso>
      </ConfigurarFilialResult>
    </ConfigurarFilialResponse>
  </s:Body>
</s:Envelope>

Exemplo de resposta de uma requisição finalizada com sucesso:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <ConfigurarFilialResponse xmlns="http://www.senior.com.br/nfe">
      <ConfigurarFilialResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <Sucesso>true</Sucesso>
      </ConfigurarFilialResult>
    </ConfigurarFilialResponse>
  </s:Body>
</s:Envelope>

ConsultarAmbiente(String, String)

Consulta informações gerais do ambiente como versão, tipo de ambiente que está em execução, etc.

  			[OperationContract]
IRetornoRequisicaoSde ConsultarAmbiente(string usuario, string senha)
  		
Parâmetros
System.String usuario

Usuário configurado na empresa para acesso ao webservice.

System.String senha

Senha configurado na empresa para acesso ao webservice.

Retorno
IRetornoRequisicaoSde

  • Em caso de erros será retornado uma instância de RetornoIntegracaoGenerico com a mensagem e código indicando o que ocorreu
  • Em caso de sucesso será retornado uma instância de DadosAplicacao com os dados da aplicação disponibilizados nesse tipo

Exemplos
  • Requisição
  • Resposta erro
  • Resposta sucesso

Exemplo da requisição SOAP:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
   <soapenv:Header/>
   <soapenv:Body>
      <nfe:ConsultarAmbiente>
         <nfe:usuario>usuario</nfe:usuario>
         <nfe:senha>senha</nfe:senha>
      </nfe:ConsultarAmbiente>
   </soapenv:Body>
</soapenv:Envelope>

Exemplo de uma resposta de erro:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <ConsultarAmbienteResponse xmlns="http://www.senior.com.br/nfe">
         <ConsultarAmbienteResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Codigo>10014</Codigo>
            <Mensagem>Usuário e/ou senha incorretos.</Mensagem>
            <Sucesso>false</Sucesso>
         </ConsultarAmbienteResult>
      </ConsultarAmbienteResponse>
   </s:Body>
</s:Envelope>

Exemplo de resposta de uma requisição finalizada com sucesso:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <ConsultarAmbienteResponse xmlns="http://www.senior.com.br/nfe">
         <ConsultarAmbienteResult i:type="DadosAplicacao" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Mensagem i:nil="true"/>
            <NomeAmbiente>Nome</NomeAmbiente>
            <Sucesso>true</Sucesso>
            <TipoAmbiente>2</TipoAmbiente>
            <VersaoAmbiente>5.8.11.90</VersaoAmbiente>
         </ConsultarAmbienteResult>
      </ConsultarAmbienteResponse>
   </s:Body>
</s:Envelope>
Generated by DocFX