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
 IGeneralFormResult::GetVaccinations method |
 |
||
|---|---|---|---|
|
This method has a Restful Webservice representation only! Method for collecting all vaccinations covered by the IGeneralFormResult interface and returned as JSON array. Please note that IGeneralCreditResult::GetVaccinations takes over the functionality of the iterator pair IGeneralCreditResult::GetFirstVaccination / IGeneralCreditResult::GetNextVaccination with a single call, making the latter superfluous. |
|||
| |||
| Restful webservice calling syntax |
|||
| [POST] | /baseURL/IGeneralFormResult/GetVaccinations | ||
| [JSON input data] | pIGeneralFormResult: | longValue, //interface address |
|
| [JSON result array] | { pbstrStructName: peDrugCodeType: pbstrCode: pbstrName: pdDate: pbstrLOTNumber: pbstrRemark: pbStatus: |
"utf8StringValue", longValue, "utf8StringValue", "utf8StringValue", "stringISODateValue", "utf8StringValue", "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. | ||
| |||
| Calling argument description |
|||
| [out] BSTR | *pbstrStructName | The PDF internal variable name/placeholder onto which the structure was mapped. | |
| [out] DrugCodeType | *peDrugCodeType | The type of the drug catalog defined by the DrugCodeType enumerator. | |
| [out] BSTR | *pbstrCode | The code of the applied vaccine as given in the corresponding drug catalog defined by eDrugCodeType. | |
| [out] BSTR | *pbstrName | Textual description of the applied vaccine as given in the corresponding drug catalog defined by eDrugCodeType. | |
| [out] DATE | *pdDate | The date the vaccination was applied | |
| [out] BSTR | *pbstrLOTNumber | The LOT number of the vaccine | |
| [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 | |
|
|||