Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The user roles collection is fetched.

Body ()

Root Schema : UserRolesResponse

Type: object

Show Source

• count(optional): number
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): number
• links(optional): array links

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserRoleResponse"
            }
        },
        "limit":{
            "type":"number"
        },
        "count":{
            "type":"number"
        },
        "hasMore":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "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"
            }
        ]
    }
}

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

• Array of: object UserRoleResponse

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserRoleResponse"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    }
}

Nested Schema : UserRoleResponse

Type: object

Show Source

• description(optional): string
• id(optional): number
• links(optional): array links
• name(optional): string
• permissions(optional): array permissions
• statusFlag(optional): boolean
  Default Value: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "permissions":{
            "type":"array",
            "items":{
                "properties":{
                    "id":{
                        "type":"string"
                    }
                }
            }
        },
        "statusFlag":{
            "type":"boolean",
            "default":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserRoleLinkItem"
            }
        }
    },
    "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"
            }
        ]
    }
}

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 : links

Type: array

Show Source

• Array of: object UserRoleLinkItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserRoleLinkItem"
    }
}

Nested Schema : permissions

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "id":{
                "type":"string"
            }
        }
    }
}

Nested Schema : UserRoleLinkItem

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"https://{url}/learn.rest/v1/learnCenters/178784/userRoles/639"
    }
}

Example:

{
    "rel":"canonical",
    "href":"https://{url}/learn.rest/v1/learnCenters/178784/userRoles/639"
}

Nested Schema : items

Type: object

Show Source

• id(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top