Carta Web Service

Carta

Click here for a complete list of operations.

ImportarCarta

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Carta.asmx HTTP/1.1
Host: ws.qcertifica.com.br
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://ws.qcertifica.com.br/ImportarCarta"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ImportarCarta xmlns="https://ws.qcertifica.com.br/">
      <data>
        <CpfCnpjContratante>string</CpfCnpjContratante>
        <CpfCnpjResponsavel>string</CpfCnpjResponsavel>
        <Token>string</Token>
        <TipoOperacao>int</TipoOperacao>
        <TipoColetaOperacao>AssinaturasDeterminadas or PodereseAlçada</TipoColetaOperacao>
        <AssuntoOperacao>string</AssuntoOperacao>
        <DescricaoOperacao>string</DescricaoOperacao>
        <DataLimiteAssinatura>dateTime</DataLimiteAssinatura>
        <CartaTemplate>boolean</CartaTemplate>
        <NomeTemplate>string</NomeTemplate>
        <TipoDocumento>int</TipoDocumento>
        <DocumentosCarta>
          <DocumentosCarta>
            <NomeDocumento>string</NomeDocumento>
            <Arquivo>base64Binary</Arquivo>
          </DocumentosCarta>
          <DocumentosCarta>
            <NomeDocumento>string</NomeDocumento>
            <Arquivo>base64Binary</Arquivo>
          </DocumentosCarta>
        </DocumentosCarta>
        <ParteAssinantes>
          <ParteAssinantesCarta>
            <NomeParte>string</NomeParte>
            <TipoPessoaParte>Física or Jurídica</TipoPessoaParte>
            <CpfCnpjParte>string</CpfCnpjParte>
            <CodigoEmpresaParte>int</CodigoEmpresaParte>
            <NomeEmpresa>string</NomeEmpresa>
            <FantasiaEmpresa>string</FantasiaEmpresa>
            <CepEmpresa>int</CepEmpresa>
            <EnderecoEmpresa>string</EnderecoEmpresa>
            <NumeroEnderecoEmpresa>int</NumeroEnderecoEmpresa>
            <ComplementoEnderecoEmpresa>string</ComplementoEnderecoEmpresa>
            <BairroEmpresa>string</BairroEmpresa>
            <CidadeEmpresa>string</CidadeEmpresa>
            <UfEmpresa>string</UfEmpresa>
            <OrdemAssinatura>int</OrdemAssinatura>
            <TipoLeitura>opcional or obrigatorio</TipoLeitura>
            <CategoriaEmpresa>string</CategoriaEmpresa>
            <Assinantes xsi:nil="true" />
          </ParteAssinantesCarta>
          <ParteAssinantesCarta>
            <NomeParte>string</NomeParte>
            <TipoPessoaParte>Física or Jurídica</TipoPessoaParte>
            <CpfCnpjParte>string</CpfCnpjParte>
            <CodigoEmpresaParte>int</CodigoEmpresaParte>
            <NomeEmpresa>string</NomeEmpresa>
            <FantasiaEmpresa>string</FantasiaEmpresa>
            <CepEmpresa>int</CepEmpresa>
            <EnderecoEmpresa>string</EnderecoEmpresa>
            <NumeroEnderecoEmpresa>int</NumeroEnderecoEmpresa>
            <ComplementoEnderecoEmpresa>string</ComplementoEnderecoEmpresa>
            <BairroEmpresa>string</BairroEmpresa>
            <CidadeEmpresa>string</CidadeEmpresa>
            <UfEmpresa>string</UfEmpresa>
            <OrdemAssinatura>int</OrdemAssinatura>
            <TipoLeitura>opcional or obrigatorio</TipoLeitura>
            <CategoriaEmpresa>string</CategoriaEmpresa>
            <Assinantes xsi:nil="true" />
          </ParteAssinantesCarta>
        </ParteAssinantes>
        <ParteConvidados>
          <NomeParteConvidado>string</NomeParteConvidado>
          <Convidados>
            <UsuariosCarta xsi:nil="true" />
            <UsuariosCarta xsi:nil="true" />
          </Convidados>
        </ParteConvidados>
      </data>
    </ImportarCarta>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ImportarCartaResponse xmlns="https://ws.qcertifica.com.br/">
      <ImportarCartaResult>
        <NroOperacao>int</NroOperacao>
        <Mensagem>string</Mensagem>
        <Situacao>Sucesso or Erro or Alerta</Situacao>
        <DocumentosOperacao>
          <RetornoDocumentosOperacao>
            <NroDocumento>long</NroDocumento>
          </RetornoDocumentosOperacao>
          <RetornoDocumentosOperacao>
            <NroDocumento>long</NroDocumento>
          </RetornoDocumentosOperacao>
        </DocumentosOperacao>
      </ImportarCartaResult>
    </ImportarCartaResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Carta.asmx HTTP/1.1
Host: ws.qcertifica.com.br
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ImportarCarta xmlns="https://ws.qcertifica.com.br/">
      <data>
        <CpfCnpjContratante>string</CpfCnpjContratante>
        <CpfCnpjResponsavel>string</CpfCnpjResponsavel>
        <Token>string</Token>
        <TipoOperacao>int</TipoOperacao>
        <TipoColetaOperacao>AssinaturasDeterminadas or PodereseAlçada</TipoColetaOperacao>
        <AssuntoOperacao>string</AssuntoOperacao>
        <DescricaoOperacao>string</DescricaoOperacao>
        <DataLimiteAssinatura>dateTime</DataLimiteAssinatura>
        <CartaTemplate>boolean</CartaTemplate>
        <NomeTemplate>string</NomeTemplate>
        <TipoDocumento>int</TipoDocumento>
        <DocumentosCarta>
          <DocumentosCarta>
            <NomeDocumento>string</NomeDocumento>
            <Arquivo>base64Binary</Arquivo>
          </DocumentosCarta>
          <DocumentosCarta>
            <NomeDocumento>string</NomeDocumento>
            <Arquivo>base64Binary</Arquivo>
          </DocumentosCarta>
        </DocumentosCarta>
        <ParteAssinantes>
          <ParteAssinantesCarta>
            <NomeParte>string</NomeParte>
            <TipoPessoaParte>Física or Jurídica</TipoPessoaParte>
            <CpfCnpjParte>string</CpfCnpjParte>
            <CodigoEmpresaParte>int</CodigoEmpresaParte>
            <NomeEmpresa>string</NomeEmpresa>
            <FantasiaEmpresa>string</FantasiaEmpresa>
            <CepEmpresa>int</CepEmpresa>
            <EnderecoEmpresa>string</EnderecoEmpresa>
            <NumeroEnderecoEmpresa>int</NumeroEnderecoEmpresa>
            <ComplementoEnderecoEmpresa>string</ComplementoEnderecoEmpresa>
            <BairroEmpresa>string</BairroEmpresa>
            <CidadeEmpresa>string</CidadeEmpresa>
            <UfEmpresa>string</UfEmpresa>
            <OrdemAssinatura>int</OrdemAssinatura>
            <TipoLeitura>opcional or obrigatorio</TipoLeitura>
            <CategoriaEmpresa>string</CategoriaEmpresa>
            <Assinantes xsi:nil="true" />
          </ParteAssinantesCarta>
          <ParteAssinantesCarta>
            <NomeParte>string</NomeParte>
            <TipoPessoaParte>Física or Jurídica</TipoPessoaParte>
            <CpfCnpjParte>string</CpfCnpjParte>
            <CodigoEmpresaParte>int</CodigoEmpresaParte>
            <NomeEmpresa>string</NomeEmpresa>
            <FantasiaEmpresa>string</FantasiaEmpresa>
            <CepEmpresa>int</CepEmpresa>
            <EnderecoEmpresa>string</EnderecoEmpresa>
            <NumeroEnderecoEmpresa>int</NumeroEnderecoEmpresa>
            <ComplementoEnderecoEmpresa>string</ComplementoEnderecoEmpresa>
            <BairroEmpresa>string</BairroEmpresa>
            <CidadeEmpresa>string</CidadeEmpresa>
            <UfEmpresa>string</UfEmpresa>
            <OrdemAssinatura>int</OrdemAssinatura>
            <TipoLeitura>opcional or obrigatorio</TipoLeitura>
            <CategoriaEmpresa>string</CategoriaEmpresa>
            <Assinantes xsi:nil="true" />
          </ParteAssinantesCarta>
        </ParteAssinantes>
        <ParteConvidados>
          <NomeParteConvidado>string</NomeParteConvidado>
          <Convidados>
            <UsuariosCarta xsi:nil="true" />
            <UsuariosCarta xsi:nil="true" />
          </Convidados>
        </ParteConvidados>
      </data>
    </ImportarCarta>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ImportarCartaResponse xmlns="https://ws.qcertifica.com.br/">
      <ImportarCartaResult>
        <NroOperacao>int</NroOperacao>
        <Mensagem>string</Mensagem>
        <Situacao>Sucesso or Erro or Alerta</Situacao>
        <DocumentosOperacao>
          <RetornoDocumentosOperacao>
            <NroDocumento>long</NroDocumento>
          </RetornoDocumentosOperacao>
          <RetornoDocumentosOperacao>
            <NroDocumento>long</NroDocumento>
          </RetornoDocumentosOperacao>
        </DocumentosOperacao>
      </ImportarCartaResult>
    </ImportarCartaResponse>
  </soap12:Body>
</soap12:Envelope>