API browser of pushAdminMessage450 COM module


/images/arrow_right.png IPushAdminMessageRequest::SetDebitor method space
Sets the debitor's GLN and the structured address.
 
The structured address is defined via a Iaddress interface instance and the address data must be defined prior to call this method.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IPushAdminMessageRequest/SetDebitor
[JSON input data] pIPushAdminMessageRequest:
bstrEAN:
pIAddress:
longValue,    //interface address
"utf8StringValue",
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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT SetDebitor( BSTR
IAddress
VARIANT_BOOL
bstrEAN,
*pIAddress,
*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
[in] BSTR bstrEAN The GLN (former EAN) number of the debitor as supplied by Stiftung Refdata
 
Note, that the debitor's EAN is a required parameter. However, debitors in Tiers Garant might not possess such an EAN. Therefore do supply a EAN from the private EAN space (e.g. 2000000000008) in such a case.
[in] IAddress *pIAddress The instance of a IAddress interface that holds the structured address parts.

A NULL pointer is supplied if no address should 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.
space