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
IGeneralInvoiceRequestManager::LoadXML method | |||
---|---|---|---|
Loads a previously generated XML infoset back into memory for further processing via the returned interface handles. The GeneralInvoiceRequest450 COM module understands and processes the generalInvoiceRequest_450 XSD standard as well as its predecessor, namely generalInvoiceRequest_440.
To analyze and retrieve the loaded data use the returned instance of the IGeneralInvoiceRequest interface and/or preview/print the data. Furthermore, this method serves as dashboard e.g. to produce a "storno" or "copy" XML infoset.
|
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralInvoiceRequestManager/LoadXML?param | ||
[param] | pIGeneralInvoiceRequestManager=longValue& bstrInputFile=urlEncodedString + <application/octet-stream> input_file_upload_stream |
||
[JSON result data] | pbstrUsedSchema: pIGeneralInvoiceRequest: pIGeneralInvoiceResult: pbStatus: |
"utf8StringValue", longValue, longValue, 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 LoadXML( | BSTR
BSTR IGeneralInvoiceRequest IGeneralInvoiceResult VARIANT_BOOL |
bstrInputFile,
*pbstrUsedSchema, **pIGeneralInvoiceRequest, **pIGeneralInvoiceResult, *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 | |||
[in] BSTR | bstrInputFile | The input XML infoset (full file name) that must be loaded and analyzed. | |
[out] BSTR | *pbstrUsedSchema | The full XSD name of the loaded XML file.
Since the current standard and its predecessor can natively be loaded the returned schema is either generalInvoiceRequest_450.xsd or generalInvoiceRequest_440.xsd. This variable is not set if the loading of an XML infoset was unsuccessful. |
|
[out] IGeneralInvoiceRequest | **pIGeneralInvoiceRequest | The IGeneralInvoiceRequest interface handle that allows to add further data.
The handle is NULL if an error occurred. |
|
[out] IGeneralInvoiceResult | **pIGeneralInvoiceResult | The instance of a IGeneralInvoiceResult interface allows to read all loaded data back.
The handle is NULL if an error occurred. |
|
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string. | |