The generalFormRequest ATL COM module manages
and fills out a PDF based form system
API browser of generalFormResponse450 COM module


/images/arrow_right.png IGeneralFormResponse::GetDocuments method space
This method has a Restful Webservice representation only!
Method for collecting all document data covered by the IGeneralFormResponse interface and returned as JSON array.
 
Please note that IGeneralFormResponse::GetDocuments takes over the functionality of the iterator pair IGeneralFormResponse::GetFirstDocument / IGeneralFormResponse::GetNextDocument with a single call, making the latter superfluous.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormResponse/GetDocuments
[JSON input data] pIGeneralFormResponse: longValue,    //interface address
[JSON result array] { pbstrFile:
pbstrTitle:
pbstrMimeType:
pbStatus:		 "utf8StringValue",
"utf8StringValue",
"utf8StringValue",
booleanValue
  },
[HTTP result status] 200 Return status 200 signals a successful method call
204 Return status 204 (noContent) signals that the end of an iteration is reached
>= 400 Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do.
space
/images/arrow_right.png Calling argument description
[out] BSTR *pbstrFile *pbstrFile supplies the full file name (path + name) of the document in a temporary working directory.

Be sure to copy away the file to a different location as all files in the working directory are deleted before the COM module shuts down!

In Restful webservice output: pbstrFile is a relative URL that subsequently must be downloaded by a GET process.
[out] BSTR *pbstrTitle The title of the document on the primary system. It thus describes the document to a certain degree in terms of its semantic content.
[out] BSTR *pbstrMimeType The MIME type of the document.

Since the underlying XSD schema restricts the type of files, the MIME type must be one of

  • application/pdf for PDF files
  • image/jpeg for JPG graphic files
  • image/png for PNG graphic files
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached
space