API browser of generalnotification451 COM module


/images/arrow_right.png IGeneralNotificationManager::GetXMLInfo method space
Preloads and analyzes a XML infoset regarding the accepted schema versions and other important information like the encryption status. The generalNotification450 COM module understands and processes the generalNotification450 XSD standard as well as both predecessors, namely generalNotification440 and generalNotification430. Infosets of another XSD standard will return an error.

This method should be called before calling LoadXML since the infoset is possibly encrypted. In this situation the corresponding PFX certificate and password must be supplied in the LoadXML method.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralNotificationManager/GetXMLInfo
[JSON input data] pIGeneralNotificationManager:
bstrInputFile:
longValue,    //interface address
"utf8StringValue"
[JSON result data] pbstrUsedSchema:
pbstrFromEAN:
pbstrToEAN:
peIsEncrypted:
pbStatus:
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetXMLInfo( BSTR
BSTR
BSTR
BSTR
YesNoType
VARIANT_BOOL
bstrInputFile,
*pbstrUsedSchema,
*pbstrFromEAN,
*pbstrToEAN,
*peIsEncrypted,
*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.
space
/images/arrow_right.png Calling argument description
[in] BSTR bstrInputFile The full file name (path + name) of a XML infoset.
[out] BSTR *pbstrUsedSchema The full name of the used XSD schema file.
[out] BSTR *pbstrFromEAN The transport EAN number of the sender as supplied by Stiftung Refdata
[out] BSTR *pbstrToEAN The transport EAN number of the receiver as supplied by Stiftung Refdata
[out] YesNoType *peIsEncrypted A Boolean that defines if the XML infoset is encrypted.

If true the private PFX certificate/password of the "to" entity must be given in the LoadXML method otherwise the infoset can not be decrypted.

[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.
space