This API end point lets read and write the device setup for a specific M&C.
Writing a device setup as a whole to the M&C requires a M&C restart to make the M&C read and interpret the changed setup. Hence this is to be considered a legacy operation which will be replaced by API calls to modify the device configuration of the M&C 'on the fly' without restarting it, as soon as these API calls are available.
Supported HTTP methods: GET, PUT, HEAD, OPTIONS
GET /api/v1/devicesetup/{mncName}
Get the device setup for the given M&C.
Parameters:
| Parameter | Description |
|---|---|
| mncName | The name of the M&C to read the device setup from. |
Expected Payload: none.
Replied Payload: A DeviceSetup document describing the device configuration of the given M&C.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, a DeviceSetup document is returned. |
| 404 | The requested M&C system does not exist. In this case an ApiError document is returned, describing details of the error. |
| 401 | Not logged in. In this case an ApiError document is returned, describing details of the error. |
PUT /api/v1/devicesetup/{mncName}
Sends a new device configuration to the given M&C. The configuration will be saved as 'vlc.setup' on this M&C, replacing the existing configuration. The M&C will use this configuration after the next restart (see /api/v1/restart).
Parameters:
| Parameter | Description |
|---|---|
| mncName | The name of the M&C to send the device setup to. |
Expected Payload: The DeviceSetup document containing the new / modified device configuration.
Replied Payload: Echoes back the DeviceSetup which has been sent.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, the echoed DeviceSetup document is returned. |
| 404 | The requested M&C system does not exist. In this case an ApiError document is returned, describing details of the error. |
| 401 | Not logged in. In this case an ApiError document is returned, describing details of the error. |