openapi: 3.2.0
info:
  title: Folio Verify Patron D2ir API
  version: v1
  description: 'Operations tagged verify-patron-d2ir across 2 of this provider''s published API definitions: folio-mod-inn-reach-circulation-openapi.json, folio-mod-inn-reach-circulation-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /inn-reach/
tags:
- name: verify-patron-d2ir
paths:
  /d2ir/circ/verifypatron:
    post:
      operationId: verifyPatron
      description: Handles D2IR request from central server for patron verification.
      tags:
      - verify-patron-d2ir
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patronInfoRequestDTO'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patronInfoResponseDTO'
        '500':
          $ref: '#/components/responses/trait_response_500'
      parameters:
      - $ref: '#/components/parameters/localCodeHeader'
      - $ref: '#/components/parameters/centralCodeHeader'
      summary: Verify patron
      x-summary-source: derived
    servers:
    - url: /inn-reach/
components:
  parameters:
    centralCodeHeader:
      name: X-From-Code
      in: header
      required: true
      schema:
        $ref: '#/components/schemas/code'
    localCodeHeader:
      name: X-To-Code
      in: header
      required: true
      schema:
        $ref: '#/components/schemas/code'
  schemas:
    patronInfoRequestDTO:
      $schema: http://json-schema.org/draft-04/schema#
      description: Request parameters for patron verify
      type: object
      properties:
        patronName:
          description: Patron name
          type: string
          maxLength: 128
        patronAgencyCode:
          description: Patron agency code
          type: string
          maxLength: 128
        visiblePatronId:
          description: User attribute configured by the system to act as their publicId (externalSystemId or barcode)
          type: string
          maxLength: 32
      additionalProperties: false
      required:
      - visiblePatronId
      - patronAgencyCode
      - patronName
    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
      additionalProperties: false
      required:
      - message
    innReachError:
      description: D2IR error
      type: object
      properties:
        messages:
          type: array
          description: Error messages
          items:
            type: string
        central:
          type: string
          description: Central code
        reason:
          type: string
          description: Reason
        type:
          type: string
          description: Error type
        rejectedValue:
          description: Rejected value
        name:
          type: string
          description: Name of the rejected field
      additionalProperties: false
      required:
      - reason
    code:
      type: string
      pattern: '[a-z,0-9]{3,5}'
    patronInfo:
      $schema: http://json-schema.org/draft-04/schema#
      description: D2IR Patron info
      type: object
      properties:
        patronId:
          type: string
          description: 32-character, alphanumeric id corresponding to a FOLIO user.id (UUID with no hyphens)
          maxLength: 32
        patronAgencyCode:
          type: string
          description: 5 character lowercase alphanumeric
        centralPatronType:
          type: integer
          description: 0-255
        patronExpireDate:
          type: integer
          format: int64
          description: Epoch UNIX time stamp
        localLoans:
          type: integer
          description: Number of local (within library) loans
        nonLocalLoans:
          type: integer
          description: Number of non-local (INN-Reach, ILL, etc.) loans
        patronName:
          type: string
          description: Maximum 128 characters
          maxLength: 128
      additionalProperties: false
      required:
      - patronId
      - patronAgencyCode
      - centralPatronType
      - patronExpireDate
      - localLoans
      - nonLocalLoans
      - patronName
    patronInfoResponseDTO:
      $schema: http://json-schema.org/draft-04/schema#
      allOf:
      - $ref: '#/components/schemas/innReachResponseDTO'
      description: D2IR Patron info response
      type: object
      x-implements: org.folio.innreach.domain.dto.InnReachResponseData
      properties:
        patronInfo:
          description: D2IR Patron info
          $ref: '#/components/schemas/patronInfo'
        requestAllowed:
          type: boolean
          description: If the value is false, the patron cannot place a central request (they will be locally blocked)
      additionalProperties: false
      required:
      - patronInfo
      - requestAllowed
    innReachResponseDTO:
      $schema: http://json-schema.org/draft-04/schema#
      description: D2IR response
      type: object
      x-implements: org.folio.innreach.domain.dto.InnReachResponseData
      properties:
        status:
          description: Status
          type: string
        reason:
          description: Reason
          type: string
        errors:
          description: Errors
          type: array
          items:
            $ref: '#/components/schemas/innReachError'
      additionalProperties: false
      required:
      - status
      - reason
      - errors
  responses:
    trait_response_500:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-refined-from:
- folio-mod-inn-reach-circulation-openapi.json
- folio-mod-inn-reach-circulation-openapi.yml