API browser of generalFormRequest450 COM module


/images/arrow_right.png IGeneralFormRequest::SetTreatment method space
Sets the primary treatment input data.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormRequest/SetTreatment
[JSON input data] pIGeneralFormRequest:
bstrStructName:
dDateBegin:
dDateEnd:
eTreatmentCanton:
eTreatmentType:
eTreatmentReason:
longValue,    //interface address
"utf8StringValue",
variantDateValue | "stringISODateValue",
variantDateValue | "stringISODateValue",
longValue,
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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT SetTreatment( BSTR
DATE
DATE
CantonType
TreatmentType
TreatmentReasonType
VARIANT_BOOL
bstrStructName,
dDateBegin,
dDateEnd,
eTreatmentCanton,
eTreatmentType,
eTreatmentReason,
*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 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 dDateBegin dDateBegin is the start of the treatment.
[in] DATE dDateEnd dDateEnd is the end of the treatment.
[in] CantonType eTreatmentCanton The treatment canton given by the CantonType enumeration
[in] TreatmentType eTreatmentType The treatment type given by the TreatmentType enumeration
[in] TreatmentReasonType eTreatmentReason The treatment reason given by the TreatmentReasonType enumeration
[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