XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

This API allows a client application to fetch a list of logical devices in a store which the physical device, retrieved through the OAuth Token, is assigned to with device type and metadata key-value based filtering option.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/company/stores/logicaldevices?deviceTypeId={deviceTypeId}&metadataKey={metadataKey}&metadataValue={metadataValue}&includeMetadata={includeMetadata}

URI Parameters

Parameter Name Description Type Conditions
deviceTypeId Id of the device. Number
metadataKey Key of the device metadata. String
metadataValue Value of the device metadata. String
includeMetadata Indicates if the result set should contain device metadata or not. Boolean

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

{
   "Data":[
      {
         "DeviceTypeId":1,
         "DeviceTypeDescription":"InStore",
         "ExpirationDate":null,
         "DeviceId":"18b808c3-d3ef-4fc3-a3c6-c773d3fd2b8f",
         "Description":"Test Device 1",
         "Metadata":[
            {
               "Key":"Sample metadata key 1",
               "Value":"Sample metadata value 3"
            },
            {
               "Key":"Sample metadata key 2",
               "Value":"Sample metadata value 2"
            },
            {
               "Key":"Sample metadata key 3",
               "Value":"Sample metadata value 3"
            }
         ]
      },
      {
         "DeviceTypeId":1,
         "DeviceTypeDescription":"InStore",
         "ExpirationDate":null,
         "DeviceId":"ed4c7d90-1f7d-46fe-8db1-76812e26aa94",
         "Description":"Test Device 2",
         "Metadata":[
            {
               "Key":"Sample metadata key 1",
               "Value":"Sample metadata value 3"
            },
            {
               "Key":"Sample metadata key 2",
               "Value":"Sample metadata value 2"
            },
            {
               "Key":"Sample metadata key 3",
               "Value":"Sample metadata value 3"
            }
         ]
      },
      {
         "DeviceTypeId":1,
         "DeviceTypeDescription":"InStore",
         "ExpirationDate":"2014-08-08T12:56:46.217",
         "DeviceId":"7f83fd6f-0ff8-4a21-b6df-e6da6562b500",
         "Description":"Test Device 3",
         "Metadata":[
            {
               "Key":"Sample metadata key 1",
               "Value":"Sample metadata value 3"
            },
            {
               "Key":"Sample metadata key 2",
               "Value":"Sample metadata value 2"
            },
            {
               "Key":"Sample metadata key 3",
               "Value":"Sample metadata value 3"
            }
         ]
      }
   ]
}

Response Body Description

Parameter Name Description Type
Data[0..N].ExpirationDate Expiration date of the device. Date
Data[0..N].DeviceId Globally unique identifier of the device. String
Data[0..N].Description Description of the device. String
Data[0..N].DeviceTypeId Unique ID of the device type ID. Number
Data[0..N].DeviceTypeDescription Description of the device type. String
Data[0..N].Metadata[0..N].Key The key for the metadata. String
Data[0..N].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 GET operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) Used physical device does not have an assigned store
404 (Not Found) No device information has been found