The generalFormRequest ATL COM module manages
and fills out a PDF based form system
and fills out a PDF based form system
API browser of generalFormResponse450 COM module
IGeneralFormResponse::GetConsumer method | |||
---|---|---|---|
Gets the consumer's EAN of the original form request.
Note that this is only a safety measure for a crosscheck. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralFormResponse/GetConsumer | ||
[JSON input data] | pIGeneralFormResponse: | longValue, //interface address |
|
[JSON result data] | pbstrEAN: pbStatus: |
"utf8StringValue", 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 GetConsumer( | BSTR
VARIANT_BOOL |
*pbstrEAN,
*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] BSTR | *pbstrEAN | The EAN number of the consumer of the initial request as supplied by Stiftung Refdata | |
[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. | |