XOMNI: Experience Omni-Channel

Last Updated: April 22, 2016

This API enables a client application to fetch a list of physical devices.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/management/company/physicaldevices?skip={skip}&take={take}&hasStoreRelation={hasStoreRelation}

URI Parameters

Parameter Name Description Type Conditions
take The number of items that should be fetched from the collection. Number
Max Value:1000
skip The number of items in the collection to skip before executing a select. Number
hasStoreRelation A boolean filed indicating whether the response contains physical devices have store relation. Bool
Optional

Request Headers

Header Field Name Description
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

{
   "Results":[
      {
         "DeviceId":"TestDevice",
         "Description":"Test Store",
         "StoreId":1,
         "StoreName":"Test"
      }
   ],
   "TotalCount":3
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of physical devices in the filtered collection without paging. Number
Results[0..N].DeviceId Unique ID of the physical device. String
Results[0..N].StoreId Unique ID of the store where physical device is used. Number
Results[0..N].Description Description of the physical device. String
Results[0..N].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 GET operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) No physical devices found.