XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides a way to fetch all comments of a particular post.

Request

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

URI Parameters

Parameter Name Description Type Conditions
socialPostId The unique ID of social post. 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

[
    {
        "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"
            }
        ]
    }
]

Response Body Description

Parameter Name Description Type
Item.TargetPostId The unique ID for the social XOMNI post which the current comment replies to and belongs to. Number
Item.TargetCommentId The unique ID for the social XOMNI comment which the current comment replies to. Number
Item.Id The unique ID for the social comment. Number
Item.CreatedDate The date when the post is created. Date
Item.Content The text content of the comment. String
Item.RelatedItemId The integer ID of an item/product related to the social post. Number
Item.AvailablePlatforms[0..N].Platform Name of the social platform. String
Item.AvailablePlatforms[0..N].Status Status of the social interaction. String
Item.AvailablePlatforms[0..N].Author Display name of the user in the social platform. String
Item.AvailablePlatforms[0..N].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) Social post could not be found.