This API end point returns a list of the preferred device communication protocols a particular device driver uses. The list is fetched from the primary M&C.
Supported HTTP methods: GET, HEAD, OPTIONS
GET /api/v1/preferredprotocols/{driverName}
Get the list of the preferred device communication protocols a particular device driver uses. Actually a sat-nms devices driver defines exactly one preferred protocol, hence this list will always have exactly one element. Future sat-nms versions may permit to define multiple preferred protocols for a driver.
Parameters:
| Parameter | Description |
|---|---|
| driverName | The name of the device driver to check. |
Expected Payload: none.
Replied Payload: An ItemList document containing the names of the preferred device communication protocols of the given driver.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, an ItemList document is returned. |
| 400 | The primary M&C is offline, cannot be queried. In this case an ApiError document is returned, describing details of the error. |
| 404 | The device driver this call refers to 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. |