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::GetTariffRestriction method | |||
---|---|---|---|
Gets extended tariff information of possible usage restrictions of the tariff | |||
Restful webservice calling syntax | |||
[POST] | /baseURL/IMiscValidator/GetTariffRestriction | ||
[JSON input data] | pIMiscValidator: bstrTariffType: |
longValue, //interface address "utf8StringValue" |
|
[JSON result data] | plRoleRestriction: plPlaceRestriction: plLawRestriction: pbstrEANRestriction: pbStatus: |
longValue, longValue, longValue, "utf8StringValue", 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 GetTariffRestriction( | BSTR
long long long BSTR VARIANT_BOOL |
bstrTariffType,
*plRoleRestriction, *plPlaceRestriction, *plLawRestriction, *pbstrEANRestriction, *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 number for which the restriction information should be retrieved. | |
[out] long | *plRoleRestriction | If set the tariff usage is restricted to the ORed list the role enumeration | |
[out] long | *plPlaceRestriction | If set the tariff usage is restricted to the ORed list the place enumeration | |
[out] long | *plLawRestriction | If set the tariff usage is restricted to the ORed list law numbers..
The law numbers are defined as follows:
|
|
[out] BSTR | *pbstrEANRestriction | If set the tariff usage is restricted to the supplied list of comma separated EANs | |
[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. | |