e-Sign REST Web Service
PostGetParticipants
e-Sign REST Web Service > All Operations Resource Group : GetParticipants (Post)

Resource Path: /api/v5/participants

Description
Get a Participant.
Request Headers
NameDescription
 
 
 
 
Request

The request body is of type ParticipantDetailsRequestModel.

Overview

ParticipantDetailsRequestModel
IDs : Array[integer]
ProntoID : string
TransactionIDs : Array[integer]
DocumentIDs : Array[integer]
TaskIDs : Array[integer]
StatusType : string
FullName : string
EmailAddress : string
Title : string
Organization : string
SearchDateType : string
SearchDateFrom : string
SearchDateTo : string
IncludeEmailNotifications : boolean
IncludeWorkflowActions : boolean
IncludeEmailTemplatePlaceholders : boolean
IncludeTasks : boolean
TaskIncludes : TaskIncludesModel
IncludeWorkflowActions : boolean
IncludeFileAttachments : boolean
IncludeTests : boolean
IncludeSignatureBlock : boolean
IncludeFileAttachmentsInfoOnly : boolean
IncludeTests : boolean
IncludeContentPlaceholders : boolean
EnableLogging : boolean
ResultsCountLimit : integer
ResultsCountStart : integer
TimeZoneID : string
Response

The response body is of type ParticipantDetailsServiceReturnModel.

OK

Overview

ParticipantDetailsServiceReturnModel
IsSuccessful : boolean
Message : string
Participants : Array[object]
ProcessingTime : string
TimeZoneUtcOffset : number
See Also
All Operations Resource Groupe-Sign REST Web Service