e-Sign REST Web Service
PostGetTransactions
e-Sign REST Web Service > All Operations Resource Group : GetTransactions (Post)

Resource Path: /api/v5/transactions

Description
Get Transaction.
Request Headers
NameDescription
ApiKey 
ApiSecret 
ApiUsername 
ApiPassword 
Request

The request body is of type TransactionDetailsRequestModel.

Overview

TransactionDetailsRequestModel
ProntoID : string
IDs : Array[integer]
DocumentIDs : Array[integer]
ParticipantIDs : Array[integer]
TaskIDs : Array[integer]
MetaDataName : string
MetaDataValue : string
StatusType : string
SearchDateType : string
SearchDateFrom : string
SearchDateTo : string
Includes : TransactionIncludesModel
IncludeWorkflowActions : boolean
IncludeMetaData : boolean
IncludeParticipants : boolean
ParticipantIncludes : ParticipantIncludesModel
IncludeEmailNotifications : boolean
IncludeWorkflowActions : boolean
IncludeEmailTemplatePlaceholders : boolean
IncludeTasks : boolean
TaskIncludes : TaskIncludesModel
IncludeWorkflowActions : boolean
IncludeFileAttachments : boolean
IncludeTests : boolean
IncludeSignatureBlock : boolean
IncludeFileAttachmentsInfoOnly : boolean
IncludeTests : boolean
IncludeContentPlaceholders : boolean
IncludeDocuments : boolean
DocumentIncludes : DocumentIncludesModel
IncludeFile : boolean
FileIncludes : DocumentFileIncludesModel
IncludeNonWatermarkedVersion : boolean
IncludePdfStampedWithCopyWatermark : boolean
IncludeFileUnlocked : boolean
IncludeOriginalSourceFile : boolean
IncludeSpecificVersion : integer
IncludeMetaData : boolean
IncludeWorkflowActions : boolean
IncludeTasks : boolean
TaskIncludes : TaskIncludesModel
IncludeWorkflowActions : boolean
IncludeFileAttachments : boolean
IncludeTests : boolean
IncludeSignatureBlock : boolean
IncludeFileAttachmentsInfoOnly : boolean
IncludeTests : boolean
IncludeVersions : boolean
IncludeTests : boolean
IncludeThirdPartyNotifications : boolean
EnableLogging : boolean
ResultsCountLimit : integer
ResultsCountStart : integer
SearchText : string
CreatorUserID : integer
TimeZoneID : string
Response

The response body is of type TransactionDetailsServiceReturnModel.

OK

Overview

TransactionDetailsServiceReturnModel
IsSuccessful : boolean
Message : string
Transactions : Array[object]
ProcessingTime : string
TimeZoneUtcOffset : number
See Also
All Operations Resource Group | e-Sign REST Web Service

 

 

© 2022 All Rights Reserved.

Send comments on this topic.