API browser of tarmedValidator100 COM module


/images/arrow_right.png ISearch::FindDescendants method space
This method has a Restful Webservice representation only!
Method for collecting all services that are descendants of a base service in one call without the necessity to call iterator pair FindDescendant / FindNextDescendant.
 
The services are returned as JSON array however large that search space might be. So this might be a memory and performance bottleneck.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ISearch/FindDescendants
[JSON input data] pISearch:
bstrCode:
longValue,    //interface address
"utf8StringValue"
[JSON result array] { 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.
space
/images/arrow_right.png Calling argument description
[in] BSTR bstrCode Base service code.
 
PATCH: bstrCode can be appended with the instruction "#no123TypeServices" to restrict the search space to services that are not 123 aka "First-Next-Last" type services.
[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.
space