The ATL COM module generalInvoiceRequest is capable of
generating electronic and printed invoices & reminders
generating electronic and printed invoices & reminders
API browser of generalInvoiceRequest450 COM module
IGeneralInvoiceResult::GetFirstDocument method | |||
---|---|---|---|
Retrieves the first document from the list of documents.
VARIANT_FALSE is returned if the end of the document list is reached. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralInvoiceResult/GetFirstDocument | ||
[JSON input data] | pIGeneralInvoiceResult: | longValue, //interface address |
|
[JSON result data] | peIsURL: pbstrSource: pbstrTitle: pbstrMimeType: pbStatus: |
longValue, "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. | ||
C/C++ calling syntax | |||
HRESULT GetFirstDocument( | YesNoType
BSTR BSTR BSTR VARIANT_BOOL |
*peIsURL,
*pbstrSource, *pbstrTitle, *pbstrMimeType, *pbStatus); |
|
[C/C++ return value] | S_OK | This value is returned if the function call was successful. | |
S_FALSE | This value is returned if the end of an iteration is reached | ||
E_name | This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions. | ||
Calling argument description | |||
[out] YesNoType | *peIsURL | Boolean that defines if the document is added online using a URL (enYes) or inline as Base64 coded stream (enNo). | |
[out] BSTR | *pbstrSource | If eIsURL = enYes then bstrSource is a URL for accessing the file online.
If eIsURL = enNo then bstrSource 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: pbstrSource 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. | |
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached | |