Pronto v5 Web Services
MethodGetPdfDataFiles
Pronto v5 Web Services > All Operations Resource Group : GetPdfDataFiles (Method)
Request (IProntoService_GetPdfDataFiles_InputMessage)

The request body is of type GetPdfDataFiles.

Request Body Parameters

NameDescriptionData Type
serviceAuthentication ServiceAuthenticationModel
documentPdfDataFileDetailsRequest DocumentPdfDataFileDetailsRequestModel
TimeZoneID Element IsCsvFormat 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 documentPdfDataFileDetailsRequest Element ApiPassword Element ApiUsername Element ApiSecretOrAuthData Element ApiKeyOrProntoID Element Sequence serviceAuthentication Element Sequence GetPdfDataFiles Element

Overview

GetPdfDataFiles
Sequence
serviceAuthentication optional ServiceAuthenticationModel Complex Type
Sequence
ApiKeyOrProntoID optional xs:string
ApiSecretOrAuthData optional xs:string
ApiUsername optional xs:string
ApiPassword optional xs:string
documentPdfDataFileDetailsRequest optional DocumentPdfDataFileDetailsRequestModel 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
IsCsvFormat optional xs:boolean
TimeZoneID optional xs:string
Response (IProntoService_GetPdfDataFiles_OutputMessage)

The response body is of type GetPdfDataFilesResponse.

Response Body Parameters

NameDescriptionData Type
GetPdfDataFilesResult DocumentFileDetailsServiceReturnModel
TimeZoneUtcOffset Element ProcessingTime Element DocumentFileDetailsModel Element Sequence DocumentFiles Element Message Element IsSuccessful Element Sequence GetPdfDataFilesResult Element Sequence GetPdfDataFilesResponse Element

Overview

GetPdfDataFilesResponse
Sequence
GetPdfDataFilesResult optional DocumentFileDetailsServiceReturnModel Complex Type
Sequence
IsSuccessful optional xs:boolean
Message optional xs:string
DocumentFiles optional ArrayOfDocumentFileDetailsModel Complex Type
Sequence
DocumentFileDetailsModel 0..∞ DocumentFileDetailsModel Complex Type
Sequence
DocumentID optional xs:int
File optional DocumentFileModel Complex Type
Sequence
FileBytes optional xs:base64Binary
FileName optional xs:string
MimeType optional xs:string
ProcessingTime optional xs:string
TimeZoneUtcOffset optional xs:double
Example
var model = new DocumentPdfDataFileDetailsRequestModel()
{
    IDs = new int[] { 1234567890 }
};
var results = serviceClient.GetPdfDataFiles(sa, model);
if (results.IsSuccessful)
{
    //do work...
}
else
{
    //handle error
}
Dim model = New DocumentPdfDataFileDetailsRequestModel() With { 
	 .IDs = New Integer() {1234567890} 
}
Dim results = serviceClient.GetPdfDataFiles(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.