Read a Linux screen's Presentation Network readiness

GET

/api/v1/screens/{id}/presentation-network

const url = 'https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/presentation-network';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/presentation-network

Readiness is server-derived from the assignment and the player’s reported helper, NetworkManager, Wi-Fi, revision, and connection facts.

Parameters

Path Parameters

required

string format: uuid

Responses

200

Assignment and operator-facing readiness state

application/json

object

data

required

object

screenId

required

string format: uuid

platform

required

string

presentationNetworkId

string format: uuid

presentationNetworkName

string

assignedAt

string format: date-time

applicable

required

boolean

status

required

string

Allowed values: not_applicable network_manager_unavailable helper_missing helper_unhealthy unsupported wifi_adapter_unavailable unassigned reporting_pending connected failed configuration_pending ready

detail

required

string

helperState

string

Allowed values: ok missing unhealthy unsupported

networkManagerAvailable

boolean

wifiAdapterPresent

boolean

radioEnabled

boolean

reportedState

string

Allowed values: unsupported unassigned pending provisioned joining connected failed

installedNetworkId

string format: uuid

installedRevision

integer format: int64

activeNetworkId

string format: uuid

lastConnectedAt

string format: date-time

lastFailureAt

string format: date-time

lastFailureCode

string

limitation

string

wiredInterfaceAvailable

boolean

wiredIpv4

string format: ipv4

credentialsAvailable

required

boolean

Example

{
  "data": {
    "status": "not_applicable",
    "helperState": "ok",
    "reportedState": "unsupported"
  }
}

403

Screen is outside the caller’s scope

404

Screen not found