GET api/Document/DigitalSignatureLogEntry/{transactionID}

Gets a log entry from the digital signature log

Request Information

URI Parameters

NameDescriptionTypeAdditional information
transactionID

Input parameter

string

Required

Body Parameters

None.

Response Information

Resource Description

WorkPoint365.WebAPI.Model.Document+LogEntry
NameDescriptionTypeAdditional information
TransactionID

The transaction id for the entry

string

None.

Title

The log title

string

None.

Description

The log description

string

None.

BusinessModuleID

The business module id

string

None.

BusinessModuleTitle

The business module title

string

None.

EntityID

The entity id

integer

None.

EntityTitle

The entity tile

string

None.

Links

Links to documents in the transaction

string

None.

LogEntryDetails

Log details for the transaction

WorkPoint365.WebAPI.Model.Document+LogEntry+Details

None.

SigningStatus

The signing status for the transaction

WorkPoint365.WebAPI.Model.Document+LogEntry+LogSigningStatus

None.

Response Formats

application/json, text/json

Sample:
{
  "TransactionID": "sample string 1",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "BusinessModuleID": "sample string 4",
  "BusinessModuleTitle": "sample string 5",
  "EntityID": 6,
  "EntityTitle": "sample string 7",
  "Links": "sample string 8",
  "LogEntryDetails": {
    "TotalSigningCount": 1,
    "TotalAppendixCount": 2,
    "InProgressCount": 3,
    "SignedCount": 4,
    "ApprovedCount": 5,
    "CancelledCount": 6,
    "RejectedCount": 7,
    "FailedCount": 8,
    "SigningProvider": "Penneo",
    "DocumentInfos": [
      {
        "DocumentSiteUrl": "sample string 1",
        "DocumentUrl": "sample string 2",
        "DocumentLastModified": "2024-03-21T23:30:25.4270799+00:00",
        "DocumentVersion": "sample string 4",
        "PdfUrl": "sample string 5",
        "PdfServerRelativeUrl": "sample string 6",
        "SigningStatus": "InProgress",
        "SigningType": "StandardSigning",
        "SetPropertiesInfo": "sample string 7",
        "DeclarePdfFileAsRecordRequired": true,
        "DeclareOriginalDocumentAsRecordRequired": true,
        "DeclareAppendixFileAsRecordRequired": true,
        "DeclareAsRecordInfo": "sample string 11",
        "LogCreated": "2024-03-21T23:30:25.4270799+00:00",
        "LogLastModified": "2024-03-21T23:30:25.4270799+00:00",
        "Message": "sample string 14"
      },
      {
        "DocumentSiteUrl": "sample string 1",
        "DocumentUrl": "sample string 2",
        "DocumentLastModified": "2024-03-21T23:30:25.4270799+00:00",
        "DocumentVersion": "sample string 4",
        "PdfUrl": "sample string 5",
        "PdfServerRelativeUrl": "sample string 6",
        "SigningStatus": "InProgress",
        "SigningType": "StandardSigning",
        "SetPropertiesInfo": "sample string 7",
        "DeclarePdfFileAsRecordRequired": true,
        "DeclareOriginalDocumentAsRecordRequired": true,
        "DeclareAppendixFileAsRecordRequired": true,
        "DeclareAsRecordInfo": "sample string 11",
        "LogCreated": "2024-03-21T23:30:25.4270799+00:00",
        "LogLastModified": "2024-03-21T23:30:25.4270799+00:00",
        "Message": "sample string 14"
      }
    ]
  },
  "SigningStatus": "InProgress"
}

application/xml, text/xml

Sample:
<Document.LogEntry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <BusinessModuleID>sample string 4</BusinessModuleID>
  <BusinessModuleTitle>sample string 5</BusinessModuleTitle>
  <Description>sample string 3</Description>
  <EntityID>6</EntityID>
  <EntityTitle>sample string 7</EntityTitle>
  <Links>sample string 8</Links>
  <LogEntryDetails>
    <ApprovedCount>5</ApprovedCount>
    <CancelledCount>6</CancelledCount>
    <DocumentInfos>
      <Document.LogEntry.Details.DocumentInfo>
        <DeclareAppendixFileAsRecordRequired>true</DeclareAppendixFileAsRecordRequired>
        <DeclareAsRecordInfo>sample string 11</DeclareAsRecordInfo>
        <DeclareOriginalDocumentAsRecordRequired>true</DeclareOriginalDocumentAsRecordRequired>
        <DeclarePdfFileAsRecordRequired>true</DeclarePdfFileAsRecordRequired>
        <DocumentLastModified>2024-03-21T23:30:25.4270799+00:00</DocumentLastModified>
        <DocumentSiteUrl>sample string 1</DocumentSiteUrl>
        <DocumentUrl>sample string 2</DocumentUrl>
        <DocumentVersion>sample string 4</DocumentVersion>
        <LogCreated>2024-03-21T23:30:25.4270799+00:00</LogCreated>
        <LogLastModified>2024-03-21T23:30:25.4270799+00:00</LogLastModified>
        <Message>sample string 14</Message>
        <PdfServerRelativeUrl>sample string 6</PdfServerRelativeUrl>
        <PdfUrl>sample string 5</PdfUrl>
        <SetPropertiesInfo>sample string 7</SetPropertiesInfo>
        <SigningStatus>InProgress</SigningStatus>
        <SigningType>StandardSigning</SigningType>
      </Document.LogEntry.Details.DocumentInfo>
      <Document.LogEntry.Details.DocumentInfo>
        <DeclareAppendixFileAsRecordRequired>true</DeclareAppendixFileAsRecordRequired>
        <DeclareAsRecordInfo>sample string 11</DeclareAsRecordInfo>
        <DeclareOriginalDocumentAsRecordRequired>true</DeclareOriginalDocumentAsRecordRequired>
        <DeclarePdfFileAsRecordRequired>true</DeclarePdfFileAsRecordRequired>
        <DocumentLastModified>2024-03-21T23:30:25.4270799+00:00</DocumentLastModified>
        <DocumentSiteUrl>sample string 1</DocumentSiteUrl>
        <DocumentUrl>sample string 2</DocumentUrl>
        <DocumentVersion>sample string 4</DocumentVersion>
        <LogCreated>2024-03-21T23:30:25.4270799+00:00</LogCreated>
        <LogLastModified>2024-03-21T23:30:25.4270799+00:00</LogLastModified>
        <Message>sample string 14</Message>
        <PdfServerRelativeUrl>sample string 6</PdfServerRelativeUrl>
        <PdfUrl>sample string 5</PdfUrl>
        <SetPropertiesInfo>sample string 7</SetPropertiesInfo>
        <SigningStatus>InProgress</SigningStatus>
        <SigningType>StandardSigning</SigningType>
      </Document.LogEntry.Details.DocumentInfo>
    </DocumentInfos>
    <FailedCount>8</FailedCount>
    <InProgressCount>3</InProgressCount>
    <RejectedCount>7</RejectedCount>
    <SignedCount>4</SignedCount>
    <SigningProvider>Penneo</SigningProvider>
    <TotalAppendixCount>2</TotalAppendixCount>
    <TotalSigningCount>1</TotalSigningCount>
  </LogEntryDetails>
  <SigningStatus>InProgress</SigningStatus>
  <Title>sample string 2</Title>
  <TransactionID>sample string 1</TransactionID>
</Document.LogEntry>