Uploaded image for project: 'mod-inn-reach'
  1. mod-inn-reach
  2. MODINREACH-87

D2IR Local Endpoint (Circulation): Item Shipped Request for INN-Reach Patron Hold

    XMLWordPrintable

    Details

    • Template:
      Front-end User Story Template
    • Sprint:
      Volaris Sprint 126, Volaris Sprint 127, Volaris Sprint 128
    • Story Points:
      5
    • Development Team:
      Volaris
    • Release:
      Lotus R1 2022

      Description

      Purpose:

      Updates patron hold transaction when the owning site reports the requested item shipped.

      Local Endpoint: 

      [PUT] /innreach/v2/circ/itemshipped/<trackingId>/<centralCode>
      • Accepts the following URL Parameters
        • trackingId: a unique ID used for transaction tracking
        • centralCode: Unique code that identifies the central server (3-5 character lower-case alphanumeric, must match requesting X-From-Code header value)
      • Accepts the following application/json request body
        • transactionTime: integer Epoch UNIX timestamp
        • patronId: lower-case alphanumeric string, maximum 32 characters (User UUID with hyphens stripped out or other system-supplied unique identifier from non-FOLIO systems)
        • patronAgencyCode: 5 character lowercase alphanumeric string
        • itemAgencyCode: 5 character lowercase alphanumeric string
        • itemId: lowercase alphanumeric string (max 32 characters: item HRID or UUID, depending on record contribution implementation)
        • centralItemType: integer (0-255)
        • itemBarcode (include if present)
        • title: string (256 bytes maximum, sent if item has a title)
        • author: string (256 bytes maximum, sent if item has an author)
        • callNumber: string (256 bytes maximum, sent if item has a call number)
        • itemLocation: string (256 bytest maximum)
        • pickupLocation: A colon-delimited list of three or four 512-byte (maximum) strings, the fourth of which is optional (<Pickup Loc Code>:<Display Name>:<Print Name>:<Delivery Stop>)
        • needBefore: integer Epoch UNIX timestamp (only optional field)
      • Retrieve INN-Reach transaction with trackingId
      • Update transaction itemBarcode shippedItemBarcode with request payload itemBarcode value (if present)
        • If itemBarcode already exists in FOLIO inventory, append the item's agencyCode
      • Add itemBarcode to FOLIO item record associated with the transaction
      • Update transaction callNumber and the FOLIO item call number to the payload callNumber (if present)
      • Add folioItemBarcode to the INN-Reach transaction
      • Update transaction status to ITEM_SHIPPED
      • Return 200 response if update is successful
      • Return 4xx error if bad request
      • Return 500 error is internal server error

      =========OLD VERSION==========

      Updates patron hold transaction when the owning site reports the requested item shipped.

      Local Endpoint: 

      [POST] /innreach/v2/circ/itemshipped/<trackingId>/<centralCode>
      • Accepts the following URL Parameters
        • trackingId: a unique ID used for transaction tracking
        • centralCode: Unique code that identifies the central server (3-5 character lower-case alphanumeric, must match requesting X-From-Code header value)
      • Accepts the following application/json request body
        • callNumber (optional)
        • itemBarcode (include if present)
      • Retrieve INN-Reach transaction with trackingId
      • Update transaction itemBarcode shippedItemBarcode with request payload itemBarcode value (if present)
        • If itemBarcode already exists in FOLIO inventory, append the item's agencyCode
      • Add itemBarcode to FOLIO item record associated with the transaction
      • Update transaction callNumber and the FOLIO item call number to the payload callNumber (if present)
      • Add folioItemBarcode to the INN-Reach transaction
      • Update transaction status to ITEM_SHIPPED
      • Return 200 response if update is successful
      • Return 4xx error if bad request
      • Return 500 error is internal server error

        TestRail: Results

          Attachments

            Issue Links

              Activity

                People

                Assignee:
                brookstravis Brooks Travis
                Reporter:
                brookstravis Brooks Travis
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved:

                    TestRail: Runs

                      TestRail: Cases