XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API allows a client application to retrieve a full list of dynamic attributes.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/catalog/dynamicattributes?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": [
            {
                "TypeId": 1,
                "TypeValueId": 1,
                "Value": "Red",
                "TypeName": "Color"
            },
            {
                "TypeId": 1,
                "TypeValueId": 2,
                "Value": "Blue",
                "TypeName": "Color"
            },
            {
                "TypeId": 1,
                "TypeValueId": 3,
                "Value": "Green",
                "TypeName": "Color"
            },
            {
                "TypeId": 2,
                "TypeValueId": 4,
                "Value": "M",
                "TypeName": "Size"
            },
            {
                "TypeId": 2,
                "TypeValueId": 5,
                "Value": "L",
                "TypeName": "Size"
            },
            {
                "TypeId": 2,
                "TypeValueId": 6,
                "Value": "XL",
                "TypeName": "Size"
            },
            {
                "TypeId": 3,
                "TypeValueId": 7,
                "Value": "A",
                "TypeName": "Style"
            },
            {
                "TypeId": 3,
                "TypeValueId": 8,
                "Value": "B",
                "TypeName": "Style"
            },
            {
                "TypeId": 2,
                "TypeValueId": 9,
                "Value": "S",
                "TypeName": "Size"
            }
        ],
        "TotalCount": 9
    }
}

Response Body Description

Parameter Name Description Type
Data.TotalCount Total count of the dynamic attributes in filtered collection without paging. Number
Data.Results[0..N].TypeId Unique ID of a dynamic field. Number
Data.Results[0..N].TypeValueId Unique ID of a dynamic field value. Number
Data.Results[0..N].Value Value of a dynamic field. String
Data.Results[0..N].TypeName Unique name of a dynamic field. 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
400 (Bad Request) Skip and/or take parameters are malformed.