XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The APIs can be used to create relationships between assets and brands. Using this API, you can assign a video to a brand.

Request

{
    "TempAssetId":179,
    "ContentMimeType":"image/jpeg",
    "IsDefault":true
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/private/catalog/brands/{brandId}/video

URI Parameters

Parameter Name Description Type Conditions
brandId The unique ID of a brand. Number

Request Body Description

Parameter Name Description Type Conditions
TempAssetId This is the unique ID of an asset in the temporary storage. You can get this id from Storage File Upload APIs. Number
Required
ContentMimeType Mime type of given asset. This value will be in the HTTP header of asset url. String
Required
IsDefault Boolean field indicating if this asset is the default asset of the relationship member or not. Unknown

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

{
    "AssetId":179,
    "RelatedId":1,
    "IsDefault":true
}

Response Body Description

Parameter Name Description Type
AssetId The unique ID of the created asset. Number
RelatedId The unique ID of the relationship member. Brand ID, Category ID or Item ID. Number
IsDefault Boolean field indicating if this asset is the default asset of the relationship member or not. Boolean

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 POST operations. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) Given asset already related with given brand.
404 (Not Found) Given asset or brand could not be found in temporary storage
409 (Conflict) Given asset has different content type than given type.