The ATL COM module generalNotification is a structured
message exchange protocol between to healthcare partners
API browser of generalnotification451 COM module


/images/arrow_right.png IGeneralNotificationResponse::GetRequest method space
Retrieves some basic parameters like the data language or the confidentiality status of the notification.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralNotificationResponse/GetRequest
[JSON input data] pIGeneralNotificationResponse: longValue,    //interface address
[JSON result data] peDataLanguage:
peIsConfidential:
peIsXMLLoaded:
peIsReplyDataset:
pbStatus:		 longValue,
longValue,
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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetRequest( LanguageType
YesNoType
YesNoType
YesNoType
VARIANT_BOOL 		*peDataLanguage,
*peIsConfidential,
*peIsXMLLoaded,
*peIsReplyDataset,
*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 The language in which the data part is coded. It is exactly the language in which the notification is formulated.

Note, that the data language and the module language (given by

[out] YesNoType *peIsConfidential A Boolean that defines if the notification thread is confidential.

Note that the confidentiality status is defined at the moment of the initial XML infoset generation, thereafter
it must be inherited into each new reply cycle.
[out] YesNoType *peIsXMLLoaded A Boolean that defines if the data stem from a XML infoset (enYes) or if a new request was generated (enNo) using the IGeneralNotificationRequest interface.

Note, that if eIsXMLLoaded=enYes then a reply can directly be made using the IGeneralNotificationRequest::SetReply method.
[out] YesNoType *peIsReplyDataset A Boolean that defines if the data represents the input (enNo) or the output (enYes). This Boolean basically defines if the singularity in data space is reached meaning if the IGeneralNotificationRequest::SetReply method was called or not.
[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