Sumex1.net/generalCreditRequest/C++ API: IGeneralCreditResult::GetPatient method

API browser of generalCreditRequest450 COM module

IGeneralCreditResult::GetPatient method
Retrieves the patient's primary parameters (sex, birthdate, SSN, etc.) as well as the structured address. The structured address data is read via the methods of the returned Iaddress interface instance.

Restful webservice calling syntax
[POST]	/baseURL/IGeneralCreditResult/GetPatient
[JSON input data]	pIGeneralCreditResult:	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 4 distinguished types are possible: the old 11 digit Swiss SSN ("AHV-Nummer") as defined by Federal Social Insurance Office the new 13 digit Swiss SSN ("SV-Nummer") beginning with 756 as defined by Federal Social Insurance Office the new 4-10 digit SSN of Liechtenstein ("AHV-Nummer") as defined by Liechtensteinische AHV-IV-FAK the 13 digit IDNR number of Liechtenstein ("IDNR-Nummer") beginning with 438
[out] IAddress	**pIAddress	The IAddress interface handle that allows to get the structured address data back. 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.