Create Virtual Devices

POST /engage/devices/virtual/site/{siteReference}

This API registers a list of virtual devices for a given site. Each list entry contains the name for each virtual device.

NOTE: Each POST request overwrites any previously existing virtual devices. To delete all current entries, send an empty array to that endpoint. Removing virtual devices from a site does not affect devices that have already been commissioned to that site.

Authentication

Basic Authentication, must be a partner managed account type

URI Parameters

• siteReference = string (required)
  • Reference ID of the site

Body Parameters

• Type: application/json
  • name = string (required)
    • A pre-determined device name (friendly name) to be commissioned by the user This field must be less than 32 ASCII characters
    • Empty or white space entries will be ignored
    • Duplicate name entries will be ignored
    • Names which have already been commissioned to this site will be ignored

Example Request:

POST //engage/devices/virtual/site/670dea61-d638-ffff-bffe-e5ffca3e9601 HTTP/1.1
Host: partner.lockwebserv.com
Authorization: Basic c2FtcGxlVXNlck5hbWU0X0FQSWRvY0BnbWFpbC5jb206cEFzU3cwckQhIw==
Content-Type: application/json
[
{"name":"Conference Room 1A"},
{"name":"Front Entry"}
]

Example Response:

HTTP status code 201

• Created

Body

• Type: application/json

Example

• "2 virtual devices have been added."