XOMNI: Experience Omni-Channel

Last Updated: March 31, 2016

This API enables a client application to fetch a list of logical devices.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/management/company/physicaldevices/{physicalDeviceId}/logicaldevices?skip={skip}&take={take}

URI Parameters

Parameter Name Description Type Conditions
skip The number of items in the collection to skip before executing a select. Number
take The number of items that should be fetched from the collection. Number
physicalDeviceId Globally unique identifier of the physical device String

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da

Response

{
   "Results":[
      {
         "RelatedPhysicalDeviceId":7,
         "RelatedPhysicalDeviceDescription":"Test Device",
         "DeviceTypeId":1,
         "DeviceTypeDescription":"InStore",
         "ExpirationDate":null,
         "DeviceId":"18b808c3-d3ef-4fc3-a3c6-c773d3fd2b8f",
         "Description":"Test Device 1"
      },
      {
         "RelatedPhysicalDeviceId":7,
         "RelatedPhysicalDeviceDescription":"Test Device 2",
         "DeviceTypeId":1,
         "DeviceTypeDescription":"InStore",
         "ExpirationDate":null,
         "DeviceId":"ed4c7d90-1f7d-46fe-8db1-76812e26aa94",
         "Description":"Test Device 2"
      },
      {
         "RelatedPhysicalDeviceId":7,
         "RelatedPhysicalDeviceDescription":"Test Device 3",
         "DeviceTypeId":1,
         "DeviceTypeDescription":"InStore",
         "ExpirationDate":"2014-08-08T12:56:46.217",
         "DeviceId":"7f83fd6f-0ff8-4a21-b6df-e6da6562b500",
         "Description":"Test Device 3"
      }
   ],
   "TotalCount":3
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of logical devices in the filtered collection without paging. Number
Results[0..N].RelatedPhysicalDeviceId Unique ID of the related physical device. String
Results[0..N].RelatedPhysicalDeviceDescription Description of the related physical device. String
Results[0..N].DeviceId Unique ID of the device. String
Results[0..N].Description Description of the device. String
Results[0..N].DeviceTypeId Unique ID of the device type. Number
Results[0..N].DeviceTypeDescription Description of the device type. String
Results[0..N].ExpirationDate Expiration date of the device. Date

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for GET operations.