and fills out a PDF based form system
 IGeneralFormRequest::SetRequest method |
 |
||
|---|---|---|---|
|
Sets the role and place information, as well as the processing parameters "storno" and "copy".
Note, that whenever the "storno" and/or "copy" parameters are set then the timestamp of the topmost form object reference (SetFormObject) must be defined that is > 0 otherwise an error will result in the IGeneralFormRequestManager::GetXML method. |
|||
| |||
| Restful webservice calling syntax |
|||
| [POST] | /baseURL/IGeneralFormRequest/SetRequest | ||
| [JSON input data] | pIGeneralFormRequest: eRoleType: ePlaceType: bstrRoleTitle: eIsStorno: eIsCopy: |
longValue, //interface address longValue, longValue, "utf8StringValue", longValue, 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 SetRequest( | RoleType
PlaceType BSTR YesNoType YesNoType VARIANT_BOOL |
eRoleType,
ePlaceType, bstrRoleTitle, eIsStorno, eIsCopy, *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] RoleType | eRoleType | Defines the role category that the form producer is best categorized by.
If the form producer has role undefined by the role enumeration then use enRoleOther and additionally supply a role title with a description of the role. |
|
| [in] PlaceType | ePlaceType | Defines the principle place where the form producer is practicing. | |
| [in] BSTR | bstrRoleTitle | Optional role title/description of the form producer.
If a suitable predefined role can not be set then bstrRoleTitle is mandatory (use enRoleOther as role in that case) |
|
| [in] YesNoType | eIsStorno | Boolean value that defines the "storno" status of the form process.
eIsStorno should be false when the initial form infoset is produced. At this step the timestamp is generated and returned in the GeneralFormRequestManager::GetXML method. Whenever eIsStorno is true then the form timestamp must be set otherwise an error will result. |
|
| [in] YesNoType | eIsCopy | Boolean value that defines the "copy" status of the form process.
eIsCopy should be false when the initial XML infoset is produced. At this step the timestamp is generated and returned in the IGeneralFormRequestRequestManager::GetXML method. Whenever eIsCopy is true then the form timestamp must be set otherwise an error will result. |
|
| [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. | |
|
|||