Pronto v5 Web Services
MethodUpdateParticipants
Pronto v5 Web Services > All Operations Resource Group : UpdateParticipants (Method)
Request (IProntoService_UpdateParticipants_InputMessage)

The request body is of type UpdateParticipants.

Request Body Parameters

NameDescriptionData Type
serviceAuthentication ServiceAuthenticationModel
participantUpdateRequest ParticipantUpdateRequestModel
EnableLogging Element ParticipantUpdateModel Element Sequence Participants Element Sequence participantUpdateRequest Element ApiPassword Element ApiUsername Element ApiSecretOrAuthData Element ApiKeyOrProntoID Element Sequence serviceAuthentication Element Sequence UpdateParticipants Element

Overview

UpdateParticipants
Sequence
serviceAuthentication optional ServiceAuthenticationModel Complex Type
Sequence
ApiKeyOrProntoID optional xs:string
ApiSecretOrAuthData optional xs:string
ApiUsername optional xs:string
ApiPassword optional xs:string
participantUpdateRequest optional ParticipantUpdateRequestModel Complex Type
Sequence
Participants optional ArrayOfParticipantUpdateModel Complex Type
Sequence
ParticipantUpdateModel 0..∞ ParticipantUpdateModel Complex Type
Sequence
ID optional xs:int
Authentication optional AuthenticationModel Complex Type
EmailTemplateSetName optional xs:string
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
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
Authentication2 optional AuthenticationModel Complex Type
BrandName optional xs:string
SendRequestViaSms optional xs:boolean
PhoneNumber optional xs:string
SmsCredentialName optional xs:string
IsDefinedParticipant optional xs:boolean
EnableLogging optional xs:boolean
Response (IProntoService_UpdateParticipants_OutputMessage)

The response body is of type UpdateParticipantsResponse.

Response Body Parameters

NameDescriptionData Type
UpdateParticipantsResult DefaultServiceReturnModel
TimeZoneUtcOffset Element ProcessingTime Element Message Element IsSuccessful Element Sequence UpdateParticipantsResult Element Sequence UpdateParticipantsResponse Element

Overview

UpdateParticipantsResponse
Sequence
UpdateParticipantsResult optional DefaultServiceReturnModel Complex Type
Sequence
IsSuccessful optional xs:boolean
Message optional xs:string
ProcessingTime optional xs:string
TimeZoneUtcOffset optional xs:double
Example
var model = new ParticipantUpdateableRequestModel()
{
    IDs = new int[] { 1234567890 }
};
var results = serviceClient.GetParticipantsUpdateable(sa, model);
if (results.IsSuccessful)
{
	results.UpdateableParticipants[0].EmailAddress = "test@test.com";
    var updateModel = new ParticipantUpdateRequestModel()
	{
	    Participants = results.UpdateableParticipants
	};
	var updateResults = serviceClient.UpdateParticipants(sa, updateModel);
	if (updateResults.IsSuccessful)
	{
		//do work...
	}
	else
	{
	    //handle error
	}
}
else
{
    //handle error
}
Dim model = New ParticipantUpdateableRequestModel() With { 
	 .IDs = New Integer() {1234567890} 
}
Dim results = serviceClient.GetParticipantsUpdateable(sa, model)
If Not results.IsSuccessful Then
	results.UpdateableParticipants(0).EmailAddress = "test@test.com"
	Dim updateModel = New ParticipantUpdateRequestModel() With { 
		 .Participants = results.UpdateableParticipants 
	}
	Dim updateResults = serviceClient.UpdateParticipants(sa, updateModel)
	If Not updateResults.IsSuccessful Then
			'do work...
	Else
			'handle error
	End If
Else
		'handle error
End If
See Also
All Operations Resource Group | Pronto v5 Web Services

 

 

© 2022 All Rights Reserved.

Send comments on this topic.