API browser of tarmedValidator100 COM module


/images/arrow_right.png ISearch::FindInclusions method space
This method has a Restful Webservice representation only!
Method for collecting all inclusion services of a base service in one call without the necessity to call iterator pair FindInclusion / FindNextInclusion.
 
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/FindInclusions
[JSON input data] pISearch:
bstrCode:
longValue,    //interface address
"utf8StringValue"
[JSON result array] { pbstrInclusionCode:
pbStatus:
"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.
space
/images/arrow_right.png Calling argument description
[in] BSTR bstrCode Base service code.
 
Patch
The virtual codes "GetLawRestriction" or "GetSexRestriction" can be used to find law or gender dependent inclusion services.
[out] BSTR *pbstrInclusionCode Inclusion service code.
 
PATCH
  • by setting bstrCode="GetLawRestriction", pbstrInclusionCode includes a semicolon separated list of applicable laws. If there is no restriction, an empty string will be returned!!
     
  • by setting bstrCode="GetSexRestriction", pbstrInclusionCode includes a gender code, namely
    • empty string == no sex restriction
    • {0|enMale} == restricted to males only
    • {1|enFemale} == restricted to females only
[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