XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API enables a client application to subscribe to OmniPlay device queue.

Request

HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/omniplay/logicaldevices/{deviceId}

URI Parameters

Parameter Name Description Type Conditions
deviceId Id of the device String

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

The response does not contain any response entity if the status is successful.

Response Headers

Header Field Name Description

Status Codes

A successful operation returns status code 200 (OK) for POST operations. Possible response status codes are as listed below:

Status Code Description
202 (Accepted) Operation Succeed
404 (Not Found) Device not found