openapi: 3.2.0
info:
  title: Folio Get Allowed Service Points API
  version: v1
  description: 'Operations tagged getAllowedServicePoints 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: getAllowedServicePoints
paths:
  /circulation-bff/requests/allowed-service-points:
    get:
      description: Retrieve allowed service points
      parameters:
      - $ref: '#/components/parameters/operation'
      - $ref: '#/components/parameters/patronGroupId'
      - $ref: '#/components/parameters/instanceId'
      - $ref: '#/components/parameters/requestId'
      - $ref: '#/components/parameters/requesterId'
      - $ref: '#/components/parameters/itemId'
      - in: header
        name: X-Okapi-Tenant
        required: true
        schema:
          type: string
        description: The tenant ID for the request
      tags:
      - getAllowedServicePoints
      responses:
        '200':
          description: Allowed service points grouped by request type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/allowedServicePoints-2'
        '400':
          $ref: '#/components/responses/badRequestResponse'
        '422':
          $ref: '#/components/responses/unprocessableEntityResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
      summary: Get circulation bff requests allowed service points
      x-summary-source: derived
      operationId: getCirculationBffRequestsAllowedServicePoints
      x-operation-id-source: derived
components:
  schemas:
    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
    allowedServicePoints:
      description: List of allowed pickup service points
      type: array
      default: null
      minItems: 1
      uniqueItems: true
      items:
        type: object
        properties:
          id:
            $ref: '#/components/schemas/uuid'
          name:
            description: Service point name
            type: string
          discoveryDisplayName:
            description: discoveryDisplayName of Service point
            type: string
        required:
        - id
        - name
    uuid:
      $schema: http://json-schema.org/draft-04/schema#
      description: A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
      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}$
    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'
    allowedServicePoints-2:
      description: Allowed pickup service points grouped by request type
      type: object
      x-class-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)'
      properties:
        Page:
          $ref: '#/components/schemas/allowedServicePoints'
        Hold:
          $ref: '#/components/schemas/allowedServicePoints'
        Recall:
          $ref: '#/components/schemas/allowedServicePoints'
  parameters:
    requesterId:
      name: requesterId
      in: query
      required: false
      schema:
        type: string
        format: uuid
    patronGroupId:
      name: patronGroupId
      in: query
      required: false
      schema:
        type: string
        format: uuid
    requestId:
      name: requestId
      in: query
      required: false
      schema:
        type: string
        format: uuid
    operation:
      name: operation
      in: query
      required: true
      schema:
        type: string
        enum:
        - create
        - replace
    instanceId:
      name: instanceId
      in: query
      required: false
      schema:
        type: string
        format: uuid
    itemId:
      name: itemId
      in: query
      required: false
      schema:
        type: string
        format: uuid
  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
  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'
    unprocessableEntityResponse:
      description: Validation error for the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          examples:
            response:
              $ref: '#/components/examples/validationErrorResponse'
    badRequestResponse:
      description: Validation errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          examples:
            validationErrorResponse:
              $ref: '#/components/examples/validationErrorResponse'
x-refined-from:
- folio-mod-circulation-bff-circulationbff-openapi.json
- folio-mod-circulation-bff-circulationbff-openapi.yml