XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API returns a list of key/value metadata pairs for the given loyalty user.

Request

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

URI Parameters

Parameter Name Description Type Conditions
loyaltyUserId The unique ID of the loyalty user. 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

{
        {
            "LoyaltyUserId": 5,
            "Key": "2a1c5efa-915b-4e96-97b2-ada1a8d58a56",
            "Value": "a2c34a01-0234-4c76-a22b-5b3e215530a1"
        },
        {
            "LoyaltyUserId": 5,
            "Key": "9e22894a-987e-4fd6-99b0-8cc15aae1ef3",
            "Value": "85c51948-946a-48e6-9ea9-4a28275be06a"
        },
        {
            "LoyaltyUserId": 5,
            "Key": "a2c4f65c-ebd2-4778-a660-485e8255a6a6",
            "Value": "b6d1ce30-3424-4459-88e5-59bdfb16ea40"
        }
}

Response Body Description

Parameter Name Description Type
[0..N].LoyaltyUserId The unique ID of the loyalty user. Number
[0..N].Key Key of the loyalty user metadata. String
[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
404 (Not Found) No loyalty user has been found for the given loyalty user ID.