GET restapi/personal/instantmessages/messagethreads/{threadId}/participants/messages-disabled/v1

Gets a collection of thread participants who cannot see messages.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
threadId

Thread ID.

integer

Required

Body Parameters

None.

Response Information

Resource Description

List of InstantMessageThread entities.

Itslearning.RestApi.Entities.MessagesDisabledThreadParticipants
NameDescriptionTypeAdditional information
Count

Number of instant message conversation participants who have messages disabled.

integer

None.

ThreadParticipants

The list of instant message conversation participants. Can be null in case if there's no such participants or if there are too many of them.

Collection of Itslearning.RestApi.Entities.ThreadParticipant

None.

Response Formats

application/json, text/json

Sample:
{
  "Count": 1,
  "ThreadParticipants": [
    {
      "SourceLocationId": 1,
      "SourceLocationType": 1,
      "IsDeleted": true,
      "CanReceive": true,
      "RoleInHierarchyTitle": "sample string 3",
      "RoleInHierarchy": 0,
      "ExtraUserInformation": "sample string 4",
      "PersonId": 5,
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "FullName": "sample string 8",
      "ProfileUrl": "sample string 9",
      "AdditionalInfo": "sample string 10",
      "ProfileImageUrl": "sample string 11",
      "ProfileImageUrlSmall": "sample string 12"
    },
    {
      "SourceLocationId": 1,
      "SourceLocationType": 1,
      "IsDeleted": true,
      "CanReceive": true,
      "RoleInHierarchyTitle": "sample string 3",
      "RoleInHierarchy": 0,
      "ExtraUserInformation": "sample string 4",
      "PersonId": 5,
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "FullName": "sample string 8",
      "ProfileUrl": "sample string 9",
      "AdditionalInfo": "sample string 10",
      "ProfileImageUrl": "sample string 11",
      "ProfileImageUrlSmall": "sample string 12"
    }
  ]
}

application/xml, text/xml

Sample:
<MessagesDisabledThreadParticipants xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities">
  <Count>1</Count>
  <ThreadParticipants>
    <ThreadParticipant xmlns="">
      <AdditionalInfo>sample string 10</AdditionalInfo>
      <FirstName>sample string 6</FirstName>
      <FullName>sample string 8</FullName>
      <LastName>sample string 7</LastName>
      <PersonId>5</PersonId>
      <ProfileImageUrl>sample string 11</ProfileImageUrl>
      <ProfileImageUrlSmall>sample string 12</ProfileImageUrlSmall>
      <ProfileUrl>sample string 9</ProfileUrl>
      <CanReceive>true</CanReceive>
      <ExtraUserInformation>sample string 4</ExtraUserInformation>
      <IsDeleted>true</IsDeleted>
      <RoleInHierarchy>None</RoleInHierarchy>
      <RoleInHierarchyTitle>sample string 3</RoleInHierarchyTitle>
      <SourceLocationId>1</SourceLocationId>
      <SourceLocationType>Course</SourceLocationType>
    </ThreadParticipant>
    <ThreadParticipant xmlns="">
      <AdditionalInfo>sample string 10</AdditionalInfo>
      <FirstName>sample string 6</FirstName>
      <FullName>sample string 8</FullName>
      <LastName>sample string 7</LastName>
      <PersonId>5</PersonId>
      <ProfileImageUrl>sample string 11</ProfileImageUrl>
      <ProfileImageUrlSmall>sample string 12</ProfileImageUrlSmall>
      <ProfileUrl>sample string 9</ProfileUrl>
      <CanReceive>true</CanReceive>
      <ExtraUserInformation>sample string 4</ExtraUserInformation>
      <IsDeleted>true</IsDeleted>
      <RoleInHierarchy>None</RoleInHierarchy>
      <RoleInHierarchyTitle>sample string 3</RoleInHierarchyTitle>
      <SourceLocationId>1</SourceLocationId>
      <SourceLocationType>Course</SourceLocationType>
    </ThreadParticipant>
  </ThreadParticipants>
</MessagesDisabledThreadParticipants>