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
IChapter::SearchName method | |||
---|---|---|---|
This method searches for chapters by name | |||
Restful webservice calling syntax | |||
[POST] | /baseURL/IChapter/SearchName | ||
[JSON input data] | pIChapter: bstrTariffType: dDate: bstrName: |
longValue, //interface address "utf8StringValue", variantDateValue | "stringISODateValue", "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 SearchName( | BSTR
DATE BSTR VARIANT_BOOL |
bstrTariffType,
dDate, bstrName, *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 to use in the query | |
[in] DATE | dDate | The date to use for the query. Valid (and returned) records must have a validity date range that does include the given date! Supply a DATE <= 0 to turn off the date range check! |
|
[in] BSTR | bstrName | Query string that is used for searching in the chapter name portion of the tariff catalog (cf. properties WildCard and WildCharacter for using wildcards) | |
[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. | |