Expose license terms over API (ERM-356)

[ERM-360] Define JSON format for public agreement+license information Created: 24/Jul/19  Updated: 14/Aug/19  Resolved: 14/Aug/19

Status: Closed
Project: ERM Platform
Components: None
Affects versions: None
Fix versions: None
Parent: Expose license terms over API

Type: Sub-task Priority: P3
Reporter: Owen Stephens Assignee: Owen Stephens
Resolution: Done Votes: 0
Labels: erm
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Sprint: ERM Sprint 78, ERM Sprint 70, ERM Sprint 71, ERM Sprint 75, ERM Sprint 76, ERM Sprint 72, ERM Sprint 73, ERM Sprint 77
Development Team: Bienenvolk

 Description   

Define JSON format to be used when outputting public agreement+license information. This is the JSON that would be returned from an edge API for retrieving agreement+license information

JSON format documented in https://docs.google.com/document/d/19pa6MyW5fFM1kFZ_8Eu2LOpgB4wxbHLt5YMw-tozH2E/edit?usp=sharing



 Comments   
Comment by Owen Stephens [ 01/Aug/19 ]

Khalilah Gambrell Theodor Tolstoy (One-Group.se) can you look at and comment on spec for the JSON we'll return for public display of license data please
https://docs.google.com/document/d/19pa6MyW5fFM1kFZ_8Eu2LOpgB4wxbHLt5YMw-tozH2E/edit?usp=sharing

Comment by Khalilah Gambrell [ 02/Aug/19 ]

Hey Owen Stephens, I reviewed the JSON and added comments. To confirm, this is the response that will be returned when we call the API with a title identifier/KB identifier?

Comment by Owen Stephens [ 02/Aug/19 ]

To confirm, this is the response that will be returned when we call the API with a title identifier/KB identifier?

Khalilah Gambrell the API call that will have this as a response is the subject of https://folio-org.atlassian.net/browse/ERM-361. I've asked in that if you could clarify with some examples of what IDs you'd want to be able to use [in the API call] and how they map to the IDs we can access in Agreements/eHoldings

We need to be happy that the data we return here:

  • Is sufficient to serve the requirements of Chalmers (and other sites) for displaying license data in user facing interfaces
  • Does not include any elements that Chalmers (or other sites) would not want exposed to patrons/public
Generated at Fri Feb 09 00:19:28 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.