The ATL COM module miscValidator provides methods to
browse, search & validate records of varied tariffs
browse, search & validate records of varied tariffs
API browser of miscValidator200 COM module
 ISearch::GetServices method |
 |
||
|---|---|---|---|
|
This method has a Restful Webservice representation only! Method for collecting all service records of the resulting search space in one call without the necessity to call the record positioning methods and the appropriate properties of this interface. The services are returned as JSON array however large that search space might be. So this might be a memory and performance bottleneck. Possibly, one might call the IMiscSearch::GetRecordCount method to get the size of the search space prior to call GetServices unconditionally. |
|||
| |||
| Restful webservice calling syntax |
|||
| [POST] | /baseURL/ISearch/GetServices | ||
| [JSON input data] | pISearch: | longValue, //interface address |
|
| [JSON result array] | { pbstrTariffType: pbstrChapterCode: pbstrCode: pReferenceCode: pbstrName: pbstrInterpretation: pbstrLimitation: pdTP: pdTPMax: pdPercentFactor: plVatRateCode: pdValidFrom: pdValidTo: plServiceProperties: pbStatus: |
"utf8StringValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", doubleValue, doubleValue, doubleValue, longValue, "stringISODateValue", "stringISODateValue", 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. | ||
| |||
| Calling argument description |
|||
| [out] BSTR | *pbstrTariffType | The tariff type (aka tariff number) of the currently focused service | |
| [out] BSTR | *pbstrChapterCode | The chapter code the currently focused service belongs to | |
| [out] BSTR | *pbstrCode | The code of the currently focused service | |
| [out] BSTR | *pReferenceCode | A comma-separated list of reference codes where the selected service is obliged to map to one of the given services. The list might be empty if target service is not known in advanced. If the selected service does not have the enServicePropertyIsNeedsRefCode bit set than the returned value is empty by definition. |
|
| [out] BSTR | *pbstrName | The name of the currently focused service | |
| [out] BSTR | *pbstrInterpretation | The interpretation text of the currently focused service | |
| [out] BSTR | *pbstrLimitation | The limitation text of the currently focused service | |
| [out] double | *pdTP | The tax point (TP) or minimum tax point (TPmin) of the currently focused service | |
| [out] double | *pdTPMax | The maximum tax point (TPmax) of the currently focused service | |
| [out] double | *pdPercentFactor | The percent factor of the currently focused service | |
| [out] long | *plVatRateCode | The applicable vat rate code of the currently focused service | |
| [out] DATE | *pdValidFrom | The validity start date of the currently focused service | |
| [out] DATE | *pdValidTo | The validity end date of the currently focused service | |
| [out] long | *plServiceProperties | The service properties value defines all semantic capabilities of a service.
The value is a 32-bit integer composed from Ored values of the ServicePropertyType enumeration list. Please note, that the explicit value of a certain capability is retrieved with the GetPropertyValue method. |
|
| [out,retval] VARIANT_BOOL | *pbStatus | Boolean return status | |
|
|||