API browser of generalFormRequest450 COM module


/images/arrow_right.png IGeneralFormResult::GetFirstAllergy method space
Retrieves the first allergy.

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

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormResult/GetFirstAllergy
[JSON input data] pIGeneralFormResult: longValue,    //interface address
[JSON result data] pbstrStructName:
peAllergyType:
pbstrCode:
pbstrName:
pdDate:
peSeverityLevel:
pbStatus:
"utf8StringValue",
longValue,
"utf8StringValue",
"utf8StringValue",
"stringISODateValue",
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 GetFirstAllergy( BSTR
AllergyType
BSTR
BSTR
DATE
SeverityLevelType
VARIANT_BOOL
*pbstrStructName,
*peAllergyType,
*pbstrCode,
*pbstrName,
*pdDate,
*peSeverityLevel,
*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 *pbstrStructName The PDF internal variable name/placeholder onto which the structure was mapped.
[out] AllergyType *peAllergyType The type of the allergy defined by the AllergyType enumerator
[out] BSTR *pbstrCode The code of the allergy as given in the corresponding allergy catalog.

bstrCode is empty if no coding system was used.

[out] BSTR *pbstrName Textual description of the allergy as given in the corresponding allergy catalog or a free text if no coding system was used.
[out] DATE *pdDate The date the allergy was first diagnosed
[out] SeverityLevelType *peSeverityLevel The severity level of the allergy defined by the SeverityLevel enumerator
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached
space