Agreements work: EBSCO KB + Agreements app integration (UXPROD-1548)

[UXPROD-1554] Agreements App: Agreement Record - show eholdings app package/title records attached via eholdings app Created: 02/Mar/19  Updated: 15/Mar/19  Resolved: 15/Mar/19

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: None
Parent: Agreements work: EBSCO KB + Agreements app integration

Type: Sub-task Priority: P3
Reporter: Khalilah Gambrell Assignee: Unassigned
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to UIEH-628 Show Package Record: Allow a user to ... Closed
relates to UIEH-629 Show Package Record: Allow a user to ... Closed
relates to UIEH-631 Show title+package (aka Resource) Rec... Closed
Development Team: Spitfire

 Description   

As a librarian
I want to view any package or title that I have attached to an Agreement via eholdings app
So that I do not add the resources twice

Requirements

  • An EBSCO KB e-Resource attached to an Agreement via eholdings app should automatically create an Agreement line under E-resources - agreement lines section

Acceptance Criteria
Given I attached an EBSCO KB e-Resource [New York Times] to an Agreement via eholdings
When I edit/view the Agreement via Agreements app
Then display the resource that I have attached as an Agreement line



 Comments   
Comment by Khalilah Gambrell [ 12/Mar/19 ]

Ian's 3/12 email response
"This is essentially providing entitlement resolution via codex-titles - and requires that the codex-titles endpoint provides search by package - if thats present, 2d"

Comment by Carole Godfrey [ 12/Mar/19 ]

Ian Ibbotson (Use this one) - on above comment – is this asking for functionality for (1) or (2) below?

Thinking both may be needed to display a package or title in Agreements Detail Panel?

(1) given a title (give me all the packages that the title resides in) or
(2) given a package (give me all titles in the package)

We can provide either of these via an eholdings endpoint.
We do not currently have a codex endpoint which supports these searches

For (1)

Sample request/response

GET http://folio-testing-backend01.aws.indexdata.com:9130/eholdings/titles/13489552?include=resources
{
  "data" : {
    "id" : "13489552",
    "type" : "titles",
    "attributes" : {
      "name" : "Academic Ethics",
      "publisherName" : "Routledge",
      "isTitleCustom" : false,
      "subjects" : [ {
        "subject" : "LAW / Ethics & Professional Responsibility",
        "type" : "BISAC"
      } ],
      "identifiers" : [ {
        "id" : "978-0-7546-2536-0",
        "subtype" : "Print",
        "type" : "ISBN"
      }, {
        "id" : "978-1-315-26346-5",
        "subtype" : "Online",
        "type" : "ISBN"
      }, {
        "id" : "978-1-351-96113-4",
        "subtype" : "Online",
        "type" : "ISBN"
      } ],
      "publicationType" : "Book",
      "isPeerReviewed" : false,
      "contributors" : [ {
        "type" : "Author",
        "contributor" : "Barrow, Robin"
      }, {
        "type" : "Author",
        "contributor" : "Keeney, Patrick"
      } ],
      "tags" : {
        "tagList" : [ ]
      }
    },
    "relationships" : {
      "resources" : {
        "data" : [ {
          "type" : "resources",
          "id" : "38-4367-13489552"
        }, {
          "type" : "resources",
          "id" : "19-5207-13489552"
        }, {
          "type" : "resources",
          "id" : "123355-3135838-13489552"
        } ]
      }
    }
  },
  "included" : [ {
    "id" : "38-4367-13489552",
    "type" : "resources",
    "attributes" : {
      "isPeerReviewed" : false,
      "isTitleCustom" : false,
      "publisherName" : "Routledge",
      "titleId" : 13489552,
      "contributors" : [ {
        "type" : "Author",
        "contributor" : "Barrow, Robin"
      }, {
        "type" : "Author",
        "contributor" : "Keeney, Patrick"
      } ],
      "identifiers" : [ {
        "id" : "978-0-7546-2536-0",
        "subtype" : "Print",
        "type" : "ISBN"
      }, {
        "id" : "978-1-315-26346-5",
        "subtype" : "Online",
        "type" : "ISBN"
      }, {
        "id" : "978-1-351-96113-4",
        "subtype" : "Online",
        "type" : "ISBN"
      } ],
      "name" : "Academic Ethics",
      "publicationType" : "Book",
      "subjects" : [ {
        "subject" : "LAW / Ethics & Professional Responsibility",
        "type" : "BISAC"
      } ],
      "customEmbargoPeriod" : {
        "embargoValue" : 0
      },
      "isPackageCustom" : false,
      "isSelected" : false,
      "isTokenNeeded" : false,
      "locationId" : 32489820,
      "managedEmbargoPeriod" : {
        "embargoValue" : 0
      },
      "packageId" : "38-4367",
      "packageName" : "Taylor & Francis eBooks (Complete Collection)",
      "url" : "https://www.taylorfrancis.com/books/9781315263465",
      "providerId" : 38,
      "providerName" : "Taylor and Francis",
      "visibilityData" : {
        "isHidden" : false,
        "reason" : ""
      },
      "managedCoverages" : [ {
        "beginCoverage" : "2006-01-01",
        "endCoverage" : "2006-12-31"
      } ],
      "customCoverages" : [ ],
      "proxy" : {
        "id" : "<n>",
        "inherited" : true
      }
    },
    "relationships" : {
      "provider" : {
        "meta" : {
          "included" : false
        }
      },
      "title" : {
        "meta" : {
          "included" : false
        }
      },
      "package" : {
        "meta" : {
          "included" : false
        }
      }
    }
  }, {
    "id" : "19-5207-13489552",
    "type" : "resources",
    "attributes" : {
      "isPeerReviewed" : false,
      "isTitleCustom" : false,
      "publisherName" : "Routledge",
      "titleId" : 13489552,
      "contributors" : [ {
        "type" : "Author",
        "contributor" : "Barrow, Robin"
      }, {
        "type" : "Author",
        "contributor" : "Keeney, Patrick"
      } ],
      "identifiers" : [ {
        "id" : "978-0-7546-2536-0",
        "subtype" : "Print",
        "type" : "ISBN"
      }, {
        "id" : "978-1-315-26346-5",
        "subtype" : "Online",
        "type" : "ISBN"
      }, {
        "id" : "978-1-351-96113-4",
        "subtype" : "Online",
        "type" : "ISBN"
      } ],
      "name" : "Academic Ethics",
      "publicationType" : "Book",
      "subjects" : [ {
        "subject" : "LAW / Ethics & Professional Responsibility",
        "type" : "BISAC"
      } ],
      "coverageStatement" : "",
      "customEmbargoPeriod" : {
        "embargoValue" : 0
      },
      "isPackageCustom" : false,
      "isSelected" : true,
      "isTokenNeeded" : false,
      "locationId" : 29192411,
      "managedEmbargoPeriod" : {
        "embargoValue" : 0
      },
      "packageId" : "19-5207",
      "packageName" : "EBSCO eBooks",
      "url" : "http://search.ebscohost.com/login.aspx?direct=true&scope=site&db=nlebk&db=nlabk&AN=1519969",
      "providerId" : 19,
      "providerName" : "EBSCO",
      "visibilityData" : {
        "isHidden" : true,
        "reason" : ""
      },
      "managedCoverages" : [ {
        "beginCoverage" : "2016-01-01",
        "endCoverage" : "2016-12-31"
      } ],
      "customCoverages" : [ ],
      "proxy" : {
        "id" : "<n>",
        "inherited" : true
      }
    },
    "relationships" : {
      "provider" : {
        "meta" : {
          "included" : false
        }
      },
      "title" : {
        "meta" : {
          "included" : false
        }
      },
      "package" : {
        "meta" : {
          "included" : false
        }
      }
    }
  }, {
    "id" : "123355-3135838-13489552",
    "type" : "resources",
    "attributes" : {
      "isPeerReviewed" : false,
      "isTitleCustom" : false,
      "publisherName" : "Routledge",
      "titleId" : 13489552,
      "contributors" : [ {
        "type" : "Author",
        "contributor" : "Barrow, Robin"
      }, {
        "type" : "Author",
        "contributor" : "Keeney, Patrick"
      } ],
      "identifiers" : [ {
        "id" : "978-0-7546-2536-0",
        "subtype" : "Print",
        "type" : "ISBN"
      }, {
        "id" : "978-1-315-26346-5",
        "subtype" : "Online",
        "type" : "ISBN"
      }, {
        "id" : "978-1-351-96113-4",
        "subtype" : "Online",
        "type" : "ISBN"
      } ],
      "name" : "Academic Ethics",
      "publicationType" : "Book",
      "subjects" : [ {
        "subject" : "LAW / Ethics & Professional Responsibility",
        "type" : "BISAC"
      } ],
      "customEmbargoPeriod" : {
        "embargoValue" : 0
      },
      "isPackageCustom" : true,
      "isSelected" : true,
      "isTokenNeeded" : false,
      "locationId" : 44243582,
      "managedEmbargoPeriod" : {
        "embargoValue" : 0
      },
      "packageId" : "123355-3135838",
      "packageName" : "apidvcorp marc custom package test 1 20180918",
      "url" : "http://test",
      "providerId" : 123355,
      "providerName" : "API DEV CORPORATE CUSTOMER",
      "visibilityData" : {
        "isHidden" : false,
        "reason" : ""
      },
      "managedCoverages" : [ ],
      "customCoverages" : [ ],
      "proxy" : {
        "id" : "<n>",
        "inherited" : true
      }
    },
    "relationships" : {
      "provider" : {
        "meta" : {
          "included" : false
        }
      },
      "title" : {
        "meta" : {
          "included" : false
        }
      },
      "package" : {
        "meta" : {
          "included" : false
        }
      }
    }
  } ],
  "jsonapi" : {
    "version" : "1.0"
  }
}

For (2)
This is the api call for a package to get all titles within the package - https://s3.amazonaws.com/foliodocs/api/mod-kb-ebsco/eholdings.html#eholdings_packages__packageid__resources_get
Sample request/response

GET http://folio-testing-backend01.aws.indexdata.com:9130/eholdings/packages/18-1357/resources?page=1
{
  "data" : [ {
    "id" : "18-1357-12316012",
    "type" : "resources",
    "attributes" : {
      "isTitleCustom" : false,
      "publisherName" : "BBC Worldwide Americas, Inc./BBC Worldwide Learning",
      "titleId" : 12316012,
      "contributors" : [ ],
      "identifiers" : [ ],
      "name" : "1996 Interview with Imprisoned Marijuana Offenders in Florida",
      "publicationType" : "Streaming Video",
      "subjects" : [ ],
      "coverageStatement" : "",
      "customEmbargoPeriod" : {
        "embargoValue" : 0
      },
      "isPackageCustom" : false,
      "isSelected" : true,
      "isTokenNeeded" : false,
      "locationId" : 26645077,
      "managedEmbargoPeriod" : {
        "embargoValue" : 0
      },
      "packageId" : "18-1357",
      "packageName" : "Academic OneFile",
      "url" : "http://link.galegroup.com/apps/pub/9JCT/AONE?u=[[galesiteid]]",
      "providerId" : 18,
      "providerName" : "Gale | Cengage",
      "visibilityData" : {
        "isHidden" : false,
        "reason" : ""
      },
      "managedCoverages" : [ ],
      "customCoverages" : [ ]
    },
    "relationships" : {
      "provider" : {
        "meta" : {
          "included" : false
        }
      },
      "title" : {
        "meta" : {
          "included" : false
        }
      },
      "package" : {
        "meta" : {
          "included" : false
        }
      }
    }
  }, {
    "id" : "18-1357-956478",
    "type" : "resources",
    "attributes" : {
      "isTitleCustom" : false,
      "publisherName" : "Strategic Studies Institute of the U.S. Army War College",
      "titleId" : 956478,
      "contributors" : [ ],
      "identifiers" : [ {
        "id" : "978-1-58487-362-4",
        "subtype" : "Print",
        "type" : "ISBN"
      } ],
      "name" : "2006 Lebanon Campaign and the Future of Warfare: Implications for Army and Defense Policy",
      "publicationType" : "Report",
      "subjects" : [ ],
      "coverageStatement" : "",
      "customEmbargoPeriod" : {
        "embargoValue" : 0
      },
      "isPackageCustom" : false,
      "isSelected" : true,
      "isTokenNeeded" : false,
      "locationId" : 3385552,
      "managedEmbargoPeriod" : {
        "embargoValue" : 0
      },
      "packageId" : "18-1357",
      "packageName" : "Academic OneFile",
      "url" : "http://link.galegroup.com/apps/pub/4MTH/AONE?u=[[galesiteid]]",
      "providerId" : 18,
      "providerName" : "Gale | Cengage",
      "visibilityData" : {
        "isHidden" : false,
        "reason" : ""
      },
      "managedCoverages" : [ {
        "beginCoverage" : "2008-01-01",
        "endCoverage" : "2008-12-31"
      } ],
      "customCoverages" : [ ]
    },
    "relationships" : {
      "provider" : {
        "meta" : {
          "included" : false
        }
      },
      "title" : {
        "meta" : {
          "included" : false
        }
      },
      "package" : {
        "meta" : {
          "included" : false
        }
      }
    }
  },         "reason" : ""
      },
      "managedCoverages" : [ ],
      "customCoverages" : [ ]
    },
    "relationships" : {
      "provider" : {
        "meta" : {
          "included" : false
        }
      },
      "title" : {
        "meta" : {
          "included" : false
        }
      },
      "package" : {
        "meta" : {
          "included" : false
        }
      }
    }
  }, 
  ……
  } ],
  "meta" : {
    "totalResults" : 9432
  },
  "jsonapi" : {
    "version" : "1.0"
  }
}
Generated at Fri Feb 09 00:16:30 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.