XOMNI: Experience Omni-Channel

Last Updated: March 31, 2016

This API enables a client application to fetch an existing logical device by its unique device ID and related physical device ID.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/management/company/physicaldevices/{physicalDeviceId}/logicaldevices/{logicalDeviceId}

URI Parameters

Parameter Name Description Type Conditions
logicalDeviceId Globally unique identifier of the logical device String
physicalDeviceId Globally unique identifier of the physical device Number

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

{
   "RelatedPhysicalDeviceId":7,
   "RelatedPhysicalDeviceDescription":"Test Device",
   "DeviceTypeId":1,
   "DeviceTypeDescription":"InStore",
   "ExpirationDate":"2014-08-08T13:18:45.473",
   "DeviceId":"f98d0f51-d748-442a-88eb-ffbd4ee3d626",
   "Description":"Test Device"
}

Response Body Description

Parameter Name Description Type
RelatedPhysicalDeviceId Unique ID of the related physical device. String
RelatedPhysicalDeviceDescription Description of the related physical device. String
DeviceId Unique ID of the device. String
Description Description of the device. String
DeviceTypeId Unique ID of the device type. Number
DeviceTypeDescription Description of the device type. String
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. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) Device not found.