XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API provides a way to fetch comments by their creation date.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/social/comments?createdOADate={createdOADate}&skip={skip}&take={take}

URI Parameters

Parameter Name Description Type Conditions
createdOADate An OleAutomation Date defining a date without time precision. Number
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
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

{
    "Results": [
        {
            "TargetPostId": 16,
            "TargetCommentId": 0,
            "Id": 14,
            "CreatedDate": "2013-08-14T14:07:54.813",
            "Content": "Sample comment content for test 8bb9579c-f1fa-4fe3-8b0e-5c061b0ba518",
            "RelatedItemId": 5,
            "AvailablePlatforms": [
                {
                    "Platform": "Facebook",
                    "Status": "Succeed",
                    "Author": "Test User",
                    "AuthorPictureUrl": "http://graph.facebook.com/100005333233573/picture"
                }
            ]
        },
        {
            "TargetPostId": 16,
            "TargetCommentId": 0,
            "Id": 34,
            "CreatedDate": "2013-04-12T15:03:25.223",
            "Content": "Sample comment content for test 8bb9579c-f1fa-4fe3-8b0e-5c061b0ba518",
            "RelatedItemId": 5,
            "AvailablePlatforms": [
                {
                    "Platform": "Facebook",
                    "Status": "Succeed",
                    "Author": "Test User",
                    "AuthorPictureUrl": "http://graph.facebook.com/100005333233573/picture"
                }
            ]
        }
    ],
    "TotalCount": 7
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of the comments in filtered collection without paging. Number
TargetPostId The unique ID for the social XOMNI post which the current comment replies to and belongs to. Number
Content The text content of the comment. String
TargetCommentId The unique ID for the social XOMNI comment which the current comment replies to. Number
Id The unique ID for the social comment. Number
CreatedDate The date when the post is created. Date
RelatedItemId The integer ID of an item/product related to the social post. Number
Platform Name of the social platform. String
Status Status of the social interaction. String
Author Display name of the user in the social platform. String
AuthorPictureUrl Profile picture of the user in the social platform. 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) Comment was not found.