XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API returns a list of logical device types.

Request

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

URI Parameters

Parameter Name Description Type Conditions
skip The number of items in the collection to skip before executing a select. Number
take The number of items that should be fetched from the collection. Number

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
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":{
      "Results":[
         {
            "Id":1,
            "Description":"InStore"
         },
         {
            "Id":2,
            "Description":"Consumer"
         }
      ],
      "TotalCount":2
   }
}

Response Body Description

Parameter Name Description Type
Data.TotalCount Total count of device types in the filtered collection without paging. Number
Data.Results[0..N].Id Unique ID of the device type Number
Data.Results[0..N].Description Description of the device type. 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.