Pronto v5 Web Services
MethodInsertTasks
Pronto v5 Web Services > All Operations Resource Group : InsertTasks (Method)
Request (IProntoService_InsertTasks_InputMessage)

The request body is of type InsertTasks.

Request Body Parameters

NameDescriptionData Type
serviceAuthentication ServiceAuthenticationModel
taskInsertRequest TaskInsertRequestModel
TimeZoneID Element EnableLogging Element IncludeFileAttachmentsInfoOnly Element IncludeSignatureBlock Element IncludeTests Element IncludeFileAttachments Element IncludeWorkflowActions Element Sequence ResponseIncludes Element TaskInsertModel Element Sequence Tasks Element Sequence taskInsertRequest Element ApiPassword Element ApiUsername Element ApiSecretOrAuthData Element ApiKeyOrProntoID Element Sequence serviceAuthentication Element Sequence InsertTasks Element

Overview

InsertTasks
Sequence
serviceAuthentication optional ServiceAuthenticationModel Complex Type
Sequence
ApiKeyOrProntoID optional xs:string
ApiSecretOrAuthData optional xs:string
ApiUsername optional xs:string
ApiPassword optional xs:string
taskInsertRequest optional TaskInsertRequestModel Complex Type
Sequence
Tasks optional ArrayOfTaskInsertModel Complex Type
Sequence
TaskInsertModel 0..∞ TaskInsertModel Complex Type
ser:Id optional xs:ID
ser:Ref optional xs:IDREF
Sequence
DocumentID optional xs:int
ParticipantID optional xs:int
Type optional Option.TaskTypes Simple Type
PdfFormFillingEnabled optional xs:boolean
PdfFormFillingFieldPrefix optional xs:string
SignatureBlock optional SignatureBlockModel Complex Type
Sequence
Signature optional SignatureModel Complex Type
Sequence
PdfPlacement optional PdfSignaturePlacementModel Complex Type
ApplicationType optional Option.SignatureBlockSignatureApplicationTypes Simple Type
ApplicationSize optional Option.SignatureBlockSignatureApplicationSizes Simple Type
DisplaySignHereTagForHardwareCaptureDeviceSignatureOnHtmlDocuments optional xs:boolean
FontName optional xs:string
FontColor optional Option.SignatureBlockSignatureColors Simple Type
IsBold optional xs:boolean
IsItalic optional xs:boolean
ImageStampedFontSize optional xs:short
ButtonPositiveText optional xs:string
ButtonNegativeText optional xs:string
PlaceSignatureOnAdditionalPdfSignaturePage optional xs:boolean
TouchPreferredSecondaryApplicationType optional Option.SignatureBlockTouchPreferredSecondarySignatureApplicationTypes Simple Type
PromptToDrawNewSignature optional xs:boolean
AdditionalPdfDataPlacements optional ArrayOfSignatureBlockPdfDataPlacementModel Complex Type
AdditionalHtmlDataPlacements optional SignatureBlockHtmlDataPlacementModel Complex Type
Sequence
DisplayTitle optional xs:boolean
DisplayOrganization optional xs:boolean
DisplayEmailAddress optional xs:boolean
DisplayDateTime optional xs:boolean
DisplayPrintedName optional xs:boolean
PdfOpenPromptPageNumber optional xs:int
HtmlOpenPromptAnchor optional xs:string
WorkflowActions optional ArrayOfTaskWorkflowActionModel Complex Type
Sequence
TaskWorkflowActionModel 0..∞ TaskWorkflowActionModel 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
Type optional Option.TaskActionTypes Simple Type
ButtonTextPositive optional xs:string
ButtonTextNegative optional xs:string
Content optional xs:string
NotRequiredAfterFirstOccurrence optional xs:boolean
IsOptional optional xs:boolean
ResponseIncludes 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
EnableLogging optional xs:boolean
TimeZoneID optional xs:string
Response (IProntoService_InsertTasks_OutputMessage)

The response body is of type InsertTasksResponse.

Response Body Parameters

NameDescriptionData Type
InsertTasksResult TaskDetailsServiceReturnModel
TimeZoneUtcOffset Element ProcessingTime Element TaskDetailsModel Element Sequence Tasks Element Message Element IsSuccessful Element Sequence InsertTasksResult Element Sequence InsertTasksResponse Element

Overview

InsertTasksResponse
Sequence
InsertTasksResult optional TaskDetailsServiceReturnModel Complex Type
Sequence
IsSuccessful optional xs:boolean
Message 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
Sequence
Signature optional SignatureModel Complex Type
Sequence
PdfPlacement optional PdfSignaturePlacementModel Complex Type
ApplicationType optional Option.SignatureBlockSignatureApplicationTypes Simple Type
ApplicationSize optional Option.SignatureBlockSignatureApplicationSizes Simple Type
DisplaySignHereTagForHardwareCaptureDeviceSignatureOnHtmlDocuments optional xs:boolean
FontName optional xs:string
FontColor optional Option.SignatureBlockSignatureColors Simple Type
IsBold optional xs:boolean
IsItalic optional xs:boolean
ImageStampedFontSize optional xs:short
ButtonPositiveText optional xs:string
ButtonNegativeText optional xs:string
PlaceSignatureOnAdditionalPdfSignaturePage optional xs:boolean
TouchPreferredSecondaryApplicationType optional Option.SignatureBlockTouchPreferredSecondarySignatureApplicationTypes Simple Type
PromptToDrawNewSignature optional xs:boolean
AdditionalPdfDataPlacements optional ArrayOfSignatureBlockPdfDataPlacementModel Complex Type
AdditionalHtmlDataPlacements optional SignatureBlockHtmlDataPlacementModel Complex Type
Sequence
DisplayTitle optional xs:boolean
DisplayOrganization optional xs:boolean
DisplayEmailAddress optional xs:boolean
DisplayDateTime optional xs:boolean
DisplayPrintedName optional xs:boolean
PdfOpenPromptPageNumber optional xs:int
HtmlOpenPromptAnchor optional xs:string
WorkflowActions optional ArrayOfTaskWorkflowActionModel Complex Type
Sequence
TaskWorkflowActionModel 0..∞ TaskWorkflowActionModel 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
Type optional Option.TaskActionTypes Simple Type
ButtonTextPositive optional xs:string
ButtonTextNegative optional xs:string
Content optional xs:string
NotRequiredAfterFirstOccurrence optional xs:boolean
FileAttachments optional ArrayOfFileAttachmentDetailsModel Complex Type
Sequence
FileAttachmentDetailsModel 0..∞ FileAttachmentDetailsModel Complex Type
Sequence
ID optional xs:int
TaskID optional xs:int
FileBytes optional xs:base64Binary
FileName optional xs:string
FileExtension optional xs:string
FileMimeType optional xs:string
CreatedDate optional xs:dateTime
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
Sequence
ID optional xs:int
AccessToken optional xs:string
TransactionID optional xs:int
StatusID optional xs:int
Title optional xs:string
UserFileNameType optional Option.DocumentUserFileNameTypes Simple Type
UserFileName optional xs:string
InformationText optional xs:string
ContactText optional xs:string
EmailTemplateSetName optional xs:string
EnableSignatureInformationAnnotation optional xs:boolean
NeverAllowAsEmailAttachment optional xs:boolean
DoNotFlattenPdfFormFields optional xs:boolean
IsOptional optional xs:boolean
PageStamp optional PageStampModel Complex Type
Sequence
Type optional Option.DocumentPageStampTypes Simple Type
Value optional xs:int
OtherValue optional xs:string
Increment optional xs:int
AdditionalSignaturePage optional AdditionalSignaturePageModel Complex Type
Sequence
HeaderText optional xs:string
StatementText optional xs:string
NumberOfPages optional xs:int
ServiceType optional Option.DocumentServiceTypes Simple Type
SourceFileType optional Option.DocumentSourceFileTypes Simple Type
SourceFileAccessType optional Option.DocumentSourceFileAccessTypes Simple Type
DisplayBitonalPdfPageImages optional xs:boolean
PdfPageCount optional xs:int
PdfPageImageRenderDpi optional xs:decimal
File optional DocumentFileModel Complex Type
Sequence
FileBytes optional xs:base64Binary
FileName optional xs:string
MimeType optional xs:string
CreatedDate optional xs:dateTime
ClosedDate optional xs:dateTime
DeleteDate optional xs:dateTime
DeletedDate optional xs:dateTime
Watermark optional WatermarkModel Complex Type
Sequence
WorkflowActions optional ArrayOfDocumentWorkflowActionModel Complex Type
Tasks optional ArrayOfTaskDetailsModel Complex Type
MetaData optional ArrayOfMetaDataModel Complex Type
IsCertifyPending optional xs:boolean
IsSealPending optional xs:boolean
CertifiedDate optional xs:dateTime
SealedDate optional xs:dateTime
Versions optional ArrayOfDocumentVersionModel Complex Type
Status optional Option.TransactionStatusTypes Simple Type
IncludeAuditReportWithCompletedDocuments optional xs:boolean
ProcessingTime optional xs:string
TimeZoneUtcOffset optional xs:double
Example
var model = new TaskInsertRequestModel()
{
    EnableLogging = false,
    Tasks = new TaskInsertModel[]
            {
                new TaskInsertModel()
                {
                    DocumentID = documentID,
                    ParticipantID = participantID,
                    Type = TaskTypes.Delivery
                }
            }
};
var results = serviceClient.InsertTasks(GetServiceAuthentication(), model);
if (results.IsSuccessful)
{
    //do work...
}
else
{
    //handle error
}
Dim model = New TaskInsertRequestModel() With { 
	.Tasks = New TaskInsertModel() {
		New TaskInsertModel() With { 
		 	.DocumentID = documentID, 
		 	.ParticipantID = participantID, 
		 	.Type = TaskTypes.Delivery 
	}} 
}
Dim results = serviceClient.InsertTasks(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.