Lugares de lista

Artículo
10/31/2023

Espacio de nombres: microsoft.graph

Obtenga una colección del tipo especificado de objetos place definidos en el inquilino. Por ejemplo, puede obtener todas las salas, todas las listas de salas o las habitaciones de una lista de salas específica del inquilino.

Un objeto place puede ser uno de los siguientes tipos:

Habitación que incluye propiedades enriquecidas, como una dirección de correo electrónico para la habitación, y accesibilidad, capacidad y compatibilidad con dispositivos.
Lista de salas que incluye una dirección de correo electrónico para la lista de salas y una propiedad de navegación para obtener la colección de instancias de sala en la lista de salas.

Tanto room como roomList se derivan del objeto place .

De forma predeterminada, esta operación devuelve 100 lugares por página.

En comparación con las funciones findRooms y findRoomLists , esta operación devuelve una carga más completa para las listas de salas y salas. Consulte los detalles de cómo se comparan.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	Place.Read.All	No disponible.
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	Place.Read.All	No disponible.

Solicitud HTTP

Para obtener todas las habitaciones de un inquilino:

GET /places/microsoft.graph.room

Para obtener todas las listas de salas de un inquilino:

GET /places/microsoft.graph.roomlist

Para obtener todas las habitaciones de la lista de habitaciones especificada:

GET /places/{room-list-emailaddress}/microsoft.graph.roomlist/rooms

Parámetros de consulta opcionales

Este método admite los siguientes parámetros de consulta para ayudar a personalizar la respuesta:

$filter
$select
$top
$skip
$count=true

Use $top para personalizar el tamaño de página. El tamaño predeterminado de la página es 100.

Para obtener información general, vea Parámetros de consulta OData.

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y una colección de objetos place en el cuerpo de la respuesta.

Ejemplos

Ejemplo 1: Enumerar todas las salas definidas en el inquilino

Solicitud

En el ejemplo siguiente se muestra cómo obtener todos los objetos de sala del inquilino.

GET https://graph.microsoft.com/v1.0/places/microsoft.graph.room


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Places.GraphRoom.GetAsync();



mgc places graph-room get



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphRoom, err := graphClient.Places().GraphRoom().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

RoomCollectionResponse result = graphClient.places().graphRoom().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let room = await client.api('/places/microsoft.graph.room')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->places()->graphRoom()->get()->wait();


Import-Module Microsoft.Graph.Calendar

Get-MgPlaceAsRoom


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.places.graph_room.get()

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#places/microsoft.graph.room",
  "value": [
    {
      "id": "3162F1E1-C4C0-604B-51D8-91DA78989EB1",
      "emailAddress": "cf100@contoso.com",
      "displayName": "Conf Room 100",
      "address": {
        "street": "4567 Main Street",
        "city": "Buffalo",
        "state": "NY",
        "postalCode": "98052",
        "countryOrRegion": "USA"
      },
      "geoCoordinates": {
        "latitude": 47.640568390488626,
        "longitude": -122.1293731033803
      },
      "phone": "000-000-0000",
      "nickname": "Conf Room",
      "label": "100",
      "capacity": 50,
      "building": "1",
      "floorNumber": 1,
      "isManaged": true,
      "isWheelChairAccessible": false,
      "bookingType": "standard",
      "tags": [
        "bean bags"
      ],
      "audioDeviceName": null,
      "videoDeviceName": null,
      "displayDevice": "surface hub"
    },
    {
      "id": "3162F1E1-C4C0-604B-51D8-91DA78970B97",
      "emailAddress": "cf200@contoso.com",
      "displayName": "Conf Room 200",
      "address": {
        "street": "4567 Main Street",
        "city": "Buffalo",
        "state": "NY",
        "postalCode": "98052",
        "countryOrRegion": "USA"
      },
      "geoCoordinates": {
        "latitude": 47.640568390488625,
        "longitude": -122.1293731033802
      },
      "phone": "000-000-0000",
      "nickname": "Conf Room",
      "label": "200",
      "capacity": 40,
      "building": "2",
      "floorNumber": 2,
      "isManaged": true,
      "isWheelChairAccessible": false,
      "bookingType": "standard",
      "tags": [
        "benches",
        "nice view"
      ],
      "audioDeviceName": null,
      "videoDeviceName": null,
      "displayDevice": "surface hub"
    }
  ]
}

Ejemplo 2: Enumerar todas las listas de salas definidas en el inquilino

Solicitud

En el ejemplo siguiente se muestra cómo obtener todos los objetos roomList del inquilino.

GET https://graph.microsoft.com/v1.0/places/microsoft.graph.roomlist


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Places.GraphRoomList.GetAsync();



mgc places graph-room-list get



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphRoomList, err := graphClient.Places().GraphRoomList().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

RoomListCollectionResponse result = graphClient.places().graphRoomList().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let roomlist = await client.api('/places/microsoft.graph.roomlist')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->places()->graphRoomList()->get()->wait();


Import-Module Microsoft.Graph.Calendar

Get-MgPlaceAsRoomList


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.places.graph_room_list.get()

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#places/microsoft.graph.roomList",
  "value": [
    {
      "id": "DC404124-302A-92AA-F98D-7B4DEB0C1705",
      "displayName": "Building 1",
      "address": {
        "street": "4567 Main Street",
        "city": "Buffalo",
        "state": "NY",
        "postalCode": "98052",
        "countryOrRegion": "USA"
      },
      "geocoordinates": null,
      "phone": null,
      "emailAddress": "bldg1@contoso.com"
    },
    {
      "id": "DC404124-302A-92AA-F98D-7B4DEB0C1706",
      "displayName": "Building 2",
      "address": {
        "street": "4567 Main Street",
        "city": "Buffalo",
        "state": "NY",
        "postalCode": "98052",
        "countryOrRegion": "USA"
      },
      "geocoordinates": null,
      "phone": null,
      "emailAddress": "bldg2@contoso.com"
    }
  ]
}

Ejemplo 3: Enumerar salas contenidas en una lista de salas

Solicitud

En el ejemplo siguiente se muestra cómo obtener una lista de objetos room contenidos en roomList.

GET https://graph.microsoft.com/v1.0/places/Building2Rooms@contoso.com/microsoft.graph.roomlist/rooms


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Places["{place-id}"].GraphRoomList.Rooms.GetAsync();



mgc places graph-room-list-by-id rooms list --place-id {place-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
rooms, err := graphClient.Places().ByPlaceId("place-id").GraphRoomList().Rooms().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

RoomCollectionResponse result = graphClient.places().byPlaceId("{place-id}").graphRoomList().rooms().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let rooms = await client.api('/places/Building2Rooms@contoso.com/microsoft.graph.roomlist/rooms')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->places()->byPlaceId('place-id')->graphRoomList()->rooms()->get()->wait();


Import-Module Microsoft.Graph.Calendar

Get-MgPlaceAsRoomListRoom -PlaceId $placeId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.places.by_place_id('place-id').graph_room_list.rooms.get()

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#places('Building2Rooms%40contoso.com')/microsoft.graph.roomList/rooms",
    "value": [
        {
            "id": "f4119db7-9a33-4bfe-a387-4444b9e7fd54",
            "displayName": "Conf Room Rainier",
            "address": null,
            "geoCoordinates": null,
            "phone": "",
            "nickname": "Conf Room Rainier",
            "emailAddress": "Rainier@contoso.com",
            "building": null,
            "floorNumber": null,
            "floorLabel": null,
            "label": null,
            "capacity": null,
            "bookingType": "standard",
            "audioDeviceName": null,
            "videoDeviceName": null,
            "displayDeviceName": null,
            "isWheelChairAccessible": false,
            "tags": []
        },
        {
            "id": "42385a28-1a16-4043-8d84-07615656c4e3",
            "displayName": "Conf Room Hood",
            "address": null,
            "geoCoordinates": null,
            "phone": "",
            "nickname": "Conf Room Hood",
            "emailAddress": "Hood@contoso.com",
            "building": null,
            "floorNumber": null,
            "floorLabel": null,
            "label": null,
            "capacity": null,
            "bookingType": "standard",
            "audioDeviceName": null,
            "videoDeviceName": null,
            "displayDeviceName": null,
            "isWheelChairAccessible": false,
            "tags": []
        },
        {
            "id": "850ee91e-a154-4d87-928e-da04c788fd90",
            "displayName": "Conf Room Baker",
            "address": null,
            "geoCoordinates": null,
            "phone": "",
            "nickname": "Conf Room Baker",
            "emailAddress": "Baker@contoso.com",
            "building": null,
            "floorNumber": null,
            "floorLabel": null,
            "label": null,
            "capacity": null,
            "bookingType": "standard",
            "audioDeviceName": null,
            "videoDeviceName": null,
            "displayDeviceName": null,
            "isWheelChairAccessible": false,
            "tags": []
        }
    ]
}

Compartir a través de

Lugares de lista

Permissions

Solicitud HTTP

Parámetros de consulta opcionales

Encabezados de solicitud

Cuerpo de la solicitud

Respuesta

Ejemplos

Ejemplo 1: Enumerar todas las salas definidas en el inquilino

Solicitud

Respuesta

Ejemplo 2: Enumerar todas las listas de salas definidas en el inquilino

Solicitud

Respuesta

Ejemplo 3: Enumerar salas contenidas en una lista de salas

Solicitud

Respuesta

Comentarios

Recursos adicionales