Update Device Info

Description

This method allows to update the poken device info.

HTTP Method

POST

Path

/devices/{deviceId}/details

Authentication

Requires an authenticated user.

Parameters

Table 28.  Parameters for " Update Device Info "

NameTypeValue TypeDescription
deviceIdPATHlongThe id of the poken device to update.
iconFORMStringThe new icon (must be the name of an icon from retrieve device icon list
nameFORMStringThe new name
statusFORMStringThe new status (ENABLED/DISABLED/LOST)
messageFORMStringThe new message

Error Codes

150001 ( Common )

The endpoint requires an authenticated account

20000 ( Device )

An unhandled exception has occured.

20002 ( Device )

Unabled to update the device detail information.

20004 ( Device )

The specified icon name is not valid.

20013 ( Device )

Don't have the permission to execute this request

Response Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://xsd.poken.com" xmlns:tns="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="success" type="tns:Status" default="FAILURE" minOccurs="0"/>
        <xs:element name="error" type="tns:Error" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="Error">
    <xs:sequence>
      <xs:element name="code" type="xs:string"/>
      <xs:element name="description" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="Status">
    <xs:restriction base="xs:string">
      <xs:enumeration value="SUCCESS"/>
      <xs:enumeration value="FAILURE"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response xmlns="http://xsd.poken.com">
	<success>SUCCESS</success>
</response>