XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API provides a way to fetch a loyalty user based on the PIIToken value received through the PIIToken HTTP header. For fetch details, PIIToken header must be contain a loyalty PII user.

Request

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

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": {
        "AvailablePoints": 28.847555258938836,
        "StreetAddress1": "244dbc92-5802-4150-809c-b8d52d519ac0",
        "StreetAddress2": "e5186f65-50c8-491a-b50b-cf13bd56313a",
        "City": "1e25cadb-f91c-4059-a85b-0b6de0fffce8",
        "State": "2236aaeb-2245-4989-a494-6dd120c9959d",
        "Zip": "60364ddc-4",
        "PhoneNumber": "6c2ba8fd-1a3b-4061-9438-f216ee6fd0c7",
        "EMailAddress": "5b91c22b-640f-4385-b9dd-a5077eb382d7",
        "Gender": "Male",
        "DateOfBirth": null,
        "UserName": "72426d72-d963-43a0-8fe4-7ea6874b8529",
        "Password": "aa1c9b20-51d6-47a9-87a8-d7c9260c9263",
        "Name": "997fa7e4-01f9-4288-bdb2-16559b5b078f",
        "PIIUserType": "Loyalty"
    }
}

Response Body Description

Parameter Name Description Type
Data.AvailablePoints Available points of the loyalty user. Number
Data.StreetAddress1 Street address of the loyalty user. String
Data.StreetAddress2 The other street address of the loyalty user. String
Data.City City of the loyalty user. String
Data.State State of the loyalty user. String
Data.Zip Zip number of the loyalty user. String
Data.PhoneNumber Phone number of the loyalty user. String
Data.EMailAddress E-Mail address of the loyalty user. String
Data.Gender Gender of the loyalty user. String
Data.DateOfBirth Birthday date of the loyalty user. Date
Data.UserName User name of the loyalty user. String
Data.Password Password of the loyalty user. String
Data.Name Full name of the loyalty user. String
Data.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. Possible response status codes are as listed below:

Status Code Description
401 (Unauthorized) Not authorized or authorized PII User not a loyalty user.