What gets returned in edge-rtac response
- Khalilah Gambrell
- (OLD ACCOUNT) Erin Nettifee
Under revIEw
25 Jul 2024: Updated with Q release updates. See schema update https://github.com/folio-org/edge-rtac/blob/master/src/main/java/org/folio/edge/rtac/model/Holding.java and https://s3.amazonaws.com/foliodocs/api/mod-rtac/p/rtac-batch.html
If an item record exist AND instance record's
mode of issuance IS NOT a serial OR nature of content = journal/newspaper
OR edge-rtac endpoint &fullperiodicals = true then following FOLIO fields are returned in response
FOLIO Field (record type) | Notes |
|---|---|
Call number (item or holdings) | Display item record effective call number field value. IF NO item effective call number then display holdings call number field value. Example: <callNumber>PR. 3903.050</callNumber> |
Temporary/Permanent Location (item or holdings) | Display effective location for item value. IF the effective location for item value is empty then check for holdings temporary location field value and if no value then check for holdings permanent location field value. Example: <location>Acquisitions Administration</location> |
Status (item) | Item record's item status field value Example: <status>Aged to lost</status> |
Due date (item) | Item record's due date field Example: <dueDate>2020-10-31T00:21:31.000+00:00</dueDate> |
Temporary loan type (item) | Item record's temporary loan type field Example: <temporaryLoanType>Alternate Type</temporaryLoanType> |
Permanent loan type (item) | Item record's permanent loan type field Example: <permanentLoanType>stks</permanentLoanType> |
Display summary (item) - Quesnelia release addition | See MODRTAC-107: Add new displaySummary field to the Item schemaClosedNOTE edge-rtac always surrounds this information in parentheses. Example: <volume>(34 test)</volume> |
Enumeration and/or Chronology otherwise use Volume (item) | MODRTAC-107: Add new displaySummary field to the Item schemaClosedIf the Display summary field is not populated then Item field's Enumeration field value and Chronology value. If no Enumeration value then return item field's Volume value. NOTE edge-rtac always surrounds this information in parentheses. Example: <volume>(34 test)</volume> |
material type (item) - Quesnelia release addition | <materialType> <id>025ba2c5-5e96-4667-a677-8186463aee69</id> <name>book</name> </materialType> |
material type id (item) - Quesnelia release addition | <materialType> <id>025ba2c5-5e96-4667-a677-8186463aee69</id> <name>book</name> </materialType> |
Location > Library name - () Quesnelia release addition | <library> <name>D'Angelo Law (DLL)</name> <code>DLL</code> </library> |
Location > Library name code - () Quesnelia release addition | <library> <name>D'Angelo Law (DLL)</name> <code>DLL</code> </library> |
suppressFromDiscovery (item) - Quesnelia release addition | <suppressFromDiscovery>false</suppressFromDiscovery> |
totalHoldRequests (item) -Quesnelia release addition | the total number of requested items for the patron <totalHoldRequests>0</totalHoldRequests> |
Holdings statement (holdings) - Quesnelia release addition | Show all Holdings statements |
Holdings statement public note (holdings) - Quesnelia release addition | Show all Holdings statements public notes |
Holdings statement staff note (holdings) - Quesnelia release addition | Show all Holdings statements staff notes |
Holdings statement for indexes (holdings) - Quesnelia release addition | Show all Holdings statements for indexes |
Holdings statement indexes public note - (holdings) - Quesnelia release addition | Show all Holdings statements for indexes - public notes |
Holdings statement indexes staff note - (holdings) - Quesnelia release addition | Show all Holdings statements for indexes - staff notes |
Holdings statement for supplement (holdings) - Quesnelia release addition | Show all Holdings statements for supplement |
Holdings statement for supplement public note (holdings) - Quesnelia release addition | Show all Holdings statements for supplement - public notes |
Holdings statement for supplement staff note (holdings) - Quesnelia release addition | Show all Holdings statements for supplement - staff notes |
Holdings Copy Number (holdings) - Quesnelia release addition | <holdingsCopyNumber>12</holdingsCopyNumber> |
Item Copy Number (Item) - Quesnelia release addition | <itemCopyNumber>12</itemCopyNumber> |
If only a holdings record exist OR instance record's
mode of issuance IS a serial OR nature of content = journal/newspaper AND edge-rtac endpoint DOES NOT specify &fullperiodicals = true then following FOLIO fields are returned in response
NOTE: The mode of issuance must be “serial”. Cannot be Serials, SERIALS, Serial, SERIAL. Unfortunately the logic is hardcoded.
FOLIO Field (record type) | Notes |
|---|---|
Call number (holdings) | Display holdings record call number field value. Example: <callNumber>AN2 22.62</callNumber> |
Permanent Location (holdings) | Display holdings record call permanent location value Example: <location>Acquisitions Administration</location> |
Holdings statement (holdings) | For Q release now RTAC returns all Holdings statements |
Holdings statement public note (holdings) - Quesnelia release addition | Show all Holdings statements public notes |
Holdings statement staff note (holdings) - Quesnelia release addition | Show all Holdings statements staff notes |
Holdings statement for indexes (holdings) - Quesnelia release addition | Show all Holdings statements for indexes |
Holdings statement indexes public note - (holdings) - Quesnelia release addition | Show all Holdings statements for indexes - public notes |
Holdings statement indexes staff note - (holdings) - Quesnelia release addition | Show all Holdings statements for indexes - staff notes |
Holdings statement for supplement (holdings) - Quesnelia release addition | Show all Holdings statements for supplement |
Holdings statement for supplement public note (holdings) - Quesnelia release addition | Show all Holdings statements for supplement - public notes |
Holdings statement for supplement staff note (holdings) - Quesnelia release addition | Show all Holdings statements for supplement - staff notes |
Holdings Copy Number (holdings) - Quesnelia release addition | <holdingsCopyNumber>12</holdingsCopyNumber> |
Location > Library name - () Quesnelia release addition | <library> <name>D'Angelo Law (DLL)</name> <code>DLL</code> </library> |
Location > Library name code - () Quesnelia release addition | <library> <name>D'Angelo Law (DLL)</name> <code>DLL</code> </library> |