GET restapi/personal/instantmessages/permissions/v1

Gets permissions for the instant message system.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The permissions that the current user has for InstantMessaging

Itslearning.RestApi.Entities.InstantMessagePermissions
NameDescriptionTypeAdditional information
CanUseSendAsIndividualMessages

Gets if the user is allowed to send a message to multiple recipients as individual messages (as opposed to a group conversation)

boolean

None.

CanAccessInstantMessageSystem

Gets if a user can access instant message system.

boolean

None.

CanSearchForCourses

Gets if a user can search for courses to use them as recipients.

boolean

None.

CanShareInstantMessages

Get if the user can share messages.

boolean

None.

CanReplyToInstantMessages

Get if the user can reply to instant messages.

boolean

None.

CanStarInstantMessages

Get if the user can star instant messages.

boolean

None.

CanReportInstantMessages

Gets if the user can report instant messages or threads.

boolean

None.

IsUserBlockingEnabled

Gets if the user can access instant message system and blocking system is enabled.

boolean

None.

CanSendBroadcastMessages

Get if the user can send broadcast messages.

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "CanUseSendAsIndividualMessages": true,
  "CanAccessInstantMessageSystem": true,
  "CanSearchForCourses": true,
  "CanShareInstantMessages": true,
  "CanReplyToInstantMessages": true,
  "CanStarInstantMessages": true,
  "CanReportInstantMessages": true,
  "IsUserBlockingEnabled": true,
  "CanSendBroadcastMessages": true
}

application/xml, text/xml

Sample:
<InstantMessagePermissions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities">
  <CanAccessInstantMessageSystem>true</CanAccessInstantMessageSystem>
  <CanReplyToInstantMessages>true</CanReplyToInstantMessages>
  <CanReportInstantMessages>true</CanReportInstantMessages>
  <CanSearchForCourses>true</CanSearchForCourses>
  <CanSendBroadcastMessages>true</CanSendBroadcastMessages>
  <CanShareInstantMessages>true</CanShareInstantMessages>
  <CanStarInstantMessages>true</CanStarInstantMessages>
  <CanUseSendAsIndividualMessages>true</CanUseSendAsIndividualMessages>
  <IsUserBlockingEnabled>true</IsUserBlockingEnabled>
</InstantMessagePermissions>