列出位置

命名空间:microsoft.graph

获取租户中定义的指定类型的 place 对象的集合。 例如,可以获取租户中所有会议室、所有会议室列表或特定会议室列表中的会议室。

注意: 无法通过此终结点检索标记为“已从 GAL 隐藏”的会议室。

place 对象可以是以下类型之一:

  • 一个 会议室 ,其中包含丰富的属性,例如会议室的电子邮件地址,以及辅助功能、容量和设备支持。
  • 会议室列表,其中包含会议室列表的电子邮件地址,以及用于获取会议室列表中会议室实例集合的导航属性。

roomroomList 都派生自 place 对象。

默认情况下,此操作每页返回 100 个位置。

findRoomsfindRoomLists 函数相比,此操作为会议室和会议室列表返回更丰富的有效负载。 请参阅 详细信息 ,了解它们之间的比较方式。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Place.Read.All 不可用。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 Place.Read.All 不可用。

HTTP 请求

若要获取租户中的所有会议室,请执行以下操作:

GET /places/microsoft.graph.room

若要获取租户中的所有会议室列表,请执行以下操作:

GET /places/microsoft.graph.roomlist

若要获取指定会议室列表中的所有会议室,请执行以下操作:

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

注意:若要获取会议室列表中的会议室,必须按 其 emailAddress 属性(而不是 ID)指定会议室列表。

可选的查询参数

此方法支持以下查询参数来帮助自定义响应:

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

使用 $top 自定义页面大小。 默认页面大小是 100。

若要了解一般信息,请参阅 OData 查询参数

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法在响应正文中返回响应 200 OK 代码和 place 对象的集合。

示例

示例 1:列出租户中定义的所有会议室

请求

以下示例演示如何获取租户中的所有 会议室 对象。

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

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

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"
    }
  ]
}

示例 2:列出租户中定义的所有会议室列表

请求

以下示例演示如何获取租户中的所有 roomList 对象。

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

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

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"
    }
  ]
}

示例 3:列出会议室列表中包含的聊天室

请求

以下示例演示如何获取 roomList 中包含的 会议室对象列表。

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

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

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": []
        }
    ]
}