XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API allows a client application to retrieve a list of key/value metadata pairs for a particular category. The metadata may be used to store contextual and optional data about a category.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/catalog/categorymetadata?categoryId={categoryId}

URI Parameters

Parameter Name Description Type Conditions
categoryId The unique ID of the category. Number

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": "categorymetadatakey1",
            "Value": "categorymetadatavalue1",
        },
        {
            "Key": "categorymetadatakey2",
            "Value": "categorymetadatavalue2",
        }
    ]
}

Response Body Description

Parameter Name Description Type
Data[0..N].Key The key for the metadata. String
Data[0..N].Value The value of the metadata. 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) CategoryId is malformed.
404 (Not Found) No metadata found for the given category.
404 (Not Found) Given category ID not found.