XOMNI: Experience Omni-Channel

Last Updated: April 22, 2016

This API enables a client application to create a new physical device.

Request

{
      "DeviceId":"TestDevice",
      "Description":"Test Store",
      "StoreId":1
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/management/company/physicaldevices

Request Body Description

Parameter Name Description Type Conditions
DeviceId Unique ID of the physical device. String
Required
StoreId Unique ID of the store where physical device is used. Number
Description Description 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

{
   "DeviceId":"TestDevice",
   "Description":"Test Store",
   "StoreId":1,
   "StoreName":"Test"
}

Response Body Description

Parameter Name Description Type
DeviceId Unique ID of the physical device. String
StoreId Unique ID of the store where physical device is used. Number
Description Description of the physical device. String
StoreName Name of the store where physical device is used. 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
409 (Conflict) Device already exists.