Since Product Version: 3.0
Resource URL
/webacs/api/v1/op/pnp/status/{serialNumber}Request Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
serialNumber optional |
path |
|
Request Payload Parameters
Type | Attribute Name | Description |
---|---|---|
String |
description |
|
String |
deviceHostName |
|
String |
deviceIPAddress |
|
String |
deviceType |
PID of device |
String |
message |
detailed message on state |
String |
serialID |
device serial ID |
String |
state |
|
Response Parameters
Type | Attribute Name | Description |
---|---|---|
String |
description |
|
String |
state |
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://172.25.123.114/webacs/api/v1/op/pnp/status/sample_serial_number
<?xml version="1.0" ?> <pnPDeviceState> <description>String value</description> <deviceHostName>String value</deviceHostName> <deviceIPAddress>String value</deviceIPAddress> <deviceType>String value</deviceType> <message>String value</message> <serialID>String value</serialID> <state>String value</state> </pnPDeviceState>
Sample JSON Request Payload
https://172.25.123.114/webacs/api/v1/op/pnp/status/sample_serial_number.json
{ "pnPDeviceState" : { "description" : "String value", "deviceHostName" : "String value", "deviceIPAddress" : "String value", "deviceType" : "String value", "message" : "String value", "serialID" : "String value", "state" : "String value" } }
Sample XML Response Payload
https://172.25.123.114/webacs/api/v1/op/pnp/status/sample_serial_number
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/pnp/status/sample_serial_number" rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <pnPResponse> <description>String value</description> <state>String value</state> </pnPResponse> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v1/op/pnp/status/sample_serial_number.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/pnp\/status\/sample_serial_number", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/", "pnPResponse" : { "description" : "String value", "state" : "String value" } } }