XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API enables a client application to assign a logical device information to a specific physical device which is represented through the header of the request.

Request

{
  "DeviceId": "597edb28-7244-4fd7-a298-5be276de4f65",
  "Description": "Test Device",
  "DeviceTypeId": 1,
  "ExpirationDate": "2014-11-19T15:14:57.2212844+02:00",
   "IsRealtimeEnabled": true
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/company/logicaldevices

Request Body Description

Parameter Name Description Type Conditions
IsRealtimeEnabled A boolean filed indicating whether the logical device has realtime capabilities or not. Unknown
RealtimeHostUrl Realtime endpoint host url. String
RealtimeAccessKey Realtime endpoint access key. String
DeviceId Unique ID of the device. String
Description Description of the device. String
Required: Yes
DeviceTypeId Unique ID of the device type. Number
DeviceTypeDescription Description of the device type. String
ExpirationDate Expiration date of the device. Date
Metadata[0..N].Key The key for the metadata. String
Metadata[0..N].Value The value of the metadata. String

Request Headers

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

Response

{
   "Data":{
      "DeviceId":"e4ded600-5faa-46fa-b7d9-7dde44725dfa",
      "Description":"Test Device",
      "DeviceTypeId":1,
      "DeviceTypeDescription":"Kiosk",
      "ExpirationDate":"2014-11-19T15:17:17.2730996+02:00",
      "Metadata":[

      ],
      "IsRealtimeEnabled":true
   }
}

Response Body Description

Parameter Name Description Type
Description Description of the device. String
Key The key for the metadata. String
Value The value of the metadata. String
IsRealtimeEnabled A boolean filed indicating whether the logical device has realtime capabilities or not. Unknown
RealtimeHostUrl Realtime endpoint host url. String
RealtimeAccessKey Realtime endpoint access key. String
DeviceId Unique ID 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 POST operations. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) DeviceId and Description are required