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
 IChapter::GetChapters method |
 |
||
|---|---|---|---|
|
This method has a Restful Webservice representation only! Method for collecting all chapter data 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 chapters 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 IMiscChapter::GetRecordCount method to get the size of the search space prior to call GetChapters unconditionally. |
|||
| |||
| Restful webservice calling syntax |
|||
| [POST] | /baseURL/IChapter/GetChapters | ||
| [JSON input data] | pIChapter: | longValue, //interface address |
|
| [JSON result array] | { pbstrTariffType: pbstrParentCode: pbstrCode: pbstrName: pbstrInterpretation: pdValidFrom: pdValidTo: pbStatus: |
"utf8StringValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", "stringISODateValue", "stringISODateValue", 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 chapter | |
| [out] BSTR | *pbstrParentCode | The parent chapter code of the currently focused chapter. If there is no parent chapter then an empty variable is supplied |
|
| [out] BSTR | *pbstrCode | The chapter code of the currently focused chapter | |
| [out] BSTR | *pbstrName | The name of the currently focused chapter | |
| [out] BSTR | *pbstrInterpretation | The interpretation text of the currently focused chapter | |
| [out] DATE | *pdValidFrom | The validity start date of the currently focused chapter | |
| [out] DATE | *pdValidTo | The validity end date of the currently focused chapter | |
| [out,retval] VARIANT_BOOL | *pbStatus | Boolean return status | |
|
|||