GET api/Documents/{documentId}/AuditLog

Gets the rights holders for the provided document identifier.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentId

The document identifier.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

The document audit log.

ESignSystems.SmartSAFE.Models.Documents.DocumentAuditLogModel
NameDescriptionTypeAdditional information
DocumentId

Gets or sets the identifier of the document this audit log is for.

 integer

None.
DocumentName

Gets or sets the the name of the document this audit log is for.

 string

None.
DocumentType

Gets or sets the the type of the document this audit log is for.

 string

None.
AuthoritativeCopy

Gets or sets the the authoritative copy value of the document this audit log is for.

 boolean

None.
AuditLogEntries

Gets or sets the audit log entries for the document this audit log is for.

 Collection of ESignSystems.SmartSAFE.Models.Documents.DocumentAuditLogEntryModel

None.
UDF1

Gets or sets the first User Defined Field.

 string

None.
UDF2

Gets or sets the second User Defined Field.

 string

None.
UDF3

Gets or sets the third User Defined Field.

 string

None.
ClientId

Gets or sets the client identifier for the document.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "DocumentId": 1,
  "DocumentName": "sample string 1",
  "DocumentType": "sample string 2",
  "AuthoritativeCopy": true,
  "AuditLogEntries": [
    {
      "ActionType": "sample string 1",
      "EntryDate": "2024-11-26T17:41:08.3418773-05:00",
      "UserName": "sample string 2",
      "SecuredParty": "sample string 3",
      "PreviousSecuredParty": "sample string 4"
    },
    {
      "ActionType": "sample string 1",
      "EntryDate": "2024-11-26T17:41:08.3418773-05:00",
      "UserName": "sample string 2",
      "SecuredParty": "sample string 3",
      "PreviousSecuredParty": "sample string 4"
    }
  ],
  "UDF1": "sample string 3",
  "UDF2": "sample string 4",
  "UDF3": "sample string 5",
  "ClientId": 6
}

application/xml, text/xml

Sample: 
<DocumentAuditLogModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Documents">
  <AuditLogEntries>
    <DocumentAuditLogEntryModel>
      <ActionType>sample string 1</ActionType>
      <EntryDate>2024-11-26T17:41:08.3418773-05:00</EntryDate>
      <PreviousSecuredParty>sample string 4</PreviousSecuredParty>
      <SecuredParty>sample string 3</SecuredParty>
      <UserName>sample string 2</UserName>
    </DocumentAuditLogEntryModel>
    <DocumentAuditLogEntryModel>
      <ActionType>sample string 1</ActionType>
      <EntryDate>2024-11-26T17:41:08.3418773-05:00</EntryDate>
      <PreviousSecuredParty>sample string 4</PreviousSecuredParty>
      <SecuredParty>sample string 3</SecuredParty>
      <UserName>sample string 2</UserName>
    </DocumentAuditLogEntryModel>
  </AuditLogEntries>
  <AuthoritativeCopy>true</AuthoritativeCopy>
  <ClientId>6</ClientId>
  <DocumentId>1</DocumentId>
  <DocumentName>sample string 1</DocumentName>
  <DocumentType>sample string 2</DocumentType>
  <UDF1>sample string 3</UDF1>
  <UDF2>sample string 4</UDF2>
  <UDF3>sample string 5</UDF3>
</DocumentAuditLogModel>