Uploaded image for project: 'mod-circulation'
  1. mod-circulation
  2. CIRC-25

Aggregate metadata for ui-requests

    XMLWordPrintable

    Details

    • Template:

      Description

      In order to simplify the presentation of a request together with the referenced item, requestor (patron/user) and loan (via the item) provide the facility to include these records in a single request.

      API Design

      Introduce a new endpoint to provide optional inclusion (thoughts welcome on what this should be named):

      GET /circulation/requests/{id}/combined
      

      UI Context

      The current requirements for UIREQ issues call for the following fields (some of these properties do not exist yet):

      From the item (identified by itemId):

      • barcode *
      • title *
      • author (out of scope)
      • call number (out of scope)
      • volume (out of scope)
      • copy (out of scope)
      • enumeration (out of scope)
      • shelving location (out of scope)

      From the user (identified by requesterId):

      • name *
      • barcode *
      • patron group

      The Requests front-end module (ui-requests), in addition to using its own /requests endpoint from mod-circ-storage, also needs access to related metadata from Users and Items. It would be more efficient to aggregate this data in a back-end business logic module than to try to combine it all in ui-requests.

        TestRail: Results

          Attachments

            Issue Links

              Activity

                People

                Assignee:
                Unassigned Unassigned
                Reporter:
                mattjlc Matt Connolly
                Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved:

                    TestRail: Runs

                      TestRail: Cases