openapi: 3.2.0
info:
  title: Folio Retrievals API
  version: v1
  description: 'Operations tagged Retrievals across 2 of this provider''s published API definitions: folio-mod-remote-storage-openapi.json, folio-mod-remote-storage-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /remote-storage/
tags:
- name: Retrievals
paths:
  /retrievals:
    get:
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/retrievalQueues'
        '500':
          description: Internal server error
          content:
            text/plain:
              schema:
                type: string
                example: Internal server error
      description: Get a list of retrieval records
      operationId: getRetrievals
      parameters:
      - $ref: '#/components/parameters/trait_queryable_retrieved'
      - $ref: '#/components/parameters/trait_queryable_storage_id'
      - $ref: '#/components/parameters/trait_queryable_created_date'
      - $ref: '#/components/parameters/trait_pageable_offset'
      - $ref: '#/components/parameters/trait_pageable_limit'
      tags:
      - Retrievals
      summary: Get retrievals
      x-summary-source: derived
    servers:
    - url: /remote-storage/
  /retrievals/id/{retrievalId}:
    put:
      responses:
        '204':
          description: Set retrieve date time
          content:
            text/plain:
              schema:
                type: string
                example: No content
      description: Set retrieval date by retrieval queue id
      operationId: setRetrievedById
      parameters:
      - name: retrievalId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      tags:
      - Retrievals
      summary: Set retrieved by id
      x-summary-source: derived
    servers:
    - url: /remote-storage/
  /retrievals/barcode/{barcode}:
    put:
      responses:
        '204':
          description: Set retrieve date time
          content:
            text/plain:
              schema:
                type: string
                example: No content
      description: Set retrieved date by item barcode
      operationId: setRetrievedByBarcode
      parameters:
      - name: barcode
        in: path
        required: true
        schema:
          type: string
      tags:
      - Retrievals
      summary: Set retrieved by barcode
      x-summary-source: derived
    servers:
    - url: /remote-storage/
components:
  schemas:
    baseCollection:
      $schema: http://json-schema.org/draft-04/schema#
      description: Basic object to create pageable responses
      type: object
      properties:
        totalRecords:
          description: total records value
          type: integer
    retrievalQueue:
      $schema: http://json-schema.org/draft-04/schema#
      description: Retrieval queue
      type: object
      properties:
        id:
          description: Retrieval queue id
          $ref: '#/components/schemas/uuid'
        holdId:
          description: Hold/request id
          type: string
        itemBarcode:
          description: Item barcode
          type: string
        instanceTitle:
          description: Instance title
          type: string
        instanceAuthor:
          description: Instance author
          type: string
        callNumber:
          description: Call number
          type: string
        patronBarcode:
          description: Patron barcode
          type: string
        patronName:
          description: Patron name
          type: string
        retrievedDateTime:
          description: Retrieved date
          type: string
          format: date-time
        pickupLocation:
          description: Pickup location
          type: string
        requestStatus:
          description: Request status
          type: string
        requestNote:
          description: Request note
          type: string
        createdDateTime:
          description: Request Date
          type: string
          format: date-time
        remoteStorageId:
          description: Remote storage id
          $ref: '#/components/schemas/uuid'
        requestType:
          description: Request type
          type: string
        metadata:
          description: Entity metadata
          type: object
          $ref: '#/components/schemas/metadata'
      additionalProperties: false
      required: []
    uuid:
      $schema: http://json-schema.org/draft-04/schema#
      description: Regexp pattern for UUID validation
      type: string
      pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$
    retrievalQueues:
      allOf:
      - $ref: '#/components/schemas/baseCollection'
      - type: object
        properties:
          retrievals:
            type: array
            items:
              $ref: '#/components/schemas/retrievalQueue'
    metadata:
      $schema: http://json-schema.org/draft-04/schema#
      title: Metadata Schema
      description: Metadata about creation and changes to records, provided by the server (client should not provide)
      type: object
      properties:
        createdDate:
          description: Date and time when the record was created
          type: string
          format: date-time
        createdByUserId:
          description: ID of the user who created the record (when available)
          $ref: '#/components/schemas/uuid'
        createdByUsername:
          description: Username of the user who created the record (when available)
          type: string
        updatedDate:
          description: Date and time when the record was last updated
          type: string
          format: date-time
        updatedByUserId:
          description: ID of the user who last updated the record (when available)
          $ref: '#/components/schemas/uuid'
        updatedByUsername:
          description: Username of the user who last updated the record (when available)
          type: string
      additionalProperties: false
      required:
      - createdDate
  parameters:
    trait_pageable_limit:
      name: limit
      in: query
      description: Limit the number of elements returned in the response
      schema:
        default: 10
        minimum: 0
        maximum: 2147483647
        type: integer
    trait_queryable_storage_id:
      name: storageId
      in: query
      description: Remote storage id
      schema:
        type: string
    trait_queryable_retrieved:
      name: retrieved
      in: query
      description: Flag to indicate, that retrievals queue record was retrieved and has retrievals date
      schema:
        type: boolean
    trait_pageable_offset:
      name: offset
      in: query
      description: Skip over a number of elements by specifying an offset value for the query
      schema:
        default: 0
        minimum: 0
        maximum: 2147483647
        type: integer
    trait_queryable_created_date:
      name: createdDate
      in: query
      description: Date of accession queue record creation
      schema:
        type: string
x-refined-from:
- folio-mod-remote-storage-openapi.json
- folio-mod-remote-storage-openapi.yml