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 generalFormRequest450 COM module
IGeneralFormRequest::AddUnemployability method | |||
---|---|---|---|
Adds an unemployability structure to the list of unemployabilities. | |||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralFormRequest/AddUnemployability | ||
[JSON input data] | pIGeneralFormRequest: bstrStructName: dDate: dBeginDate: dEndDate: lPercentage: bstrRemark: |
longValue, //interface address "utf8StringValue", variantDateValue | "stringISODateValue", variantDateValue | "stringISODateValue", variantDateValue | "stringISODateValue", longValue, "utf8StringValue" |
|
[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 AddUnemployability( | BSTR
DATE DATE DATE long BSTR VARIANT_BOOL |
bstrStructName,
dDate, dBeginDate, dEndDate, lPercentage, bstrRemark, *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] BSTR | bstrStructName | The variable name/placeholder of the structure.
Use the iterator pair GetFirstStructRole / GetNextStructRole to retrieve the variable name, the semantical typification and the status (defined or undefined) of all structures defined by the currently load PDF form. |
|
[in] DATE | dDate | The date when the unemployability record was created | |
[in] DATE | dBeginDate | The date when the unemployability starts | |
[in] DATE | dEndDate | The date when the unemployability ends. | |
[in] long | lPercentage | The percentage of the unemployability supplied as a integer value in the interval [0,100]. | |
[in] BSTR | bstrRemark | An optional remark | |
[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. | |