XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The Anonymous PII API allows a client application to create a PII of type “Anonymous”. Anonymous PIIs are used to move user data states through multiple devices and environments without requiring the user to register for a separated user account. The full Anonymous PII authentication is intended to be used in a transparent way to the user.

Request

{
    "UserName":"ba07168f-1c41-4299-81e8-52a72718798d",
    "FirstLastName":null
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/pii/anonymous

Request Body Description

Parameter Name Description Type Conditions
UserName This is the unique username for anonymous PII. String
Required
FirstLastName The first and last name for anonymous PII. String

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da

Response

{
    "Data": {
        "UserName": "ba07168f-1c41-4299-81e8-52a72718798d",
        "Password": "dd5cb105-68f9-401b-9dfb-4ff85aa112ef",
        "Name": null,
        "PIIUserType": "Anonymous"
    }
}

Response Body Description

Parameter Name Description Type
Data.UserName Unique username for anonymous PII. String
Data.Password API generated password for the specified PIIUser. String
Data.Name The first and last name for anonymous PII. String
Data.PIIUserType PIIUserType for the generated PIIUser. Default value for this API is “Anonymous” and it can’t be changed. 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 POST operations. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) Username parameter cannot be null or empty.
409 (Conflict) Specified username is in use.