Locais de lista
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 coleção do tipo especificado de objetos place definidos no locatário.
Você pode fazer o seguinte para um determinado locatário:
- Liste todas as salas.
- Liste todos os workspaces.
- Liste todas as listas de salas.
- Listar salas em uma lista de salas específica.
- Liste workspaces em uma lista de salas específica.
Um objeto place pode ser um dos seguintes tipos:
- Uma sala, que inclui propriedades avançadas, como um endereço de email para a sala, e acessibilidade, capacidade e suporte ao dispositivo.
- Um workspace, que inclui propriedades como um endereço de email para o workspace, acessibilidade e capacidade.
- Uma roomList, que inclui um endereço de email para a lista de salas e uma propriedade de navegação para obter a coleção de instâncias de sala na lista de salas.
Os recursos de sala, workspace e roomList são derivados do objeto place .
Por padrão, essa operação retorna até 100 lugares por página.
Em comparação com as funções findRooms e findRoomLists , essa operação retorna uma carga mais rica para salas e listas de salas. Para obter detalhes sobre como eles se comparam, consulte Usando a API de locais.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas 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 privilegiadas mais altas |
---|---|---|
Delegado (conta corporativa ou de estudante) | Place.Read.All | Indisponível. |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Aplicativo | Place.Read.All | Indisponível. |
Solicitação HTTP
Para obter todos os quartos em um locatário:
GET /places/microsoft.graph.room
Para obter todos os workspaces em um locatário:
GET /places/microsoft.graph.workspace
Para obter todas as listas de salas em um locatário:
GET /places/microsoft.graph.roomlist
Para obter todas as salas na lista de salas especificada:
GET /places/{room-list-emailaddress}/microsoft.graph.roomlist/rooms
Para obter todos os workspaces na lista de salas especificada:
GET /places/{room-list-emailaddress}/microsoft.graph.roomlist/workspaces
Observação: para obter salas ou workspaces em uma lista de salas, você deve especificar a lista de salas por sua propriedade emailAddress , não por sua ID.
Parâmetros de consulta opcionais
Esse método dá suporte aos seguintes parâmetros de consulta para ajudar a personalizar a resposta:
$filter
$select
$top
$skip
$count=true
Use $top
para personalizar o tamanho da página. O tamanho de página padrão é 100.
Para obter informações gerais, acesse Parâmetros de consulta OData.
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 de lugar no corpo da resposta.
Exemplos
Exemplo 1: Listar todas as salas definidas no locatário
Solicitação
O exemplo a seguir mostra como obter todos os objetos de sala no locatário.
GET https://graph.microsoft.com/beta/places/microsoft.graph.room
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$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,
"isWheelChairAccessible": false,
"bookingType": "standard",
"tags": [
"bean bags"
],
"audioDeviceName": null,
"videoDeviceName": null,
"displayDeviceName": "surface hub",
"placeId": "080ed1a0-7b54-4995-85a5-eeec751786f5"
},
{
"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,
"isWheelChairAccessible": false,
"bookingType": "standard",
"tags": [
"benches",
"nice view"
],
"audioDeviceName": null,
"videoDeviceName": null,
"displayDeviceName": "surface hub",
"placeId": "282c6d10-f8d4-441e-9f7f-edd2e554f61d"
}
]
}
Exemplo 2: listar todos os workspaces definidos no locatário
Solicitação
O exemplo a seguir mostra como obter todos os objetos workspaces no locatário.
GET https://graph.microsoft.com/beta/places/microsoft.graph.workspace
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#places/microsoft.graph.workspace",
"value": [
{
"id": "3162F1E1-C4C0-604B-51D8-91DA78989EB1",
"emailAddress": "ws100@contoso.com",
"displayName": "Workspace 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": "Workspace",
"label": "100",
"capacity": 50,
"building": "1",
"floorNumber": 1,
"isWheelChairAccessible": false,
"tags": [
"bean bags"
],
"placeId": "357e8ddc-8af5-4c7c-bc38-ddb3bcfec0d9"
},
{
"id": "3162F1E1-C4C0-604B-51D8-91DA78970B97",
"emailAddress": "ws200@contoso.com",
"displayName": "Workspace 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": "Workspace",
"label": "200",
"capacity": 40,
"building": "2",
"floorNumber": 2,
"isWheelChairAccessible": false,
"tags": [
"benches",
"nice view"
],
"placeId": "ca4e4ca8-4e92-4a83-afe4-5104c0ca1de3"
}
]
}
Exemplo 3: listar todas as listas de salas definidas no locatário
Solicitação
O exemplo a seguir mostra como obter todos os objetos roomList no locatário.
GET https://graph.microsoft.com/beta/places/microsoft.graph.roomlist
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$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",
"placeId": "406bd1b2-237c-4710-bda2-8b7900d61b27"
},
{
"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",
"placeId": "25709e2a-4c17-49ab-b591-1daf8d9b786d"
}
]
}
Exemplo 4: Listar salas contidas em uma lista de salas
Solicitação
O exemplo a seguir mostra como obter uma lista de objetos de sala contidos em uma roomList.
GET https://graph.microsoft.com/beta/places/bldg2@contoso.com/microsoft.graph.roomlist/rooms
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#places('bldg2%40contoso.com')/microsoft.graph.roomList/rooms",
"value": [
{
"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,
"isWheelChairAccessible": false,
"bookingType": "standard",
"tags": [
"benches",
"nice view"
],
"audioDeviceName": null,
"videoDeviceName": null,
"displayDeviceName": "surface hub",
"placeId": "62cfc8cb-fc2b-4783-aeea-f9ce0f8e2904"
}
]
}
Exemplo 5: Listar workspaces contidos em uma lista de salas
Solicitação
O exemplo a seguir mostra como obter uma lista de objetos de workspace contidos em uma roomList.
GET https://graph.microsoft.com/beta/places/bldg2@contoso.com/microsoft.graph.roomlist/workspaces
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#places('bldg2%40contoso.com')/microsoft.graph.roomList/workspaces",
"value": [
{
"id": "3162F1E1-C4C0-604B-51D8-91DA78970B97",
"emailAddress": "ws200@contoso.com",
"displayName": "Workspace 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": "Workspace",
"label": "200",
"capacity": 40,
"building": "2",
"floorNumber": 2,
"isWheelChairAccessible": false,
"tags": [
"benches",
"nice view"
],
"placeId": "ca4e4ca8-4e92-4a83-afe4-5104c0ca1de3"
}
]
}