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
IMiscValidator::SetTariffFilter method | |||
---|---|---|---|
Sets restriction criteria in the sense of that the usage of a certain tariff is possible under the defined criteria. The resulting list of applicable tariffs is returned with the GetFirstTariff/GetNextTariff iterator. The implicit default restriction criteria is "no tariff filter".
Please note that all tariff catalogs without any restriction will be returned in the tariff iterator whatever restriction criteria is set. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IMiscValidator/SetTariffFilter | ||
[JSON input data] | pIMiscValidator: lRoleRestriction: lPlaceRestriction: lLawRestriction: bstrEANRestriction: |
longValue, //interface address longValue, longValue, 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 SetTariffFilter( | long
long long BSTR VARIANT_BOOL |
lRoleRestriction,
lPlaceRestriction, lLawRestriction, bstrEANRestriction, *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] long | lRoleRestriction | Role restriction as a ORed list of roles. If the variable is enRoleUndefined then no role restriction is applied. | |
[in] long | lPlaceRestriction | Place restriction as a ORed list of places. If the variable is enPlaceUndefined then no place restriction is applied. | |
[in] long | lLawRestriction | Law restriction as an ORed list of law numbers. If the variable is 0 than no law restriction is applied.
The law numbers are defined as follows:
|
|
[in] BSTR | bstrEANRestriction | EAN restriction for tariffs of a certain insurance like the S01 tariff applicable only for the SUVA. A comma separated list of EANs can be supplied. If the variable is NULL then no restriction is applied. | |
[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 and value. | |