Get Virtual Devices

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

This API retrieves a list of virtual devices for a given site.

Authentication

Basic Authentication, must be a partner managed account type.

URI Parameters

• siteReference = string (required)

  • Reference ID of the site

• page = integer (optional)

  • The specific page in the device collection. If not specified, value is assumed to be 1.

• items = integer (optional)

  • The number of virtual device records to return per page. If not specified, value is assumed to be 5000.

Body Parameters

• None

Example Request:

GET //engage/devices/virtual/site/670dea61-d638-ffff-bffe-e5ffca3e9601 HTTP/1.1
Host: partner.lockwebserv.com
Authorization: Basic c2FtcGxlVXNlck5hbWU0X0FQSWRvY0BnbWFpbC5jb206cEFzU3cwckQhIw==

Response

HTTP status code 200

• OK

Body

• Type: application/json

  NOTE: Entries are sorted alphabetically by name.

Parameters

• “CreatedUtcTicks” = integer

  • The value of this property represents the number of 100-nanosecond intervals that have elapsed since 12:00:00 midnight, January 1, 0001 (0:00:00 UTC on January 1, 0001, in the Gregorian calendar)
  • Refer to the official Microsoft documentation for more information: Microsoft
  • This link: Readable Timestamp can be used to convert to a human readable timestamp

• “Name” = string

  • The “name” of the device from the POST request
  • Entries are sorted alphabetically by name

Example:

[
 {
  "CreatedUtcTicks": 636288574297046848,
  "Name": "Conference Room 1A"
 },
 {
  "CreatedUtcTicks": 636288574297046848,
  "Name": "Front Entry"
 }
]