XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API returns a list of social platform profile data for the current PII user.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/social/profiles

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
PIIToken
Includes the base64-encoded “Personally Identifiable Information” data.
Sample: dXNlcm5hbWU6SW5uQXBwc1VzZXI7cGFzc3dvcmQ6SW5uQXBwc1Bhc3M=
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

{
    "Data": [
        {
            "Platform": "Facebook",
            "FirstName": "XOMNI",
            "LastName": "Guy",
            "DisplayName": "XOMNI Guy",
            "AvatarUrl": "http://graph.facebook.com/100005298216720/picture",
            "SocialPlatformTokenStatus": "Valid"
        }
    ]
}

Response Body Description

Parameter Name Description Type
Data[0..N].Platform Name of the social platform that social information belongs to. String
Data[0..N].FirstName First Name of the user in the social platform. String
Data[0..N].LastName Last Name of the user in the social platform. String
Data[0..N].DisplayName Display name of the user in the social platform. String
Data[0..N].AvatarUrl Avatar URL of the user in the social platform. String
Data[0..N].SocialPlatformTokenStatus Social platform token status information. String

Possible values for social platform token status

Value Description
Valid The access token stored in API is valid.
Expired The access token stored in API is expired. Execute getting access token process and send a new access token to the API.

Possible values for available platforms

Value Description
facebook The key used for the Facebook social platform.
twitter The key used for the Twitter social platform.

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 social platform profile found.