XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API fetches a member by ID.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/management/security/members/{memberId}

URI Parameters

Parameter Name Description Type Conditions
memberId Unique ID of a member. Number

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

{
   "Id":9,
   "Username":"NewPrivateApiUserName",
   "Name":"New Private Api User",
   "Password":"MyPassword",
   "Roles":[
      {
         "Id":2,
         "Description":"Private"
      }
   ]
}

Response Body Description

Parameter Name Description Type
Id The unique ID of the member. Number
Username User name of the member. String
Name Name of the member. String
Password Password of the member. String
Roles[0..N].Id Unique ID of the member role. Number
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) Member not found.