Get a list of user role in a LearnCenter.

get

/learn.rest/v1/learnCenters/{learnCenterId}/userRoles

Request

Path Parameters
Query Parameters
  • Specify how many items should be returned in a payload. Must be lower than server default limit size.
  • Specify starting point of the response.
    Default Value: 0
  • 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.
Back to Top

Response

Supported Media Types

200 Response

The user roles collection is fetched.
Body ()
Root Schema : UserRolesResponse
Type: object
Show Source
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 : items
Type: array
Show Source
Nested Schema : UserRoleResponse
Type: object
Show Source
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 : permissions
Type: array
Show Source
Nested Schema : UserRoleLinkItem
Type: object
Show Source
Example:
{
    "rel":"canonical",
    "href":"https://{url}/learn.rest/v1/learnCenters/178784/userRoles/639"
}
Nested Schema : items
Type: object
Show Source
Back to Top