API browser of CareCreditRequest450 COM module


/images/arrow_right.png ICareCreditRequest::SetHomeCare method space
Sets the primary parameters for a "Home Care" nursing case situation, that is the ordinary home caring situation supplied by a home care organization ("Spitex")
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ICareCreditRequest/SetHomeCare
[JSON input data] pICareCreditRequest:
bstrPlanningCatalog:
eStayDaycareCenter:
lDomesticAidDaysPerWeek:
lDomesticAidHoursPerDay:
eMiGelSelfapplication:
longValue,    //interface address
"utf8StringValue",
longValue,
longValue,
longValue,
longValue
[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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT SetHomeCare( BSTR
YesNoType
long
long
YesNoType
VARIANT_BOOL
bstrPlanningCatalog,
eStayDaycareCenter,
lDomesticAidDaysPerWeek,
lDomesticAidHoursPerDay,
eMiGelSelfapplication,
*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
[in] BSTR bstrPlanningCatalog Defines the official name of the used planning catalog.
 
Note, that the name should consist of a slash-separated planning catalog name and edition e.g. "RAI-NC/2018" or "BESA/2018". Thus the given name should allow for an unambiguous identification of the catalog.
[in] YesNoType eStayDaycareCenter The Boolean eStayDaycareCenter indicates whether a patient is staying in a day-care center during daytime (enYes) or not (enNo)
[in] long lDomesticAidDaysPerWeek The variables lDomesticAidDaysPerWeek and lDomesticAidHoursPerDay define the frequency and magnitude of work provided by a domestic aid. lDomesticAidDaysPerWeek in special defines the number of days, that the domestic aid is working per week.
 
Note, that a value of 0 means, that the patient has no domestic aid per se.
[in] long lDomesticAidHoursPerDay The variables lDomesticAidDaysPerWeek and lDomesticAidHoursPerDay define the frequency and magnitude of work provided by a domestic aid. lDomesticAidHoursPerDay in special defines the number of hours, that the domestic aid is working per day.
 
Note, that a value of 0 means, that the patient has no domestic aid per se.
[in] YesNoType eMiGelSelfapplication The Boolean eMiGelSelfapplication indicates whether the patient receives MiGel care products for self-application from the nursing care organization (enYes) or not (enNo)
[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