XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides a way to fetch a full list of social posts and related comments of a user.

Request

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

URI Parameters

Parameter Name Description Type Conditions
userId The unique id of the user. 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
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

{
    "Results": [
        {
            "Comments": [
                {
                    "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"
                        }
                    ]
                }
            ],
            "Author": "Test PII User",
            "Id": 16,
            "CreatedDate": "2013-08-14T13:51:03.563",
            "Content": "Sample post content for test 15bbb7fb-6d41-4c61-9bcc-82e3ce5d31bc",
            "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 social posts. Number
Results[0..N].Author The name of the PII User. String
Results[0..N].Id The unique ID for the social XOMNI post. Number
Results[0..N].CreatedDate The date when the post is created. Date
Results[0..N].Content The text content of the message. String
Results[0..N].RelatedItemId The integer ID of an item/product related to the social post. Number
Results[0..N].AvailablePlatforms[0..N].Platform Name of the social platform. String
Results[0..N].AvailablePlatforms[0..N].Status Status of the social interaction. String
Results[0..N].AvailablePlatforms[0..N].Author Display name of the user in the social platform. String
Results[0..N].AvailablePlatforms[0..N].AuthorPictureUrl Profile picture of the user in the social platform. String
Results[0..N].Comments[0..N].TargetPostId The unique ID for the social XOMNI post which the current comment replies to and belongs to. Number
Results[0..N].Comments[0..N].TargetCommentId The unique ID for the social XOMNI comment which the current comment replies to. Number
Results[0..N].Comments[0..N].Id The unique ID for the social comment. Number
Results[0..N].Comments[0..N].CreatedDate The date when the post is created. Date
Results[0..N].Comments[0..N].Content The text content of the comment. String
Results[0..N].Comments[0..N].RelatedItemId The integer ID of an item/product related to the social post. Number
Results[0..N].Comments[0..N].AvailablePlatforms[0..N].Platform Name of the social platform. String
Results[0..N].Comments[0..N].AvailablePlatforms[0..N].Status Status of the social interaction. String
Results[0..N].Comments[0..N].AvailablePlatforms[0..N].Author Display name of the user in the social platform. String
Results[0..N].Comments[0..N].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 was not found.