D2IR Local Endpoint (Circulation): Respond to Patron Verification Requests at /innreach/v2/circ/verifypatron

Purpose:

User story statement(s):

As an INN-Reach Central server, I want verify that the patron creating an INN-Reach request is an active patron in FOLIO without any borrowing or request blocks, so that I can successfully process their request.

Scenarios:

1. Scenario:
   • Given the patron provides their name in format "First Last", and
   • Given the patron provides their User attribute configured by the system to act as their publicId (externalSystemId or barcode)
   • Given that the local server is not configured to require a PIN/Password
   • When the patron verification request is sent to /innreach/v2/circ/verifypatron
   • Then return the success payload specified in the D2IR API documentation
2. Scenario:
   • Given the patron provides their name in format "First Middle Last", and
   • Given the patron provides their Library ID (externalSystemId)
   • Given that the local server is not configured to require a PIN/Password
   • When the patron verification request is sent to /innreach/v2/circ/verifypatron
   • Then return the success payload specified in the D2IR API documentation
3. Scenario:
   • Given the patron provides their name in format "Middle Last", and
   • Given the patron provides their Library ID (externalSystemId)
   • Given that the local server is not configured to require a PIN/Password
   • When the patron verification request is sent to /innreach/v2/circ/verifypatron
   • Then return the success payload specified in the D2IR API documentation
4. Scenario:
   • Given the patron provides their name in format "First Last", and
   • Given the patron provides their User attribute configured by the system to act as their publicId (externalSystemId or barcode)
   • Given that the local server is configured to require a PIN/Password
   • Given that the patron provides the correct PIN/Password (NOT IMPLEMENTED YET)
   • When the patron verification request is sent to /innreach/v2/circ/verifypatron
   • Then return the success payload specified in the D2IR API documentation
5. Scenario:
   • Given the patron provides their name in format "First Middle Last", and
   • Given the patron provides their Library ID (externalSystemId)
   • Given that the local server is not configured to require a PIN/Password
   • Given that the patron provides the correct PIN/Password (NOT IMPLEMENTED YET)
   • When the patron verification request is sent to /innreach/v2/circ/verifypatron
   • Then return the success payload specified in the D2IR API documentation
6. Scenario:
   • Given the patron provides their name in format "Middle Last", and
   • Given the patron provides their Library ID (externalSystemId)
   • Given that the local server is not configured to require a PIN/Password
   • Given that the patron provides the correct PIN/Password (NOT IMPLEMENTED YET)
   • When the patron verification request is sent to /innreach/v2/circ/verifypatron
   • Then return the success payload specified in the D2IR API documentation
7. Scenario:
   • Given any other combination of Name, Public ID, and PIN/Password
   • Then return the appropriate error state to the central server when the verification request is sent to /innreach/v2/circ/verifypatron

Acceptance criteria:

• AC: If provided with valid patron information that is verified by the module, the module should pass the required payload (according to III-provided documentation) back to the edge module.
• AC: If provided with invalid patron information that is rejected by the backend, the module should return an appropriate error message back to the edge module.