Pronto v5 Web Services
MethodGetDocumentsUpdateable
Pronto v5 Web Services > All Operations Resource Group : GetDocumentsUpdateable (Method)
Request (IProntoService_GetDocumentsUpdateable_InputMessage)

The request body is of type GetDocumentsUpdateable.

Request Body Parameters

NameDescriptionData Type
serviceAuthentication ServiceAuthenticationModel
documentUpdateableRequest DocumentUpdateableRequestModel
TimeZoneID Element IncludeTests Element ResultsCountStart Element ResultsCountLimit Element EnableLogging Element SearchDateTo Element SearchDateFrom Element SearchDateType Element StatusType Element MetaDataValue Element MetaDataName Element int Element Sequence TaskIDs Element int Element Sequence ParticipantIDs Element int Element Sequence TransactionIDs Element int Element Sequence IDs Element ProntoID Element Sequence documentUpdateableRequest Element ApiPassword Element ApiUsername Element ApiSecretOrAuthData Element ApiKeyOrProntoID Element Sequence serviceAuthentication Element Sequence GetDocumentsUpdateable Element

Overview

GetDocumentsUpdateable
Sequence
serviceAuthentication optional ServiceAuthenticationModel Complex Type
Sequence
ApiKeyOrProntoID optional xs:string
ApiSecretOrAuthData optional xs:string
ApiUsername optional xs:string
ApiPassword optional xs:string
documentUpdateableRequest optional DocumentUpdateableRequestModel Complex Type
Sequence
ProntoID optional xs:string
IDs optional ArrayOfint Complex Type
Sequence
int 0..∞ xs:int
TransactionIDs optional ArrayOfint Complex Type
Sequence
int 0..∞ xs:int
ParticipantIDs optional ArrayOfint Complex Type
Sequence
int 0..∞ xs:int
TaskIDs optional ArrayOfint Complex Type
Sequence
int 0..∞ xs:int
MetaDataName optional xs:string
MetaDataValue optional xs:string
StatusType optional Option.TransactionStatusTypes Simple Type
SearchDateType optional Option.TransactionSearchDateTypes Simple Type
SearchDateFrom optional xs:dateTime
SearchDateTo optional xs:dateTime
EnableLogging optional xs:boolean
ResultsCountLimit optional xs:int
ResultsCountStart optional xs:int
IncludeTests optional xs:boolean
TimeZoneID optional xs:string
Response (IProntoService_GetDocumentsUpdateable_OutputMessage)

The response body is of type GetDocumentsUpdateableResponse.

Response Body Parameters

NameDescriptionData Type
GetDocumentsUpdateableResult DocumentUpdateableServiceReturnModel
TimeZoneUtcOffset Element ProcessingTime Element DocumentUpdateModel Element Sequence UpdateableDocuments Element Message Element IsSuccessful Element Sequence GetDocumentsUpdateableResult Element Sequence GetDocumentsUpdateableResponse Element

Overview

GetDocumentsUpdateableResponse
Sequence
GetDocumentsUpdateableResult optional DocumentUpdateableServiceReturnModel Complex Type
Sequence
IsSuccessful optional xs:boolean
Message optional xs:string
UpdateableDocuments optional ArrayOfDocumentUpdateModel Complex Type
Sequence
DocumentUpdateModel 0..∞ DocumentUpdateModel Complex Type
Sequence
ID 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
IsOptional optional xs:boolean
DeleteDate optional xs:dateTime
Fields optional ArrayOfFormFieldModel Complex Type
Sequence
FormFieldModel 0..∞ FormFieldModel Complex Type
Sequence
Name optional xs:string
Value optional xs:string
IncludeAuditReportWithCompletedDocuments optional xs:boolean
ProcessingTime optional xs:string
TimeZoneUtcOffset optional xs:double
Example
var model = new DocumentUpdateableRequestModel()
{
    IDs = new int[] { 1234567890 }
};
var results = serviceClient.GetDocumentsUpdateable(sa, model);
if (results.IsSuccessful)
{
    //do work...
}
else
{
    //handle error
}
Dim model = New DocumentUpdateableRequestModel() With { 
	 .IDs = New Integer() {1234567890} 
}
Dim results = serviceClient.GetDocumentsUpdateable(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.