Jump to

• Request
• Response

Creates a new user role

post

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

Request

Supported Media Types

• application/json

Path Parameters

• learnCenterId: number
  Unique identifier of a LearnCenter.

Body ()

User role object that needs to be created.

Root Schema : UserRoleRequest

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "permissions":{
            "type":"array",
            "items":{
                "properties":{
                    "id":{
                        "type":"string"
                    }
                }
            }
        },
        "statusFlag":{
            "type":"boolean",
            "default":true
        }
    },
    "example":{
        "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
    }
}

Example:

{
    "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
}

Nested Schema : permissions

Type: array

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

• id(optional): string

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

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/json

201 Response

A new user role is created.

Body ()

Root 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"
        }
    }
}

400 Response

Request has incorrect syntax or does not contain a field that is required.

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

404 Response

Resource not found.

422 Response

Request may contain validation errors.

500 Response

Internal server error.

Back to Top