Partager via


Répertorier les lieux

Espace de noms: microsoft.graph

Obtient une collection du type spécifié d’objets place définis dans le locataire. Par exemple, vous pouvez obtenir toutes les salles, toutes les listes de salles ou les salles d’une liste de salles spécifique dans le locataire.

Note: Les salles marquées « Masquées de la liste d’adresses » ne peuvent pas être récupérées via ce point de terminaison.

Un objet place peut être de l’un des types suivants :

  • Une salle qui inclut des propriétés enrichies telles qu’une adresse e-mail pour la salle, et l’accessibilité, la capacité et la prise en charge des appareils.
  • Liste de salles qui inclut une adresse e-mail pour la liste de salles et une propriété de navigation pour obtenir la collection d’instances de salle dans la liste des salles.

room et roomList sont dérivés de l’objet place.

Par défaut, cette opération retourne 100 places par page.

Par rapport aux fonctions findRooms et findRoomLists , cette opération retourne une charge utile plus riche pour les salles et les listes de salles. Consultez les détails de leur comparaison.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Place.Read.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Place.Read.All Non disponible.

Requête HTTP

Pour obtenir toutes les salles d’un locataire :

GET /places/microsoft.graph.room

Pour obtenir toutes les listes de salles dans un locataire :

GET /places/microsoft.graph.roomlist

Pour obtenir toutes les salles de la liste de salles spécifiée :

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

Remarque : Pour obtenir des salles dans une liste de salles, vous devez spécifier la liste de salles par sa propriété emailAddress , et non par son ID.

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de requête suivants pour personnaliser la réponse :

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

Utilisez $top pour personnaliser la taille de la page. La taille de page par défaut est 100.

Pour des informations générales, consultez paramètres de la requête OData.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et une collection d’objets de place dans le corps de la réponse.

Exemples

Exemple 1 : Répertorier toutes les salles définies dans le locataire

Demande

L’exemple suivant montre comment obtenir tous les objets de salle dans le locataire.

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

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ici peut être raccourci pour plus de lisibilité.

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

Exemple 2 : Répertorier toutes les listes de salles définies dans le locataire

Demande

L’exemple suivant montre comment obtenir tous les objets roomList dans le locataire.

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

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ici peut être raccourci pour plus de lisibilité.

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

Exemple 3 : Répertorier les salles contenues dans une liste de salles

Demande

L’exemple suivant montre comment obtenir une liste d’objets de salle contenus dans un roomList.

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

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ici peut être raccourci pour plus de lisibilité.

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