update_operating
To start or stop a retranslator or retransmission for a past period, use the method retranslator/update_operating:
svc=retranslator/update_operating¶ms={"itemId":<long>,
"operate":<bool>,
"stopTime":<uint>,
"timeFrom":<uint>,
"timeTo":<uint>,
"callMode":<text>
}
Parameters
The request can contain the following parameters. The required parameters are marked with an asterisk (*).
| Name | Description |
|---|---|
| itemId* | Retranslator ID. |
| operate* | Start or stop retransmission: use true to start and false to stop. 1 and 0 are also accepted. |
| callMode | Set callMode to switch to start or stop the retranslator. Set callMode to history to start or stop the retransmission for a past period. If not set, the default value is switch. |
| stopTime | Time, when retransmission will be stopped automatically. The parameter can be used only when callMode=switch and operate=true. Optional parameter. |
| timeFrom | Beginning of history retransmission, Unix time. Required only when callMode=history and operate=true. |
| timeTo | End of history retransmission, Unix time. Required only when callMode=history and operate=true. |
Response
If the request is completed successfully, a response of the following format is returned:
{
"rtro":<int>, /* 0 - stopped, 1 - started */
"rtrst":<uint> /* Time when the retransmission stops. Unix time. */
}
Otherwise, an error code is returned.
Error codes
| Error code | Description |
|---|---|
| 4 | Wrong input parameters or failed to start/stop retranslator. |
| 7 | The retranslator isn’t found or the user doesn’t have the ADF_ACL_AVL_RETR_EDIT_SETTINGS access right to the retranslator (Edit retranslator properties including start/stop). |