Access Keys:
Skip to content (Access Key - 0)
 

Beehive 3.0 REST JSON API documentation(support JDBC)

The following document describes the Beehive 3.0 REST/JSON API(support JDBC) which supports JSON client. For the new REST/JDBC API feature, we recommand to use JSON data.

By default the response format is XML, you can also use JSON. You should to specify 'Accept' type in HTTP header, if you want to use JSONP, see how to 'Use JSONP format' in this document.The JSON format is different with the previous Beehive REST API, because the JSON provider changed(from jettison to jackson).

For verifying authentication by crowd, so modified the HTTP basic header Authorization, from "Basic base64(username:md5(password,username))" to "Basic base64(username:password)"

New feature:

  • JSON format changed(from jettison to jackson)
  • user save/query/delete
  • device save/query/delete
  • device command save/query/delete
  • sensor save/query/delete
  • switch save/query/delete
  • slider save/query/delete
  • device macro save/query/delete
  • controller config save/query/delete

Index:

(1) Export a LIRC configuration as a text file, concatenate different RemoteSection.

  • Request URL: 
    /lirc.conf
  • Request Method: GET
  • Parameters: ids (RemoteSection ids, separate by comma)
  • Output:Combined Configuration files content as String.
  • Sample Response: 
    #
# This config file has been automatically converted from a device file
# found in the 06/26/00 release of the Windows Slink-e software
# package.
#
# Many thanks to Colby Boles of Nirvis Systems Inc. for allowing us to
# use these files.
#
# The original filename was: "3m mp8640 3m lcd projector.cde"
#
# The original description for this device was:
#
# 3m mp8640 3m lcd projector
#



begin remote
  name                    MP8640
  bits                    32
  flags                   SPACE_ENC
  eps                     20
  aeps                    200

  header                  8800 4400
  one                     550 1650
  zero                    550 550
  ptrail                  550
  repeat                  8800 2200
  gap                     38500
  toggle_bit              0

  frequency               38000

      begin codes
          STANDBY/ON              0x000000000AF5E817
          VOLUME'/\'              0x000000000AF548B7
          ...

      end codes

end remote



#
# this config file was automatically generated
# using lirc-0.6.6(serial) on Sat May 24 18:35:13 2003
#
# contributed by
#
# brand:                       Abit
# model no. of remote control: ?
# devices being controlled by this remote: AU10 audio card / windvd
#


begin remote

  name                    ABIT_WINDVD
  bits                    16
  flags                   SPACE_ENC|CONST_LENGTH
  eps                     30
  aeps                    100

  header                  9149 4422
  one                     666 1569
  zero                    666 474
  ptrail                  666
  pre_data_bits           16
  pre_data                0x807F
  gap                     108554
  toggle_bit              0

      begin codes
          OnOff                   0x000000000000E01F
          Mute                    0x00000000000010EF
          Title                   0x000000000000906F
          Screen                  0x00000000000050AF
          eject                   0x000000000000D02F
          ...
      end codes


end remote

(2) List all hardware vendors in the database

  • Request URL: 
    /lirc
  • Request Method: GET
  • Output:json of a vendors list.
  • Sample Response:
    • content-type:application/json 
      {"vendors":
          [
             {"id":1,
              "name":"3m"
             },
             {"id":2,
              "name":"abit"},
             ...
           ]
 }
  • Errors:
    • Error Code:204, No Content. See HTTP/1.1 documentation.If system has no Vendor at all.

(3) List all models of a vendor in the database

  • Request URL: 
    /lirc/{vendor_name}
  • Request Method: GET
  • Sample Response:
    • content-type:application/json : 
      {"models":
         [
               {
                 "id":1,
                 "name":"MP8640"}
         ]
}
  • Errors:
    • Error Code:404, Not Found. See HTTP/1.1 documentation. If system can't find such a Vendor .
    • Error Code:204, No Content. See HTTP/1.1 documentation. If this Vendor has no Model at all .

(4) List all RemoteSections of a model in the database

  • Request URL: 
    /lirc/{vendor_name}/{model_name}
  • Request Method: GET
  • Sample Response:
    • content-type:application/json : 
      {"sections":
    [
        {"id":1,
          "comment":"#\r\n# This config file has been automatically converted from a device file\r\n#...",
          "name":"MP8640",
          "raw":false
        }
    ]
}
  • Errors:
    • Error Code:404, Not Found. See HTTP/1.1 documentation. If system can't find such a RemoteSection .

(5) List all RemoteOptions of a RemoteSection in the database

  • Request URL: 
     /lirc/{vendor_name}/{model_name}/{section_id}/options
  • Request Method: GET
  • Sample Response:
    • content-type:application/json : 
      {"options":
                [
                  {"id":1,
                   "comment":"",
                   "name":"name",
                   "value":"MP8640"},
                   ...
                ]
}
  • Errors:
    • Error Code:204, No Content. See HTTP/1.1 documentation. If this RemoteSection has no RemoteOption at all .

(6) List all Codes of a Section in the database

  • Request URL: 
     /lirc/{vendor_name}/{model_name}/{section_id}/codes
  • Request Method: GET
  • Sample Response:
    • content-type:application/json : 
      {"codes":
              [
                  {"id":1,
                   "comment":"",
                   "name":"STANDBY\/ON",
                   "remoteName":"MP8640",
                   "value":"0x000000000AF5E817"
                   },
                   ...
               ]
}
  • Errors:
    • Error Code:204, No Content. See HTTP/1.1 documentation. If this RemoteSection has no Code at all .

(7) List all icons identified by button command name (Included in M2)

  • Request URL: 
     /icons/{icon_name}
  • Request Method: GET
  • Sample Response:
    • content-type:application/json : 
      {"icons":
            [
              {"id":21,
               "fileName":"http:\/\/localhost:8080\/beehive\/icons\/menu.png",
               "name":"menu"},
              ...
            ]
}
  • Errors:
    • Error Code:404, Not Found. See HTTP/1.1 documentation. If system can't find any icons.
    • Error Code:204, No Content. See HTTP/1.1 documentation. If this button has no icons at all .

(8) List all icons (Included in M2)

  • Request URL: 
     /icons
  • Request Method: GET
  • Sample Response:
    • content-type:application/json : 
      {"icons":
           [
              {"id":1,
               "fileName":"http:\/\/localhost:8080\/beehive\/icons\/power.png",
               "name":"power"},
               {"id":2,
               "fileName":"http:\/\/localhost:8080\/beehive\/icons\/home.png",
               "name":"home"},
              ...
            ]
}
  • Errors:
    • Error Code:404, Not Found. See HTTP/1.1 documentation. If system can't find any icons.
    • Error Code:204, No Content. See HTTP/1.1 documentation. If this button has no icons at all .

(9) Get all templates from account (Included in M7)

  • Request URL: 
     /account/{account_id}/templates/{share_scope}
  • Sample Response:
    • content-type:application/json : 
      {
    "templates":
     [
       {
            "id":3,
            "content":"content...",
            "keywords":"sony,tv",
            "name":"t3"
        }
        ...
     ]
}
  • Errors:
    • Error Code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:404, Not Found. See HTTP/1.1 documentation. If can't find any template.

(10) Save a template into account (Included in M7)

  • Request URL: 
     /account/{account_id}/template
  • Sample Response:
    • content-type:application/json : 
          {
        "template":
        {
            "id":3,
            "content":"content...",
            "keywords":"sony,tv",
            "name":"t3"
        }

    }
  • Errors:
    • Error Code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(11) Update a template into account (Included in M7)

  • Request URL: 
     /account/{account_id}/template/{template_id}
  • Request Method: PUT
  • Parameters: account_id(account id), template_id (template id)
  • HTTP basic header Authorization : "Basic base64(username:password,username)"
  • Sample Request Url:http://localhost:8080/beehive/rest/account/1/template/1
  • Output:json of the updated template in account.
  • Sample Response:
    • content-type:application/json : 
          {
        "template":
        {
            "id":3,
            "content":"content...",
            "keywords":"sony,tv",
            "name":"t3"
        }

    }
  • Errors:
    • Error Code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(12) Delete a template from account (Included in M7)

  • Request URL: 
     /account/{account_id}/template/{template_id}
  • Sample Response:
    • if success : 
      	true
    • if fail : 
              false
  • Errors:
    • Error Code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(13) Upload template resource(images etc) into account (Included in M7)

  • Request URL: 
     /account/{account_id}/template/{template_id}/resource
  • Sample Response:
    • if success : 
      	true
    • if fail : 
              false
  • Errors:
    • Error Code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(14) Download template resource(images etc) from account (Included in M7)

  • Request URL: 
     /account/{account_id}/template/{template_id}/resource
  • Errors:
    • Error Code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:404, openremote.zip not found. See HTTP/1.1 documentation.

(15) Upload account resource(openremote.zip for controller) into account (Included in M7)

  • Request URL: 
     /account/{account_id}/openremote.zip
  • Sample Response:
    • if success : 
      	true
    • if fail : 
              false
  • Errors:
    • Error Code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(16) Download account resource(openremote.zip for controller) from account (Included in M7)

  • Request URL: 
     /user/{username}/openremote.zip
  • Errors:
    • Error Code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:404, openremote.zip not found. See HTTP/1.1 documentation.

(17) Search public templates by keywords from others (Included in M7)

  • Request URL: 
     /templates/keywords/{keywords}/page/{page}
  • Sample Response:
    • content-type:application/json : 
      {
    "templates":
       [
           {
            "id":3,
            "content":"content...",
            "keywords":"sony,tv",
            "name":"t3"
           }
           ...
       ]
}
  • Errors:
    • Error Code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:404, Not Found. See HTTP/1.1 documentation. If can't find any template.

(18) Create a new user with the Admin role, it will create a new account also(support JDBC)

  • Request URL: 
     /manageuser/create
  • Output:json of the new user.
  • Sample Response:
    • content-type:application/json : 
           
{
     "username":"macuser5",
     "account":{"id":2},
     "token":null,
     "pendingRoleName":null,
     "id":2
}
  • Errors:
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(19) Show user by user id(support JDBC)

  • Request URL: 
     /manageuser/get/{user_id}
  • Sample Response:
    • content-type:application/json : 
              
{
      "username":"dan",
      "account":{"id":1},
      "token":null,
      "pendingRoleName":null,
      "id":1
}
  • Errors:
    • Error Code:404, No user found.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(20) Show user by user name(support JDBC)

  • Request URL: 
     /manageuser/getbyname/{username}
  • Sample Response:
    • content-type:application/json : 
              
{
      "username":"dan",
      "account":{"id":1},
      "token":null,
      "pendingRoleName":null,
      "id":1
}
  • Errors:
    • Error Code:404, No user found.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(21) Update User token and pendingRoleName by posted UserDTO(support JDBC)

  • Request URL: 
     /manageuser/update
  • Request Method: POST
  • Parameters: userDTO(the received UserDTO Object, in post content)
  • Sample Request Url:http://localhost:8080/beehive/rest/manageuser/update
    • content-type:application/json : 
      {
      "username":"tomsky",
      "account":{"id":2},
      "token":null,
      "pendingRoleName":"Admin",
      "id":2
}
  • Output:true.
  • Errors:
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(22) Delete a user by user id(support JDBC)

  • Request URL: 
     /manageuser/delete/{user_id}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(23) Create an invitee by posted UserDTO under the specified Account(support JDBC)

  • Request URL: 
     /manageuser/createinvitee/{account_id}
  • Request Method: POST
  • Parameters: userDTO(the received UserDTO Object, in post content), account_id(account id)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/manageuser/createinvitee/1
    • content-type:application/json : 
      {"id":0,"pendingRoleName":"Admin","token":null,"username":"tomsky.wang@finalist.hk"}
  • Output:json of the new invitee.
  • Sample Response:
    • content-type:application/json : 
           
{
     "username":"tomsky.wang@finalist.hk",
     "account":{"id":1},
     "token":null,
     "pendingRoleName":"Admin",
     "id":2
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(24) Show all users under an Account.(support JDBC)

  • Request URL: 
     /manageuser/loadall/{account_id}
  • Sample Response:
    • content-type:application/json : 
           
{
   "users":
   [
      {"username":"dan",
       "account":{"id":1},
       "token":null,
       "pendingRoleName":null,
       "id":1},
      {"username":"tomsky.wang@finalist.hk",
       "account":{"id":1},
       "token":null,
       "pendingRoleName":"Admin",
       "id":2}
   ]
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error code:404, Not Found. See HTTP/1.1 documentation. If can't find any users.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(25) Create an new simple device under an account, it just includes name,vendor and model(support JDBC)

  • Request URL: 
     /device/save/{account_id}
  • Request Method: POST
  • Parameters: deviceDTO(the received DeviceDTO Object, in post content), account_id(account id)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/device/save/1
    • content-type:application/json : 
      {"id":0,"model":"dev","name":"device1","vendor":"dev"}
  • Output:json of the new device.
  • Sample Response:
    • content-type:application/json : 
           
{
   "name":"device1",
   "model":"dev",
   "vendor":"dev",
   "id":1
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(26) Create an new device with contents, the contents includes commands, sensors, switchs and sliders(support JDBC)

  • Request URL: 
     /device/savewithcontent/{account_id}
  • Request Method: POST
  • Parameters: deviceDTO(the received DeviceDTO Object, in post content), account_id(account id)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/device/savewithcontent/1
    • content-type:application/json : 
      {"deviceAttrs":null,"deviceCommands":[{"id":0,"name":"cmd1","protocol":{"attributes":[{"id":0,"name":"url","value":"http://
cmd1.com"}],"id":0,"type":"HTTP"},"sectionId":null},{"id":0,"name":"cmd2","protocol":{"attributes":[{"id":0,"name":"url","value":"http://
cmd2.com"}],"id":0,"type":"HTTP"},"sectionId":null},{"id":0,"name":"cmd3","protocol":{"attributes":[{"id":0,"name":"url","value":"http://
cmd3.com"}],"id":0,"type":"HTTP"},"sectionId":null},{"id":0,"name":"cmd4","protocol":{"attributes":[{"id":0,"name":"url","value":"http://
cmd4.com"}],"id":0,"type":"HTTP"},"sectionId":null},{"id":0,"name":"cmd5","protocol":{"attributes":[{"id":0,"name":"url","value":"http://
cmd5.com"}],"id":0,"type":"HTTP"},"sectionId":null},{"id":0,"name":"cmd6","protocol":{"attributes":[{"id":0,"name":"url","value":"http://
cmd6.com"}],"id":0,"type":"HTTP"},"sectionId":null}],"id":0,"model":"devc","name":"DeviceWithContent","sensors":
[{"classType":"Sensor","id":0,"name":"switchsensor","sensorCommandRef":{"deviceCommand":{"id":0,"name":"cmd3","protocol":{"attributes":[{"id":0,"name":"url","value":"http://
cmd3.com"}],"id":0,"type":"HTTP"},"sectionId":null},"id":0},"type":"SWITCH"},{"classType":"RangeSensor","id":0,"max":100,"min":1,"name":"slidersensor","sensorCommandRef":
{"deviceCommand":{"id":0,"name":"cmd5","protocol":{"attributes":[{"id":0,"name":"url","value":"http://
cmd5.com"}],"id":0,"type":"HTTP"},"sectionId":null},"id":0},"type":"RANGE"}],"sliders":[{"id":0,"name":"slider1","setValueCmd":{"deviceCommand":
{"id":0,"name":"cmd6","protocol":{"attributes":[{"id":0,"name":"url","value":"http://cmd6.com"}],"id":0,"type":"HTTP"},"sectionId":null},"id":0},"sliderSensorRef":
{"id":0,"sensor":{"classType":"RangeSensor","id":0,"max":100,"min":1,"name":"slidersensor","sensorCommandRef":{"deviceCommand":{"id":0,"name":"cmd5","protocol":{"attributes":
[{"id":0,"name":"url","value":"http://cmd5.com"}],"id":0,"type":"HTTP"},"sectionId":null},"id":0},"type":"RANGE"}}}],"switchs":
[{"id":0,"name":"switch1","switchCommandOffRef":{"deviceCommand":{"id":0,"name":"cmd2","protocol":{"attributes":[{"id":0,"name":"url","value":"http://
cmd2.com"}],"id":0,"type":"HTTP"},"sectionId":null},"id":0},"switchCommandOnRef":{"deviceCommand":{"id":0,"name":"cmd1","protocol":{"attributes":
[{"id":0,"name":"url","value":"http://cmd1.com"}],"id":0,"type":"HTTP"},"sectionId":null},"id":0},"switchSensorRef":{"id":0,"sensor":
{"classType":"Sensor","id":0,"name":"switchsensor","sensorCommandRef":{"deviceCommand":{"id":0,"name":"cmd3","protocol":{"attributes":[{"id":0,"name":"url","value":"http://
cmd3.com"}],"id":0,"type":"HTTP"},"sectionId":null},"id":0},"type":"SWITCH"}}}],"vendor":"devc"}
  • Output:json of the new device.
  • Sample Response:
    • content-type:application/json : 
           
{"name":"DeviceWithContent","account":{"id":1},"model":"devc","sensors":[{"classType":"Sensor","name":"switchsensor","type":"SWITCH","device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sensorCommandRef":
{"sensor":null,"deviceCommand":{"name":"cmd3","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd3.com","id":3}],"id":3},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":3},"deviceName":"DeviceWithContent","id":1},"id":1},
{"classType":"RangeSensor","min":1,"max":100,"name":"slidersensor","type":"RANGE","device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sensorCommandRef":
{"sensor":null,"deviceCommand":{"name":"cmd5","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd5.com","id":5}],"id":5},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":5},"deviceName":"DeviceWithContent","id":2},"id":2}],"switchs":
[{"name":"switch1","device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"switchCommandOffRef":
{"offSwitch":null,"deviceCommand":{"name":"cmd2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd2.com","id":2}],"id":2},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":2},"deviceName":"DeviceWithContent","id":4},"switchCommandOnRef":
{"onSwitch":null,"deviceCommand":{"name":"cmd1","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd1.com","id":1}],"id":1},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":1},"deviceName":"DeviceWithContent","id":5},"switchSensorRef":
{"switchToggle":null,"sensor":{"classType":"Sensor","name":"switchsensor","type":"SWITCH","device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sensorCommandRef":
{"sensor":null,"deviceCommand":{"name":"cmd3","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd3.com","id":3}],"id":3},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":3},"deviceName":"DeviceWithContent","id":1},"id":1},"id":0},"id":1}],"deviceCommands":
[{"name":"cmd1","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd1.com","id":1}],"id":1},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":1},
{"name":"cmd2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd2.com","id":2}],"id":2},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":2},
{"name":"cmd3","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd3.com","id":3}],"id":3},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":3},
{"name":"cmd4","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd4.com","id":4}],"id":4},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":4},
{"name":"cmd5","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd5.com","id":5}],"id":5},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":5},
{"name":"cmd6","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd6.com","id":6}],"id":6},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":6}],"sliders":
[{"name":"slider1","device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sliderSensorRef":
{"slider":null,"sensor":{"classType":"RangeSensor","min":1,"max":100,"name":"slidersensor","type":"RANGE","device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sensorCommandRef":
{"sensor":null,"deviceCommand":{"name":"cmd5","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd5.com","id":5}],"id":5},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":5},"deviceName":"DeviceWithContent","id":2},"id":2},"id":0},"setValueCmd":
{"slider":null,"deviceCommand":{"name":"cmd6","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd6.com","id":6}],"id":6},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":6},"deviceName":"DeviceWithContent","id":3},"id":1}],"vendor":"devc","id":2}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(27) Show a list of devices with simple properties under an account, each device includes id, name, vendor and model(support JDBC)

  • Request URL: 
     /device/loadall/{account_id}
  • Sample Response:
    • content-type:application/json : 
           
{
   "devices":
   [
      {
       "name":"device1",
       "model":"dev",
       "vendor":"dev",
       "id":1
      }
   ]
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error code:404, Not Found. See HTTP/1.1 documentation. If can't find any devices.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(28) Show a device by device id, it includes commands,sensors,sliders and switchs(support JDBC)

  • Request URL: 
     /device/load/{device_id}
  • Sample Response:
    • content-type:application/json : 
           
{"name":"DeviceWithContent","account":{"id":1},"model":"devc","sensors":[{"classType":"Sensor","name":"switchsensor","type":"SWITCH","device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sensorCommandRef":
{"sensor":null,"deviceCommand":{"name":"cmd3","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd3.com","id":3}],"id":3},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":3},"deviceName":"DeviceWithContent","id":1},"id":1},
{"classType":"RangeSensor","min":1,"max":100,"name":"slidersensor","type":"RANGE","device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sensorCommandRef":
{"sensor":null,"deviceCommand":{"name":"cmd5","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd5.com","id":5}],"id":5},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":5},"deviceName":"DeviceWithContent","id":2},"id":2}],"switchs":
[{"name":"switch1","device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"switchCommandOffRef":
{"offSwitch":null,"deviceCommand":{"name":"cmd2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd2.com","id":2}],"id":2},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":2},"deviceName":"DeviceWithContent","id":4},"switchCommandOnRef":
{"onSwitch":null,"deviceCommand":{"name":"cmd1","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd1.com","id":1}],"id":1},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":1},"deviceName":"DeviceWithContent","id":5},"switchSensorRef":
{"switchToggle":null,"sensor":{"classType":"Sensor","name":"switchsensor","type":"SWITCH","device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sensorCommandRef":
{"sensor":null,"deviceCommand":{"name":"cmd3","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd3.com","id":3}],"id":3},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":3},"deviceName":"DeviceWithContent","id":1},"id":1},"id":0},"id":1}],"deviceCommands":
[{"name":"cmd1","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd1.com","id":1}],"id":1},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":1},
{"name":"cmd2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd2.com","id":2}],"id":2},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":2},
{"name":"cmd3","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd3.com","id":3}],"id":3},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":3},
{"name":"cmd4","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd4.com","id":4}],"id":4},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":4},
{"name":"cmd5","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd5.com","id":5}],"id":5},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":5},
{"name":"cmd6","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd6.com","id":6}],"id":6},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":6}],"sliders":
[{"name":"slider1","device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sliderSensorRef":
{"slider":null,"sensor":{"classType":"RangeSensor","min":1,"max":100,"name":"slidersensor","type":"RANGE","device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sensorCommandRef":
{"sensor":null,"deviceCommand":{"name":"cmd5","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd5.com","id":5}],"id":5},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":5},"deviceName":"DeviceWithContent","id":2},"id":2},"id":0},"setValueCmd":
{"slider":null,"deviceCommand":{"name":"cmd6","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd6.com","id":6}],"id":6},"device":
{"name":"DeviceWithContent","account":null,"model":"devc","sensors":null,"switchs":null,"deviceCommands":null,"sliders":null,"vendor":"devc","id":2},"sectionId":null,"id":6},"deviceName":"DeviceWithContent","id":3},"id":1}],"vendor":"devc","id":2}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(29) Update Device name,vendor and model(support JDBC)

  • Request URL: 
     /device/update
  • Request Method: POST
  • Parameters: deviceDTO(the received DeviceDTO Object, in post content)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/device/update
    • content-type:application/json : 
      {"name":"Update device","model":"update","vendor":"update","id":1}
  • Output:true.
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(30) Delete a device by device id(support JDBC)

  • Request URL: 
     /device/delete/{device_id}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(31) Show a list of devices with same contents except id under an Account(support JDBC)

  • Request URL: 
     /device/loadsamedevices/{account_id}
  • Request Method: GET
  • Parameters: deviceDTO(the device to be compared, its not specified id, in post content), account_id(account id)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/device/loadsamedevices/1
    • content-type:application/json : 
      {"name":"device1","model":"dev","vendor":"dev","id":0}
  • Output:json of a list of devices.
  • Sample Response:
    • content-type:application/json : 
           
{
   "devices":
   [
      {
       "name":"device1",
       "model":"dev",
       "vendor":"dev",
       "id":1
      }
   ]
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error code:404, Not Found. See HTTP/1.1 documentation. If can't find any devices.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(32) Create an new device command(support JDBC)

  • Request URL: 
     /devicecommand/save
  • Request Method: POST
  • Parameters: deviceCommandDTO(the received DeviceCommandDTO Object, in post content)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/devicecommand/save
    • content-type:application/json : 
      {
    "device":{"id":1,"model":"dev","name":"device1","vendor":"dev"},
    "id":0,
    "name":"command1",
    "protocol":{"attributes":[{"id":0,"name":"url","value":"http://command1.com"}],"id":0,"type":"HTTP"},
    "sectionId":null
}
  • Output:json of the new device command, it has the specified id.
  • Sample Response:
    • content-type:application/json : 
           
{
   "name":"command1",
   "protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://command1.com","id":1}],"id":1},
   "device":{"name":"device1","model":"dev","vendor":"dev","id":1},
   "sectionId":null,
   "id":1
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(33) Show a device command by command id(support JDBC)

  • Request URL: 
     /devicecommand/load/{command_id}
  • Sample Response:
    • content-type:application/json : 
           
{
   "name":"command1",
   "protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://command1.com","id":1}],"id":1},
   "device":{"name":"device1","model":"dev","vendor":"dev","id":1},
   "sectionId":null,
   "id":1
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(34) Update a device command(support JDBC)

  • Request URL: 
     /devicecommand/update
  • Request Method: POST
  • Parameters: deviceCommandDTO(the received DeviceCommandDTO Object, in post content)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/devicecommand/update
    • content-type:application/json : 
      {
   "name":"update command",
   "protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://update.command.com","id":1}],"id":1},
   "device":{"name":"device1","model":"dev","vendor":"dev","id":1},
   "sectionId":null,
   "id":1
}
  • Output:json of the updated device command.
  • Sample Response:
    • content-type:application/json : 
           
{
   "name":"update command",
   "protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://update.command.com","id":0}],"id":0},
   "device":{"name":"device1","model":"dev","vendor":"dev","id":1},
   "sectionId":null,
   "id":1
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(35) Delete a device command by command id(support JDBC)

  • Request URL: 
     /devicecommand/delete/{command_id}
  • Sample Response:
    • If success: 
       true
    • If fail: 
       false
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(36) Create a list of device commands(support JDBC)

  • Request URL: 
     /devicecommand/saveall
  • Request Method: POST
  • Parameters: deviceCommandListing(includes a list of deviceCommandDTOs, in post content)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/devicecommand/save
    • content-type:application/json : 
      {"deviceCommands":[{"device":{"id":2,"model":"dev","name":"device1","vendor":"dev"},"id":0,"name":"STANDBY/ON","protocol":{"attributes":
[{"id":0,"name":"name","value":"MP8640"},{"id":0,"name":"command","value":"STANDBY/ON"}],"id":0,"type":"Infrared"},"sectionId":"1"},{"device":
{"id":2,"model":"dev","name":"device1","vendor":"dev"},"id":0,"name":"VOLUME'\\/'","protocol":{"attributes":[{"id":0,"name":"name","value":"MP8640"},
{"id":0,"name":"command","value":"VOLUME'\\/'"}],"id":0,"type":"Infrared"},"sectionId":"1"},{"device":
{"id":2,"model":"dev","name":"device1","vendor":"dev"},"id":0,"name":"POSITION","protocol":{"attributes":[{"id":0,"name":"name","value":"MP8640"},
{"id":0,"name":"command","value":"POSITION"}],"id":0,"type":"Infrared"},"sectionId":"1"},{"device":
{"id":2,"model":"dev","name":"device1","vendor":"dev"},"id":0,"name":"LEFT_MOUSE","protocol":{"attributes":[{"id":0,"name":"name","value":"MP8640"},
{"id":0,"name":"command","value":"LEFT_MOUSE"}],"id":0,"type":"Infrared"},"sectionId":"1"}]}
  • Output:json of a deviceCommandListing(includes a list of deviceCommandDTOs), each deviceCommandDTO has the specified id.
  • Sample Response:
    • content-type:application/json : 
           
{"deviceCommands":[{"name":"STANDBY/ON","protocol":{"type":"Infrared","attributes":[{"name":"name","value":"MP8640","id":3},{"name":"command","value":"STANDBY/
ON","id":4}],"id":3},"device":{"name":"device1","model":"dev","vendor":"dev","id":2},"sectionId":"1","id":2},
{"name":"VOLUME'/\\'","protocol":{"type":"Infrared","attributes":[{"name":"name","value":"MP8640","id":5},{"name":"command","value":"VOLUME'/\\'","id":6}],"id":4},"device":
{"name":"device1","model":"dev","vendor":"dev","id":2},"sectionId":"1","id":3},
{"name":"VOLUME'\\/'","protocol":{"type":"Infrared","attributes":[{"name":"name","value":"MP8640","id":7},{"name":"command","value":"VOLUME'\\/'","id":8}],"id":5},"device":
{"name":"device1","model":"dev","vendor":"dev","id":2},"sectionId":"1","id":4},
{"name":"MUTE","protocol":{"type":"Infrared","attributes":[{"name":"name","value":"MP8640","id":9},{"name":"command","value":"MUTE","id":10}],"id":6},"device":
{"name":"device1","model":"dev","vendor":"dev","id":2},"sectionId":"1","id":5}]}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(37) Show a list of DeviceCommands under a device by by device id(support JDBC)

  • Request URL: 
     /devicecommand/loadbydevice/{device_id}
  • Sample Response:
    • content-type:application/json : 
           
{"deviceCommands":[{"name":"STANDBY/ON","protocol":{"type":"Infrared","attributes":[{"name":"name","value":"MP8640","id":3},{"name":"command","value":"STANDBY/
ON","id":4}],"id":3},"device":{"name":"device1","model":"dev","vendor":"dev","id":2},"sectionId":"1","id":2},
{"name":"VOLUME'/\\'","protocol":{"type":"Infrared","attributes":[{"name":"name","value":"MP8640","id":5},{"name":"command","value":"VOLUME'/\\'","id":6}],"id":4},"device":
{"name":"device1","model":"dev","vendor":"dev","id":2},"sectionId":"1","id":3},
{"name":"VOLUME'\\/'","protocol":{"type":"Infrared","attributes":[{"name":"name","value":"MP8640","id":7},{"name":"command","value":"VOLUME'\\/'","id":8}],"id":5},"device":
{"name":"device1","model":"dev","vendor":"dev","id":2},"sectionId":"1","id":4},
{"name":"MUTE","protocol":{"type":"Infrared","attributes":[{"name":"name","value":"MP8640","id":9},{"name":"command","value":"MUTE","id":10}],"id":6},"device":
{"name":"device1","model":"dev","vendor":"dev","id":2},"sectionId":"1","id":5}]}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(38) Show a list of deviceCommandDTOs, each of them has the same properties with the specified deviceCommandDTO(support JDBC)

  • Request URL: 
     /devicecommand/loadsamecommands
  • Request Method: GET
  • Parameters: deviceCommandDTO(the device command to be compared, its not specified id, in post content), account_id(account id)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/devicecommand/loadsamecommands
    • content-type:application/json : 
      {"name":"STANDBY/ON","protocol":{"type":"Infrared","attributes":[{"name":"name","value":"MP8640","id":0},{"name":"command","value":"STANDBY/ON","id":0}],"id":0},"device":{"name":"device1","model":"dev","vendor":"dev","id":0},"sectionId":"1","id":0}
  • Output:json of a list of device commands.
  • Sample Response:
    • content-type:application/json : 
           
{
"deviceCommands":[
   {"name":"STANDBY/ON",
    "protocol":{"type":"Infrared","attributes":[{"name":"name","value":"MP8640","id":3},{"name":"command","value":"STANDBY/ON","id":4}],"id":3},
    "device":{"name":"device1","deviceCommands":null,"account":null,"model":"dev","sensors":null,"switchs":null,"sliders":null,"vendor":"dev","id":2},"sectionId":"1","id":2
   }
]}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(39) Create a new sensor under an account(support JDBC)

  • Request URL: 
     /sensor/save/{account_id}
  • Request Method: POST
  • Parameters: sensorDTO(the received SensorDTO Object, in post content), account_id(account id)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/sensor/save/1
    • content-type:application/json : 
      {
   "classType":"Sensor",
   "device":{"id":1,"model":"dev","name":"device1","vendor":"dev"},
   "id":0,
   "name":"switchsensor",
   "sensorCommandRef":{"deviceCommand":{"id":1,"name":"command1","sectionId":null},"id":0},
   "type":"SWITCH"
}
  • Output:json of the new sensor, it has the specified id.
  • Sample Response:
    • content-type:application/json : 
           
{
   "classType":"Sensor",
   "name":"switchsensor",
   "type":"SWITCH",
   "device":{"name":"device1","model":"dev","vendor":"dev","id":1},
   "sensorCommandRef":{"sensor":null,"deviceCommand":{"name":"command1","protocol":null,"device":
        {"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"device1","id":1},
   "id":1
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(40) Update a sensor(support JDBC)

  • Request URL: 
     /sensor/update
  • Request Method: POST
  • Parameters: sensorDTO(the received SensorDTO Object, in post content)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/sensor/update
    • content-type:application/json : 
      {
   "classType":"Sensor",
   "name":"update switchsensor",
   "type":"SWITCH",
   "device":{"name":"device1","model":"dev","vendor":"dev","id":1},
   "sensorCommandRef":{"sensor":null,"deviceCommand":{"name":"command1","protocol":null,"device":
        {"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"device1","id":1},
   "id":1
}
  • Output:json of the updated sensor.
  • Sample Response:
    • content-type:application/json : 
           
{
   "classType":"Sensor",
   "name":"update switchsensor",
   "type":"SWITCH",
   "device":{"name":"device1","model":"dev","vendor":"dev","id":1},
   "sensorCommandRef":{"sensor":null,"deviceCommand":{"name":"command1","protocol":null,"device":
        {"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"device1","id":1},
   "id":1
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(41) Delete a sensor by sensor id(support JDBC)

  • Request URL: 
     /sensor/delete/{sensor_id}
  • Sample Response:
    • If success: 
       true
    • If fail: 
       false
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(42) Show a list of sensors under an account(support JDBC)

  • Request URL: 
     /sensor/loadall/{account_id}
  • Sample Response:
    • content-type:application/json : 
           
{
  "sensors":[
       {"classType":"Sensor",
        "name":"update switchsensor",
        "type":"SWITCH",
        "device":{"name":"device1","model":"dev","vendor":"dev","id":1},
        "sensorCommandRef":{"sensor":null,
            "deviceCommand":{"name":"command1","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://command1.com","id":1}],"id":1},
            "device":{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"device1","id":2},
        "id":1}
]}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error code:404, Not Found. See HTTP/1.1 documentation. If can't find any sensors.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(43) Show a sensor by sensor id(support JDBC)

  • Request URL: 
     /sensor/load/{sensor_id}
  • Sample Response:
    • content-type:application/json : 
           
{
   "classType":"RangeSensor",
   "min":1,
   "max":100,
   "name":"rangesensor",
   "type":"RANGE",
   "device":{"name":"device1","model":"dev","vendor":"dev","id":1},
   "sensorCommandRef":{"sensor":null,
          "deviceCommand":{"name":"command2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://command2.com","id":2}],"id":2},
          "device":{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":2},"deviceName":"device1","id":1},
   "id":1
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(44) Show a list of sensors, each of them has the same properties with the specified sensor(support JDBC)

  • Request URL: 
     /sensor/loadsamesensors
  • Request Method: GET
  • Parameters: sensorDTO(the sensor to be compared, its not specified id, in post content)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/sensor/loadsamesensors
    • content-type:application/json : 
      {
   "classType":"RangeSensor",
   "min":1,
   "max":100,
   "name":"rangesensor",
   "type":"RANGE",
   "device":{"name":"device1","model":"dev","vendor":"dev","id":0},
   "sensorCommandRef":{"sensor":null,
          "deviceCommand":{"name":"command2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://command2.com","id":0}],"id":0},
          "device":{"name":"device1","model":"dev","vendor":"dev","id":0},"sectionId":null,"id":0},"deviceName":"device1","id":0},
   "id":0
}
  • Output:json of a list of sensors.
  • Sample Response:
    • content-type:application/json : 
           
{
 "sensors":[
    {"classType":"RangeSensor",
     "min":1,
     "max":100,
     "name":"rangesensor",
     "type":"RANGE",
     "device":{"name":"device1","model":"dev","vendor":"dev","id":1},
     "sensorCommandRef":{"sensor":null,
     "deviceCommand":{"name":"command2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://command2.com","id":2}],"id":2},
     "device":{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":2},"deviceName":"device1","id":1},
     "id":1}
  ]
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error code:404, Not Found. See HTTP/1.1 documentation. If can't find any sensors.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(45) Create a new switch under an account(support JDBC)

  • Request URL: 
     /switch/save/{account_id}
  • Request Method: POST
  • Parameters: switchDTO(the received SwitchDTO Object, in post content), account_id(account id)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/switch/save/1
    • content-type:application/json : 
      {
   "device":{"id":1,"model":"dev","name":"light","vendor":"dev"},
   "id":0,
   "name":"lightswitch",
   "switchCommandOffRef":{"deviceCommand":{"id":2,"name":"off","sectionId":null},"id":0},
   "switchCommandOnRef":{"deviceCommand":{"id":1,"name":"on","sectionId":null},"id":0},
   "switchSensorRef":{"id":0,"sensor":
         {"classType":"Sensor","id":1,"name":"lightsensor",
        "sensorCommandRef":{"deviceCommand":{"id":3,"name":"status","sectionId":null},"id":90,"sensor":null},"type":"SWITCH"}}
}
  • Output:json of the new switch, it has the specified id.
  • Sample Response:
    • content-type:application/json : 
           
{
   "name":"lightswitch",
   "device":{"name":"light","model":"dev","sliders":null,"vendor":"dev","id":1},
   "switchCommandOffRef":{"offSwitch":null,"deviceCommand":{"name":"off","protocol":null,"device":
        {"name":"light","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":2},"deviceName":"light","id":2},
   "switchCommandOnRef":{"onSwitch":null,"deviceCommand":{"name":"on","protocol":null,"device":
        {"name":"light","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"light","id":3},
   "switchSensorRef":{"switchToggle":null,"sensor":{"classType":"Sensor","name":"lightsensor","type":"SWITCH","sensorCommandRef":{"sensor":null,"deviceCommand":
        {"name":"status","protocol":null,"device":null,"sectionId":null,"id":3},"deviceName":null,"id":0},"device":
        {"name":"light","model":"dev","vendor":"dev","id":1},"id":1},"id":1},
   "id":1
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(46) Update a switch(support JDBC)

  • Request URL: 
     /switch/update
  • Request Method: POST
  • Parameters: switchDTO(the received SwitchDTO Object, in post content)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/switch/update
    • content-type:application/json : 
      {
   "name":"update lightswitch",
   "device":{"name":"light","model":"dev","sliders":null,"vendor":"dev","id":1},
   "switchCommandOffRef":{"offSwitch":null,"deviceCommand":{"name":"off","protocol":null,"device":
        {"name":"light","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":2},"deviceName":"light","id":2},
   "switchCommandOnRef":{"onSwitch":null,"deviceCommand":{"name":"on","protocol":null,"device":
        {"name":"light","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"light","id":3},
   "switchSensorRef":{"switchToggle":null,"sensor":{"classType":"Sensor","name":"lightsensor","type":"SWITCH","sensorCommandRef":{"sensor":null,"deviceCommand":
        {"name":"status","protocol":null,"device":null,"sectionId":null,"id":3},"deviceName":null,"id":0},"device":
        {"name":"light","model":"dev","vendor":"dev","id":1},"id":1},"id":1},
   "id":1
}
  • Output:json of the updated switch.
  • Sample Response:
    • content-type:application/json : 
           
{
   "name":"update lightswitch",
   "device":{"name":"light","model":"dev","sliders":null,"vendor":"dev","id":1},
   "switchCommandOffRef":{"offSwitch":null,"deviceCommand":{"name":"off","protocol":null,"device":
        {"name":"light","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":2},"deviceName":"light","id":2},
   "switchCommandOnRef":{"onSwitch":null,"deviceCommand":{"name":"on","protocol":null,"device":
        {"name":"light","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"light","id":3},
   "switchSensorRef":{"switchToggle":null,"sensor":{"classType":"Sensor","name":"lightsensor","type":"SWITCH","sensorCommandRef":{"sensor":null,"deviceCommand":
        {"name":"status","protocol":null,"device":null,"sectionId":null,"id":3},"deviceName":null,"id":0},"device":
        {"name":"light","model":"dev","vendor":"dev","id":1},"id":1},"id":1},
   "id":1
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(47) Delete a switch by switch id(support JDBC)

  • Request URL: 
     /switch/delete/{switch_id}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(48) Show a list of switchs under an account(support JDBC)

  • Request URL: 
     /switch/loadall/{account_id}
  • Sample Response:
    • content-type:application/json : 
           
{
"switchs":[
   {"name":"switch1",
    "device":{"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},
    "switchCommandOffRef":{"offSwitch":null,
        "deviceCommand":{"name":"cmd2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd2.com","id":2}],"id":2},"device":
        {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},"sectionId":null,"id":2},"deviceName":"DeviceWithContent","id":4},
    "switchCommandOnRef":{"onSwitch":null,
        "deviceCommand":{"name":"cmd1","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd1.com","id":1}],"id":1},"device":
        {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},"sectionId":null,"id":1},"deviceName":"DeviceWithContent","id":5},
    "switchSensorRef":{"switchToggle":null,
        "sensor":{"classType":"Sensor","name":"switchsensor","type":"SWITCH","sensorCommandRef":{"sensor":null,"deviceCommand":{"name":"cmd3","protocol":
        {"type":"HTTP","attributes":[{"name":"url","value":"http://cmd3.com","id":3}],"id":3},"device":
        {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},"sectionId":null,"id":3},"deviceName":"DeviceWithContent","id":1},"device":
        {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},"id":1},"id":1},
    "id":1}
  ]
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error code:404, Not Found. See HTTP/1.1 documentation. If can't find any switchs.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(49) Show a list of switchs, each of them has the same properties with the specified switch(support JDBC)

  • Request URL: 
     /switch/loadsameswitchs
  • Request Method: GET
  • Parameters: switchDTO(the switch to be compared, its not specified id, in post content)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/switch/loadsameswitchs
    • content-type:application/json : 
      {"name":"switch1",
    "device":{"name":"DeviceWithContent","model":"devc","vendor":"devc","id":0},
    "switchCommandOffRef":{"offSwitch":null,
        "deviceCommand":{"name":"cmd2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd2.com","id":0}],"id":0},"device":
        {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":0},"sectionId":null,"id":0},"deviceName":"DeviceWithContent","id":0},
    "switchCommandOnRef":{"onSwitch":null,
        "deviceCommand":{"name":"cmd1","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd1.com","id":0}],"id":0},"device":
        {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":0},"sectionId":null,"id":0},"deviceName":"DeviceWithContent","id":0},
    "switchSensorRef":{"switchToggle":null,
        "sensor":{"classType":"Sensor","name":"switchsensor","type":"SWITCH","sensorCommandRef":{"sensor":null,"deviceCommand":{"name":"cmd3","protocol":
        {"type":"HTTP","attributes":[{"name":"url","value":"http://cmd3.com","id":0}],"id":0},"device":
        {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":0},"sectionId":null,"id":0},"deviceName":"DeviceWithContent","id":0},"device":
        {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":0},"id":0},"id":0},
    "id":0
}
  • Output:json of a list of switchs.
  • Sample Response:
    • content-type:application/json : 
           
{
"switchs":[
   {"name":"switch1",
    "device":{"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},
    "switchCommandOffRef":{"offSwitch":null,
        "deviceCommand":{"name":"cmd2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd2.com","id":2}],"id":2},"device":
        {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},"sectionId":null,"id":2},"deviceName":"DeviceWithContent","id":4},
    "switchCommandOnRef":{"onSwitch":null,
        "deviceCommand":{"name":"cmd1","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd1.com","id":1}],"id":1},"device":
        {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},"sectionId":null,"id":1},"deviceName":"DeviceWithContent","id":5},
    "switchSensorRef":{"switchToggle":null,
        "sensor":{"classType":"Sensor","name":"switchsensor","type":"SWITCH","sensorCommandRef":{"sensor":null,"deviceCommand":{"name":"cmd3","protocol":
        {"type":"HTTP","attributes":[{"name":"url","value":"http://cmd3.com","id":3}],"id":3},"device":
        {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},"sectionId":null,"id":3},"deviceName":"DeviceWithContent","id":1},"device":
        {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},"id":1},"id":1},
    "id":1}
  ]
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error code:404, Not Found. See HTTP/1.1 documentation. If can't find any switchs.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(50) Create a new slider under an account(support JDBC)

  • Request URL: 
     /slider/save/{account_id}
  • Request Method: POST
  • Parameters: sliderDTO(the received SliderDTO Object, in post content), account_id(account id)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/slider/save/1
    • content-type:application/json : 
      {
   "device":{"id":1,"model":"dev","name":"light","vendor":"dev"},
   "id":0,
   "name":"lightcolor",
   "setValueCmd":{"deviceCommand":{"id":1,"name":"setcolor","sectionId":null},"id":0},
   "sliderSensorRef":{"id":0,"sensor":{"classType":"Sensor","id":1,"name":"colorsensor",
         "sensorCommandRef":{"deviceCommand":{"id":2,"name":"colorstatus","sectionId":null},"id":1,"sensor":null},"type":"COLOR"}}
}
  • Output:json of the new slider, it has the specified id.
  • Sample Response:
    • content-type:application/json : 
           
{
   "device":{"id":1,"model":"dev","name":"light","vendor":"dev"},
   "id":1,
   "name":"lightcolor",
   "setValueCmd":{"deviceCommand":{"id":1,"name":"setcolor","sectionId":null},"id":1},
   "sliderSensorRef":{"id":1,"sensor":{"classType":"Sensor","id":1,"name":"colorsensor",
         "sensorCommandRef":{"deviceCommand":{"id":2,"name":"colorstatus","sectionId":null},"id":1,"sensor":null},"type":"COLOR"}}
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(51) Update a slider(support JDBC)

  • Request URL: 
     /slider/update
  • Request Method: POST
  • Parameters: sliderDTO(the received SliderDTO Object, in post content)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/slider/update
    • content-type:application/json : 
      {
   "device":{"id":1,"model":"dev","name":"light","vendor":"dev"},
   "id":1,
   "name":"update lightcolor",
   "setValueCmd":{"deviceCommand":{"id":1,"name":"setcolor","sectionId":null},"id":1},
   "sliderSensorRef":{"id":1,"sensor":{"classType":"Sensor","id":1,"name":"colorsensor",
         "sensorCommandRef":{"deviceCommand":{"id":2,"name":"colorstatus","sectionId":null},"id":1,"sensor":null},"type":"COLOR"}}
}
  • Output:json of the updated slider.
  • Sample Response:
    • content-type:application/json : 
           
{
   "device":{"id":1,"model":"dev","name":"light","vendor":"dev"},
   "id":1,
   "name":"update lightcolor",
   "setValueCmd":{"deviceCommand":{"id":1,"name":"setcolor","sectionId":null},"id":1},
   "sliderSensorRef":{"id":1,"sensor":{"classType":"Sensor","id":1,"name":"colorsensor",
         "sensorCommandRef":{"deviceCommand":{"id":2,"name":"colorstatus","sectionId":null},"id":1,"sensor":null},"type":"COLOR"}}
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(52) Delete a slider by slider id(support JDBC)

  • Request URL: 
     /slider/delete/{slider_id}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(53) Show a list of sliders under an account(support JDBC)

  • Request URL: 
     /slider/loadall/{account_id}
  • Sample Response:
    • content-type:application/json : 
           
{
 "sliders":[
  {"name":"slider1",
   "device":{"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},
   "sliderSensorRef":{"slider":null,
      "sensor":{"classType":"RangeSensor","min":1,"max":100,"name":"slidersensor","type":"RANGE","sensorCommandRef":{"sensor":null,"deviceCommand":
      {"name":"cmd5","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd5.com","id":5}],"id":5},"device":
      {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},"sectionId":null,"id":5},"deviceName":"DeviceWithContent","id":2},"device":
      {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},"id":2},"id":1},
   "setValueCmd":{"slider":null,"deviceCommand":{"name":"cmd6","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd6.com","id":6}],"id":6},"device":
      {"name":"DeviceWithContent","model":"devc","vendor":"devc","id":1},"sectionId":null,"id":6},"deviceName":"DeviceWithContent","id":3},
   "id":1}
 ]
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error code:404, Not Found. See HTTP/1.1 documentation. If can't find any sliders.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(54) Show a list of sliders, each of them has the same properties with the specified slider(support JDBC)

  • Request URL: 
     /slider/loadsamesliders
  • Request Method: GET
  • Parameters: switchDTO(the switch to be compared, its not specified id, in post content)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/slider/loadsamesliders
    • content-type:application/json : 
      {
   "device":{"id":0,"model":"dev","name":"light","vendor":"dev"},
   "id":0,
   "name":"lightcolor",
   "setValueCmd":{"deviceCommand":{"id":0,"name":"setcolor","sectionId":null},"id":0},
   "sliderSensorRef":{"id":0,"sensor":{"classType":"Sensor","id":1,"name":"colorsensor",
         "sensorCommandRef":{"deviceCommand":{"id":0,"name":"colorstatus","sectionId":null},"id":0,"sensor":null},"type":"COLOR"}}
}
  • Output:json of a list of sliders.
  • Sample Response:
    • content-type:application/json : 
           
{
"sliders":[
  {"name":"lightcolor",
   "device":{"name":"light","model":"dev","vendor":"dev","id":1},
   "sliderSensorRef":{"slider":null,"sensor":{"classType":"Sensor","name":"colorsensor","type":"COLOR","sensorCommandRef":{"sensor":null,"deviceCommand":
        {"name":"colorstatus","id":2},"deviceName":"light","id":0},"device":
        {"name":"light","model":"dev","vendor":"dev","id":1},"id":1},"id":1},
   "setValueCmd":{"slider":null,"deviceCommand":{"name":"setcolor","protocol":null,"device":
        {"name":"light","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"light","id":3},
   "id":1}
 ]
}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error code:404, Not Found. See HTTP/1.1 documentation. If can't find any sliders.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(55) Create a new deviceMacro under an account(support JDBC)

  • Request URL: 
     /devicemacro/save/{account_id}
  • Request Method: POST
  • Parameters: deviceMacroDTO(the received DeviceMacroDTO Object, in post content), account_id(account id)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/slider/save/1
    • content-type:application/json : 
      {"deviceMacroItems":[{"classType":"DeviceCommandRef","deviceCommand":{"id":1,"name":"cmd1","sectionId":null},"id":0},{"classType":"CommandDelay","delaySecond":"3","id":0},{"classType":"DeviceCommandRef","deviceCommand":{"id":2,"name":"cmd2","sectionId":null},"id":0},{"classType":"CommandDelay","delaySecond":"2","id":0},{"classType":"DeviceCommandRef","deviceCommand":{"id":3,"name":"cmd3","sectionId":null},"id":0}],"id":0,"name":"macro1"}
  • Output:json of the new devicemacro, it has the specified id.
  • Sample Response:
    • content-type:application/json : 
           
{"name":"macro1","deviceMacroItems":[{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd1","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://
cmd1.com","id":1}],"id":1},"device":{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"device1","parentDeviceMacro":
{"name":"macro1","deviceMacroItems":[],"account":null,"id":1},"id":1},{"classType":"CommandDelay","delaySecond":"3","parentDeviceMacro":{"name":"macro1","deviceMacroItems":
[],"account":null,"id":1},"id":2},{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://
cmd2.com","id":2}],"id":2},"device":{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":2},"deviceName":"device1","parentDeviceMacro":
{"name":"macro1","deviceMacroItems":[],"account":null,"id":1},"id":3},{"classType":"CommandDelay","delaySecond":"2","parentDeviceMacro":{"name":"macro1","deviceMacroItems":
[],"account":null,"id":1},"id":4},{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd3","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://
cmd3.com","id":3}],"id":3},"device":{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":3},"deviceName":"device1","parentDeviceMacro":
{"name":"macro1","deviceMacroItems":[],"account":null,"id":1},"id":5}],"account":{"id":1},"id":1}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(56) Update a devicemacro(support JDBC)

  • Request URL: 
     /devicemacro/update
  • Request Method: POST
  • Parameters: deviceMacroDTO(the received DeviceMacroDTO Object, in post content)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/devicemacro/update
    • content-type:application/json : 
      {"name":"update macro1","deviceMacroItems":[{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd1","protocol":{"type":"HTTP","attributes":
[{"name":"url","value":"http://cmd1.com","id":1}],"id":1},"device":
{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"device1","parentDeviceMacro":
{"name":"macro1","deviceMacroItems":[],"account":null,"id":1},"id":1},{"classType":"CommandDelay","delaySecond":"3","parentDeviceMacro":{"name":"macro1","deviceMacroItems":
[],"account":null,"id":1},"id":2},{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://
cmd2.com","id":2}],"id":2},"device":
{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":2},"deviceName":"device1","parentDeviceMacro":
{"name":"macro1","deviceMacroItems":[],"account":null,"id":1},"id":3},{"classType":"CommandDelay","delaySecond":"2","parentDeviceMacro":{"name":"macro1","deviceMacroItems":
[],"account":null,"id":1},"id":4},{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd3","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://
cmd3.com","id":3}],"id":3},"device":
{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":3},"deviceName":"device1","parentDeviceMacro":
{"name":"macro1","deviceMacroItems":[],"account":null,"id":1},"id":5}],"account":{"id":1},"id":1}
  • Output:json of the updated devicemacro.
  • Sample Response:
    • content-type:application/json : 
           
{"name":"update macro1","deviceMacroItems":[{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd1","protocol":{"type":"HTTP","attributes":
[{"name":"url","value":"http://cmd1.com","id":1}],"id":1},"device":
{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"device1","parentDeviceMacro":
{"name":"macro1","deviceMacroItems":[],"account":null,"id":1},"id":1},{"classType":"CommandDelay","delaySecond":"3","parentDeviceMacro":{"name":"macro1","deviceMacroItems":
[],"account":null,"id":1},"id":2},{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://
cmd2.com","id":2}],"id":2},"device":
{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":2},"deviceName":"device1","parentDeviceMacro":
{"name":"macro1","deviceMacroItems":[],"account":null,"id":1},"id":3},{"classType":"CommandDelay","delaySecond":"2","parentDeviceMacro":{"name":"macro1","deviceMacroItems":
[],"account":null,"id":1},"id":4},{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd3","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://
cmd3.com","id":3}],"id":3},"device":
{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":3},"deviceName":"device1","parentDeviceMacro":
{"name":"macro1","deviceMacroItems":[],"account":null,"id":1},"id":5}],"account":{"id":1},"id":1}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(57) Delete a devicemacro by macro id(support JDBC)

  • Request URL: 
     /devicemacro/delete/{macro_id}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(58) Show deviceMacroItems under a deviceMacro by macro id(support JDBC)

  • Request URL: 
     /devicemacro/loaditemsbyid/{macro_id}
  • Sample Response:
    • content-type:application/json : 
           
{"deviceMacroItems":[{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd1","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://
cmd1.com","id":1}],"id":1},"device":{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"device1","parentDeviceMacro":
{"name":"update macro1","deviceMacroItems":[],"account":null,"id":1},"id":6},{"classType":"CommandDelay","delaySecond":"3","parentDeviceMacro":{"name":"update 
macro1","deviceMacroItems":[],"account":null,"id":1},"id":7},{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd2","protocol":{"type":"HTTP","attributes":
[{"name":"url","value":"http://cmd2.com","id":2}],"id":2},"device":
{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":2},"deviceName":"device1","parentDeviceMacro":{"name":"update macro1","deviceMacroItems":
[],"account":null,"id":1},"id":8},{"classType":"CommandDelay","delaySecond":"2","parentDeviceMacro":{"name":"update macro1","deviceMacroItems":
[],"account":null,"id":1},"id":9},{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd3","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://
cmd3.com","id":3}],"id":3},"device":{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":3},"deviceName":"device1","parentDeviceMacro":
{"name":"update macro1","deviceMacroItems":[],"account":null,"id":1},"id":10}]}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error code:404, Not Found. See HTTP/1.1 documentation. If can't find any macro items.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(59) Show deviceMacros under an account(support JDBC)

  • Request URL: 
     /devicemacro/loadall/{account_id}
  • Sample Response:
    • content-type:application/json : 
           
{"deviceMacros":[{"name":"macro1","deviceMacroItems":[{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd1","protocol":{"type":"HTTP","attributes":
[{"name":"url","value":"http://cmd1.com","id":1}],"id":1},"device":
{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"device1","parentDeviceMacro":{"name":"macro1","deviceMacroItems":
[],"account":null,"id":1},"id":1},{"classType":"CommandDelay","delaySecond":"3","parentDeviceMacro":{"name":"macro1","deviceMacroItems":[],"account":null,"id":1},"id":2},
{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd2.com","id":2}],"id":2},"device":
{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":2},"deviceName":"device1","parentDeviceMacro":{"name":"macro1","deviceMacroItems":
[],"account":null,"id":1},"id":3},{"classType":"CommandDelay","delaySecond":"2","parentDeviceMacro":{"name":"macro1","deviceMacroItems":[],"account":null,"id":1},"id":4},
{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd3","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd3.com","id":3}],"id":3},"device":
{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":3},"deviceName":"device1","parentDeviceMacro":{"name":"macro1","deviceMacroItems":
[],"account":null,"id":1},"id":5}],"account":{"id":1},"id":1}]}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error code:404, Not Found. See HTTP/1.1 documentation. If can't find any macros.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(60) Show a list of devicemacros, each of them has the same properties with the specified devicemacaro(support JDBC)

  • Request URL: 
     /devicemacro/loadsamemacros/{account_id}
  • Request Method: GET
  • Parameters: deviceMacroDTO(the deviceMacro to be compared, its not specified id, in post content), account_id(account id)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/devicemacro/loadsamemacros/1
    • content-type:application/json : 
      {"name":"macro1","deviceMacroItems":[{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd1","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://
cmd1.com","id":1}],"id":1},"device":{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":1},"deviceName":"device1","parentDeviceMacro":
{"name":"macro1","id":1},"id":1},{"classType":"CommandDelay","delaySecond":"3","parentDeviceMacro":{"name":"macro1","id":1},"id":2},
{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd2","protocol":{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd2.com","id":2}],"id":2},"device":
{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":2},"deviceName":"device1","parentDeviceMacro":{"name":"macro1","id":1},"id":3},
{"classType":"CommandDelay","delaySecond":"2","parentDeviceMacro":{"name":"macro1","id":1},"id":4},{"classType":"DeviceCommandRef","deviceCommand":{"name":"cmd3","protocol":
{"type":"HTTP","attributes":[{"name":"url","value":"http://cmd3.com","id":3}],"id":3},"device":
{"name":"device1","model":"dev","vendor":"dev","id":1},"sectionId":null,"id":3},"deviceName":"device1","parentDeviceMacro":{"name":"macro1","id":1},"id":5}],"account":
{"id":1},"id":1}
  • Output:json of a list of devicemacros.
  • Sample Response:
    • content-type:application/json : 
           
{"deviceMacros":[{"name":"macro1","deviceMacroItems":[],"account":null,"id":1}]}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error code:404, Not Found. See HTTP/1.1 documentation. If can't find any devicemacros.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(61) Save default controllerConfigs under an account, it will be call when create the new Account(support JDBC)

  • Request URL: 
     /controllerconfig/savedefault/{account_id}
  • Request Method: POST
  • Parameters: controllerListing(include a list of controllerConfigs, in post content), account_id(account id)
  • Sample Request Url:http://localhost:8080/beehive/rest/controllerconfig/savedefault/1
    • content-type:application/json : 
      {"controllerConfigs":[{"category":"roundrobin","id":0,"name":"controller.roundrobin.tcpserver.port","value":"20000"},
{"category":"advance","id":0,"name":"multicast.address","value":"224.0.1.100"},
{"category":"roundrobin","id":0,"name":"controller.roundrobin.multicast.port","value":"10000"},
{"category":"advance","id":0,"name":"multicast.port","value":"3333"},{"category":"roundrobin","id":0,"name":"controller.groupname","value":"floor20"},
{"category":"macro","id":0,"name":"Macro.IR.Execution.Delay","value":"500"},
{"category":"roundrobin","id":0,"name":"controller.roundrobin.multicast.address","value":"224.0.1.200"},{"category":"infrared","id":0,"name":"lircd.conf.path","value":"/etc/
lircd.conf"},{"category":"roundrobin","id":0,"name":"controller.groupmember.autodetect.on","value":"true"},
{"category":"discovery","id":0,"name":"webapp.port","value":"8080"},{"category":"infrared","id":0,"name":"copy.lircd.conf.on","value":"true"},
{"category":"infrared","id":0,"name":"irsend.path","value":"/usr/local/bin/irsend"},{"category":"security","id":0,"name":"resource.upload.enable","value":"true"},
{"category":"advance","id":0,"name":"controller.applicationname","value":"controller"}]}
  • Output:true.
  • Errors:
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(62) Show a list of controllerConfigs under an account by categoryName(support JDBC)

  • Request URL: 
     /controllerconfig/load/{account_id}/{catagory_name}
  • Sample Response:
    • content-type:application/json : 
           
{"controllerConfigs":[{"name":"controller.roundrobin.tcpserver.port","value":"20000","category":"roundrobin","id":1},
{"name":"controller.roundrobin.multicast.port","value":"10000","category":"roundrobin","id":3},
{"name":"controller.groupname","value":"floor20","category":"roundrobin","id":5},
{"name":"controller.roundrobin.multicast.address","value":"224.0.1.200","category":"roundrobin","id":7},
{"name":"controller.groupmember.autodetect.on","value":"true","category":"roundrobin","id":9}]}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(63) Save or update a list of controllerConfigs into an account(support JDBC)

  • Request URL: 
     /controllerconfig/saveall/{account_id}
  • Request Method: POST
  • Parameters: controllerListing(include a list of controllerConfigs, in post content), account_id(account id)
  • HTTP basic header Authorization : "Basic base64(username:password)"
  • Sample Request Url:http://localhost:8080/beehive/rest/controllerconfig/saveall/1
    • content-type:application/json : 
      {"controllerConfigs":[{"category":"roundrobin","id":1,"name":"controller.roundrobin.tcpserver.port","value":"20000"},
{"category":"roundrobin","id":3,"name":"controller.roundrobin.multicast.port","value":"10000"},
{"category":"roundrobin","id":5,"name":"controller.groupname","value":"floor20"},
{"category":"roundrobin","id":7,"name":"controller.roundrobin.multicast.address","value":"224.0.1.200"},
{"category":"roundrobin","id":9,"name":"controller.groupmember.autodetect.on","value":"false"}]}
  • Output:json of the controllerConfigs, it has the specified id.
  • Sample Response:
    • content-type:application/json : 
           
{"controllerConfigs":[{"name":"controller.roundrobin.tcpserver.port","value":"20000","category":"roundrobin","id":1},
{"name":"controller.roundrobin.multicast.port","value":"10000","category":"roundrobin","id":3},
{"name":"controller.groupname","value":"floor20","category":"roundrobin","id":5},
{"name":"controller.roundrobin.multicast.address","value":"224.0.1.200","category":"roundrobin","id":7},
{"name":"controller.groupmember.autodetect.on","value":"false","category":"roundrobin","id":9}]}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

(64) Show all controllerConfigs under an account(support JDBC)

  • Request URL: 
     /controllerconfig/loadall/{account_id}
  • Sample Response:
    • content-type:application/json : 
           
{"controllerConfigs":[{"name":"controller.roundrobin.tcpserver.port","value":"20000","category":"roundrobin","id":1},
{"name":"multicast.address","value":"224.0.1.100","category":"advance","id":2},{"name":"controller.roundrobin.multicast.port","value":"10000","category":"roundrobin","id":3},
{"name":"multicast.port","value":"3333","category":"advance","id":4},{"name":"controller.groupname","value":"floor20","category":"roundrobin","id":5},
{"name":"Macro.IR.Execution.Delay","value":"500","category":"macro","id":6},
{"name":"controller.roundrobin.multicast.address","value":"224.0.1.200","category":"roundrobin","id":7},{"name":"lircd.conf.path","value":"/etc/
lircd.conf","category":"infrared","id":8},{"name":"controller.groupmember.autodetect.on","value":"true","category":"roundrobin","id":9},
{"name":"webapp.port","value":"8080","category":"discovery","id":10},{"name":"copy.lircd.conf.on","value":"true","category":"infrared","id":11},
{"name":"irsend.path","value":"/usr/local/bin/irsend","category":"infrared","id":12},{"name":"resource.upload.enable","value":"true","category":"security","id":13},
{"name":"controller.applicationname","value":"controller","category":"advance","id":14}]}
  • Errors:
    • Error code:401, unauthorized. See HTTP/1.1 documentation.
    • Error Code:500, Server error. See HTTP/1.1 documentation.

Use JSONP format

JSON-P is a method of wrapping the JSON output of API calls to allow other developers to call cross site. To use JSON-P, developer should include a 'callback' as request parameter like this: http://localhost:8080/beehive/rest/lirc?callback=aaa
then response will be :

aaa && aaa({"vendors":[{"id":1,"name":"3m"},{"id":2,"name":"abit"}]})
 
Labels:

Added by Tomsky Wang

Last edit by Tomsky Wang on Feb 28, 2011 10:09
Adaptavist Theme Builder Powered by Atlassian Confluence
Free theme builder license