XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API returns a list of key/value metadata pairs of a particular loyalty user based on the PIIToken value received through the PIIToken HTTP header.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/pii/loyaltymetadata

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": [
        {
            "Key": "Sample Key 1",
            "Value": "Sample Value 2"
        },
        {
            "Key": "Sample Key 2",
            "Value": "Sample Value 2"
        },
    ]
}

Response Body Description

Parameter Name Description Type
Data[0..N].Key Key of the loyalty user metadata. String
Data[0..N].Value Value of the loyalty user metadata. 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
401 (Unauthorized) Not authorized or authorized PII User was not a loyalty user.
404 (Not Found) No metadata found for given loyalty user.