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
 IValidate::GetService method |
 |
||
|---|---|---|---|
|
This method has a Restful Webservice representation only! Method for collecting all data of the currently focused service in one call without the necessity to call the appropriate properties of this interface. The counterpart method to add services is IMigelValidator::AddService |
|||
| |||
| Restful webservice calling syntax |
|||
| [POST] | /baseURL/IValidate/GetService | ||
| [JSON input data] | pIValidate: | longValue, //interface address |
|
| [JSON result data] | plID: pbstrCode: pbstrName: pdQuantity: pdTP: pdTPValue: pdDate: peIgnoreValidate: plHook: pdExternalFactor: peCantonType: peLawType: peSettlementType: peRoleType: pdCharge: pbStatus: |
longValue, "utf8StringValue", "utf8StringValue", doubleValue, doubleValue, doubleValue, "stringISODateValue", longValue, longValue, doubleValue, longValue, longValue, longValue, longValue, doubleValue, 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] long | *plID | The internal ID of the currently focused service | |
| [out] BSTR | *pbstrCode | The code of the currently focused service | |
| [out] BSTR | *pbstrName | The name of the currently focused service | |
| [out] double | *pdQuantity | The quantity 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 | *pdDate | The application date of the currently focused service | |
| [out] YesNoType | *peIgnoreValidate | The flag indicating whether the currently focused service was ignored in validation (enNo) or not (enYes). | |
| [out] long | *plHook | The hook of the currently focused service | |
| [out] double | *pdExternalFactor | The external scaling factor applied to the currently focused service | |
| [out] CantonType | *peCantonType | The canton type applied to the currently focused service
This canton setting is copied from the data supplied with the IMigelValidator::SetTreatment method. |
|
| [out] LawType | *peLawType | The law type applied to the currently focused service
This law setting is copied from the data supplied with the IMigelValidator::SetTreatment method. |
|
| [out] SettlementType | *peSettlementType | The settlement type applied to the currently focused service
This settlement setting is copied from the data supplied with the IMigelValidator::SetTreatment method. |
|
| [out] RoleType | *peRoleType | The role type applied to the currently focused service
This role setting is copied from the data supplied with the IMigelValidator::SetRoleType property. |
|
| [out] double | *pdCharge | The charge in CHF of the currently focused service calculated as ( Charge = Quantity * TP * TPValue * ExternalFactor ) | |
| [out,retval] VARIANT_BOOL | *pbStatus | Boolean return status | |
|
|||