Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Devicestates

Method

Path

Return Model

Summary

GET

/deviceStates

List[DeviceState]

List all ARI controlled device states.

GET

/deviceStates/{deviceName}

DeviceState

Retrieve the current state of a device.

PUT

/deviceStates/{deviceName}

void

Change the state of a device controlled by ARI. (Note - implicitly creates the device state).

DELETE

/deviceStates/{deviceName}

void

Destroy a device-state controlled by ARI.

list: GET /deviceStates

List all ARI controlled device states.

get: GET /deviceStates/{deviceName}

Retrieve the current state of a device.

Path parameters

  • deviceName: string - Name of the device

update: PUT /deviceStates/{deviceName}

Change the state of a device controlled by ARI. (Note - implicitly creates the device state).

Path parameters

  • deviceName: string - Name of the device

Query parameters

  • deviceState: string - (required) Device state value
    • Allowed values: NOT_INUSE, INUSE, BUSY, INVALID, UNAVAILABLE, RINGING, RINGINUSE, ONHOLD

Error Responses

  • 404 - Device name is missing
  • 409 - Uncontrolled device specified

delete: DELETE /deviceStates/{deviceName}

Destroy a device-state controlled by ARI.

Path parameters

  • deviceName: string - Name of the device

Error Responses

  • 404 - Device name is missing
  • 409 - Uncontrolled device specified
  • No labels