XOMNI: Experience Omni-Channel

Last Updated: February 19, 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"
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/company/logicaldevices

Request Body Description

Parameter Name Description Type Conditions
ExpirationDate Expiration date of the device. Date
DeviceId Globally unique identifier of the device. String
Description Description of the device. String
Required: Yes
DeviceTypeId Unique ID of the device type ID. 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

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

      ]
   }
}

Response Body Description

Parameter Name Description Type
Data.ExpirationDate Expiration date of the device. Date
Data.DeviceId Globally unique identifier of the device. String
Data.Description Description of the device. String
Data.DeviceTypeId Unique ID of the device type ID. Number
Data.DeviceTypeDescription Description of the device type. String
Data.Metadata[0..N].Key The key for the metadata. String
Data.Metadata[0..N].Value The value of the metadata. String

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