Microsoft 365 Places.place.Functions API

openapi: 3.2.0
info:
  title: Calendar Places.place.Functions API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: places.place.Functions
paths:
  /places/{place-id}/microsoft.graph.descendants():
    get:
      tags:
      - places.place.Functions
      summary: Invoke function descendants
      operationId: place_descendant
      parameters:
      - name: place-id
        in: path
        description: The unique identifier of place
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: place
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $orderby
        in: query
        description: Order items by property values
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                title: Collection of place
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/microsoft.graph.place'
                  '@odata.nextLink':
                    type:
                    - string
                    - 'null'
                additionalProperties:
                  type: object
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: function
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
components:
  schemas:
    microsoft.graph.checkInClaim:
      title: checkInClaim
      type: object
      properties:
        calendarEventId:
          type: string
          description: The unique identifier for an Outlook calendar event associated with the checkInClaim object. For more information, see the iCalUId property in event.
        checkInMethod:
          $ref: '#/components/schemas/microsoft.graph.checkInMethod'
        createdDateTime:
          pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
          type:
          - string
          - 'null'
          description: The date and time when the checkInClaim object was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
          format: date-time
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.physicalAddress:
      title: physicalAddress
      type: object
      properties:
        city:
          type:
          - string
          - 'null'
          description: The city.
        countryOrRegion:
          type:
          - string
          - 'null'
          description: The country or region. It's a free-format string value, for example, 'United States'.
        postalCode:
          type:
          - string
          - 'null'
          description: The postal code.
        state:
          type:
          - string
          - 'null'
          description: The state.
        street:
          type:
          - string
          - 'null'
          description: The street.
      additionalProperties:
        type: object
    microsoft.graph.checkInMethod:
      title: checkInMethod
      enum:
      - unspecified
      - manual
      - inferred
      - verified
      - unknownFutureValue
      type: string
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.MainError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          x-ms-primary-error-message: true
        target:
          type:
          - string
          - 'null'
        details:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
        innerError:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
      additionalProperties:
        type: object
    microsoft.graph.outlookGeoCoordinates:
      title: outlookGeoCoordinates
      type: object
      properties:
        accuracy:
          type:
          - number
          - 'null'
          description: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.
          format: double
        altitude:
          type:
          - number
          - 'null'
          description: The altitude of the location.
          format: double
        altitudeAccuracy:
          type:
          - number
          - 'null'
          description: The accuracy of the altitude.
          format: double
        latitude:
          type:
          - number
          - 'null'
          description: The latitude of the location.
          format: double
        longitude:
          type:
          - number
          - 'null'
          description: The longitude of the location.
          format: double
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
      additionalProperties:
        type: object
    microsoft.graph.entity:
      title: entity
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for an entity. Read-only.
      additionalProperties:
        type: object
    microsoft.graph.place:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: place
        type: object
        properties:
          address:
            $ref: '#/components/schemas/microsoft.graph.physicalAddress'
          displayName:
            type: string
            description: The name that is associated with the place.
          geoCoordinates:
            $ref: '#/components/schemas/microsoft.graph.outlookGeoCoordinates'
          isWheelChairAccessible:
            type:
            - boolean
            - 'null'
            description: Indicates whether the place is wheelchair accessible.
          label:
            type:
            - string
            - 'null'
            description: User-defined description of the place.
          parentId:
            type:
            - string
            - 'null'
            description: The ID of a parent place.
          phone:
            type:
            - string
            - 'null'
            description: The phone number of the place.
          placeId:
            type:
            - string
            - 'null'
            description: A stable service-level identifier for the place object used by Places workloads.
          tags:
            type: array
            items:
              type: string
            description: Custom tags that are associated with the place for categorization or filtering.
          checkIns:
            type: array
            items:
              $ref: '#/components/schemas/microsoft.graph.checkInClaim'
            description: A subresource of a place object that indicates the check-in status of an Outlook calendar event booked at the place.
            x-ms-navigationProperty: true
        additionalProperties:
          type: object
  parameters:
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
    top:
      name: $top
      in: query
      description: Show only the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
      example: 50
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
    skip:
      name: $skip
      in: query
      description: Skip the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
  responses:
    error:
      description: error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
  securitySchemes:
    azureaadv2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}