Get a list of user role in a LearnCenter.
get
/learn.rest/v1/learnCenters/{learnCenterId}/userRoles
Request
Path Parameters
-
learnCenterId: number
Unique identifier of a LearnCenter.
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/json
200 Response
The user roles collection is fetched.
Root Schema : UserRolesResponse
Type:
Show Source
object
-
count(optional):
number
-
hasMore(optional):
boolean
-
items(optional):
array items
-
limit(optional):
number
-
links(optional):
array links
Example:
{
"items":[
{
"id":639,
"name":"admin role",
"description":"test",
"permissions":[
"useComSystemAddressBook",
"viewContent",
"modifyReviews",
"useCommunicationTools",
"useChatRooms",
"viewCoursePages",
"sendComSystemMessages",
"viewInsightReportingReports",
"viewLearnCenterPages",
"addGlobalLCCalendarEvents",
"viewReviews",
"useForums",
"emailCompletionCertificates",
"attachFilesToMessages",
"receiveComSystemMessages",
"viewCertificatesContent",
"printCompletionCertificates",
"insertNewReviews"
],
"statusFlag":true,
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178784/userRoles/639"
}
]
},
{
"...":null
}
],
"limit":100,
"count":9,
"hasMore":false,
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178784/userRoles"
}
]
}
Nested Schema : UserRoleResponse
Type:
Show Source
object
-
description(optional):
string
-
id(optional):
number
-
links(optional):
array links
-
name(optional):
string
-
permissions(optional):
array permissions
-
statusFlag(optional):
boolean
Default Value:
true
Example:
{
"id":234,
"name":"admin role",
"description":"test",
"permissions":[
"receiveComSystemMessages",
"attachFilesToMessages",
"emailCompletionCertificates",
"useForums",
"viewReviews",
"addGlobalLCCalendarEvents",
"insertNewReviews",
"viewLearnCenterPages",
"viewInsightReportingReports",
"sendComSystemMessages",
"viewCoursePages",
"useComSystemAddressBook",
"useChatRooms",
"useCommunicationTools",
"modifyReviews",
"printCompletionCertificates",
"viewCertificatesContent",
"viewContent"
],
"statusFlag":true,
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178784/userRoles/639"
}
]
}
Nested Schema : UserRoleLinkItem
Type:
Show Source
object
Example:
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178784/userRoles/639"
}