API browser of generalFormRequest450 COM module


/images/arrow_right.png IGeneralFormResult::GetFirstDiagnosis method space
Retrieves the first diagnosis.

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

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormResult/GetFirstDiagnosis
[JSON input data] pIGeneralFormResult: longValue,    //interface address
[JSON result data] pbstrStructName:
peDiagnosisCodeType:
pbstrCode:
pbstrName:
pdDate:
peIsActive:
pbstrRemark:
pbStatus:
"utf8StringValue",
longValue,
"utf8StringValue",
"utf8StringValue",
"stringISODateValue",
longValue,
"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 GetFirstDiagnosis( BSTR
DiagnosisCodeType
BSTR
BSTR
DATE
YesNoType
BSTR
VARIANT_BOOL
*pbstrStructName,
*peDiagnosisCodeType,
*pbstrCode,
*pbstrName,
*pdDate,
*peIsActive,
*pbstrRemark,
*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] DiagnosisCodeType *peDiagnosisCodeType The type of the diagnosis defined by the DiagnosisCodeType enumerator.
[out] BSTR *pbstrCode The code of the diagnosis as given in the corresponding diagnosis catalog defined by eDiagnosisCodeType .
[out] BSTR *pbstrName Textual description of the code as given in the corresponding diagnosis catalog defined by eDiagnosisCodeType .
[out] DATE *pdDate The date the diagnosis was defined
[out] YesNoType *peIsActive A Boolean designating if the diagnosis is active (enYes) or not (enNo).
[out] BSTR *pbstrRemark An optional remark
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached
space