XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API provides a way to fetch a full list of all loyalty users with skip and take parameters.

Request

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

URI Parameters

Parameter Name Description Type Conditions
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": [
        {
            "UserName": "edf60bde-9202-4c73-80a0-3154af1c02c6",
            "Id": 2,
            "CreatedDate": "2013-08-16T12:22:05.453",
            "PIIUserTypeId": 2,
            "AvailablePoints": 11.620054434575167,
            "StreetAddress1": "0202e75a-683b-4c41-88f2-72ae051b4323",
            "StreetAddress2": "348bf3b8-2d5a-4a42-b9cd-915ce67d3884",
            "City": "23d5910e-d2ee-46fc-aded-32394fe40ca2",
            "State": "b2451f95-c5a4-42cf-a9dd-b050b8fa99eb",
            "Zip": "4cbc71fa-0",
            "PhoneNumber": "08a4b03b-3ea4-440a-8721-4633a3fe7cd2",
            "EMailAddress": "c512faac-b0bc-4886-9e41-245176bd27ec",
            "Gender": "Male",
            "DateOfBirth": null,
            "Password": "93163a13-3a50-484e-8510-74d08a834def",
            "Name": "e4050437-053b-4a3e-9388-2b600e0037d8",
            "PIIUserType": "Loyalty",
    "InitiatedSocialLikeCount":0
        }
    ],
    "TotalCount": 4
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of loyalty users in the filtered collection without paging. Number
Results[0..N].UserName User name of the loyalty user. String
Results[0..N].Id The unique ID of the loyalty user. Number
Results[0..N].CreatedDate Created date of the loyalty user. Date
Results[0..N].PIIUserTypeId Assigned PII user type ID of the loyalty user. Number
Results[0..N].InitiatedSocialLikeCount Total like count of the social posts shared by the loyalty user. Number
Results[0..N].AvailablePoints Available points of the loyalty user. Number
Results[0..N].StreetAddress1 Street address of the loyalty user. String
Results[0..N].StreetAddress2 Another street address of the loyalty user. String
Results[0..N].City City of the loyalty user. String
Results[0..N].State State of the loyalty user. String
Results[0..N].Zip Zip number of the loyalty user. String
Results[0..N].PhoneNumber Phone number of the loyalty user. String
Results[0..N].EMailAddress E-Mail address of the loyalty user. String
Results[0..N].Gender Gender of the loyalty user. String
Results[0..N].DateOfBirth Birthday date of the loyalty user. Date
Results[0..N].Password Password of the loyalty user. String
Results[0..N].Name Full name of the loyalty user. String
Results[0..N].PIIUserType Assigned PII user type description of the loyalty user. 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.