The acfValidator provides methods to browse, search,
validate & group records of the ACF and/or LKAAT tariff
validate & group records of the ACF and/or LKAAT tariff
API browser of acfValidator100 COM module
 ISearchTMA::GetOptServicesTree method |
 |
||
|---|---|---|---|
|
This method has a Restful Webservice representation only! Method for collecting all optional services in one call without the necessity to call the iterator pair ISearchTMA::GetFirstOptServiceTree / ISearchTMA::GetNextOptServiceTree. The service records are returned as JSON array however large that array size might be. So this might be a memory and performance bottleneck. |
|||
| |||
| Restful webservice calling syntax |
|||
| [POST] | /baseURL/ISearchTMA/GetOptServicesTree | ||
| [JSON input data] | pISearchTMA: | longValue, //interface address |
|
| [JSON result array] | { pbstrDecisionID: pbstrDecisionYesID: peDecisionYesIsACF: pbstrDecisionNoID: peDecisionNoIsACF: pbstrCode: pbstrName: pdMinQuantity: peMinSide: pbstrChoiceSet: pbStatus: |
"utf8StringValue", "utf8StringValue", longValue, "utf8StringValue", longValue, "utf8StringValue", "utf8StringValue", doubleValue, longValue, "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. | ||
| |||
| Calling argument description |
|||
| [out] BSTR | *pbstrDecisionID | This is a fictional ID of a decision node representing one optional TMA service with requested quantity and side dependency. The supplied bstrChoiceSet is a fictional choice set name, collecting a set of TMA services. At least one element of the set must be selected to qualify for the YES path.
If there are more than 1 distinct choice set names on a certain decision node, than these sets are AND connected, meaning that at least one element of each set must be selected to qualify for the YES path. |
|
| [out] BSTR | *pbstrDecisionYesID | This is the fictional ID of the next decision node, if the YES path is selected.
If the Boolean variable eDecisionYesIsACF=enYes than bstrDecisionYesID represents a terminal ACF service code. If eDecisionYesIsACF=enNo you have to go to this fictional ID and start there with a decision process. |
|
| [out] YesNoType | *peDecisionYesIsACF | A Boolean variable defining the bstrDecisionYesID ID as terminal ACF service (=enYes) or as another fictional node ID (=enNo). | |
| [out] BSTR | *pbstrDecisionNoID | This is the fictional ID of the next decision node, if the NO path is selected.
If the Boolean variable eDecisionNoIsACF=enYes than bstrDecisionNoID represents a terminal ACF service code. If eDecisionNoIsACF=enNo you have to go to this fictional ID and start there with a decision process. |
|
| [out] YesNoType | *peDecisionNoIsACF | A Boolean variable defining the bstrDecisionNoID ID as terminal ACF service (=enYes) or as another fictional node ID (=enNo). | |
| [out] BSTR | *pbstrCode | The code of a TMA service in the set of services with the same bstrChoiceSet | |
| [out] BSTR | *pbstrName | The name of a TMA service in the set of services with the same bstrChoiceSet | |
| [out] double | *pdMinQuantity | This is the minimal quantity of the given TMA code to qualify for fulfilled service | |
| [out] SideType | *peMinSide | This is the minimal side dependency of the given TMA code to qualify for fulfilled service | |
| [out] BSTR | *pbstrChoiceSet | The supplied bstrChoiceSet is a fictional choice set name, collecting a set of TMA services. At least one element of the set must be selected to qualify for the YES path. | |
| [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. |
|
|
|||