XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides a way to fetch a list of users.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/pii/users?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
Content-Type
Content type of the response entity. The value of this header is always application/json.
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":[
      {
         "Id":1,
         "UserName":"Test",
         "Password":"Pass",
         "Name":"Test",
         "CreatedDate":"2013-08-16T12:23:02.4499918+03:00",
         "PIIUserTypeId":1,
         "PIIUserType":"Anonymous",
         "InitiatedSocialLikeCount":0
      },
      {
         "Id":21,
         "UserName":"Test2",
         "Password":"Pass2",
         "Name":"Test2",
         "CreatedDate":"2013-08-16T12:23:02.4499918+03:00",
         "PIIUserTypeId":1,
         "PIIUserType":"Anonymous",
         "InitiatedSocialLikeCount":0
      },
      {
         "Id":11,
         "UserName":"Test3",
         "Password":"Pass3",
         "Name":"Test3",
         "CreatedDate":"2013-08-16T12:23:02.4499918+03:00",
         "PIIUserTypeId":1,
         "PIIUserType":"Anonymous",
         "InitiatedSocialLikeCount":0
      }
   ],
   "TotalCount":50
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of users in the filtered collection without paging. Number
Results[0..N].Id Unique ID of the user. Number
Results[0..N].PIIUserTypeId User type ID of the user. Number
Results[0..N].CreatedDate Creation date of the user. Date
Results[0..N].InitiatedSocialLikeCount Initiated social like count for the user. Number
Results[0..N].UserName User name for the user. String
Results[0..N].Password Password for the user String
Results[0..N].Name Name of the user. String
Results[0..N].PIIUserType User type description. 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.