The ATL COM module tarmedValidator provides methods to
browse, search & validate records of the Tarmed tariff
API browser of tarmedValidator100 COM module


/images/arrow_right.png ISearch::FindInclusion method space
This method finds the first inclusion service for a base service.
 
PATCH
Due to the fact that certain services are for specific laws and/or gender the ISearch::FindInclusion method is patched to allow for a filtering of law and/or gender information in the aforementioned services. The patch is applied by using one of the specific code {"GetLawRestriction", "GetSexRestriction"}.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ISearch/FindInclusion
[JSON input data] pISearch:
bstrCode:		 longValue,    //interface address
"utf8StringValue"
[JSON result data] 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 C/C++ calling syntax
HRESULT FindInclusion( BSTR
BSTR
VARIANT_BOOL 		bstrCode,
*pbstrInclusionCode,
*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.
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