openapi: 3.2.0
info:
  title: Folio Get Search Slips API
  version: v1
  description: 'Operations tagged getSearchSlips across 2 of this provider''s published API definitions: folio-mod-circulation-bff-circulationbff-openapi.json, folio-mod-circulation-bff-circulationbff-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: getSearchSlips
paths:
  /circulation-bff/search-slips/{servicePointId}:
    get:
      description: API to get search slips
      operationId: getSearchSlips
      tags:
      - getSearchSlips
      parameters:
      - $ref: '#/components/parameters/servicePointId'
      responses:
        '200':
          description: A collection of search slips
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/searchSlipCollection'
        '404':
          $ref: '#/components/responses/notFoundResponse'
        '422':
          $ref: '#/components/responses/unprocessableEntityResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
      summary: Get search slips
      x-summary-source: derived
components:
  schemas:
    staffSlip:
      description: Staff slip
      type: object
      properties:
        currentDateTime:
          type: string
          format: date-time
        item:
          type: object
          properties:
            title:
              type: string
            primaryContributor:
              type: string
            allContributors:
              type: string
            barcode:
              type: string
            status:
              type: string
            enumeration:
              type: string
            volume:
              type: string
            chronology:
              type: string
            yearCaption:
              type: string
            materialType:
              type: string
            loanType:
              type: string
            copy:
              type: string
            numberOfPieces:
              type: string
            displaySummary:
              type: string
            descriptionOfPieces:
              type: string
            effectiveLocationSpecific:
              type: string
            effectiveLocationLibrary:
              type: string
            effectiveLocationCampus:
              type: string
            effectiveLocationInstitution:
              type: string
            effectiveLocationDiscoveryDisplayName:
              type: string
            effectiveLocationPrimaryServicePointName:
              type: string
            callNumber:
              type: string
            callNumberPrefix:
              type: string
            callNumberSuffix:
              type: string
            lastCheckedInDateTime:
              type: string
              format: date-time
        request:
          type: object
          properties:
            requestID:
              type: string
              format: uuid
            servicePointPickup:
              type: string
            requestDate:
              type: string
              format: date-time
            requestExpirationDate:
              type: string
              format: date-time
            holdShelfExpirationDate:
              type: string
              format: date-time
            additionalInfo:
              type: string
            reasonForCancellation:
              type: string
            deliveryAddressType:
              type: string
            patronComments:
              type: string
        requester:
          type: object
          properties:
            firstName:
              type: string
            preferredFirstName:
              type: string
            lastName:
              type: string
            middleName:
              type: string
            barcode:
              type: string
            patronGroup:
              type: string
            departments:
              type: string
            primaryDeliveryAddressType:
              type: string
            primaryAddressLine1:
              type: string
            primaryAddressLine2:
              type: string
            primaryCity:
              type: string
            primaryStateProvRegion:
              type: string
            primaryZipPostalCode:
              type: string
            primaryCountry:
              type: string
            addressType:
              type: string
            addressLine1:
              type: string
            addressLine2:
              type: string
            city:
              type: string
            region:
              type: string
            postalCode:
              type: string
            countryId:
              type: string
    parameter:
      description: List of key/value parameters of an error
      type: object
      properties:
        key:
          description: Parameter key
          type: string
        value:
          description: Parameter value
          type: string
      example:
        key: source
        value: 'null'
    errorResponse:
      description: A set of errors
      type: object
      properties:
        errors:
          description: List of errors
          type: array
          items:
            $ref: '#/components/schemas/error'
        total_records:
          description: Total number of errors
          type: integer
      example:
        errors:
        - message: Illegal argument error
          type: IllegalArgumentException
          code: unknown_error
        total_records: 1
    error:
      description: An error
      type: object
      properties:
        message:
          type: string
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          type: string
          description: Error message code
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/parameter'
    searchSlipCollection:
      description: Collection of search slips
      type: object
      properties:
        totalRecords:
          type: integer
          description: Total number of search slips
        searchSlips:
          type: array
          items:
            $ref: '#/components/schemas/staffSlip'
      required:
      - totalRecords
      - searchSlips
  examples:
    validationErrorResponse:
      value:
        errors:
        - message: must not be null
          type: MethodArgumentNotValidException
          code: validation_error
          parameters:
          - key: parameter
            value: 'null'
        total_records: 1
    unknownError:
      value:
        errors:
        - message: Illegal argument error
          type: IllegalArgumentException
          code: unknown_error
        total_records: 1
  parameters:
    servicePointId:
      name: servicePointId
      in: path
      required: true
      schema:
        type: string
  responses:
    internalServerErrorResponse:
      description: When unhandled exception occurred during code execution, e.g. NullPointerException.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          examples:
            unknownError:
              $ref: '#/components/examples/unknownError'
    notFoundResponse:
      description: Not found
      content:
        application/json:
          example:
            errors:
            - message: Not found
            total_records: 1
          schema:
            $ref: '#/components/schemas/errorResponse'
    unprocessableEntityResponse:
      description: Validation error for the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          examples:
            response:
              $ref: '#/components/examples/validationErrorResponse'
x-refined-from:
- folio-mod-circulation-bff-circulationbff-openapi.json
- folio-mod-circulation-bff-circulationbff-openapi.yml