The generalCreditRequest ATL COM module for
generating electronic and paper based credit requests
API browser of generalCreditRequest450 COM module


/images/arrow_right.png IGeneralCreditResult::GetCreditObject method space
Retrieves the general credit object reference parameters.
 
The creditRef (if supplied) and credit object references form a object reference chain (creditRef -> credit) with the credit as topmost object reference. The page "object reference" provides an in-depth description of the concepts of "object reference", "object reference chain", and "topmost object reference".
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralCreditResult/GetCreditObject
[JSON input data] pIGeneralCreditResult: longValue,    //interface address
[JSON result data] peCreditType:
pbstrRequestCreditID:
pdRequestCreditDate:
plRequestCreditTimestamp:
pbStatus:		 longValue,
"utf8StringValue",
"stringISODateValue",
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 GetCreditObject( CreditType
BSTR
DATE
long
VARIANT_BOOL 		*peCreditType,
*pbstrRequestCreditID,
*pdRequestCreditDate,
*plRequestCreditTimestamp,
*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] CreditType *peCreditType The type of credit request defined from the CreditType enumeration list
[out] BSTR *pbstrRequestCreditID The request credit ID is the main software's identification of the general credit ("Kostengutsprachenummer").
 
This is one of 3 identifiers that form the general credit object reference.
[out] DATE *pdRequestCreditDate The request credit date is the main software's date of the general credit ("Kostengutsprachedatum")
 
This is one of 3 identifiers that form the general credit object reference.
[out] long *plRequestCreditTimestamp This is a UNIX timestamp defined at the moment of the general credit infoset generation.
 
This is one of 3 identifiers that form the general credit object reference.
[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