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::GetFirstTariff method | |||
---|---|---|---|
Retrieves the information for the first tariff catalog covered by the applied tariff filter | |||
Restful webservice calling syntax | |||
[POST] | /baseURL/IMiscValidator/GetFirstTariff | ||
[JSON input data] | pIMiscValidator: | longValue, //interface address |
|
[JSON result data] | pbstrTariffType: pbstrName: pbstrVersion: pdValidFrom: pdValidTo: pbStatus: |
"utf8StringValue", "utf8StringValue", "utf8StringValue", "stringISODateValue", "stringISODateValue", 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 GetFirstTariff( | BSTR
BSTR BSTR DATE DATE VARIANT_BOOL |
*pbstrTariffType,
*pbstrName, *pbstrVersion, *pdValidFrom, *pdValidTo, *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 | |||
[out] BSTR | *pbstrTariffType | The number (e.g. 311, S01,...) of the tariff catalog | |
[out] BSTR | *pbstrName | The name of the tariff catalog | |
[out] BSTR | *pbstrVersion | The version of the tariff catalog | |
[out] DATE | *pdValidFrom | The end date of validity of the tariff catalog | |
[out] DATE | *pdValidTo | The start date of validity of the tariff catalog | |
[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. |
|