XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The dimension type management systems provides APIs to get a single dimension type from the backend.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/dimensiontype?dimensionTypeId={dimensionTypeId}

URI Parameters

Parameter Name Description Type Conditions
dimensionTypeId The unique Id of a dimension type. Number

Request Headers

Header Field Name Description
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

{
    "Id":3,
    "Description":" Sample Dimension Type Description 3"
}

Response Body Description

Parameter Name Description Type
Id This is the unique ID for a dimension type. Number
Description The description of the dimension 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. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) No dimension type found for given dimension type ID.