The generalFormRequest ATL COM module manages
and fills out a PDF based form system
API browser of generalFormResponse450 COM module


/images/arrow_right.png IGeneralFormResponse::GetResponse method space
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:

GetAcceptType Per definition this means that the corresponding request is fully accepted and will be processed to a final stage. An optional explanation might be supplied but no messages.
GetPendingType Per definition this means that the corresponding request can not be processed to a final stage as some data are missing. An optional explanation and [0,n] messages (instructions) are supplied to "unfreeze" the request.
GetRejectType Per definition this means that the corresponding request is rejected and as a consequence the status of the request goes to the "canceled" state. An optional explanation and [0,n] errors are supplied to justify the decision.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormResponse/GetResponse
[JSON input data] pIGeneralFormResponse: longValue,    //interface address
[JSON result data] peDataLanguage:
peIsStorno:
peIsCopy:
peResponseType:
peModusType:
pbStatus:		 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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetResponse( LanguageType
YesNoType
YesNoType
ResponseType
ModusType
VARIANT_BOOL 		*peDataLanguage,
*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.
space
/images/arrow_right.png 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 IGeneralFormResponseManager::SetModuleLanguage) are independent and can be different!
[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.
space