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

User role response object comprising user response parameters.

Show Source

• count(optional): number
  Count is the current number of records displayed in the response.

  Example: 1
• hasMore(optional): boolean
  True indicates that we have more records to be displayed.

  Example: false
• items(optional): array items
• limit(optional): number
  Limit implies the maximum number of records which can be displayed in the page.

  Example: 100
• links(optional): array links
  Link to the user roles.

{
    "type":"object",
    "description":"User role response object comprising user response parameters.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserRoleResponse"
            }
        },
        "limit":{
            "type":"number",
            "example":100,
            "description":"Limit implies the maximum number of records which can be displayed in the page."
        },
        "count":{
            "type":"number",
            "example":1,
            "description":"Count is the current number of records displayed in the response."
        },
        "hasMore":{
            "type":"boolean",
            "example":false,
            "description":" True indicates that we have more records to be displayed."
        },
        "links":{
            "type":"array",
            "description":"Link to the user roles.",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles"
                }
            ]
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object UserRoleResponse
  Object comprising all the item parameters.

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

Nested Schema : links

Type: array

Link to the user roles.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Link to the user roles.",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    },
    "example":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles"
        }
    ]
}

Example:

[
    {
        "rel":"canonical",
        "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles"
    }
]

Nested Schema : UserRoleResponse

Type: object

Object comprising all the item parameters.

Show Source

• description(optional): string
  Description of the user role.

  Example: test
• id(optional): number
  Example: 234
• links(optional): array links
  Link to the User role items.
• name(optional): string
  Name of the user role

  Example: admin role
• permissions(optional): array permissions
  Permissions applicable to a user role.
• statusFlag(optional): boolean
  Default Value: true

  Status of the user role.

  Example: true

{
    "type":"object",
    "description":"Object comprising all the item parameters.",
    "properties":{
        "id":{
            "type":"number",
            "example":234
        },
        "name":{
            "type":"string",
            "example":"admin role",
            "description":"Name of the user role"
        },
        "description":{
            "type":"string",
            "example":"test",
            "description":"Description of the user role."
        },
        "permissions":{
            "type":"array",
            "description":"Permissions applicable to a user role.",
            "items":{
                "properties":{
                    "id":{
                        "type":"string"
                    }
                }
            },
            "example":[
                "receiveComSystemMessages",
                "attachFilesToMessages",
                "emailCompletionCertificates",
                "useForums",
                "viewReviews",
                "addGlobalLCCalendarEvents",
                "insertNewReviews",
                "viewLearnCenterPages",
                "viewInsightReportingReports",
                "sendComSystemMessages",
                "viewCoursePages",
                "useComSystemAddressBook",
                "useChatRooms",
                "useCommunicationTools",
                "modifyReviews",
                "printCompletionCertificates",
                "viewCertificatesContent",
                "viewContent"
            ]
        },
        "statusFlag":{
            "type":"boolean",
            "default":true,
            "example":true,
            "description":"Status of the user role."
        },
        "links":{
            "type":"array",
            "description":"Link to the User role items.",
            "items":{
                "$ref":"#/definitions/UserRoleLinkItem"
            }
        }
    }
}

Nested Schema : links

Type: array

Link to the User role items.

Show Source

• Array of: object UserRoleLinkItem

{
    "type":"array",
    "description":"Link to the User role items.",
    "items":{
        "$ref":"#/definitions/UserRoleLinkItem"
    }
}

Nested Schema : permissions

Type: array

Permissions applicable to a user role.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Permissions applicable to a user role.",
    "items":{
        "properties":{
            "id":{
                "type":"string"
            }
        }
    },
    "example":[
        "receiveComSystemMessages",
        "attachFilesToMessages",
        "emailCompletionCertificates",
        "useForums",
        "viewReviews",
        "addGlobalLCCalendarEvents",
        "insertNewReviews",
        "viewLearnCenterPages",
        "viewInsightReportingReports",
        "sendComSystemMessages",
        "viewCoursePages",
        "useComSystemAddressBook",
        "useChatRooms",
        "useCommunicationTools",
        "modifyReviews",
        "printCompletionCertificates",
        "viewCertificatesContent",
        "viewContent"
    ]
}

Example:

[
    "receiveComSystemMessages",
    "attachFilesToMessages",
    "emailCompletionCertificates",
    "useForums",
    "viewReviews",
    "addGlobalLCCalendarEvents",
    "insertNewReviews",
    "viewLearnCenterPages",
    "viewInsightReportingReports",
    "sendComSystemMessages",
    "viewCoursePages",
    "useComSystemAddressBook",
    "useChatRooms",
    "useCommunicationTools",
    "modifyReviews",
    "printCompletionCertificates",
    "viewCertificatesContent",
    "viewContent"
]

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/178409/userRoles/639"
    }
}

Example:

{
    "rel":"canonical",
    "href":"https://{url}/learn.rest/v1/learnCenters/178409/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