The ATL COM module tardocValidator provides methods to
browse, search & validate records of the TARDOC tariff
browse, search & validate records of the TARDOC tariff
API browser of tardocValidator100 COM module
| Method to find any services that are descendants of a base service using a recursive-decent approach. | |||
| [POST] | /baseURL/ISearch/FindFirstDescendant | ||
| [JSON input data] | pISearch: bstrCode: eExpandFilter: |
longValue, //interface address "utf8StringValue", longValue |
|
| [JSON result data] | pbstrDescendantCode: pbstrDescendantReference: plLevel: pbStatus: |
"utf8StringValue", "utf8StringValue", longValue, 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. | ||
| HRESULT FindFirstDescendant( | BSTR
YesNoType BSTR BSTR long VARIANT_BOOL |
bstrCode,
eExpandFilter, *pbstrDescendantCode, *pbstrDescendantReference, *plLevel, *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. | ||
| [in] BSTR | bstrCode | The base service code from which to begin the descendant search. | |
| [in] YesNoType | eExpandFilter | Set to `enYes` to exclude services that would already be returned by `IUtility::Expand` (e.g., automatically expandable time-based services such as follow-ups). Set to `enNo` to include all descendants regardless of expandability. |
|
| [out] BSTR | *pbstrDescendantCode | Descendant service code. | |
| [out] BSTR | *pbstrDescendantReference | Immediate parent reference code of the descendant service (note that this may differ from the base service code, since the entire descendant tree is searched). | |
| [out] long | *plLevel | The nesting level of the descendant service code. | |
| [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. |
|