List virtualEventRegistrations

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Obtenha uma lista de todos os registros de registro de um webinar ou reunião geral.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ❌ ❌ ❌

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Sem suporte. Sem suporte.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application VirtualEvent.Read. Chat Indisponível.

Observação

Para usar permissões de aplicativo para essa API, os administradores de locatários devem criar uma política de acesso ao aplicativo e atribuí-la a um usuário. Isso permite que o aplicativo autorizado acesse registros de eventos virtuais criados por esse usuário específico.

Solicitação HTTP

Para listar os registros de um webinar:

GET /solutions/virtualEvents/webinars/{webinarId}/registrations
GET /solutions/virtualEvents/webinars/{webinarId}/registrations?$filter=userId eq '{userId}'
GET /solutions/virtualEvents/webinars/{webinarId}/registrations?$filter=email eq '{email}'

Para listar os registros de uma reunião geral:

GET /solutions/virtualEvents/townhalls/{townhallId}/registrations
GET /solutions/virtualEvents/townhalls/{townhallId}/registrations?$filter=userId eq '{userId}'
GET /solutions/virtualEvents/townhalls/{townhallId}/registrations?$filter=email eq '{email}'

Parâmetros de consulta opcionais

Esse método dá suporte a um filtro dos parâmetros de consulta OData para ajudar a personalizar a resposta.

Parâmetros de função

Na URL da solicitação, você pode fornecer valores a um dos seguintes parâmetros de consulta.

Parâmetro Tipo Descrição
userId Cadeia de caracteres A ID do usuário especificado no Microsoft Entra.
email Cadeia de caracteres O endereço de email do usuário especificado registrado no webinar.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e uma coleção de objetos virtualEventRegistration no corpo da resposta. Se você buscar um registro de evento virtual por userId ou email, esse método retornará uma coleção que contém apenas um objeto virtualEventRegistration no corpo da resposta.

Exemplos

Exemplo 1: recuperar uma lista de registros de eventos virtuais

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/f4b39f1c-520e-4e75-805a-4b0f2016a0c6@a1a56d21-a8a6-4a6b-97f8-ced53d30f143/registrations

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.virtualEventRegistration",
      "id": "127962bb-84e1-7b62-fd98-1c9d39def7b6",
      "userId": "String",
      "firstName": "Emilee",
      "lastName": "Pham",
      "email": "EmileeMPham@contoso.com",
      "externalRegistrationInformation": {
        "referrer": "Fabrikam",
        "registrationId": "myExternalRegistrationId"
      },
      "status": "registered",
      "registrationDateTime": "2023-03-07T22:04:17",
      "cancelationDateTime": null,
      "preferredTimezone":"Pacific Standard Time",
      "preferredLanguage":"en-us",
      "registrationQuestionAnswers": [
        {
          "questionId": "95320781-96b3-4b8f-8cf8-e6561d23447a",
          "displayName": "Which city do you currently work in?",
          "value": null,
          "booleanValue": null,
          "multiChoiceValues": [
            "Seattle"
          ]
        },
        {
          "questionId": "4577afdb-8bee-4219-b482-04b52c6b855c",
          "displayName": "Do you in the same city where you work?",
          "value": null,
          "booleanValue": true,
          "multiChoiceValues": []
        },
        {
          "questionId": "80fefcf1-caf7-4cd3-b8d7-159e17c47f20",
          "displayName": "Which cities have you worked in?",
          "value": null,
          "booleanValue": null,
          "multiChoiceValues": [
            "Cancun",
            "Hoboken",
            "Beijing"
          ]
        }
      ]
    }
  ]
}

Exemplo 2: recuperar um registro de evento virtual por ID de usuário

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/f4b39f1c-520e-4e75-805a-4b0f2016a0c6@a1a56d21-a8a6-4a6b-97f8-ced53d30f143/registrations?$filter=userId eq 'b7ef013a-c73c-4ec7-8ccb-e56290f45f68'

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.virtualEventRegistration",
      "id": "127962bb-84e1-7b62-fd98-1c9d39def7b6",
      "userId": "String",
      "firstName": "Emilee",
      "lastName": "Pham",
      "email": "EmileeMPham@contoso.com",
      "externalRegistrationInformation": {
        "referrer": "Fabrikam",
        "registrationId": "myExternalRegistrationId"
      },
      "status": "registered",
      "registrationDateTime": "2023-03-07T22:04:17",
      "cancelationDateTime": null,
      "preferredTimezone":"Pacific Standard Time",
      "preferredLanguage":"en-us",
      "registrationQuestionAnswers": [
        {
          "questionId": "95320781-96b3-4b8f-8cf8-e6561d23447a",
          "displayName": "Which city do you currently work in?",
          "value": null,
          "booleanValue": null,
          "multiChoiceValues": [
            "Seattle"
          ]
        },
        {
          "questionId": "4577afdb-8bee-4219-b482-04b52c6b855c",
          "displayName": "Do you in the same city where you work?",
          "value": null,
          "booleanValue": true,
          "multiChoiceValues": []
        },
        {
          "questionId": "80fefcf1-caf7-4cd3-b8d7-159e17c47f20",
          "displayName": "Which cities have you worked in?",
          "value": null,
          "booleanValue": null,
          "multiChoiceValues": [
            "Cancun",
            "Hoboken",
            "Beijing"
          ]
        }
      ]
    }
  ]
}

Exemplo 3: recuperar um registro de evento virtual por email

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/f4b39f1c-520e-4e75-805a-4b0f2016a0c6@a1a56d21-a8a6-4a6b-97f8-ced53d30f143/registrations?$filter=email eq 'EmileeMPham@contoso.com'

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.virtualEventRegistration",
      "id": "127962bb-84e1-7b62-fd98-1c9d39def7b6",
      "userId": "String",
      "firstName": "Emilee",
      "lastName": "Pham",
      "email": "EmileeMPham@contoso.com",
      "externalRegistrationInformation": {
        "referrer": "Fabrikam",
        "registrationId": "myExternalRegistrationId"
      },
      "status": "registered",
      "registrationDateTime": "2023-03-07T22:04:17",
      "cancelationDateTime": null,
      "preferredTimezone":"Pacific Standard Time",
      "preferredLanguage":"en-us",
      "registrationQuestionAnswers": [
        {
          "questionId": "95320781-96b3-4b8f-8cf8-e6561d23447a",
          "displayName": "Which city do you currently work in?",
          "value": null,
          "booleanValue": null,
          "multiChoiceValues": [
            "Seattle"
          ]
        },
        {
          "questionId": "4577afdb-8bee-4219-b482-04b52c6b855c",
          "displayName": "Do you in the same city where you work?",
          "value": null,
          "booleanValue": true,
          "multiChoiceValues": []
        },
        {
          "questionId": "80fefcf1-caf7-4cd3-b8d7-159e17c47f20",
          "displayName": "Which cities have you worked in?",
          "value": null,
          "booleanValue": null,
          "multiChoiceValues": [
            "Cancun",
            "Hoboken",
            "Beijing"
          ]
        }
      ]
    }
  ]
}