The ATL COM module careCreditRequest is capable of
generating electronic & printed nursing care credit requests
generating electronic & printed nursing care credit requests
API browser of CareCreditRequest450 COM module
ICareCreditResult::GetRequest method | |||
---|---|---|---|
Returns the primary parameters of the request, namely the language the data is supplied, the "storno" and "copy" status besides an optional remark. | |||
Restful webservice calling syntax | |||
[POST] | /baseURL/ICareCreditResult/GetRequest | ||
[JSON input data] | pICareCreditResult: | longValue, //interface address |
|
[JSON result data] | peDataLanguage: peIsStorno: peIsCopy: peOrdinance: pbstrRemark: pbStatus: |
longValue, longValue, longValue, longValue, "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 GetRequest( | LanguageType
YesNoType YesNoType OrdinanceType BSTR VARIANT_BOOL |
*peDataLanguage,
*peIsStorno, *peIsCopy, *peOrdinance, *pbstrRemark, *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] LanguageType | *peDataLanguage | Gets the language in which the data part is coded. It is exactly the language in which the request is formulated.
Note, that the data language and the module language (given by ICareCreditRequestManager::SetModuleLanguage) are independent and can be different! |
|
[out] YesNoType | *peIsStorno | 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. |
|
[out] YesNoType | *peIsCopy | 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. |
|
[out] OrdinanceType | *peOrdinance | ||
[out] BSTR | *pbstrRemark | 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. | |