API browser of CareCreditResponse450 COM module


/images/arrow_right.png ICareCreditResponse::GetPendingType method space
Retrieves detailed information for a response of type Pending. Call this method if the GetResponse method returns the type enResponsePending.

Calling the iterator pair GetFirstNotification / GetNextNotification is only necessary if eHasMessage=enYes.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ICareCreditResponse/GetPendingType
[JSON input data] pICareCreditResponse: longValue,    //interface address
[JSON result data] pbstrExplanation:
peStatusIn:
peStatusOut:
peHasMessage:
pbStatus:
"utf8StringValue",
longValue,
longValue,
longValue,
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 GetPendingType( BSTR
StatusType
StatusType
YesNoType
VARIANT_BOOL
*pbstrExplanation,
*peStatusIn,
*peStatusOut,
*peHasMessage,
*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 *pbstrExplanation An optional explanation.
The explanation is formulated in the data language returned by the GetResponse method
[out] StatusType *peStatusIn The status of the invoice/reminder request (given by the topmost object reference) before this response was generated
[out] StatusType *peStatusOut The status of the invoice/reminder request (given by the topmost object reference) after this response was generated
[out] YesNoType *peHasMessage A Boolean that defines if messages are available in which case the iterator pair GetFirstNotification / GetNextNotification should be called.
[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