The ATL COM module migelValidator provides methods to
browse, search & validate records of the MiGeL tariff
browse, search & validate records of the MiGeL tariff
API browser of migelValidator100 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 IMigelSearch::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] | { pbstrCode: pbstrName: pbstrInterpretation: pbstrLimitation: pdTP: pdTPValue: pdValidFrom: pdValidTo: pdQuantity: pbstrUnit: pbstrOldCode: pbStatus: |
"utf8StringValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", doubleValue, doubleValue, "stringISODateValue", "stringISODateValue", doubleValue, "utf8StringValue", "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 | *pbstrCode | The code of the currently focused service | |
| [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) of the currently focused service | |
| [out] double | *pdTPValue | The tax point value (TPV) 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] double | *pdQuantity | The defined quantity of the currently focused service | |
| [out] BSTR | *pbstrUnit | The defined unit of the currently focused service | |
| [out] BSTR | *pbstrOldCode | Obsolete: old MiGel code.
Method patched to return the used tariff 452 or 454! The list of all applied patches can be seen at "List of patches for managing the new tariff 454" |
|
| [out,retval] VARIANT_BOOL | *pbStatus | Boolean return status | |
|
|||