The ATL COM module miscValidator provides methods to
browse, search & validate records of varied tariffs
browse, search & validate records of varied tariffs
API browser of miscValidator200 COM module
IValidate::Finalize method | |||
---|---|---|---|
Validate all services of the given tariff type by running the "late binding" rules and than finalizes all records added so far and finally calculates the total amount in CHF over all service amounts of the given tariff type. This method is the counterpart to the Initialize method.
Note, this method should be called after all data have been set in the IValidate:AddService method. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IValidate/Finalize | ||
[JSON input data] | pIValidate: bstrTariffType: |
longValue, //interface address "utf8StringValue" |
|
[JSON result data] | pdTotalAmount: pbStatus: |
doubleValue, 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 Finalize( | BSTR
double VARIANT_BOOL |
bstrTariffType,
*pdTotalAmount, *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 | bstrTariffType | The tariff type for which the total amount should be to calculated.
If bstrTariffType is NULL then the total amount over all tariff types is calculated. |
|
[out] double | *pdTotalAmount | The total amount in CHF over all service amounts of the given tariff type. | |
[out,retval] VARIANT_BOOL | *pbStatus | Return status. VARIANT_TRUE means S_OK, VARIANT_FALSE means S_FALSE (e.g. in an iterator) or an error (E_name). In the later case check for possible errors with the GetAbortInfo method. |
|