DOCUMENTATION

Audit Log Inquiry

Name: ListarLogAuditoria

This function is intended to list the audit log in the reported period.

Input format:

<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
        <sessao>XXXX</sessao> 
        <historico>
            <periodo de="01/06/2016" ate="25/06/2016" />
            <relacionamento nome="" cnpjcpf="" />
            <documento status="" referencia="" />
        </historico>
</documentoeletronico>
Parameter Format Required Description
sessão Text Y Registered access key for your company.
historico Text Y Node to set maintenance history request
periodo Text Y Node to indicate filter by time period.
Completion of the period is mandatory.
de Text Y Initial search date in DD / MM / YYYY format.
ate Text Y Final search date in DD / MM / YYYY format
Relacionamento Node Y Node to indicate the relationship filter.
nome Text N Trading name of the relationship.
cnpjcpf Text N CNPJ/CPF of the relationship.
documento Node Y Node with search filters for documents.
status Text N Document status. Possible values:
  • Not filled - All status
  • A - In force/Active;
  • C - Canceled;
  • P - Pending signature/approval/acceptance
  • T - Waiting for Time Stamp;
  • V - Expired.
referencia Text N Reference of a document.

Output format:

                                    <?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
    <CodErro />0<CodErro /><MsgErro><MsgErro />
    <Historicos>
    <Historico Referencia="ref 2" Status="P" Data="22/11/2016 16:23:21" IDUsuario="webservices" NomeUsuario="WebServices - Representante" DescricaoAcao="xxxxx 2" Motivo="" IP="iii"   CNPJAcao="xxx" />
    <Historico Referencia="999 2" Status="A" Data="22/11/2016 16:23:17" IDUsuario="webservices" NomeUsuario="WebServices - Representante" DescricaoAcao="xxxx" Motivo="" IP="::1" CNPJAcao="xx" />
    </Historicos>
</documentoeletronico>
Parameter Format Description
CodErro Numeric Error code (See Error Codes).
MsgErro Text Error message.
Historicos Node Entries list.
Historico   Entries details.
Referencia Text Document reference.
Status Text Document status.
Data Text Operation date.
IDUsuario Text Id of the user who performed the action.
NomeUsuario Text Name of the user who performed the action.
Motivo Text Reason for action.
DescricaoAcao Text Description of the action.
IP Text IP address of the station that acted.
CNPJAcao Text CNPJ / CPF of the relationship where the action occurred.