API browser of CareCreditRequest450 COM module


/images/arrow_right.png ICareCreditRequest::SetRequest method space
Sets the primary parameters of the request, namely the "storno" and "copy" status besides an optional remark.
 
Note, that whenever the "storno" and/or "copy" parameters are set then the timestamp of the topmost object reference (SetCreditObject) must be defined as >0 otherwise an error will result in the Finalize method.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ICareCreditRequest/SetRequest
[JSON input data] pICareCreditRequest:
eIsStorno:
eIsCopy:
eOrdinance:
bstrRemark:
longValue,    //interface address
longValue,
longValue,
longValue,
"utf8StringValue"
[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 SetRequest( YesNoType
YesNoType
OrdinanceType
BSTR
VARIANT_BOOL
eIsStorno,
eIsCopy,
eOrdinance,
bstrRemark,
*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] YesNoType eIsStorno Boolean value that defines the "storno" status of the nursing care credit request
 
eIsStorno should be false when the initial request object is produced. At this step the timestamp is generated and returned in the ICareCreditRequestManager::Print and/or ICareCreditRequestManager::GetXML method. Whenever eIsStorno is true then the request timestamp must be set otherwise an error will result.
[in] YesNoType eIsCopy Boolean value that defines the "copy" status of the nursing care credit request
 
eIsCopy should be false when the initial request object is produced. At this step the timestamp is generated and returned in the ICareCreditRequestManager::Print and/or ICareCreditRequestManager::GetXML method. Whenever eIsCopy is true then the request timestamp must be set otherwise an error will result.
[in] OrdinanceType eOrdinance
[in] BSTR bstrRemark An overall optional remark for the nursing care credit request
[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