feat(inventory-hierarchy): add Library code, Location id, material ty…

…pe (#949) Closes: MODINVSTOR-1133 Co-authored-by: Humoyun_Norboboev <[email protected]> Co-authored-by: Pavlo Smahin <[email protected]>
folio-org · Feb 19, 2024 · ab31531 · ab31531
1 parent 7cb0785
commit ab31531
Show file tree

Hide file tree

Showing 8 changed files with 368 additions and 1 deletion.
diff --git a/NEWS.md b/NEWS.md
@@ -4,8 +4,10 @@
 
 ### New APIs versions
 * Provides `item-storage v10.1`
+* Provides `inventory-hierarchy 0.4`
 
 ### Features
+* Add location properties and material type id to inventory-hierarchy items-and-holdings response ([MODINVSTOR-1133](https://issues.folio.org/browse/MODINVSTOR-1133))
 * Add new field "Display summary" for the item schema ([MODINVSTOR-1154](https://issues.folio.org/browse/MODINVSTOR-1154))
 * Add new Identifier type Cancelled LCCN ([MODINVSTOR-1156](https://folio-org.atlassian.net/browse/MODINVSTOR-1156))
 

diff --git a/descriptors/ModuleDescriptor-template.json b/descriptors/ModuleDescriptor-template.json
@@ -1212,7 +1212,7 @@
     },
     {
       "id": "inventory-hierarchy",
-      "version": "0.3",
+      "version": "0.4",
       "handlers": [
         {
           "methods": ["GET"],

diff --git a/ramls/examples/inventory-items-and-holdings.json b/ramls/examples/inventory-items-and-holdings.json
@@ -17,16 +17,20 @@
       ],
       "location": {
         "permanentLocation": {
+          "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
           "name": "Annex",
           "campusName": "City Campus",
           "libraryName": "Datalogisk Institut",
+          "libraryCode": "DI",
           "institutionName": "Københavns Universitet",
           "code": "KU/CC/DI/A"
         },
         "temporaryLocation": {
+          "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
           "name": "Annex",
           "campusName": "City Campus",
           "libraryName": "Datalogisk Institut",
+          "libraryCode": "DI",
           "institutionName": "Københavns Universitet",
           "code": "KU/CC/DI/A"
         }
@@ -118,23 +122,29 @@
       ],
       "location": {
         "location": {
+          "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
           "name": "Annex",
           "campusName": "City Campus",
           "libraryName": "Datalogisk Institut",
+          "libraryCode": "DI",
           "institutionName": "Københavns Universitet",
           "code": "KU/CC/DI/A"
         },
         "permanentLocation": {
+          "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
           "name": "Annex",
           "campusName": "City Campus",
           "libraryName": "Datalogisk Institut",
+          "libraryCode": "DI",
           "institutionName": "Københavns Universitet",
           "code": "KU/CC/DI/A"
         },
         "temporaryLocation": {
+          "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
           "name": "Annex",
           "campusName": "City Campus",
           "libraryName": "Datalogisk Institut",
+          "libraryCode": "DI",
           "institutionName": "Københavns Universitet",
           "code": "KU/CC/DI/A"
         }
@@ -163,6 +173,7 @@
       "itemDamagedStatus": "Not Damaged",
       "itemDamagedStatusDate": "2020-07-28T09:34:40.562Z",
       "materialType": "book",
+      "materialTypeId": "059f3856-2659-45aa-b35a-e0b10d63141d",
       "permanentLoanType": "Can circulate",
       "temporaryLoanType": "Can circulate",
       "electronicAccess": [

diff --git a/ramls/inventory-hierarchy/inventory-instance-records.json b/ramls/inventory-hierarchy/inventory-instance-records.json
@@ -61,6 +61,10 @@
                 "type": "object",
                 "description": "Permanent shelving location in which an item resides",
                 "properties": {
+                  "id": {
+                    "description": "id of this (shelf) location record as UUID.",
+                    "type": "string"
+                  },
                   "name": {
                     "description": "Name of the (shelf) location",
                     "type": "string"
@@ -73,6 +77,10 @@
                     "description": "The name of the library, the third-level location unit, this (shelf) location belongs to",
                     "type": "string"
                   },
+                  "libraryCode": {
+                    "description": "The name of the library, the third-level location unit, this (shelf) location belongs to",
+                    "type": "string"
+                  },
                   "institutionName": {
                     "description": "The name of the institution, the first-level location unit, this (shelf) location belongs to",
                     "type": "string"
@@ -94,6 +102,10 @@
                 "type": "object",
                 "description": "Temporary location, shelving location, or holding which is a physical place where items are stored, or an Online location",
                 "properties": {
+                  "id": {
+                    "description": "id of this (shelf) location record as UUID.",
+                    "type": "string"
+                  },
                   "name": {
                     "description": "Name of the (shelf) location",
                     "type": "string"
@@ -106,6 +118,10 @@
                     "description": "The name of the library, the third-level location unit, this (shelf) location belongs to",
                     "type": "string"
                   },
+                  "libraryCode": {
+                    "description": "The code of the library, the third-level location unit, this (shelf) location belongs to",
+                    "type": "string"
+                  },
                   "institutionName": {
                     "description": "The name of the institution, the first-level location unit, this (shelf) location belongs to",
                     "type": "string"
@@ -120,6 +136,10 @@
                 "type": "object",
                 "description": "Effective location, shelving location, or holding which is a physical place where items are stored, or an Online location",
                 "properties": {
+                  "id": {
+                    "description": "id of this (shelf) location record as UUID.",
+                    "type": "string"
+                  },
                   "name": {
                     "description": "Name of the (shelf) location",
                     "type": "string"
@@ -132,6 +152,10 @@
                     "description": "The name of the library, the third-level location unit, this (shelf) location belongs to",
                     "type": "string"
                   },
+                  "libraryCode": {
+                    "description": "The code of the library, the third-level location unit, this (shelf) location belongs to",
+                    "type": "string"
+                  },
                   "institutionName": {
                     "description": "The name of the institution, the first-level location unit, this (shelf) location belongs to",
                     "type": "string"
@@ -439,6 +463,10 @@
                 "type": "object",
                 "description": "Current home location for the item",
                 "properties": {
+                  "id": {
+                    "description": "id of this (shelf) location record as UUID.",
+                    "type": "string"
+                  },
                   "name": {
                     "description": "Name of the (shelf) location",
                     "type": "string"
@@ -451,6 +479,10 @@
                     "description": "The name of the library, the third-level location unit, this (shelf) location belongs to",
                     "type": "string"
                   },
+                  "libraryCode": {
+                    "description": "The code of the library, the third-level location unit, this (shelf) location belongs to",
+                    "type": "string"
+                  },
                   "institutionName": {
                     "description": "The name of the institution, the first-level location unit, this (shelf) location belongs to",
                     "type": "string"
@@ -465,6 +497,10 @@
                 "type": "object",
                 "description": "Permanent shelving location in which an item resides",
                 "properties": {
+                  "id": {
+                    "description": "id of this (shelf) location record as UUID.",
+                    "type": "string"
+                  },
                   "name": {
                     "description": "Name of the (shelf) location",
                     "type": "string"
@@ -477,6 +513,10 @@
                     "description": "The name of the library, the third-level location unit, this (shelf) location belongs to",
                     "type": "string"
                   },
+                  "libraryCode": {
+                    "description": "The code of the library, the third-level location unit, this (shelf) location belongs to",
+                    "type": "string"
+                  },
                   "institutionName": {
                     "description": "The name of the institution, the first-level location unit, this (shelf) location belongs to",
                     "type": "string"
@@ -491,6 +531,10 @@
                 "type": "object",
                 "description": "Temporary location, shelving location, or holding which is a physical place where items are stored, or an Online location",
                 "properties": {
+                  "id": {
+                    "description": "id of this (shelf) location record as UUID.",
+                    "type": "string"
+                  },
                   "name": {
                     "description": "Name of the (shelf) location",
                     "type": "string"
@@ -503,6 +547,10 @@
                     "description": "The name of the library, the third-level location unit, this (shelf) location belongs to",
                     "type": "string"
                   },
+                  "libraryCode": {
+                    "description": "The code of the library, the third-level location unit, this (shelf) location belongs to",
+                    "type": "string"
+                  },
                   "institutionName": {
                     "description": "The name of the institution, the first-level location unit, this (shelf) location belongs to",
                     "type": "string"
@@ -604,6 +652,10 @@
             "description": "Define what type of thing the item is",
             "type": "string"
           },
+          "materialTypeId": {
+            "description": "Define what type id of thing the item is",
+            "type": "string"
+          },
           "permanentLoanType": {
             "description": "Default loan type for a given item. Loan types are tenant-defined",
             "type": "string"