API browser of generalInvoiceRequest500 COM module


/images/arrow_right.png IGeneralInvoiceResult::GetInsured method space
Retrieves the insured's primary parameters as well as the structured address.
 
The structured address data is read via the methods of the returned IAddress interface instance.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceResult/GetInsured
[JSON input data] pIGeneralInvoiceResult: longValue,    //interface address
[JSON result data] peSexType:
peGenderType:
pdBirthdate:
pbstrSSN:
pbstrInsuredID:
ppIAddress:





















pbStatus:
longValue,
longValue,
"stringISODateValue",
"utf8StringValue",
"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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetInsured( SexType
GenderType
DATE
BSTR
BSTR
IAddress
VARIANT_BOOL
*peSexType,
*peGenderType,
*pdBirthdate,
*pbstrSSN,
*pbstrInsuredID,
**ppIAddress,
*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
[out] SexType *peSexType The insured's medical sex (pre-dominantly induced by the actual hormonal balance of the body) encoded by a terminal set of tokens.
[out] GenderType *peGenderType The insured's social gender encoded by a terminal set of tokens
[out] DATE *pdBirthdate The insured's birthdate.
[out] BSTR *pbstrSSN The insured's social security number (SSN) in its printed form whereupon 3 distinguished types are possible:
[out] BSTR *pbstrInsuredID The insured's insurance, whereas in most cases it is the 20-digits official card ID or if this one is unknown/unavailable then the old proprietary 7-digits insurance ID is given
[out] IAddress **ppIAddress The instance of an 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.
space