| Current Path : /usr/share/asterisk/rest-api/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : //usr/share/asterisk/rest-api/deviceStates.json |
{
"_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
"_author": "Kevin Harwell <kharwell@digium.com>",
"_svn_revision": "$Revision$",
"apiVersion": "2.0.0",
"swaggerVersion": "1.1",
"basePath": "http://localhost:8088/ari",
"resourcePath": "/api-docs/deviceStates.{format}",
"requiresModules": [
"res_stasis_device_state"
],
"apis": [
{
"path": "/deviceStates",
"description": "Device states",
"operations": [
{
"httpMethod": "GET",
"summary": "List all ARI controlled device states.",
"nickname": "list",
"responseClass": "List[DeviceState]"
}
]
},
{
"path": "/deviceStates/{deviceName}",
"description": "Device state",
"operations": [
{
"httpMethod": "GET",
"summary": "Retrieve the current state of a device.",
"nickname": "get",
"responseClass": "DeviceState",
"parameters": [
{
"name": "deviceName",
"description": "Name of the device",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
}
]
},
{
"httpMethod": "PUT",
"summary": "Change the state of a device controlled by ARI. (Note - implicitly creates the device state).",
"nickname": "update",
"responseClass": "void",
"parameters": [
{
"name": "deviceName",
"description": "Name of the device",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
},
{
"name": "deviceState",
"description": "Device state value",
"paramType": "query",
"required": true,
"allowMultiple": false,
"dataType": "string",
"allowableValues": {
"valueType": "LIST",
"values": [
"NOT_INUSE",
"INUSE",
"BUSY",
"INVALID",
"UNAVAILABLE",
"RINGING",
"RINGINUSE",
"ONHOLD"
]
}
}
],
"errorResponses": [
{
"code": 404,
"reason": "Device name is missing"
},
{
"code": 409,
"reason": "Uncontrolled device specified"
}
]
},
{
"httpMethod": "DELETE",
"summary": "Destroy a device-state controlled by ARI.",
"nickname": "delete",
"responseClass": "void",
"parameters": [
{
"name": "deviceName",
"description": "Name of the device",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
}
],
"errorResponses": [
{
"code": 404,
"reason": "Device name is missing"
},
{
"code": 409,
"reason": "Uncontrolled device specified"
}
]
}
]
}
],
"models": {
"DeviceState": {
"id": "DeviceState",
"description": "Represents the state of a device.",
"properties": {
"name": {
"type": "string",
"description": "Name of the device.",
"required": true
},
"state": {
"type": "string",
"description": "Device's state",
"required": true,
"allowableValues": {
"valueType": "LIST",
"values": [
"UNKNOWN",
"NOT_INUSE",
"INUSE",
"BUSY",
"INVALID",
"UNAVAILABLE",
"RINGING",
"RINGINUSE",
"ONHOLD"
]
}
}
}
}
}
}