API browser of generalFormRequest450 COM module


/images/arrow_right.png IGeneralFormRequest::AddAllergy method space
Adds an allergy structure to the list of allergies.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormRequest/AddAllergy
[JSON input data] pIGeneralFormRequest:
bstrStructName:
eAllergyType:
bstrCode:
bstrName:
dDate:
eSeverityLevel:
longValue,    //interface address
"utf8StringValue",
longValue,
"utf8StringValue",
"utf8StringValue",
variantDateValue | "stringISODateValue",
longValue
[JSON result data] pbStatus: 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 AddAllergy( BSTR
AllergyType
BSTR
BSTR
DATE
SeverityLevelType
VARIANT_BOOL
bstrStructName,
eAllergyType,
bstrCode,
bstrName,
dDate,
eSeverityLevel,
*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
[in] BSTR bstrStructName The variable name/placeholder of the structure.

Use the iterator pair GetFirstStructRole / GetNextStructRole to retrieve the variable name, the semantical typification and the status (defined or undefined) of all structures defined by the currently load PDF form.

[in] AllergyType eAllergyType The type of the allergy defined by the AllergyType enumerator
[in] BSTR bstrCode The code of the allergy as given in the corresponding allergy catalog.

Leave empty if no coding system is used.

[in] BSTR bstrName Textual description of the allergy as given in the corresponding allergy catalog.

Supply a free text description of the allergy if no coding system is used.

[in] DATE dDate The date the allergy was first diagnosed
[in] SeverityLevelType eSeverityLevel 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 then an error occurred and GetAbortInfo should be called to retrieve the error string.
space