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::GetFirstNotification method space
Retrieves the first notification object.

The notification is casted as message if GetResponse= enResponsePending or is casted as error if GetResponse= enResponseRejected. The GetResponse= enResponseAccepted has no notifications per definition.

VARIANT_FALSE is returned if the end of the object list is reached.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormResponse/GetFirstNotification
[JSON input data] pIGeneralFormResponse: longValue,    //interface address
[JSON result data] pbstrCode:
pbstrText:
peIsAnError:
plRecordID:
pbstrErrorValue:
pbstrValidValue:
pbStatus:		 "utf8StringValue",
"utf8StringValue",
longValue,
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 GetFirstNotification( BSTR
BSTR
YesNoType
long
BSTR
BSTR
VARIANT_BOOL 		*pbstrCode,
*pbstrText,
*peIsAnError,
*plRecordID,
*pbstrErrorValue,
*pbstrValidValue,
*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] BSTR *pbstrCode A message or error code dependent on the notification type.
Note that this code is defined by the "fromEAN" entity and is not standardized.
[out] BSTR *pbstrText A message or error text dependent on the notification type.
Note that this text is defined by the "fromEAN" entity and is not standardized.
[out] YesNoType *peIsAnError A Boolean that defines if it is an error or a message.
In the latter case bstrErrorValue and bstrValidValue are empty and lRecordID is set to 0.
[out] long *plRecordID A record sequence number from the request uniquely identifying the target service record.
If eIsAnError=enYes or the error is not related to a service record lRecordID is 0.
[out] BSTR *pbstrErrorValue The erroneous/incorrect value if the notification is casted as error (eIsAnError=enYes) otherwise 0
[out] BSTR *pbstrValidValue The valid/correct value if the notification is casted as error (eIsAnError=enYes) otherwise 0
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached
space