Get a list of users mapped to a user role in a learnCenter.
get
/learn.rest/v1/learnCenters/{learnCenterId}/userRoles/{userRoleId}/users
Request
Path Parameters
-
learnCenterId: number
Unique identifier of a LearnCenter.
-
userRoleId: number
Unique identifier of a user role.
Query Parameters
-
limit(optional): integer
Specify how many items should be returned in a payload. Must be lower than server default limit size.
-
offset(optional): integer
Specify starting point of the response.Default Value:
0
-
totalResults(optional): boolean
If set to true, the payload includes a total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.
Response
Supported Media Types
- application/xml
- application/json
200 Response
Users collection fetched.
Root Schema : UsersResponse
Type:
Show Source
object
-
count(optional):
number
-
hasMore(optional):
boolean
-
items(optional):
array items
-
limit(optional):
number
-
links(optional):
array links
Example:
{
"items":[
{
"id":947334,
"username":"cwallace",
"nickname":"cw",
"firstName":"Christopher",
"lastName":"Wallace",
"street1":"500 Oracle Parkway",
"street2":"n/a",
"city":"Redwood Shores",
"postalCode":"94065",
"state":"CA",
"country":"US",
"phoneDaytime":"+1.650.506.7000",
"phoneEvening":"n/a",
"phoneMobile":"+1.800.392.2999",
"fax":"n/a",
"pager":"n/a",
"pagerInteractive":"n/a",
"email":"info@oracle.com",
"email2":"n/a",
"gender":"male",
"ssn":"n/a",
"employeeId":"n/a",
"company":"Oracle",
"officeName":"HQ",
"department":"Product Development",
"jobTitle":"Product Manager",
"profession":"Product Management",
"managerName":"n/a",
"createdDate":{
},
"lastAccessedDate":{
},
"lastUpdatedDate":{
},
"lastUpdatedByUserId":947334,
"lastUpdatedByUser":{
"links":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/{userId}"
}
]
},
"passwordValidUntilDate":{
},
"includeInSearchFlag":true,
"memberships":{
"links":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/{userId}/memberships"
}
]
},
"links":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/{userId}"
}
]
},
{
"...":null
}
],
"totalResults":1200,
"limit":100,
"count":100,
"hasMore":true,
"links":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users"
},
{
"rel":"first",
"href":"{url}/v1/users?limit=100&offset=0"
},
{
"rel":"prev",
"href":"{url}/learn.rest/v1/users?limit=100&offset=0"
},
{
"rel":"next",
"href":"{url}/learn.rest/v1/users?limit=100&offset=10"
},
{
"rel":"last",
"href":"{url}/learn.rest/v1/users?limit=100&offset=1200"
}
]
}
Nested Schema : User
Type:
Show Source
object
-
city(optional):
string
-
company(optional):
string
-
country(optional):
string
-
createdDate(optional):
string(datetime)
-
department(optional):
string
-
email(optional):
string
-
email2(optional):
string
-
employeeId(optional):
string
-
fax(optional):
string
-
firstName(optional):
string
-
gender(optional):
string
Allowed Values:
[ "male", "female" ]
enum for gender are: male, female -
id(optional):
number
-
includeInSearchFlag(optional):
boolean
Default Value:
false
-
jobTitle(optional):
string
-
lastAccesedDate(optional):
string(datetime)
-
lastName(optional):
string
-
lastUpdatedByUser(optional):
array lastUpdatedByUser
-
lastUpdatedByUserId(optional):
number
-
lastUpdatedDate(optional):
string(datetime)
-
managerName(optional):
string
-
officeName(optional):
string
-
pager(optional):
string
-
pagerInteractive(optional):
string
-
passwordValidUntilDate(optional):
string
-
phoneDaytime(optional):
string
-
phoneEvening(optional):
string
-
phoneMobile(optional):
string
-
postalCode(optional):
string
-
profession(optional):
string
-
ssn(optional):
string
-
state(optional):
string
-
street1(optional):
string
-
street2(optional):
string
-
username(optional):
string
Username of the user
Example:
{
"username":"cwallace",
"firstName":"Chris",
"lastName":"Wallace",
"street1":"500 Oracle Parkway",
"street2":"suite 500",
"city":"Redwood Shores",
"state":"CA",
"postalCode":"94065",
"country":"US",
"officeName":"HQ",
"gender":"male",
"includeInSearchFlag":true,
"jobTitle":"Product Manager",
"managerName":"n/a",
"pagerInteractive":"n/a",
"ssn":"n/a",
"email2":"n/a",
"pager":"n/a",
"company":"Oracle",
"fax":"n/a",
"department":"Product Development",
"phoneEvening":"n/a",
"email":"info@oracle.com",
"phoneDaytime":"+1.650.506.7000",
"profession":"Product Management",
"phoneMobile":"+1.800.392.2999",
"employeeId":"n/a",
"passwordValidUntilDate":"2016-10-12T11:00:00-04:00"
}
Nested Schema : UserLinkItems
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/users/456
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/456"
}
401 Response
500 Response
Internal server error.