XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API returns specified store storage data collection.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com /company/stores/{storeId}/storage?key={key}

URI Parameters

Parameter Name Description Type Conditions
storeId Id of the store. Integer
key The filtering key for the store storage. String

"current" magic word can be used for storeId parameter to point the store attached to licence.

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":[  
      {  
         "Key":"SampleKey",
         "Value":"SampleValue",
         "IsPublic":true,
         "StoreId":1,
         "TimeStamp":"YXJtdXQ="
      },
      {  
         "Key":"SampleKey1",
         "Value":"SampleValue1",
         "IsPublic":false,
         "StoreId":1,
         "TimeStamp":"YXJtdXQ="
      }
   ]
}

Response Body Description

Parameter Name Description Type
Data[0..N].StoreId Id of the store. Number
Data[0..N].Key Data storage key. String
Data[0..N].Value Data storage value. String
Data[0..N].IsPublic A Boolean field indicating whether the data storage item is accessable from other devices or not. Boolean
Data[0..N].TimeStamp Timestamp value for concurrency support. Array

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) Store storage item is private. Only related licence can access this item.
404 (Not Found) Specified store storage is empty.