XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

This API allows a client application to retrieve distinct values of the specified dynamic attribute type.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/catalog/dynamicattributes/{dynamicAttributeTypeId}

URI Parameters

Parameter Name Description Type Conditions
dynamicAttributeTypeId The unique ID of the dynamic attribute type. Number

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
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": [
        {
            "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": 2,
            "TypeValueId": 9,
            "Value": "S",
            "TypeName": "Size"
        }
    ]
}

Response Body Description

Parameter Name Description Type
Data[0..N].TypeId Unique ID of a dynamic field. Number
Data[0..N].TypeValueId Unique ID of a dynamic field value. Number
Data[0..N].Value Value of a dynamic field. String
Data[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
404 (Not Found) Dynamic attribute could not be found.