Gives access to the device screen definitions stored on the primary M&C. Screen definitions may be listed, read or written with this call.
Supported HTTP methods: GET, POST, HEAD, OPTIONS
GET /api/v1/dscreens
Returns a list of all available dscreens. The list is read from the primary M&C.
Parameters: none.
Expected Payload: none.
Replied Payload: Returns an ItemList containing the names of all available device screens.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns an ItemList containing the names of all available device screens. |
| 400 | the primary M&C is offline, the list cannot be read. In this case a ApiError document is returned, describing details of the error. |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
GET /api/v1/dscreens/{name}
Returns a ScreenDefinition document describing the requested screen. The screen is read from the primary M&C.
Parameters:
| Parameter | Description |
|---|---|
| name | The name of the screen to load. Please note, that screen names are case sensitive, the name must match exactly to be loaded. |
Expected Payload: none.
Replied Payload: Returns a ScreenDefinition document describing the requested screen.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns a ScreenDefinition document describing the requested screen. |
| 400 | the primary M&C is offline, the screen cannot be read. In this case a ApiError document is returned, describing details of the error. |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
| 404 | no screen definition with the given name exists. In this case a ApiError document is returned, describing details of the error. |
POST /api/v1/dscreens/{name}
Stores a ScreenDefinition at the primary M&C. If the screen already exists, it gets overwritten.
Parameters:
| Parameter | Description |
|---|---|
| name | The name of the screen to store. Screen definition names may consist of the characters A-Z, a-z, 0-9 and the hyphen character. |
Expected Payload: The ScreenDefinition to store.
Replied Payload: Echoes back the written ScreenDefinition.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, echoes back the written ScreenDefinition. |
| 400 | the primary M&C is offline, the screen cannot be written. In this case a ApiError document is returned, describing details of the error. |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
DELETE /api/v1/dscreens/{name}
Deletes a ScreenDefinition at the primary M&C.
Parameters:
| Parameter | Description |
|---|---|
| name | The name of the screen to delete. Screen definition names may consist of the characters A-Z, a-z, 0-9 and the hyphen character. |
Expected Payload: none.
Replied Payload: none.
Return Codes:
| Code | Description |
|---|---|
| 204 | OK, the screen has been deleted. |
| 400 | the primary M&C is offline, the screen cannot be deleted. In this case a ApiError document is returned, describing details of the error. |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
| 404 | not found. No screen of this name exists. In this case a ApiError document is returned, describing details of the error. |