Skip to content

virtualeventtownhall-getbyuseridandrole.md

Latest commit

 

History

History
172 lines (138 loc) · 6.13 KB

virtualeventtownhall-getbyuseridandrole.md

File metadata and controls

172 lines (138 loc) · 6.13 KB
title virtualEventTownhall: getByUserIdAndRole
description Get a list of virtualEventTownhall objects where the specified user is either the organizer or a coorganizer.
author halleclottey-msft
ms.localizationpriority medium
ms.subservice cloud-communications
doc_type apiPageType
ms.date 10/15/2024

virtualEventTownhall: getByUserIdAndRole

Namespace: microsoft.graph

Get a list of virtualEventTownhall objects where the specified user is either the organizer or a coorganizer.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

Important

To use application permission for this API, tenant administrators must create an application access policy and grant it to the specified user to authorize the app to get virtualEventTownhall objects on behalf of that user.

HTTP request

GET /solutions/virtualEvents/townhalls/getByUserIdAndRole(userId='{userId}', role='{role}')

Function parameters

In the request URL, provide the following query parameters with values.

Parameter Type Description
role String User role of the specified user in the virtualEventTownhall. The possible values are: organizer, coOrganizer.
userId String The ID of the specified user in Microsoft Entra.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this function returns a 200 OK response code and a collection of virtualEventTownhall objects in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/v1.0/solutions/virtualEvents/townhalls/getByUserIdAndRole(userId='b7ef013a-c73c-4ec7-8ccb-e56290f45f68', role='organizer')

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.virtualEventTownhall",
      "id": "88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33",
      "status": "published",
      "displayName": "The Impact of Tech on Our Lives",
      "description": {
        "contentType": "text",
        "content": "Discusses how technology has changed the way we communicate, work, and interact with each other."
      },
      "startDateTime": {
        "dateTime": "2023-03-30T10:00:00",
        "timeZone": "PacificSt"
      },
      "endDateTime": {
        "dateTime": "2023-03-30T17:00:00",
        "timeZone": "PacificSt"
      },
      "createdBy": {
        "application": null,
        "device": null,
        "user": {
          "@odata.type": "#microsoft.graph.communicationsUserIdentity",
          "id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68",
          "displayName": "Diane Demoss",
          "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
        }
      },
      "audience": "everyone",
      "coOrganizers": [
        {
          "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b",
          "displayName": "Kenneth Brown",
          "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
        }
      ],
      "settings": {
        "isAttendeeEmailNotificationEnabled": false
      },
      "externalEventInformation": [
        {
          "applicationId" : "1b7ba4d1-c377-4b2f-ad0e-a3fc50bc987b",
          "externalEventId": "myExternalEventId"
        }
      ]
    }
  ]
}