- Conteúdo da página
- Introdução
- Formato de entrada
- Formato de Saida
Chamada: DocumentoCancelar
Esta função tem por intuito realizar o cancelamento de um documento informando a referência ou passcode do documento.
Formato de entrada:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
<sessao>XXXX</sessao>
<documentos>
<referencia>XXXX</referencia>
<referencia>YYYY</referencia>
<referencia>ZZZZ</referencia>
</documentos>
</documentoeletronico>
E a seguinte estrutura quando informado o passcode:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
<sessao>XXXX</sessao>
<documentos>
<passcode>RKILF-FG4FR-TCDEW-57RFE</passcode>
<passcode>AKILX-HT4FR-ACDE1-47ZF1</passcode>
<passcode>JKILG-NG4FR-UCDEN-88XFE</passcode>
</documentos>
</documentoeletronico>
Parâmetro | Formato | Obrigatório | Descrição |
---|---|---|---|
sessao | Texto | S | Chave de acesso cadastrada para sua empresa. |
documentos | Texto | S | Node para definir os documentos a serem listados |
referencia | Texto | S | Lista de referências de documentos. |
passcode | Texto | S | Lista de Passcodes de documentos. Passcode é a identificação de um documento gerada pelo Portal QualiSign. |
Formato de saída:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
<CodErro />
<MsgErro />
<documentos>
<documento docto_referencia="" docto_status="" docto_validade="" />
<documento docto_referencia="" docto_status="" docto_validade="" />
</documentos>
</documentoeletronico>
Parâmetro | Formato | Descrição |
---|---|---|
CodErro | Numérico | Código de erro (ver Códigos de Erros). |
MsgErro | Texto | Mensagem de Erro |
docto_referencia | Texto | Referência do documento. |
docto_passcode | Texto | passcode do documento |
status_alterado | Texto | Informa se foi possível alterar o status do documento. (S-Sim, N-Não) |