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 generalFormResponse450 COM module
IGeneralFormResponse::GetPatient method | |||
---|---|---|---|
Retrieves the primary parameters and structured address of the patient - these data are mirrored from the request.
The address is defined via an IAddress interface pointer and the address data must be retrieved using the methods of IAddress. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralFormResponse/GetPatient | ||
[JSON input data] | pIGeneralFormResponse: | longValue, //interface address |
|
[JSON result data] | peSexType: pdBirthdate: pbstrSSN: pIAddress: pbStatus: |
longValue, "stringISODateValue", "utf8StringValue", { pbIsPrivateAddress: true, pbstrCompanyName: "utf8StringValue", pbstrDepartment: "utf8StringValue", pbstrSalutation: "utf8StringValue", pbstrTitle: "utf8StringValue", pbstrFamilyname: "utf8StringValue", pbstrGivenname: "utf8StringValue", pbstrSubaddressing: "utf8StringValue", pbstrStreet: "utf8StringValue", pbstrPoBox: "utf8StringValue", pbstrZip: "utf8StringValue", pbstrCity: "utf8StringValue", pbstrStateCode: "utf8StringValue", pbstrCountryCode: "utf8StringValue", pbstrPhone1: "utf8StringValue", pbstrPhone2: "utf8StringValue", pbstrPhone3: "utf8StringValue", pbstrFax: "utf8StringValue", pbstrEMail: "utf8StringValue", pbstrUrl: "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. | ||
C/C++ calling syntax | |||
HRESULT GetPatient( | SexType
DATE BSTR IAddress VARIANT_BOOL |
*peSexType,
*pdBirthdate, *pbstrSSN, **pIAddress, *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 | |||
[out] SexType | *peSexType | The patient's gender. | |
[out] DATE | *pdBirthdate | The patient's birthdate. | |
[out] BSTR | *pbstrSSN | The social security number (SSN) of the patient in its printed form whereupon 3 distinguished types are possible:
|
|
[out] IAddress | **pIAddress | The instance of a IAddress interface that allows to read back the structured address data.
If no address is defined then the handle is NULL. |
|
[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. | |