The generalFormRequest ATL COM module manages
and fills out a PDF based form system
and fills out a PDF based form system
API browser of generalFormRequest450 COM module
IGeneralFormRequest::AddVaccination method | |||
---|---|---|---|
Adds a vaccination structure to the list of vaccinations. | |||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralFormRequest/AddVaccination | ||
[JSON input data] | pIGeneralFormRequest: bstrStructName: eDrugCodeType: bstrCode: bstrName: dDate: bstrLOTNumber: bstrRemark: |
longValue, //interface address "utf8StringValue", longValue, "utf8StringValue", "utf8StringValue", variantDateValue | "stringISODateValue", "utf8StringValue", "utf8StringValue" |
|
[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. | ||
C/C++ calling syntax | |||
HRESULT AddVaccination( | BSTR
DrugCodeType BSTR BSTR DATE BSTR BSTR VARIANT_BOOL |
bstrStructName,
eDrugCodeType, bstrCode, bstrName, dDate, bstrLOTNumber, bstrRemark, *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. | ||
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] DrugCodeType | eDrugCodeType | The type of the drug catalog defined by the DrugCodeType enumerator. | |
[in] BSTR | bstrCode | The code of the applied vaccine as given in the corresponding drug catalog defined by eDrugCodeType. | |
[in] BSTR | bstrName | Textual description of the applied vaccine as given in the corresponding drug catalog defined by eDrugCodeType. | |
[in] DATE | dDate | The date the vaccination was applied | |
[in] BSTR | bstrLOTNumber | The LOT number of the vaccine | |
[in] BSTR | bstrRemark | An optional remark | |
[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. | |