openapi: 3.2.0
info:
  title: Folio Reading Room Patron Permission API
  version: 1.0.0
  description: 'Operations tagged Reading Room Patron Permission across 2 of this provider''s published API definitions: folio-mod-reading-room-patron-permission-openapi.json, folio-mod-reading-room-patron-permission-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Reading Room Patron Permission
paths:
  /reading-room-patron-permission/{patronId}:
    parameters:
    - $ref: '#/components/parameters/userId'
    get:
      summary: Get list of patron permissions based on userId
      operationId: getPatronPermissionsByUserId
      parameters:
      - $ref: '#/components/parameters/servicePointId'
      responses:
        '200':
          description: patron permissions retrieved successfully
          $ref: '#/components/responses/patronPermissionObjectResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Reading Room Patron Permission
    put:
      summary: update list of patron permissions based on userId
      operationId: UpdatePatronReadingRoomPermission
      requestBody:
        $ref: '#/components/requestBodies/patronPermissionBody'
      responses:
        '200':
          $ref: '#/components/responses/patronPermissionObjectResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Reading Room Patron Permission
components:
  parameters:
    servicePointId:
      in: query
      name: servicePointId
      schema:
        $ref: '#/components/schemas/uuid'
      required: false
    userId:
      in: path
      name: patronId
      schema:
        $ref: '#/components/schemas/uuid'
      required: true
  schemas:
    PatronPermission:
      description: Patron permission for a reading room
      type: object
      properties:
        id:
          description: A unique patron permission record identifier
          type: string
          format: UUID
        userId:
          description: A unique identifier of user
          type: string
          format: UUID
        readingRoomId:
          description: A unique identifier of reading room
          type: string
          format: UUID
        readingRoomName:
          description: Name of the reading room
          type: string
        access:
          description: A field to determine the access of a user for a reading room
          type: string
          enum:
          - ALLOWED
          - NOT_ALLOWED
        notes:
          description: Notes for the user
          type: string
        metadata:
          type: object
          $ref: '#/components/schemas/Metadata'
    Error:
      description: An error
      type: object
      properties:
        message:
          type: string
          minLength: 1
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          type: string
          description: Error message code
        parameters:
          description: Error message parameters
          $ref: '#/components/schemas/Parameters'
      additionalProperties: false
      required:
      - message
    Parameter:
      description: List of key/value parameters of an error
      type: object
      properties:
        key:
          type: string
          minLength: 1
        value:
          type: string
      additionalProperties: false
      required:
      - key
    Metadata:
      type: object
      title: Metadata
      description: Metadata about creation and changes to records
      properties:
        createdDate:
          type: string
          description: Date and time when the record was created
        createdByUserId:
          $ref: '#/components/schemas/uuid'
          description: ID of the user who created the record
        updatedDate:
          type: string
          description: Date and time when the record was last updated
        updatedByUserId:
          $ref: '#/components/schemas/uuid'
          description: ID of the user who last updated the record
    uuid:
      type: string
      format: uuid
    PatronPermissionCollection:
      type: array
      description: The list of patronPermissions
      items:
        $ref: '#/components/schemas/PatronPermission'
    Parameters:
      description: List of key/value parameters of an error
      type: array
      items:
        $ref: '#/components/schemas/Parameter'
      additionalProperties: false
  responses:
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    patronPermissionObjectResponse:
      description: Collection of patron permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PatronPermissionCollection'
  requestBodies:
    patronPermissionBody:
      description: Collection of patron permissions
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PatronPermissionCollection'
x-refined-from:
- folio-mod-reading-room-patron-permission-openapi.json
- folio-mod-reading-room-patron-permission-openapi.yml