XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API returns specified logical device storage data collection.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/company/logicaldevices/{deviceId}/storage?key={key}&delete={delete}

URI Parameters

Parameter Name Description Type Conditions
deviceId Id of the device String
Key The filtering key for the device storage. String
Delete A boolean flag for delete retrieved data in a single tranction. Bool

Request Headers

Header Field Name Description
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

{  
   "Data":[  
      {  
         "DeviceId":"9ead1d3d-28c1-4dc4-b99e-3542401c9f77",
         "Key":"SampleKey",
         "Value":"SampleValue",
         "IsPublic":true
      },
      {  
         "DeviceId":"9ead1d3d-28c1-4dc4-b99e-3542401c9f77",
         "Key":"SampleKey1",
         "Value":"SampleValue",
         "IsPublic":true
      }
   ]
}

Response Body Description

Parameter Name Description Type
Data[0..N].IsPublic A Boolean field indicating whether the data storage item is accessable from other devices or not. Boolean
Data[0..N].DeviceId Id of the device String
Data[0..N].Key Data storage key. String
Data[0..N].Value Data storage value. 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
403 (Forbidden) Device storage item that you're trying to access is private.
404 (Not Found) Specified device not found.
404 (Not Found) Specified device does not have any storage data.