The generalCreditRequest ATL COM module for
generating electronic and paper based credit requests
generating electronic and paper based credit requests
API browser of generalCreditRequest450 COM module
IGeneralCreditRequest::SetCreditObject method | |||
---|---|---|---|
Sets 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". |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralCreditRequest/SetCreditObject | ||
[JSON input data] | pIGeneralCreditRequest: eCreditType: bstrRequestCreditID: dRequestCreditDate: lRequestCreditTimestamp: |
longValue, //interface address longValue, "utf8StringValue", variantDateValue | "stringISODateValue", longValue |
|
[JSON result data] | pbStatus: | 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 SetCreditObject( | CreditType
BSTR DATE long VARIANT_BOOL |
eCreditType,
bstrRequestCreditID, dRequestCreditDate, lRequestCreditTimestamp, *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 | |||
[in] CreditType | eCreditType | The type of credit request to set from the CreditType enumeration list | |
[in] BSTR | bstrRequestCreditID | 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. |
|
[in] DATE | dRequestCreditDate | 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. |
|
[in] long | lRequestCreditTimestamp | This is a UNIX timestamp defined at the moment of the general credit infoset generation.
Set this variable 0 to indicate the generation of a new general credit object reference. The IGeneralCreditRequestManager::GetXML and/or IGeneralCreditRequestManager::Print method will return the timestamp that must be used from that point on as 3rd parameter of the object reference.
This is one of 3 identifiers that form the general credit object reference. The timestamp will be generated once for a certain general credit object reference and thereafter the timestamp is always referenced. |
|
[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. | |