XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API enables the client to update the specific logical device information through an HTTP PATCH request. You can omit the fields of the request body as you are using the PATCH HTTP method.

Request

{
    "Description": "sample description",
    "ExpirationDate": "2012-02-18T00:54:06.8447642Z"
}
HTTP Method Resource URI
PATCH https://{tenantName}.api.xomni.com/company/logicaldevices/{deviceId}

URI Parameters

Parameter Name Description Type Conditions
deviceId The Id of the device which is going to be updated. String

Request Body Description

Parameter Name Description Type Conditions
ExpirationDate Expiration date of the device. Date
Description Description of the device String
IsRealtimeEnabled A boolean filed indicating whether the logical device has realtime capabilities or not. boolean

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, */*

Response

{
   "Data":{
      "DeviceId":"1121",
      "Description": "sample description",
      "DeviceTypeId":21,
      "DeviceTypeDescription": "device type description",
      "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 PATCH operations. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) DeviceId is required.
404 (Not Found) Specified device not found.