pushAdminMessage COM module is a data
exchange system for treatment messages
API browser of pushAdminMessage500 COM module


/images/arrow_right.png IPushAdminMessageResult::GetRequest method space
Returns the primary parameters of the request, namely the language the data is supplied, besides the GUID of the XML infoset and an optional remark.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IPushAdminMessageResult/GetRequest
[JSON input data] pIPushAdminMessageResult: longValue,    //interface address
[JSON result data] peDataLanguage:
pbstrRemark:
pbstrGUID:
pbStatus:		 longValue,
"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 C/C++ calling syntax
HRESULT GetRequest( LanguageType
BSTR
BSTR
VARIANT_BOOL 		*peDataLanguage,
*pbstrRemark,
*pbstrGUID,
*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
[out] LanguageType *peDataLanguage Gets the language in which the data part is coded. It is exactly the language in which the request is formulated.
 
Note, that the data language and the module language (given by IGeneralInvoiceRequestManager::SetModuleLanguage) are independent and can be different!
[out] BSTR *pbstrRemark An overall optional remark for the admin message
[out] BSTR *pbstrGUID Gets the unique GUID (Globally Unique IDentifier) allocated to the current XML infoset defined as a
32 hex-digit string covered by the pattern [A-Fa-f0-9]{32}.
[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