XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API returns a full list of members.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/management/security/members?skip={skip}&take={take}&role={role}

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
role Role name of the member. String

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":[
      {
         "Id":2,
         "Username":"DebugApiPrivateTestUser",
         "Name":"Debug Private Api User",
         "Password":"DebugApiPrivateTestPass",
         "Roles":[
            {
               "Id":2,
               "Description":"Private"
            }
         ]
      },
      {
         "Id":9,
         "Username":"NewPrivateApiUserName",
         "Name":"New Private Api User",
         "Password":"MyPassword",
         "Roles":[
            {
               "Id":2,
               "Description":"Private"
            }
         ]
      }
   ],
   "TotalCount":2
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of members in the filtered collection without paging. Number
Results[0..N].Id The unique ID of the member. Number
Results[0..N].Username User name of the member. String
Results[0..N].Name Name of the member. String
Results[0..N].Password Password of the member. String
Results[0..N].Roles[0..N].Id Unique ID of the member role. Number
Results[0..N].Roles[0..N].Description Description of the member role. 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
404 (Not Found) No members found.