Pronto v5 Web Services
MethodGetParticipants
Pronto v5 Web Services > All Operations Resource Group : GetParticipants (Method)
Request (IProntoService_GetParticipants_InputMessage)

The request body is of type GetParticipants.

Request Body Parameters

NameDescriptionData Type
serviceAuthentication ServiceAuthenticationModel
participantDetailsRequest ParticipantDetailsRequestModel
TimeZoneID Element ResultsCountStart Element ResultsCountLimit Element EnableLogging Element IncludeContentPlaceholders Element IncludeTests Element TaskIncludes Element IncludeTasks Element IncludeEmailTemplatePlaceholders Element IncludeWorkflowActions Element IncludeEmailNotifications Element Sequence Includes Element SearchDateTo Element SearchDateFrom Element SearchDateType Element Organization Element Title Element EmailAddress Element FullName Element StatusType Element int Element Sequence TaskIDs Element int Element Sequence DocumentIDs Element int Element Sequence TransactionIDs Element ProntoID Element int Element Sequence IDs Element Sequence participantDetailsRequest Element ApiPassword Element ApiUsername Element ApiSecretOrAuthData Element ApiKeyOrProntoID Element Sequence serviceAuthentication Element Sequence GetParticipants Element

Overview

GetParticipants
Sequence
serviceAuthentication optional ServiceAuthenticationModel Complex Type
Sequence
ApiKeyOrProntoID optional xs:string
ApiSecretOrAuthData optional xs:string
ApiUsername optional xs:string
ApiPassword optional xs:string
participantDetailsRequest optional ParticipantDetailsRequestModel Complex Type
Sequence
IDs optional ArrayOfint Complex Type
Sequence
int 0..∞ xs:int
ProntoID optional xs:string
TransactionIDs optional ArrayOfint Complex Type
Sequence
int 0..∞ xs:int
DocumentIDs optional ArrayOfint Complex Type
Sequence
int 0..∞ xs:int
TaskIDs optional ArrayOfint Complex Type
Sequence
int 0..∞ xs:int
StatusType optional Option.TransactionStatusTypes Simple Type
FullName optional xs:string
EmailAddress optional xs:string
Title optional xs:string
Organization optional xs:string
SearchDateType optional Option.TransactionSearchDateTypes Simple Type
SearchDateFrom optional xs:dateTime
SearchDateTo optional xs:dateTime
Includes optional ParticipantIncludesModel Complex Type
Sequence
IncludeEmailNotifications optional xs:boolean
IncludeWorkflowActions optional xs:boolean
IncludeEmailTemplatePlaceholders optional xs:boolean
IncludeTasks optional xs:boolean
TaskIncludes optional TaskIncludesModel Complex Type
Sequence
IncludeWorkflowActions optional xs:boolean
IncludeFileAttachments optional xs:boolean
IncludeTests optional xs:boolean
IncludeSignatureBlock optional xs:boolean
IncludeFileAttachmentsInfoOnly optional xs:boolean
IncludeTests optional xs:boolean
IncludeContentPlaceholders optional xs:boolean
EnableLogging optional xs:boolean
ResultsCountLimit optional xs:int
ResultsCountStart optional xs:int
TimeZoneID optional xs:string
Response (IProntoService_GetParticipants_OutputMessage)

The response body is of type GetParticipantsResponse.

Response Body Parameters

NameDescriptionData Type
GetParticipantsResult ParticipantDetailsServiceReturnModel
TimeZoneUtcOffset Element ProcessingTime Element ParticipantDetailsModel Element Sequence Participants Element Message Element IsSuccessful Element Sequence GetParticipantsResult Element Sequence GetParticipantsResponse Element

Overview

GetParticipantsResponse
Sequence
GetParticipantsResult optional ParticipantDetailsServiceReturnModel Complex Type
Sequence
IsSuccessful optional xs:boolean
Message optional xs:string
Participants optional ArrayOfParticipantDetailsModel Complex Type
Sequence
ParticipantDetailsModel 0..∞ ParticipantDetailsModel Complex Type
Sequence
ID optional xs:int
AccessToken optional xs:string
Authentication optional AuthenticationModel Complex Type
TransactionID optional xs:int
Url optional xs:string
EmailTemplateSetName optional xs:string
StatusID optional xs:int
CreatedDate optional xs:dateTime
ClosedDate optional xs:dateTime
LastNotificationSentDate optional xs:dateTime
NextNotificationSendDate optional xs:dateTime
EmailsSentCount optional xs:int
MaxEmailsAllowed optional xs:int
SendRequestViaEmail optional xs:boolean
CompletedTransactionNotificationType optional Option.ParticipantCompletedTransactionNotificationTypes Simple Type
DisableDocumentDownloads optional xs:boolean
EnableAccessToAllTransactionDocuments optional xs:boolean
CertificationType optional Option.ParticipantCertificationTypes Simple Type
CompletedDocumentBehaviorType optional Option.ParticipantCompletedDocumentBehaviorTypes Simple Type
CancelledTaskBehaviorType optional Option.ParticipantCancelledTaskBehaviorTypes Simple Type
ErrorBehaviorType optional Option.ParticipantErrorBehaviorTypes Simple Type
DocumentTaskStatusPageBehaviorType optional Option.ParticipantDocumentTaskStatusPageBehaviorTypes Simple Type
ConfirmSignatureIntent optional xs:boolean
ClientReturnUrl optional xs:string
FullName optional xs:string
QueryForName optional xs:boolean
NormalizeFullName optional xs:boolean
EmailAddress optional xs:string
QueryForEmailAddress optional xs:boolean
Title optional xs:string
QueryForTitle optional xs:boolean
Organization optional xs:string
QueryForOrganization optional xs:boolean
ThirdPartyData optional xs:string
DownloadWindowInMinutes optional xs:int
DownloadLimit optional xs:short
Jurisdiction optional ParticipantJurisdictionModel Complex Type
Sequence
Country optional xs:string
StateProvince optional xs:string
EmailNotifications optional ArrayOfEmailNotificationModel Complex Type
Sequence
WorkflowActions optional ArrayOfParticipantWorkflowActionModel Complex Type
Sequence
ParticipantWorkflowActionModel 0..∞ ParticipantWorkflowActionModel Complex Type
Sequence
Data optional xs:string
Url optional xs:string
Description optional xs:string
ActionStatus optional xs:int
PhoneNumber optional xs:string
EmailAddress optional xs:string
StartedDate optional xs:dateTime
NextRetryDate optional xs:dateTime
RetryLimitDate optional xs:dateTime
CompletedDate optional xs:dateTime
Data optional xs:string
Type optional Option.ParticipantActionTypes Simple Type
IsPreAuthentication optional xs:boolean
NotRequiredAfterFirstOccurrence optional xs:boolean
ButtonTextPositive optional xs:string
ButtonTextNegative optional xs:string
Content optional xs:string
DefineParticipantOptions optional ParticipantActionDefineParticipantOptionsModel Complex Type
EmailTemplatePlaceholders optional ArrayOfEmailTemplatePlaceholderModel Complex Type
Sequence
EmailTemplatePlaceholderModel 0..∞ EmailTemplatePlaceholderModel Complex Type
Sequence
Name optional xs:string
Value optional xs:string
Tasks optional ArrayOfTaskDetailsModel Complex Type
Sequence
TaskDetailsModel 0..∞ TaskDetailsModel Complex Type
Sequence
ID optional xs:int
DocumentID optional xs:int
ParticipantID optional xs:int
StatusID optional xs:int
Type optional Option.TaskTypes Simple Type
SignatureApplicationType optional Option.SignatureBlockSignatureApplicationTypes Simple Type
SignatureSizeType optional Option.SignatureBlockSignatureApplicationSizes Simple Type
SignatureCount optional xs:int
PdfFormFillingAllowed optional xs:boolean
PdfFormFillingFieldPrefix optional xs:string
CreatedDate optional xs:dateTime
ClosedDate optional xs:dateTime
NotificationSentDate optional xs:dateTime
TaskStartedDate optional xs:dateTime
IntentConfirmedDate optional xs:dateTime
IpAddress optional xs:string
HostName optional xs:string
AccessToken optional xs:string
EmailTemplateSetName optional xs:string
LastComment optional xs:string
SignatureBlock optional SignatureBlockModel Complex Type
WorkflowActions optional ArrayOfTaskWorkflowActionModel Complex Type
FileAttachments optional ArrayOfFileAttachmentDetailsModel Complex Type
IsOptional optional xs:boolean
TouchPreferredSecondarySignatureApplicationType optional Option.SignatureBlockTouchPreferredSecondarySignatureApplicationTypes Simple Type
PromptToDrawNewSignature optional xs:boolean
Status optional Option.TransactionStatusTypes Simple Type
EmailTemplateSetLanguage optional xs:string
Copy optional xs:string
Name optional xs:string
AccountTemplateSet optional xs:string
AccountTemplateSetLanguage optional xs:string
EmailAddress optional xs:string
Document optional DocumentDetailsModel Complex Type
AccessOrder optional xs:int
ContentPlaceholders optional ArrayOfContentPlaceholderModel Complex Type
Sequence
ContentPlaceholderModel 0..∞ ContentPlaceholderModel Complex Type
Sequence
Name optional xs:string
Value optional xs:string
ContentSetName optional xs:string
LanguagePreferred optional xs:string
AllowReassignment optional xs:boolean
Role optional xs:string
Initials optional xs:string
QueryForInitials optional xs:boolean
BrandName optional xs:string
EmailSentDate optional xs:dateTime
Status optional Option.TransactionStatusTypes Simple Type
SendRequestViaSms optional xs:boolean
PhoneNumber optional xs:string
SmsCredentialName optional xs:string
TinyUrl optional xs:string
ProcessingTime optional xs:string
TimeZoneUtcOffset optional xs:double
Example
var model = new ParticipantDetailsRequestModel()
{
    EnableLogging = false,
    IDs = new int[] { 1234567890 },
    Includes = new ParticipantIncludesModel()
    {
        IncludeEmailNotifications = true,
        IncludeEmailTemplatePlaceholders = true,
        IncludeWorkflowActions = true,
        IncludeTasks = true
    }
};
var results = serviceClient.GetParticipants(sa, model);
if (results.IsSuccessful)
{
    //do work...
}
else
{
    //handle error
}
Dim model = New ParticipantDetailsRequestModel() With { 
	 .EnableLogging = False, 
	 .IDs = New Integer() {1234567890}, 
	 .Includes = New ParticipantIncludesModel() With { 
		 .IncludeEmailNotifications = True, 
		 .IncludeEmailTemplatePlaceholders = True, 
		 .IncludeWorkflowActions = True, 
		 .IncludeTasks = True 
	} 
}
Dim results = serviceClient.GetParticipants(sa, model)
If Not results.IsSuccessful Then
    'do work...
Else
    'handle error
End If
See Also
All Operations Resource Group | Pronto v5 Web Services

 

 

© 2022 All Rights Reserved.

Send comments on this topic.