The careCreditResponse ATL COM module loads &
analyzes electronic responses to care credit requests
analyzes electronic responses to care credit requests
API browser of CareCreditResponse450 COM module
ICareCreditResponse::GetResponse method | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Returns the primary parameters of the response infoset, namely the operation modus, the language the infoset is formulated, and most important the type of the response.
Based on the response type one of the following methods should be called:
|
||||||||||||
Restful webservice calling syntax | ||||||||||||
[POST] | /baseURL/ICareCreditResponse/GetResponse | |||||||||||
[JSON input data] | pICareCreditResponse: | longValue, //interface address |
||||||||||
[JSON result data] | peDataLanguage: plResponseTimestamp: peIsStorno: peIsCopy: peResponseType: peModusType: pbStatus: |
longValue, longValue, longValue, 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. | |||||||||||
C/C++ calling syntax | ||||||||||||
HRESULT GetResponse( | LanguageType
long YesNoType YesNoType ResponseType ModusType VARIANT_BOOL |
*peDataLanguage,
*plResponseTimestamp, *peIsStorno, *peIsCopy, *peResponseType, *peModusType, *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 | The language in which the response is formulated.
Note, that the data language and the module language (given by IGeneralInvoiceResponseManager::SetModuleLanguage) are independent and can be different! |
||||||||||
[out] long | *plResponseTimestamp | This is a UNIX timestamp defined at the moment of the care credit's infoset generation. | ||||||||||
[out] YesNoType | *peIsStorno | Boolean value that defines the "storno" status of the sent request.
Note that this is the initial value of the request mirrored in the response |
||||||||||
[out] YesNoType | *peIsCopy | Boolean value that defines the "copy" status of the sent request.
Note that this is the initial value of the request mirrored in the response |
||||||||||
[out] ResponseType | *peResponseType | The main response type. | ||||||||||
[out] ModusType | *peModusType | The operation modus.
The default modus is enProduction whereas for developing/debugging purposes enTest has to be set. |
||||||||||
[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. | ||||||||||