Pronto v5 Web Services
MethodInsertParticipants
Pronto v5 Web Services > All Operations Resource Group : InsertParticipants (Method)
Request (IProntoService_InsertParticipants_InputMessage)

The request body is of type InsertParticipants.

Request Body Parameters

NameDescriptionData Type
 ServiceAuthenticationModel
 ParticipantInsertRequestModel
TimeZoneID Element EnableLogging Element IncludeContentPlaceholders Element IncludeTests Element TaskIncludes Element IncludeTasks Element IncludeEmailTemplatePlaceholders Element IncludeWorkflowActions Element IncludeEmailNotifications Element Sequence ResponseIncludes Element ParticipantInsertModel Element Sequence Participants Element Sequence participantInsertRequest Element ApiPassword Element ApiUsername Element ApiSecretOrAuthData Element ApiKeyOrProntoID Element Sequence serviceAuthentication Element Sequence InsertParticipants Element

Overview

Sequence
Sequence
ApiKeyOrProntoID optional xs:string
ApiSecretOrAuthData optional xs:string
ApiUsername optional xs:string
ApiPassword optional xs:string
Sequence
Sequence
Sequence
TransactionID optional xs:int
EmailTemplateSetName optional xs:string
SendRequestViaEmail optional xs:boolean
DisableDocumentDownloads optional xs:boolean
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
Sequence
Country optional xs:string
StateProvince optional xs:string
Sequence
Sequence
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
IsPreAuthentication optional xs:boolean
ButtonTextPositive optional xs:string
ButtonTextNegative optional xs:string
Content optional xs:string
Sequence
Sequence
Name optional xs:string
Value optional xs:string
Sequence
ser:Id optional xs:ID
ser:Ref optional xs:IDREF
Sequence
AccessOrder optional xs:int
Sequence
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
PdfFieldForFullName optional xs:string
PdfFieldForFirstName optional xs:string
PdfFieldForLastName optional xs:string
PdfFieldForEmailAddress optional xs:string
PdfFieldForTitle optional xs:string
PdfFieldForOrganization optional xs:string
SendRequestViaSms optional xs:boolean
PhoneNumber optional xs:string
SmsCredentialName optional xs:string
IsDefinedParticipant optional xs:boolean
Sequence
IncludeEmailNotifications optional xs:boolean
IncludeWorkflowActions optional xs:boolean
IncludeTasks optional xs:boolean
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
TimeZoneID optional xs:string
Response (IProntoService_InsertParticipants_OutputMessage)

The response body is of type InsertParticipantsResponse.

Response Body Parameters

NameDescriptionData Type
 ParticipantDetailsServiceReturnModel
TimeZoneUtcOffset Element ProcessingTime Element ParticipantDetailsModel Element Sequence Participants Element Message Element IsSuccessful Element Sequence InsertParticipantsResult Element Sequence InsertParticipantsResponse Element

Overview

Sequence
Sequence
IsSuccessful optional xs:boolean
Message optional xs:string
Sequence
Sequence
ID optional xs:int
AccessToken optional xs:string
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
DisableDocumentDownloads optional xs:boolean
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
Sequence
Country optional xs:string
StateProvince optional xs:string
Sequence
Sequence
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
IsPreAuthentication optional xs:boolean
ButtonTextPositive optional xs:string
ButtonTextNegative optional xs:string
Content optional xs:string
Sequence
Sequence
Name optional xs:string
Value optional xs:string
Sequence
Sequence
ID optional xs:int
DocumentID optional xs:int
ParticipantID optional xs:int
StatusID optional xs:int
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
IsOptional optional xs:boolean
PromptToDrawNewSignature optional xs:boolean
EmailTemplateSetLanguage optional xs:string
Copy optional xs:string
Name optional xs:string
AccountTemplateSet optional xs:string
AccountTemplateSetLanguage optional xs:string
EmailAddress optional xs:string
AccessOrder optional xs:int
Sequence
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
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 ParticipantInsertRequestModel()
{
    Participants = new ParticipantInsertModel[]
                    {
                        new ParticipantInsertModel()
                        {
                            TransactionID = 1234567890,
                            FullName = "Sally Smith"
                        }
                    }
};
var results = serviceClient.InsertParticipants(sa, model);
if (results.IsSuccessful)
{
    //do work...
}
else
{
    //handle error
}
Dim model = New ParticipantInsertRequestModel() With { 
	 .Participants = New ParticipantInsertModel() {New ParticipantInsertModel() With { 
		 .TransactionID = 1234567890, 
		 .FullName = "Sally Smith" 
	}} 
}
Dim results = serviceClient.InsertParticipants(sa, model)
If Not results.IsSuccessful Then
    'do work...
Else
    'handle error
End If
See Also
All Operations Resource GroupPronto v5 Web Services