Edit

Share via

place resource type

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents basic location attributes such as name, physical address, and geographic coordinates. This resource is the base type for richer location types such as room, workspace, and roomList.

Using the places API

Exchange Online administrators can organize meeting rooms and workspaces in a tenant into room lists. Using the places API, you can use the list operation to get all the rooms, workspaces, or room lists in the tenant, or get the rooms and workspaces in a specific room list.

Places like room, workspace, and roomList contain the basic ID, display name, and email address. In addition, they contain navigational information like physical address and geographical coordinates, and in the case of rooms, other relevant information such as AV capabilities, floor number, and capacity.

The findRooms and findRoomLists functions support similar lookups for rooms and room lists in a tenant. The following table compares the places API and these functions.

Note: The findRooms and findRoomLists functions are deprecated.

Places API findRooms and findRoomLists functions (deprecated)
Gets all the rooms or room lists in a tenant, and all the rooms in a room list. Gets all the rooms or room lists in a tenant, and all the rooms in a room list.
List places can return more than 100 rooms in a tenant. findRooms returns up to the first 100 rooms in a tenant.
Supports getting an individual room or room list in a tenant. Doesn't support getting an individual room or room list in a tenant.
Defines the specific entities of room and roomList that specify a richer property set, the display name, and the SMTP address. Each room and room list is of a lighter weight emailAddress type that specifies only the display name and SMTP address.
Supports only organizational scenarios with delegated (work or school accounts) or application permissions. Supports only organizational scenarios with delegated or application permissions.
Supports updating an individual room or room list in a tenant. Doesn't support updating an individual room or room list in a tenant.

Methods

Method Return Type Description
List places A collection of the requested, derived type of place Get a collection of the specified type of place objects defined in the tenant.
Get place The requested, derived type of place Get the properties and relationships of a specified place object.
Update place The requested, derived type of place Update the properties and relationships of a specified place object.

Properties

Property Type Description
address physicalAddress The street address of the place.
displayName String The name associated with the place.
geoCoordinates outlookGeoCoordinates Specifies the place location in latitude, longitude, and (optionally) altitude coordinates.
id String A unique identifier for the place. Read-only. This identifier isn't immutable and can change if there are changes to the mailbox or to the tenant configuration.
phone String The phone number of the place.
placeId String A unique, immutable identifier for the place. Read-only. The value of this identifier is equal to the ExternalDirectoryObjectId returned from the Get-Mailbox cmdlet.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "address": {"@odata.type": "microsoft.graph.physicalAddress"},
  "displayName": "String",
  "id": "String (identifier)",
  "geoCoordinates": {"@odata.type": "microsoft.graph.outlookGeoCoordinates"},
  "phone": "String",
  "placeId": "String (alternate identifier)"
}

Related content