API browser of CareCreditResponse450 COM module


/images/arrow_right.png ICareCreditResponse::GetPackage method space
Retrieves the identification parameters of the sender's main software.

Since the package information is optionally VARIANT_FALSE is returned if the sender's main software is undefined.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ICareCreditResponse/GetPackage
[JSON input data] pICareCreditResponse: longValue,    //interface address
[JSON result data] pbstrSoftwarePackage:
plSoftwareVersion:
plSoftwareID:
pbstrSoftwareCopyright:
pbStatus:
"utf8StringValue",
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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetPackage( BSTR
long
long
BSTR
VARIANT_BOOL
*pbstrSoftwarePackage,
*plSoftwareVersion,
*plSoftwareID,
*pbstrSoftwareCopyright,
*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] BSTR *pbstrSoftwarePackage Name of the main software .
[out] long *plSoftwareVersion Version of the main software coded as 32-bit value where lSoftwareVersion = 100*Major version + Minor version.
[out] long *plSoftwareID Optional ID of the main software
[out] BSTR *pbstrSoftwareCopyright The copyright notice of the main software.
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then no package data is available
space