- Page Content
- Introduction
- Input format
- Output format
Name: DocumentoCancelar
This function is intended to cancel a document informing the reference or passcode of the document.
Input format:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
<sessao>XXXX</sessao>
<documentos>
<referencia>XXXX</referencia>
<referencia>YYYY</referencia>
<referencia>ZZZZ</referencia>
</documentos>
</documentoeletronico>
And the following structure when the passcode is informed
<?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>
Parameter | Format | Required | Description |
---|---|---|---|
sessao | Text | Y | Registered access key for your company. |
documentos | Text | Y | Node for defining documents to be cancelled. |
referencia | Text | Y | Document reference. |
passcode | Text | Y | Document passcode. Passcode is the identification of a document generated by the QualiSign Portal. |
Output format:
<?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>
Parameter | Format | Description |
---|---|---|
CodErro | Numeric | Error code (See "Error Codes"). |
MsgErro | Text | Error message. |
docto_referencia | Text | Document reference. |
docto_passcode | Text | Document passcode. |
status_alterado | Text | Indicates whether the status of the document has changed. (S-Yes, N-No). |