swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Rooms API
schemes:
- https
tags:
- name: Rooms
paths:
  /rooms:
    post:
      tags:
      - Rooms
      summary: Microsoft Azure Creates A New Room
      operationId: microsoftAzureRoomsCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - in: header
        name: Repeatability-Request-ID
        description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-ID and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-ID is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.
        type: string
        format: uuid
      - in: header
        name: Repeatability-First-Sent
        description: If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date.
        type: string
        format: date-time-rfc1123
      - in: body
        name: createRoomRequest
        description: The create room request body.
        schema:
          $ref: '#/definitions/CreateRoomRequest'
        required: true
      responses:
        '201':
          description: Request successful. The action returns a new room.
          schema:
            $ref: '#/definitions/RoomModel'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              type: string
      x-ms-examples:
        Create a new meeting room.:
          $ref: ./examples/Rooms_Create.json
      description: Needs a more full description created.
    get:
      tags:
      - Rooms
      summary: Microsoft Azure Retrieves All Created Rooms
      operationId: microsoftAzureRoomsList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request successful. The action returns a collection of rooms.
          schema:
            $ref: '#/definitions/RoomsCollection'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              type: string
      x-ms-examples:
        List all rooms.:
          $ref: ./examples/Rooms_List.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      description: Needs a more full description created.
  /rooms/{roomId}:
    get:
      tags:
      - Rooms
      summary: Microsoft Azure Retrieves An Existing Room By Id
      operationId: microsoftAzureRoomsGet
      produces:
      - application/json
      parameters:
      - in: path
        name: roomId
        description: The id of the room requested.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request successful. The action returns a room.
          schema:
            $ref: '#/definitions/RoomModel'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              type: string
      x-ms-examples:
        Get meeting room.:
          $ref: ./examples/Rooms_Get.json
      description: Needs a more full description created.
    patch:
      tags:
      - Rooms
      summary: Microsoft Azure Update A Room With Given Changes
      operationId: microsoftAzureRoomsUpdate
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: roomId
        description: The id of the room requested.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: updateRoomRequest
        description: The update room request.
        required: true
        schema:
          $ref: '#/definitions/UpdateRoomRequest'
      responses:
        '200':
          description: Request successful. The action returns an updated room.
          schema:
            $ref: '#/definitions/RoomModel'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              type: string
      x-ms-examples:
        Update meeting room's properties.:
          $ref: ./examples/Rooms_Update.json
      description: Needs a more full description created.
    delete:
      tags:
      - Rooms
      summary: Microsoft Azure Delete A Room
      operationId: microsoftAzureRoomsDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: roomId
        description: The id of the room to be deleted.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '204':
          description: The room was successfully deleted.
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              type: string
      x-ms-examples:
        Delete a meeting room.:
          $ref: ./examples/Rooms_Delete.json
      description: Needs a more full description created.
definitions:
  RoomsCollection:
    description: A collection of rooms.
    required:
    - value
    type: object
    properties:
      value:
        description: A collection of rooms
        type: array
        items:
          $ref: '#/definitions/RoomModel'
      nextLink:
        description: If there are more rooms that can be retrieved, the next link will be populated.
        type: string
  CommunicationErrorResponse:
    $ref: ../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse
  Role:
    description: The role of a room participant. The default value is Attendee.
    enum:
    - Presenter
    - Attendee
    - Consumer
    type: string
    x-ms-enum:
      name: Role
      modelAsString: true
  UpdateRoomRequest:
    description: Request payload for updating a room.
    type: object
    properties:
      validFrom:
        format: date-time
        description: '(Optional) The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        example: '2021-09-07T07:55:41Z'
      validUntil:
        format: date-time
        description: '(Optional) The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        example: '2021-09-08T15:55:41Z'
      pstnDialOutEnabled:
        description: Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false.
        type: boolean
  RoomModel:
    description: The meeting room.
    type: object
    required:
    - createdAt
    - id
    - validFrom
    - validUntil
    - pstnDialOutEnabled
    properties:
      id:
        description: Unique identifier of a room. This id is server generated.
        type: string
        example: '99199690362660524'
      createdAt:
        format: date-time
        description: 'The timestamp when the room was created at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        example: '2021-09-06T05:55:41Z'
      validFrom:
        format: date-time
        description: 'The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        example: '2021-09-07T07:55:41Z'
      validUntil:
        format: date-time
        description: 'The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        example: '2021-09-08T15:55:41Z'
      pstnDialOutEnabled:
        description: Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false.
        type: boolean
  CreateRoomRequest:
    description: Request payload for creating new room.
    type: object
    properties:
      validFrom:
        format: date-time
        description: 'The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. The default value is the current date time.'
        type: string
        example: '2021-09-07T07:55:41Z'
      validUntil:
        format: date-time
        description: 'The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. The default value is the current date time plus 180 days.'
        type: string
        example: '2021-09-08T15:55:41Z'
      pstnDialOutEnabled:
        description: Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false.
        type: boolean
      participants:
        description: (Optional) Participants to be invited to the room.
        type: object
        additionalProperties:
          $ref: '#/definitions/ParticipantProperties'
        example:
          rawId1:
            role: Presenter
          rawId2:
            role: Attendee
          rawId3: null
  ParticipantProperties:
    required:
    - role
    type: object
    properties:
      role:
        $ref: '#/definitions/Role'
parameters:
  ApiVersionParameter:
    in: query
    name: api-version
    description: Version of API to invoke.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'