Pronto v5 Web Services
MethodInsertDocuments
Pronto v5 Web Services > All Operations Resource Group : InsertDocuments (Method)
Request (IProntoService_InsertDocuments_InputMessage)

The request body is of type InsertDocuments.

Request Body Parameters

NameDescriptionData Type
 ServiceAuthenticationModel
 DocumentInsertRequestModel
TimeZoneID Element EnableLogging Element IncludeVersions Element IncludeTests Element TaskIncludes Element IncludeTasks Element IncludeWorkflowActions Element IncludeMetaData Element FileIncludes Element IncludeFile Element Sequence ResponseIncludes Element DocumentInsertModel Element Sequence Documents Element Sequence documentInsertRequest Element ApiPassword Element ApiUsername Element ApiSecretOrAuthData Element ApiKeyOrProntoID Element Sequence serviceAuthentication Element Sequence InsertDocuments 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
Title optional xs:string
Sequence
FileBytes optional xs:base64Binary
FilePath optional xs:string
FileUrl optional xs:string
UserFileName optional xs:string
InformationText optional xs:string
ContactText optional xs:string
EmailTemplateSetName optional xs:string
NeverAllowAsEmailAttachment optional xs:boolean
DoNotFlattenPdfFormFields optional xs:boolean
IsOptional optional xs:boolean
Sequence
Value optional xs:int
OtherValue optional xs:string
Increment optional xs:int
Sequence
HeaderText optional xs:string
StatementText optional xs:string
NumberOfPages optional xs:int
PdfPageImageRenderDpi optional xs:decimal
DeleteDate optional xs:dateTime
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
Sequence
ser:Id optional xs:ID
ser:Ref optional xs:IDREF
Sequence
Sequence
Sequence
Name optional xs:string
Value optional xs:string
Sequence
DisplayBitonalPdfPageImages optional xs:boolean
Sequence
Sequence
Name optional xs:string
Value optional xs:string
Sequence
Sequence
TextToStamp optional xs:string
FontSize optional xs:float
FontName optional xs:string
FormField_FieldName optional xs:string
FormField_Instance optional xs:int
SearchText_Text optional xs:string
SearchText_Instance optional xs:int
XOffset optional xs:int
YOffset optional xs:int
Sequence
IncludeFile optional xs:boolean
Sequence
IncludeNonWatermarkedVersion optional xs:boolean
IncludeFileUnlocked optional xs:boolean
IncludeOriginalSourceFile optional xs:boolean
IncludeSpecificVersion optional xs:short
IncludeMetaData 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
IncludeVersions optional xs:boolean
EnableLogging optional xs:boolean
TimeZoneID optional xs:string
Response (IProntoService_InsertDocuments_OutputMessage)

The response body is of type InsertDocumentsResponse.

Response Body Parameters

NameDescriptionData Type
 DocumentDetailsServiceReturnModel
TimeZoneUtcOffset Element ProcessingTime Element DocumentDetailsModel Element Sequence Documents Element Message Element IsSuccessful Element Sequence InsertDocumentsResult Element Sequence InsertDocumentsResponse 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
StatusID optional xs:int
Title optional xs:string
UserFileName optional xs:string
InformationText optional xs:string
ContactText optional xs:string
EmailTemplateSetName optional xs:string
NeverAllowAsEmailAttachment optional xs:boolean
DoNotFlattenPdfFormFields optional xs:boolean
IsOptional optional xs:boolean
Sequence
Value optional xs:int
OtherValue optional xs:string
Increment optional xs:int
Sequence
HeaderText optional xs:string
StatementText optional xs:string
NumberOfPages optional xs:int
DisplayBitonalPdfPageImages optional xs:boolean
PdfPageCount optional xs:int
PdfPageImageRenderDpi optional xs:decimal
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
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
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
Sequence
Sequence
Name optional xs:string
Value optional xs:string
IsCertifyPending optional xs:boolean
IsSealPending optional xs:boolean
CertifiedDate optional xs:dateTime
SealedDate optional xs:dateTime
Sequence
Sequence
ID optional xs:int
DocumentID optional xs:int
Version optional xs:short
TransID optional xs:int
ProntoID optional xs:string
FileName optional xs:string
TSCreate optional xs:dateTime
TSSealed optional xs:dateTime
TSCertified optional xs:dateTime
SealPending optional xs:short
CertifyPending optional xs:short
DocumentSHA256Hash optional xs:string
VersionInfo optional xs:string
IsFinal optional xs:boolean
ProcessingTime optional xs:string
TimeZoneUtcOffset optional xs:double
Example
DocumentInsertRequestModel model = new DocumentInsertRequestModel()
{
    Documents = new DocumentInsertModel[]
                    {
                        new DocumentInsertModel()
                        {
                            TransactionID = 1234567890,
                            Title = "Web Services Insert Test Document",
                            Source = new SourceModel()
                            {
                                FilePath = @"c:\myDocument.pdf"
                            },
                            Tasks = new TaskInsertModel[]
                            {
                                new TaskInsertModel()
                                {
                                    ParticipantID = 1987654320
                                }
                            }
                        }
                    }
};
var results = serviceClient.InsertDocuments(GetServiceAuthentication(), model);
if (results.IsSuccessful)
{
    //do work...
}
else
{
    //handle error
}
Dim model As New DocumentInsertRequestModel() With { 
	 .Documents = New DocumentInsertModel() {New DocumentInsertModel() With { 
		 .TransactionID = 1234567890, 
		 .Title = "Web Services Insert Test Document", 
		 .Source = New SourceModel() With { 
			Key .FilePath = "c:\myDocument.pdf" 
		}, 
		 .Tasks = New TaskInsertModel() {New TaskInsertModel() With { 
			 .ParticipantID = 1987654320 
		}} 
	}} 
}
Dim results = serviceClient.InsertDocuments(GetServiceAuthentication(), model)
If Not results.IsSuccessful Then
    'do work...
Else
    'handle error
End If
See Also
All Operations Resource GroupPronto v5 Web Services