https://github.com/folio-org/mod-kb-ebsco-java
Implements the eholdings interface using EBSCO KB as backend.
Retrieve a collection of packages based on the search query.
GET /eholdings/packagesFilter to get list of custom packages Possible values are
Example:
trueString used to search to retrieve a collection
Example:
ABC-CLIOFilter to narrow down results based on selection status. Possible values are all, true, false, ebsco.
Example:
allFilter to narrow down results based on content type. Defaults to all. Possible values are all, aggregatedfulltext, abstractandindex, ebook, ejournal, print, unknown, streamingmedia, mixedcontent, onlinereference.
Example:
ebookFilter to narrow down results based on assigned tags. Contains list of required tags.
Filter to narrow down results based on assigned access type.
Option by which results are sorted. Possible values are name, relevance.
Page number
Example:
1Page size
Example:
100OK
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Collection Schema",
"description": "Package Collection Schema",
"javaType": "org.folio.rest.jaxrs.model.PackageCollection",
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "List of packages",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package object schema for a collection",
"description": "Package object schema for a collection",
"javaType": "org.folio.rest.jaxrs.model.PackageCollectionItem",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of package - combination of providerId-packageId",
"example": "91525-1152699"
},
"type": {
"type": "string",
"description": "Type of resource",
"example": "packages"
},
"attributes": {
"type": "object",
"description": "Package object data attributes",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Object Data Attributes Schema",
"javaType": "org.folio.rest.jaxrs.model.PackageDataAttributes",
"additionalProperties": false,
"properties": {
"contentType": {
"type": "string",
"description": "Content Type of Package",
"example": "Online Reference",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Content Type Schema",
"javaType": "org.folio.rest.jaxrs.model.ContentType",
"additionalProperties": false,
"enum": [
"Aggregated Full Text",
"Abstract and Index",
"E-Book",
"E-Journal",
"Print",
"Unknown",
"Online Reference",
"Streaming Media",
"Mixed Content"
]
},
"customCoverage": {
"type": "object",
"description": "Custom Coverage",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Coverage Schema",
"javaType": "org.folio.rest.jaxrs.model.Coverage",
"additionalProperties": false,
"properties": {
"beginCoverage": {
"type": "string",
"description": "Begin Coverage Date",
"example": "2003-01-01"
},
"endCoverage": {
"type": "string",
"description": "End Coverage Date",
"example": "2003-12-01"
}
}
},
"isCustom": {
"type": "boolean",
"description": "Whether this package is custom or not",
"example": false
},
"isSelected": {
"type": "boolean",
"description": "Whether this package is selected or not",
"example": false
},
"name": {
"type": "string",
"description": "Package name",
"example": "Shenbao"
},
"packageId": {
"type": "integer",
"description": "Package Id",
"example": 1152699
},
"packageType": {
"type": "string",
"description": "Package type",
"example": "Complete"
},
"providerId": {
"type": "integer",
"description": "Provider Id",
"example": 91525
},
"providerName": {
"type": "string",
"description": "Provider name",
"example": "Green Apple - Qingpingguo"
},
"selectedCount": {
"type": "integer",
"description": "Selected count",
"example": 0
},
"titleCount": {
"type": "integer",
"description": "Title count",
"example": 1
},
"visibilityData": {
"type": "object",
"description": "Visibility data",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Visibility Data Schema",
"javaType": "org.folio.rest.jaxrs.model.VisibilityData",
"additionalProperties": false,
"properties": {
"isHidden": {
"type": "boolean",
"description": "Whether resource is hidden or not",
"example": false
},
"reason": {
"type": "string",
"description": "Reason why resource is hidden",
"example": "Set by System"
}
}
},
"allowKbToAddTitles": {
"type": "boolean",
"description": "Allow KB to add titles",
"example": true
},
"packageToken": {
"type": "object",
"description": "Package Token",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Token Schema",
"javaType": "org.folio.rest.jaxrs.model.Token",
"additionalProperties": false,
"properties": {
"factName": {
"type": "string",
"description": "Fact Name",
"example": "[[galesiteid]]"
},
"prompt": {
"type": "string",
"description": "Prompt",
"example": "/itweb/"
},
"helpText": {
"type": "string",
"description": "Help text",
"example": "What is token and how to use it"
},
"value": {
"type": "string",
"description": "Value",
"example": "hellotoken"
}
}
},
"proxy": {
"type": "object",
"description": "Proxy",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Proxy Schema",
"javaType": "org.folio.rest.jaxrs.model.Proxy",
"additionalProperties": true,
"properties": {
"id": {
"type": "string",
"description": "Proxy Id",
"example": "EZProxy"
},
"inherited": {
"type": "boolean",
"description": "Whether this proxy is inherited",
"example": true
}
}
},
"tags": {
"type": "object",
"description": "Package tags",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "tags.schema",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
},
"relationships": {
"type": "object",
"description": "Displays if any resources are included in relationships",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package relationships object schema in package collection item",
"javaType": "org.folio.rest.jaxrs.model.PackageRelationship",
"additionalProperties": false,
"properties": {
"resources": {
"type": "object",
"description": "Displays Resources Relationship if any",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for an array of objects",
"javaType": "org.folio.rest.jaxrs.model.HasManyRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "relationship Data Information",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"description": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
},
"provider": {
"type": "object",
"description": "Displays Provider Relationship if any",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for a given object",
"javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "relationship Data Information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
},
"accessType": {
"type": "object",
"description": "Displays Access Type Relationship if any",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for a given object",
"javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "relationship Data Information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
}
}
}
}
}
},
"meta": {
"type": "object",
"description": "metadata containing total results in packages collection",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata total results Schema",
"javaType": "org.folio.rest.jaxrs.model.MetaTotalResults",
"additionalProperties": false,
"properties": {
"totalResults": {
"type": "integer",
"description": "Total number of results",
"example": 2
}
},
"required": [
"totalResults"
]
},
"jsonapi": {
"type": "object",
"description": "version of json api",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
},
"required": [
"data",
"jsonapi"
]
}Example:
{
"data": [
{
"id": "583-4345",
"type": "packages",
"attributes": {
"contentType": "E-Book",
"customCoverage": {
"beginCoverage": "",
"endCoverage": ""
},
"isCustom": false,
"isSelected": true,
"name": "ABC-CLIO eBook Collection",
"packageId": 4345,
"packageType": "Variable",
"providerId": 583,
"providerName": "ABC-CLIO",
"selectedCount": 9589,
"titleCount": 9590,
"vendorId": 583,
"vendorName": "ABC-CLIO",
"visibilityData": {
"isHidden": false,
"reason": ""
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
{
"id": "583-2356523",
"type": "packages",
"attributes": {
"contentType": "E-Book",
"customCoverage": {
"beginCoverage": "",
"endCoverage": ""
},
"isCustom": false,
"isSelected": false,
"name": "ABC-CLIO eBook Collection 2008 (TAEBC)",
"packageId": 2356523,
"packageType": "Complete",
"providerId": 583,
"providerName": "ABC-CLIO",
"selectedCount": 0,
"titleCount": 693,
"vendorId": 583,
"vendorName": "ABC-CLIO",
"visibilityData": {
"isHidden": false,
"reason": ""
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
{
"id": "583-2356522",
"type": "packages",
"attributes": {
"contentType": "E-Book",
"customCoverage": {
"beginCoverage": "",
"endCoverage": ""
},
"isCustom": false,
"isSelected": false,
"name": "ABC-CLIO eBook Collection 2009 (TAEBC)",
"packageId": 2356522,
"packageType": "Complete",
"providerId": 583,
"providerName": "ABC-CLIO",
"selectedCount": 0,
"titleCount": 1624,
"vendorId": 583,
"vendorName": "ABC-CLIO",
"visibilityData": {
"isHidden": false,
"reason": ""
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"vendor": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
{
"id": "583-2356521",
"type": "packages",
"attributes": {
"contentType": "E-Book",
"customCoverage": {
"beginCoverage": "",
"endCoverage": ""
},
"isCustom": false,
"isSelected": false,
"name": "ABC-CLIO eBook Collection 2010 (TAEBC)",
"packageId": 2356521,
"packageType": "Complete",
"providerId": 583,
"providerName": "ABC-CLIO",
"selectedCount": 0,
"titleCount": 359,
"vendorId": 583,
"vendorName": "ABC-CLIO",
"visibilityData": {
"isHidden": false,
"reason": ""
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
{
"id": "583-2356520",
"type": "packages",
"attributes": {
"contentType": "E-Book",
"customCoverage": {
"beginCoverage": "",
"endCoverage": ""
},
"isCustom": false,
"isSelected": false,
"name": "ABC-CLIO eBook Collection 2011 (TAEBC)",
"packageId": 2356520,
"packageType": "Complete",
"providerId": 583,
"providerName": "ABC-CLIO",
"selectedCount": 0,
"titleCount": 221,
"vendorId": 583,
"vendorName": "ABC-CLIO",
"visibilityData": {
"isHidden": false,
"reason": ""
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"vendor": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
{
"id": "583-2356519",
"type": "packages",
"attributes": {
"contentType": "E-Book",
"customCoverage": {
"beginCoverage": "",
"endCoverage": ""
},
"isCustom": false,
"isSelected": false,
"name": "ABC-CLIO eBook Collection 2012 (TAEBC)",
"packageId": 2356519,
"packageType": "Complete",
"providerId": 583,
"providerName": "ABC-CLIO",
"selectedCount": 0,
"titleCount": 302,
"vendorId": 583,
"vendorName": "ABC-CLIO",
"visibilityData": {
"isHidden": false,
"reason": ""
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
{
"id": "583-2356518",
"type": "packages",
"attributes": {
"contentType": "E-Book",
"customCoverage": {
"beginCoverage": "",
"endCoverage": ""
},
"isCustom": false,
"isSelected": false,
"name": "ABC-CLIO eBook Collection 2014 (TAEBC)",
"packageId": 2356518,
"packageType": "Complete",
"providerId": 583,
"providerName": "ABC-CLIO",
"selectedCount": 0,
"titleCount": 169,
"vendorId": 583,
"vendorName": "ABC-CLIO",
"visibilityData": {
"isHidden": false,
"reason": ""
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"vendor": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
{
"id": "203-5302",
"type": "packages",
"attributes": {
"contentType": "Aggregated Full Text",
"customCoverage": {
"beginCoverage": "",
"endCoverage": ""
},
"isCustom": false,
"isSelected": false,
"name": "Credo ABC-CLIO Collection",
"packageId": 5302,
"packageType": "Variable",
"providerId": 203,
"providerName": "Credo Reference",
"selectedCount": 0,
"titleCount": 339,
"vendorId": 203,
"vendorName": "Credo Reference",
"visibilityData": {
"isHidden": false,
"reason": ""
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
{
"id": "203-5316",
"type": "packages",
"attributes": {
"contentType": "Aggregated Full Text",
"customCoverage": {
"beginCoverage": "",
"endCoverage": ""
},
"isCustom": false,
"isSelected": false,
"name": "Credo ABC-CLIO Contemporary World Issues",
"packageId": 5316,
"packageType": "Variable",
"providerId": 203,
"providerName": "Credo Reference",
"selectedCount": 0,
"titleCount": 74,
"vendorId": 203,
"vendorName": "Credo Reference",
"visibilityData": {
"isHidden": false,
"reason": ""
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"vendor": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
{
"id": "203-5317",
"type": "packages",
"attributes": {
"contentType": "Aggregated Full Text",
"customCoverage": {
"beginCoverage": "",
"endCoverage": ""
},
"isCustom": false,
"isSelected": false,
"name": "Credo ABC-CLIO World Mythology Collection",
"packageId": 5317,
"packageType": "Variable",
"providerId": 203,
"providerName": "Credo Reference",
"selectedCount": 0,
"titleCount": 10,
"vendorId": 203,
"vendorName": "Credo Reference",
"visibilityData": {
"isHidden": false,
"reason": ""
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
{
"id": "1075-7698",
"type": "packages",
"attributes": {
"contentType": "Online Reference",
"customCoverage": {
"beginCoverage": "",
"endCoverage": ""
},
"isCustom": false,
"isSelected": false,
"name": "ABC Chemistry: Directory of Free Full-Text Journals in Chemistry",
"packageId": 7698,
"packageType": "Complete",
"providerId": 1075,
"providerName": "ABC Chemistry",
"selectedCount": 0,
"titleCount": 1,
"vendorId": 1075,
"vendorName": "ABC Chemistry",
"visibilityData": {
"isHidden": false,
"reason": ""
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"vendor": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
}
],
"meta": {
"totalResults": 11
},
"jsonapi": {
"version": "1.0"
}
}
Bad Request
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response Schema",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiError",
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"description": "Error Response List",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response object",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Error Message Title",
"example": "Invalid KB API Credentials"
},
"detail": {
"type": "string",
"description": "Error Message Detail",
"example": "Kb api credentials are invalid"
},
"source": {
"type": "object",
"description": "Source of Error Message",
"example": {}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "JSON API Version",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
}
}Example:
{
"errors": [{
"title": "Invalid filter parameter"
}],
"jsonapi": {
"version": "1.0"
}
}
Create a custom package
POST /eholdings/packagesExample:
application/vnd.api+jsonMedia type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package POST Request Schema",
"description": "Package Post Request Schema using JSON API",
"javaType": "org.folio.rest.jaxrs.model.PackagePostRequest",
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"description": "Data object of package post request",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Post Data Schema",
"javaType": "org.folio.rest.jaxrs.model.PackagePostData",
"additionalProperties": false,
"properties": {
"type": {
"description": "Data type",
"type": "string",
"enum": [
"packages"
],
"example": "packages"
},
"attributes": {
"description": "Data type attributes",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Post Data attributes schema",
"javaType": "org.folio.rest.jaxrs.model.PackagePostDataAttributes",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Package name",
"example": "Advanced Placement Psychology Collection"
},
"contentType": {
"type": "string",
"description": "Package content type",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Content Type Schema",
"javaType": "org.folio.rest.jaxrs.model.ContentType",
"additionalProperties": false,
"enum": [
"Aggregated Full Text",
"Abstract and Index",
"E-Book",
"E-Journal",
"Print",
"Unknown",
"Online Reference",
"Streaming Media",
"Mixed Content"
]
},
"accessTypeId": {
"type": "string",
"description": "Access type id",
"example": "f973c3b6-85fc-4d35-bda8-f31b568957bf",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"customCoverage": {
"type": "object",
"description": "Custom Coverage",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Coverage Schema",
"javaType": "org.folio.rest.jaxrs.model.Coverage",
"additionalProperties": false,
"properties": {
"beginCoverage": {
"type": "string",
"description": "Begin Coverage Date",
"example": "2003-01-01"
},
"endCoverage": {
"type": "string",
"description": "End Coverage Date",
"example": "2003-12-01"
}
}
}
},
"required": [
"name",
"contentType"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
}Example:
{
"data": {
"type": "packages",
"attributes": {
"name": "yet another custom package",
"contentType": "Unknown",
"customCoverage": {
"beginCoverage": "2003-01-01",
"endCoverage": "2004-01-01"
}
}
}
}
OK
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package object schema",
"description": "Package object schema",
"javaType": "org.folio.rest.jaxrs.model.Package",
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "The Data Schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package object schema for a collection",
"javaType": "org.folio.rest.jaxrs.model.PackageCollectionItem",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of package - combination of providerId-packageId",
"example": "91525-1152699"
},
"type": {
"type": "string",
"description": "Type of resource",
"example": "packages"
},
"attributes": {
"type": "object",
"description": "Package object data attributes",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Object Data Attributes Schema",
"javaType": "org.folio.rest.jaxrs.model.PackageDataAttributes",
"additionalProperties": false,
"properties": {
"contentType": {
"type": "string",
"description": "Content Type of Package",
"example": "Online Reference",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Content Type Schema",
"javaType": "org.folio.rest.jaxrs.model.ContentType",
"additionalProperties": false,
"enum": [
"Aggregated Full Text",
"Abstract and Index",
"E-Book",
"E-Journal",
"Print",
"Unknown",
"Online Reference",
"Streaming Media",
"Mixed Content"
]
},
"customCoverage": {
"type": "object",
"description": "Custom Coverage",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Coverage Schema",
"javaType": "org.folio.rest.jaxrs.model.Coverage",
"additionalProperties": false,
"properties": {
"beginCoverage": {
"type": "string",
"description": "Begin Coverage Date",
"example": "2003-01-01"
},
"endCoverage": {
"type": "string",
"description": "End Coverage Date",
"example": "2003-12-01"
}
}
},
"isCustom": {
"type": "boolean",
"description": "Whether this package is custom or not",
"example": false
},
"isSelected": {
"type": "boolean",
"description": "Whether this package is selected or not",
"example": false
},
"name": {
"type": "string",
"description": "Package name",
"example": "Shenbao"
},
"packageId": {
"type": "integer",
"description": "Package Id",
"example": 1152699
},
"packageType": {
"type": "string",
"description": "Package type",
"example": "Complete"
},
"providerId": {
"type": "integer",
"description": "Provider Id",
"example": 91525
},
"providerName": {
"type": "string",
"description": "Provider name",
"example": "Green Apple - Qingpingguo"
},
"selectedCount": {
"type": "integer",
"description": "Selected count",
"example": 0
},
"titleCount": {
"type": "integer",
"description": "Title count",
"example": 1
},
"visibilityData": {
"type": "object",
"description": "Visibility data",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Visibility Data Schema",
"javaType": "org.folio.rest.jaxrs.model.VisibilityData",
"additionalProperties": false,
"properties": {
"isHidden": {
"type": "boolean",
"description": "Whether resource is hidden or not",
"example": false
},
"reason": {
"type": "string",
"description": "Reason why resource is hidden",
"example": "Set by System"
}
}
},
"allowKbToAddTitles": {
"type": "boolean",
"description": "Allow KB to add titles",
"example": true
},
"packageToken": {
"type": "object",
"description": "Package Token",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Token Schema",
"javaType": "org.folio.rest.jaxrs.model.Token",
"additionalProperties": false,
"properties": {
"factName": {
"type": "string",
"description": "Fact Name",
"example": "[[galesiteid]]"
},
"prompt": {
"type": "string",
"description": "Prompt",
"example": "/itweb/"
},
"helpText": {
"type": "string",
"description": "Help text",
"example": "What is token and how to use it"
},
"value": {
"type": "string",
"description": "Value",
"example": "hellotoken"
}
}
},
"proxy": {
"type": "object",
"description": "Proxy",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Proxy Schema",
"javaType": "org.folio.rest.jaxrs.model.Proxy",
"additionalProperties": true,
"properties": {
"id": {
"type": "string",
"description": "Proxy Id",
"example": "EZProxy"
},
"inherited": {
"type": "boolean",
"description": "Whether this proxy is inherited",
"example": true
}
}
},
"tags": {
"type": "object",
"description": "Package tags",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "tags.schema",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
},
"relationships": {
"type": "object",
"description": "Displays if any resources are included in relationships",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package relationships object schema in package collection item",
"javaType": "org.folio.rest.jaxrs.model.PackageRelationship",
"additionalProperties": false,
"properties": {
"resources": {
"type": "object",
"description": "Displays Resources Relationship if any",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for an array of objects",
"javaType": "org.folio.rest.jaxrs.model.HasManyRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "relationship Data Information",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"description": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
},
"provider": {
"type": "object",
"description": "Displays Provider Relationship if any",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for a given object",
"javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "relationship Data Information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
},
"accessType": {
"type": "object",
"description": "Displays Access Type Relationship if any",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for a given object",
"javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "relationship Data Information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
}
}
}
}
},
"included": {
"type": "array",
"description": "List of included items",
"items": {
"type": "object",
"javaType": "java.lang.Object"
}
},
"jsonapi": {
"type": "object",
"description": "version of json api",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
},
"required": [
"data",
"jsonapi"
]
}Example:
{
"data": {
"id": "123356-3168443",
"type": "packages",
"attributes": {
"contentType": "E-Journal",
"customCoverage": {
"beginCoverage": "2003-01-01",
"endCoverage": "2003-12-01"
},
"isCustom": true,
"isSelected": true,
"name": "DT custom packages api test one",
"packageId": 3168443,
"packageType": "Custom",
"providerId": 123356,
"providerName": "API DEV GOVERNMENT CUSTOMER",
"selectedCount": 0,
"titleCount": 0,
"vendorId": 123356,
"vendorName": "API DEV GOVERNMENT CUSTOMER",
"visibilityData": {
"isHidden": false,
"reason": ""
},
"allowKbToAddTitles": false,
"packageToken": null,
"proxy": {
"id": "<n>",
"inherited": true
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
"jsonapi": {
"version": "1.0"
}
}
Bad Request
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response Schema",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiError",
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"description": "Error Response List",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response object",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Error Message Title",
"example": "Invalid KB API Credentials"
},
"detail": {
"type": "string",
"description": "Error Message Detail",
"example": "Kb api credentials are invalid"
},
"source": {
"type": "object",
"description": "Source of Error Message",
"example": {}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "JSON API Version",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
}
}Example:
{
"errors": [
{
"title": "Custom Package with the provided name already exists"
}
],
"jsonapi": {
"version": "1.0"
}
}
Unprocessable Entity
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response Schema",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiError",
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"description": "Error Response List",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response object",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Error Message Title",
"example": "Invalid KB API Credentials"
},
"detail": {
"type": "string",
"description": "Error Message Detail",
"example": "Kb api credentials are invalid"
},
"source": {
"type": "object",
"description": "Source of Error Message",
"example": {}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "JSON API Version",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
}
}Example:
{
"errors": [
{
"title": "Invalid name",
"detail": "Name can't be blank",
"source": {}
}
],
"jsonapi": {
"version": "1.0"
}
}
Retrieve a specific package given packageId. Note that packageId is providerId-packageId
GET /eholdings/packages/{packageId}identifier of the package formed from Provider Id and Package Id (see example)
Example:
583-4345Include resources or provider in response Possible values are
Example:
resourcesOK
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package object schema",
"description": "Package object schema",
"javaType": "org.folio.rest.jaxrs.model.Package",
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "The Data Schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package object schema for a collection",
"javaType": "org.folio.rest.jaxrs.model.PackageCollectionItem",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of package - combination of providerId-packageId",
"example": "91525-1152699"
},
"type": {
"type": "string",
"description": "Type of resource",
"example": "packages"
},
"attributes": {
"type": "object",
"description": "Package object data attributes",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Object Data Attributes Schema",
"javaType": "org.folio.rest.jaxrs.model.PackageDataAttributes",
"additionalProperties": false,
"properties": {
"contentType": {
"type": "string",
"description": "Content Type of Package",
"example": "Online Reference",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Content Type Schema",
"javaType": "org.folio.rest.jaxrs.model.ContentType",
"additionalProperties": false,
"enum": [
"Aggregated Full Text",
"Abstract and Index",
"E-Book",
"E-Journal",
"Print",
"Unknown",
"Online Reference",
"Streaming Media",
"Mixed Content"
]
},
"customCoverage": {
"type": "object",
"description": "Custom Coverage",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Coverage Schema",
"javaType": "org.folio.rest.jaxrs.model.Coverage",
"additionalProperties": false,
"properties": {
"beginCoverage": {
"type": "string",
"description": "Begin Coverage Date",
"example": "2003-01-01"
},
"endCoverage": {
"type": "string",
"description": "End Coverage Date",
"example": "2003-12-01"
}
}
},
"isCustom": {
"type": "boolean",
"description": "Whether this package is custom or not",
"example": false
},
"isSelected": {
"type": "boolean",
"description": "Whether this package is selected or not",
"example": false
},
"name": {
"type": "string",
"description": "Package name",
"example": "Shenbao"
},
"packageId": {
"type": "integer",
"description": "Package Id",
"example": 1152699
},
"packageType": {
"type": "string",
"description": "Package type",
"example": "Complete"
},
"providerId": {
"type": "integer",
"description": "Provider Id",
"example": 91525
},
"providerName": {
"type": "string",
"description": "Provider name",
"example": "Green Apple - Qingpingguo"
},
"selectedCount": {
"type": "integer",
"description": "Selected count",
"example": 0
},
"titleCount": {
"type": "integer",
"description": "Title count",
"example": 1
},
"visibilityData": {
"type": "object",
"description": "Visibility data",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Visibility Data Schema",
"javaType": "org.folio.rest.jaxrs.model.VisibilityData",
"additionalProperties": false,
"properties": {
"isHidden": {
"type": "boolean",
"description": "Whether resource is hidden or not",
"example": false
},
"reason": {
"type": "string",
"description": "Reason why resource is hidden",
"example": "Set by System"
}
}
},
"allowKbToAddTitles": {
"type": "boolean",
"description": "Allow KB to add titles",
"example": true
},
"packageToken": {
"type": "object",
"description": "Package Token",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Token Schema",
"javaType": "org.folio.rest.jaxrs.model.Token",
"additionalProperties": false,
"properties": {
"factName": {
"type": "string",
"description": "Fact Name",
"example": "[[galesiteid]]"
},
"prompt": {
"type": "string",
"description": "Prompt",
"example": "/itweb/"
},
"helpText": {
"type": "string",
"description": "Help text",
"example": "What is token and how to use it"
},
"value": {
"type": "string",
"description": "Value",
"example": "hellotoken"
}
}
},
"proxy": {
"type": "object",
"description": "Proxy",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Proxy Schema",
"javaType": "org.folio.rest.jaxrs.model.Proxy",
"additionalProperties": true,
"properties": {
"id": {
"type": "string",
"description": "Proxy Id",
"example": "EZProxy"
},
"inherited": {
"type": "boolean",
"description": "Whether this proxy is inherited",
"example": true
}
}
},
"tags": {
"type": "object",
"description": "Package tags",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "tags.schema",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
},
"relationships": {
"type": "object",
"description": "Displays if any resources are included in relationships",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package relationships object schema in package collection item",
"javaType": "org.folio.rest.jaxrs.model.PackageRelationship",
"additionalProperties": false,
"properties": {
"resources": {
"type": "object",
"description": "Displays Resources Relationship if any",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for an array of objects",
"javaType": "org.folio.rest.jaxrs.model.HasManyRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "relationship Data Information",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"description": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
},
"provider": {
"type": "object",
"description": "Displays Provider Relationship if any",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for a given object",
"javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "relationship Data Information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
},
"accessType": {
"type": "object",
"description": "Displays Access Type Relationship if any",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for a given object",
"javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "relationship Data Information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
}
}
}
}
},
"included": {
"type": "array",
"description": "List of included items",
"items": {
"type": "object",
"javaType": "java.lang.Object"
}
},
"jsonapi": {
"type": "object",
"description": "version of json api",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
},
"required": [
"data",
"jsonapi"
]
}Example:
{
"data": {
"id": "123355-2848228",
"attributes": {
"contentType": "E-Journal",
"customCoverage": {
"beginCoverage": "2003-01-01",
"endCoverage": "2004-01-01"
},
"isCustom": true,
"isSelected": true,
"name": "test package for documentation again",
"packageId": 2848228,
"packageType": "Custom",
"providerId": 123355,
"providerName": "API DEV CORPORATE CUSTOMER",
"selectedCount": 0,
"titleCount": 0,
"vendorId": 123355,
"vendorName": "API DEV CORPORATE CUSTOMER",
"visibilityData": {
"isHidden": true,
"reason": ""
},
"allowKbToAddTitles": false,
"packageToken": {
"factName":"siteid",
"prompt":"/itweb/",
"helpText":"<ul><li>Enter your token</li></ul>",
"value": "123456"
},
"proxy": {
"id": "<n>",
"inherited": true
}
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
"jsonapi": {
"version": "1.0"
}
}
Bad Request
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response Schema",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiError",
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"description": "Error Response List",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response object",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Error Message Title",
"example": "Invalid KB API Credentials"
},
"detail": {
"type": "string",
"description": "Error Message Detail",
"example": "Kb api credentials are invalid"
},
"source": {
"type": "object",
"description": "Source of Error Message",
"example": {}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "JSON API Version",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
}
}Example:
{
"errors": [
{
"title": "Package or provider id are invalid"
}
],
"jsonapi": {
"version": "1.0"
}
}
Not Found
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response Schema",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiError",
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"description": "Error Response List",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response object",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Error Message Title",
"example": "Invalid KB API Credentials"
},
"detail": {
"type": "string",
"description": "Error Message Detail",
"example": "Kb api credentials are invalid"
},
"source": {
"type": "object",
"description": "Source of Error Message",
"example": {}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "JSON API Version",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
}
}Example:
{
"errors": [
{
"title": "Package not found"
}
],
"jsonapi": {
"version": "1.0"
}
}
Update a managed or custom package using packageId Note that packageId is providerId-packageId
PUT /eholdings/packages/{packageId}identifier of the package formed from Provider Id and Package Id (see example)
Example:
583-4345Example:
application/vnd.api+jsonMedia type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package PUT Request Schema",
"description": "Package PUT Request Schema using JSON API",
"javaType": "org.folio.rest.jaxrs.model.PackagePutRequest",
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"description": "Data object of package put request",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Put Data Schema",
"javaType": "org.folio.rest.jaxrs.model.PackagePutData",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"readonly": true,
"description": "Unique package id",
"example": "19-2333046"
},
"type": {
"description": "Data type",
"type": "string",
"enum": [
"packages"
],
"example": "packages"
},
"attributes": {
"description": "Data type attributes",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Put Data attributes schema",
"javaType": "org.folio.rest.jaxrs.model.PackagePutDataAttributes",
"additionalProperties": false,
"properties": {
"contentType": {
"type": "string",
"description": "Content Type of Package",
"example": "Online Reference",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Content Type Schema",
"javaType": "org.folio.rest.jaxrs.model.ContentType",
"additionalProperties": false,
"enum": [
"Aggregated Full Text",
"Abstract and Index",
"E-Book",
"E-Journal",
"Print",
"Unknown",
"Online Reference",
"Streaming Media",
"Mixed Content"
]
},
"accessTypeId": {
"type": "string",
"description": "Access type id",
"example": "f973c3b6-85fc-4d35-bda8-f31b568957bf",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"customCoverage": {
"type": "object",
"description": "Custom Coverage",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Coverage Schema",
"javaType": "org.folio.rest.jaxrs.model.Coverage",
"additionalProperties": false,
"properties": {
"beginCoverage": {
"type": "string",
"description": "Begin Coverage Date",
"example": "2003-01-01"
},
"endCoverage": {
"type": "string",
"description": "End Coverage Date",
"example": "2003-12-01"
}
}
},
"isCustom": {
"type": "boolean",
"description": "Whether this package is custom or not",
"example": false
},
"isSelected": {
"type": "boolean",
"description": "Whether this package is selected or not",
"example": false
},
"isFullPackage": {
"type": "boolean",
"description": "Whether this package is partially selected or not",
"example": false
},
"name": {
"type": "string",
"description": "Package name",
"example": "Shenbao"
},
"visibilityData": {
"type": "object",
"description": "Visibility data",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Visibility Data Schema",
"javaType": "org.folio.rest.jaxrs.model.VisibilityData",
"additionalProperties": false,
"properties": {
"isHidden": {
"type": "boolean",
"description": "Whether resource is hidden or not",
"example": false
},
"reason": {
"type": "string",
"description": "Reason why resource is hidden",
"example": "Set by System"
}
}
},
"allowKbToAddTitles": {
"type": "boolean",
"description": "Allow KB to add titles",
"example": true
},
"packageToken": {
"type": "object",
"description": "Package Token",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Token Schema",
"javaType": "org.folio.rest.jaxrs.model.Token",
"additionalProperties": false,
"properties": {
"factName": {
"type": "string",
"description": "Fact Name",
"example": "[[galesiteid]]"
},
"prompt": {
"type": "string",
"description": "Prompt",
"example": "/itweb/"
},
"helpText": {
"type": "string",
"description": "Help text",
"example": "What is token and how to use it"
},
"value": {
"type": "string",
"description": "Value",
"example": "hellotoken"
}
}
},
"proxy": {
"type": "object",
"description": "Proxy",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Proxy Schema",
"javaType": "org.folio.rest.jaxrs.model.Proxy",
"additionalProperties": true,
"properties": {
"id": {
"type": "string",
"description": "Proxy Id",
"example": "EZProxy"
},
"inherited": {
"type": "boolean",
"description": "Whether this proxy is inherited",
"example": true
}
}
}
}
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
}Example:
{
"data": {
"type": "packages",
"attributes": {
"name": "test package for documentation",
"contentType": "Unknown",
"customCoverage": {
"beginCoverage": "2003-01-01",
"endCoverage": "2003-12-01"
},
"isSelected": true,
"visibilityData": {
"isHidden": true
},
"packageToken": {
"value": "hellotoken"
},
"proxy": {
"id": "EZProxy"
}
}
}
}
OK
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package object schema",
"description": "Package object schema",
"javaType": "org.folio.rest.jaxrs.model.Package",
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "The Data Schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package object schema for a collection",
"javaType": "org.folio.rest.jaxrs.model.PackageCollectionItem",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of package - combination of providerId-packageId",
"example": "91525-1152699"
},
"type": {
"type": "string",
"description": "Type of resource",
"example": "packages"
},
"attributes": {
"type": "object",
"description": "Package object data attributes",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Object Data Attributes Schema",
"javaType": "org.folio.rest.jaxrs.model.PackageDataAttributes",
"additionalProperties": false,
"properties": {
"contentType": {
"type": "string",
"description": "Content Type of Package",
"example": "Online Reference",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Content Type Schema",
"javaType": "org.folio.rest.jaxrs.model.ContentType",
"additionalProperties": false,
"enum": [
"Aggregated Full Text",
"Abstract and Index",
"E-Book",
"E-Journal",
"Print",
"Unknown",
"Online Reference",
"Streaming Media",
"Mixed Content"
]
},
"customCoverage": {
"type": "object",
"description": "Custom Coverage",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Coverage Schema",
"javaType": "org.folio.rest.jaxrs.model.Coverage",
"additionalProperties": false,
"properties": {
"beginCoverage": {
"type": "string",
"description": "Begin Coverage Date",
"example": "2003-01-01"
},
"endCoverage": {
"type": "string",
"description": "End Coverage Date",
"example": "2003-12-01"
}
}
},
"isCustom": {
"type": "boolean",
"description": "Whether this package is custom or not",
"example": false
},
"isSelected": {
"type": "boolean",
"description": "Whether this package is selected or not",
"example": false
},
"name": {
"type": "string",
"description": "Package name",
"example": "Shenbao"
},
"packageId": {
"type": "integer",
"description": "Package Id",
"example": 1152699
},
"packageType": {
"type": "string",
"description": "Package type",
"example": "Complete"
},
"providerId": {
"type": "integer",
"description": "Provider Id",
"example": 91525
},
"providerName": {
"type": "string",
"description": "Provider name",
"example": "Green Apple - Qingpingguo"
},
"selectedCount": {
"type": "integer",
"description": "Selected count",
"example": 0
},
"titleCount": {
"type": "integer",
"description": "Title count",
"example": 1
},
"visibilityData": {
"type": "object",
"description": "Visibility data",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Visibility Data Schema",
"javaType": "org.folio.rest.jaxrs.model.VisibilityData",
"additionalProperties": false,
"properties": {
"isHidden": {
"type": "boolean",
"description": "Whether resource is hidden or not",
"example": false
},
"reason": {
"type": "string",
"description": "Reason why resource is hidden",
"example": "Set by System"
}
}
},
"allowKbToAddTitles": {
"type": "boolean",
"description": "Allow KB to add titles",
"example": true
},
"packageToken": {
"type": "object",
"description": "Package Token",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Token Schema",
"javaType": "org.folio.rest.jaxrs.model.Token",
"additionalProperties": false,
"properties": {
"factName": {
"type": "string",
"description": "Fact Name",
"example": "[[galesiteid]]"
},
"prompt": {
"type": "string",
"description": "Prompt",
"example": "/itweb/"
},
"helpText": {
"type": "string",
"description": "Help text",
"example": "What is token and how to use it"
},
"value": {
"type": "string",
"description": "Value",
"example": "hellotoken"
}
}
},
"proxy": {
"type": "object",
"description": "Proxy",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Proxy Schema",
"javaType": "org.folio.rest.jaxrs.model.Proxy",
"additionalProperties": true,
"properties": {
"id": {
"type": "string",
"description": "Proxy Id",
"example": "EZProxy"
},
"inherited": {
"type": "boolean",
"description": "Whether this proxy is inherited",
"example": true
}
}
},
"tags": {
"type": "object",
"description": "Package tags",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "tags.schema",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
},
"relationships": {
"type": "object",
"description": "Displays if any resources are included in relationships",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package relationships object schema in package collection item",
"javaType": "org.folio.rest.jaxrs.model.PackageRelationship",
"additionalProperties": false,
"properties": {
"resources": {
"type": "object",
"description": "Displays Resources Relationship if any",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for an array of objects",
"javaType": "org.folio.rest.jaxrs.model.HasManyRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "relationship Data Information",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"description": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
},
"provider": {
"type": "object",
"description": "Displays Provider Relationship if any",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for a given object",
"javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "relationship Data Information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
},
"accessType": {
"type": "object",
"description": "Displays Access Type Relationship if any",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for a given object",
"javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "relationship Data Information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
}
}
}
}
},
"included": {
"type": "array",
"description": "List of included items",
"items": {
"type": "object",
"javaType": "java.lang.Object"
}
},
"jsonapi": {
"type": "object",
"description": "version of json api",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
},
"required": [
"data",
"jsonapi"
]
}Example:
{
"data": {
"id": "123355-2880981",
"type": "packages",
"attributes": {
"contentType": "E-Book",
"customCoverage": {
"beginCoverage": "2003-01-01",
"endCoverage": "2004-01-01"
},
"isCustom": true,
"isSelected": true,
"name": "yet another custom package again",
"packageId": 2880981,
"packageType": "Custom",
"providerId": 123355,
"providerName": "API DEV CORPORATE CUSTOMER",
"selectedCount": 0,
"titleCount": 0,
"vendorId": 123355,
"vendorName": "API DEV CORPORATE CUSTOMER",
"visibilityData": {
"isHidden": true,
"reason": ""
},
"allowKbToAddTitles": true
},
"relationships": {
"resources": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
}
}
},
"jsonapi": {
"version": "1.0"
}
}
Bad Request
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response Schema",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiError",
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"description": "Error Response List",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response object",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Error Message Title",
"example": "Invalid KB API Credentials"
},
"detail": {
"type": "string",
"description": "Error Message Detail",
"example": "Kb api credentials are invalid"
},
"source": {
"type": "object",
"description": "Source of Error Message",
"example": {}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "JSON API Version",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
}
}Example:
{
"errors": [{
"title": {
"errors": [{
"code": 1005,
"subCode": 0,
"message": "Attribute IsSelected is missing."
}]
}
}],
"jsonapi": {
"version": "1.0"
}
}
Not Found
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response Schema",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiError",
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"description": "Error Response List",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response object",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Error Message Title",
"example": "Invalid KB API Credentials"
},
"detail": {
"type": "string",
"description": "Error Message Detail",
"example": "Kb api credentials are invalid"
},
"source": {
"type": "object",
"description": "Source of Error Message",
"example": {}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "JSON API Version",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
}
}Example:
{
"errors": [{
"title": {
"errors": [{
"code": 1001,
"subCode": 0,
"message": "Vendor not found"
}]
}
}],
"jsonapi": {
"version": "1.0"
}
}
Unprocessable Entity
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response Schema",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiError",
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"description": "Error Response List",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response object",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Error Message Title",
"example": "Invalid KB API Credentials"
},
"detail": {
"type": "string",
"description": "Error Message Detail",
"example": "Kb api credentials are invalid"
},
"source": {
"type": "object",
"description": "Source of Error Message",
"example": {}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "JSON API Version",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
}
}Example:
{
"errors": [{
"title": "Invalid beginCoverage",
"detail": "Begincoverage must be blank",
"source": {}
},
{
"title": "Invalid endCoverage",
"detail": "Endcoverage must be blank",
"source": {}
}
],
"jsonapi": {
"version": "1.0"
}
}
Delete a specific custom package using packageId. Note that packageId is providerId-packageId
DELETE /eholdings/packages/{packageId}identifier of the package formed from Provider Id and Package Id (see example)
Example:
583-4345No Content
Bad Request
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response Schema",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiError",
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"description": "Error Response List",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response object",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Error Message Title",
"example": "Invalid KB API Credentials"
},
"detail": {
"type": "string",
"description": "Error Message Detail",
"example": "Kb api credentials are invalid"
},
"source": {
"type": "object",
"description": "Source of Error Message",
"example": {}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "JSON API Version",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
}
}Example:
{
"errors": [
{
"title": "Invalid package",
"detail": "Package cannot be deleted",
"source": {}
}
],
"jsonapi": {
"version": "1.0"
}
}
Include all resources belonging to a specific package
GET /eholdings/packages/{packageId}/resourcesidentifier of the package formed from Provider Id and Package Id (see example)
Example:
583-4345Filter to narrow down results based on assigned tags. Contains list of required tags.
Filter to narrow down results based on assigned access type.
Filter to narrow down results based on selection status. Defaults to all. Possible values are all, true, false, ebsco.
Example:
ebscoFilter to narrow down results based on content type. Possible values are all, audiobook, book, bookseries, database, journal, newsletter, newspaper, proceedings, report, streamingaudio, streamingvideo,thesisdissertation, website, unspecified.
String to search title name to get a collection of titles
Example:
War and PeaceString to search ISSN and ISBN to get a collection of titles
Example:
1050-3331String to search subjects to get a collection of titles
Example:
historyString to search publishers to get a collection of titles
Example:
academicOption by which results are sorted. Possible values are name, relevance.
Page number
Example:
1Page size
Example:
100OK
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Resource Collection Schema",
"description": "Resource Collection Schema",
"javaType": "org.folio.rest.jaxrs.model.ResourceCollection",
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "List of resources",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Resource object schema for a collection",
"description": "Resource object schema for a collection",
"javaType": "org.folio.rest.jaxrs.model.ResourceCollectionItem",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of resource - combination of providerId-packageId-titleId",
"example": "583-4345-760027"
},
"type": {
"type": "string",
"description": "Type of resource",
"enum": [
"resources"
],
"example": "resources"
},
"attributes": {
"type": "object",
"description": "Resource object data attributes",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Resource Object Data Attributes Schema",
"javaType": "org.folio.rest.jaxrs.model.ResourceDataAttributes",
"additionalProperties": false,
"properties": {
"alternateTitles": {
"type": "array",
"description": "List of alternate titles",
"items": {
"type": "object",
"description": "Alternate Title Schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Alternate Title Schema",
"javaType": "org.folio.rest.jaxrs.model.AlternateTitle",
"additionalProperties": false,
"properties": {
"alternateTitle": {
"type": "string",
"description": "alternate title name",
"example": "Boston Coll Law Rev"
},
"titleType": {
"type": "string",
"description": "alternate title type",
"example": "Abbreviated"
}
}
}
},
"description": {
"type": "string",
"description": "Description of Resource. Note that this attribute can be updated ONLY FOR A CUSTOM RESOURCE.",
"example": "Online Reference"
},
"edition": {
"type": "string",
"description": "Edition. Note that this attribute can be updated ONLY FOR A CUSTOM RESOURCE."
},
"isPeerReviewed": {
"type": "boolean",
"description": "Defines if peer is reviewed. Note that this attribute can be updated ONLY FOR A CUSTOM RESOURCE.",
"example": false
},
"isTitleCustom": {
"type": "boolean",
"readonly": true,
"description": "Defines if title is custom",
"example": false
},
"publisherName": {
"type": "string",
"description": "Publisher. Note that this attribute can be updated ONLY FOR A CUSTOM RESOURCE.",
"example": "Indiana University-Purdue Fort Wayne"
},
"titleId": {
"type": "integer",
"readonly": true,
"description": "Title Id",
"example": 2985519
},
"contributors": {
"type": "array",
"description": "List of contributors. Note that this attribute can be updated ONLY FOR A CUSTOM RESOURCE.",
"items": {
"type": "object",
"description": "The Contributors Schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Contributor object schema",
"javaType": "org.folio.rest.jaxrs.model.Contributors",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "Type of contributor. Valid values are Author, Illustrator, and Editor.",
"example": "Author"
},
"contributor": {
"type": "string",
"description": "Contributor Name",
"example": "Havard, Margaret"
}
}
}
},
"identifiers": {
"type": "array",
"description": "List of identifiers. Note that this attribute can be updated ONLY FOR A CUSTOM RESOURCE.",
"items": {
"type": "object",
"description": "The Identifiers Schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Identifier object schema",
"javaType": "org.folio.rest.jaxrs.model.Identifier",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Identifier Value",
"example": "100130"
},
"subtype": {
"type": "string",
"description": "Subtype for the identifier. Valid values are Print, Online.",
"enum": [
"Print",
"Online"
],
"example": "Print"
},
"type": {
"type": "string",
"description": "Type of identifier. Valid values are ISSN, ISBN.",
"enum": [
"ISSN",
"ISBN"
],
"example": "ISSN"
}
}
}
},
"name": {
"type": "string",
"description": "Resource name. Note that this attribute can be updated ONLY FOR A CUSTOM RESOURCE.",
"example": "American Journal of Undergraduate Research"
},
"publicationType": {
"type": "string",
"description": "Publication type. Note that this attribute can be updated ONLY FOR A CUSTOM RESOURCE.",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Publication Type schema",
"javaType": "org.folio.rest.jaxrs.model.PublicationType",
"additionalProperties": false,
"enum": [
"All",
"Audiobook",
"Audio book",
"Book",
"Book Series",
"Database",
"Journal",
"Newsletter",
"Newspaper",
"Proceedings",
"Report",
"Streaming Audio",
"Streaming Video",
"Thesis & Dissertation",
"Thesis/Dissertation",
"Website",
"Web site",
"Unspecified"
],
"example": "Journal"
},
"subjects": {
"type": "array",
"readonly": true,
"description": "List of subjects for a given resource",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Subject object schema",
"description": "Subject object schema",
"javaType": "org.folio.rest.jaxrs.model.TitleSubject",
"additionalProperties": false,
"properties": {
"subject": {
"type": "string",
"description": "Subject subtype",
"example": "Social Services"
},
"type": {
"type": "string",
"description": "Subject type",
"example": "TLI"
}
}
}
},
"coverageStatement": {
"type": "string",
"description": "Coverage statement. Note that this attribute can be updated both for CUSTOM AND MANAGED RESOURCES.",
"example": "Only 2000s issues available."
},
"customEmbargoPeriod": {
"type": "object",
"description": "Custom Embargo Period information. Note that this attribute can be updated both for CUSTOM AND MANAGED RESOURCES.",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Embargo Period Schema",
"javaType": "org.folio.rest.jaxrs.model.EmbargoPeriod",
"additionalProperties": false,
"properties": {
"embargoUnit": {
"type": "string",
"description": "The unit of time to use for the embargo. Possible values are 'Days', 'Weeks', 'Months', 'Years'",
"enum": [
"Days",
"Weeks",
"Months",
"Years"
],
"example": "Days"
},
"embargoValue": {
"type": "integer",
"description": "The embargo value (number of embargoUnits). A Null value means there is no embargo.",
"example": 7
}
}
},
"isPackageCustom": {
"type": "boolean",
"readonly": true,
"description": "Defines if package is custom",
"example": false
},
"isSelected": {
"type": "boolean",
"description": "Defines if this item is selected. Note that this attribute can be updated both for CUSTOM AND MANAGED RESOURCES.",
"example": false
},
"titleHasSelectedResources": {
"type": "boolean",
"description": "Indicates if the title that contains this resource has selected resources",
"example": true
},
"isTokenNeeded": {
"type": "boolean",
"readonly": true,
"description": "Defines if token is needed",
"example": false
},
"locationId": {
"type": "integer",
"readonly": true,
"description": "Unique location id",
"example": 9091063
},
"managedEmbargoPeriod": {
"type": "object",
"readonly": true,
"description": "Managed Embargo Period information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Embargo Period Schema",
"javaType": "org.folio.rest.jaxrs.model.EmbargoPeriod",
"additionalProperties": false,
"properties": {
"embargoUnit": {
"type": "string",
"description": "The unit of time to use for the embargo. Possible values are 'Days', 'Weeks', 'Months', 'Years'",
"enum": [
"Days",
"Weeks",
"Months",
"Years"
],
"example": "Days"
},
"embargoValue": {
"type": "integer",
"description": "The embargo value (number of embargoUnits). A Null value means there is no embargo.",
"example": 7
}
}
},
"packageId": {
"type": "string",
"readonly": true,
"description": "Unique package id",
"example": "19-2333046"
},
"packageName": {
"type": "string",
"readonly": true,
"description": "Package name",
"example": "Applied Science & Technology Source Ultimate"
},
"url": {
"type": "string",
"description": "URL. Note that this attribute can be updated ONLY FOR A CUSTOM RESOURCE.",
"example": "http://search.ebscohost.com/direct.asp?db=aps&jid=BDGR&scope=site"
},
"providerId": {
"type": "integer",
"readonly": true,
"description": "Provider Id",
"example": 19
},
"providerName": {
"type": "string",
"readonly": true,
"description": "Provider name",
"example": "EBSCO"
},
"visibilityData": {
"type": "object",
"description": "Visibility data. Note that this attribute can be updated both for CUSTOM AND MANAGED RESOURCES.",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Visibility Data Schema",
"javaType": "org.folio.rest.jaxrs.model.VisibilityData",
"additionalProperties": false,
"properties": {
"isHidden": {
"type": "boolean",
"description": "Whether resource is hidden or not",
"example": false
},
"reason": {
"type": "string",
"description": "Reason why resource is hidden",
"example": "Set by System"
}
}
},
"managedCoverages": {
"type": "array",
"readonly": true,
"description": "List of Managed Coverages information",
"items": {
"type": "object",
"description": "Managed Coverages information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Coverage Schema",
"javaType": "org.folio.rest.jaxrs.model.Coverage",
"additionalProperties": false,
"properties": {
"beginCoverage": {
"type": "string",
"description": "Begin Coverage Date",
"example": "2003-01-01"
},
"endCoverage": {
"type": "string",
"description": "End Coverage Date",
"example": "2003-12-01"
}
}
}
},
"customCoverages": {
"type": "array",
"description": "List of Custom Coverages information. Note that this attribute can be updated both for CUSTOM AND MANAGED RESOURCES.",
"items": {
"type": "object",
"description": "Custom Coverages information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Coverage Schema",
"javaType": "org.folio.rest.jaxrs.model.Coverage",
"additionalProperties": false,
"properties": {
"beginCoverage": {
"type": "string",
"description": "Begin Coverage Date",
"example": "2003-01-01"
},
"endCoverage": {
"type": "string",
"description": "End Coverage Date",
"example": "2003-12-01"
}
}
}
},
"proxy": {
"type": "object",
"description": "Proxy. Note that this attribute can be updated both for CUSTOM AND MANAGED RESOURCES.",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Proxy Url Schema",
"javaType": "org.folio.rest.jaxrs.model.ProxyUrl",
"additionalProperties": false,
"extends": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Proxy Schema",
"description": "Proxy Schema",
"javaType": "org.folio.rest.jaxrs.model.Proxy",
"type": "object",
"additionalProperties": true,
"properties": {
"id": {
"type": "string",
"description": "Proxy Id",
"example": "EZProxy"
},
"inherited": {
"type": "boolean",
"description": "Whether this proxy is inherited",
"example": true
}
}
},
"properties": {
"proxiedUrl": {
"type": "string",
"description": "Proxied Url",
"example": "https://example.com"
}
}
},
"tags": {
"type": "object",
"description": "Resource tags",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "tags.schema",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"userDefinedField1": {
"type": "string",
"description": "User defined field 1",
"maxLength": 100
},
"userDefinedField2": {
"type": "string",
"description": "User defined field 2",
"maxLength": 100
},
"userDefinedField3": {
"type": "string",
"description": "User defined field 3",
"maxLength": 100
},
"userDefinedField4": {
"type": "string",
"description": "User defined field 4",
"maxLength": 100
},
"userDefinedField5": {
"type": "string",
"description": "User defined field 5",
"maxLength": 100
}
}
},
"relationships": {
"type": "object",
"description": "Displays if any relationship is included",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.ResourceRelationships",
"additionalProperties": false,
"properties": {
"provider": {
"type": "object",
"description": "Relationship of provider for a given object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for a given object",
"javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "relationship Data Information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
},
"title": {
"type": "object",
"description": "Relationship of title for a given object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for a given object",
"javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "relationship Data Information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
},
"package": {
"type": "object",
"description": "Relationship of package for a given object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for a given object",
"javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "relationship Data Information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
},
"accessType": {
"type": "object",
"description": "Relationship of access type for a given object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Relationship for a given object",
"javaType": "org.folio.rest.jaxrs.model.HasOneRelationship",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"description": "relationship Data Information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Data of relationships for a given object",
"javaType": "org.folio.rest.jaxrs.model.RelationshipData",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "The Type Schema",
"example": "resources"
},
"id": {
"type": "string",
"description": "The Id Schema",
"example": "269-1565-316875"
}
}
},
"meta": {
"type": "object",
"description": "Meta information",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
},
"resources": {
"type": "object",
"description": "Resources relationship",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of whether an object is related to this resource",
"javaType": "org.folio.rest.jaxrs.model.MetaIncluded",
"additionalProperties": false,
"properties": {
"meta": {
"type": "object",
"description": "Metadata of whether an object is related to this resource",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata of packages related to a provider",
"javaType": "org.folio.rest.jaxrs.model.MetaDataIncluded",
"additionalProperties": false,
"properties": {
"included": {
"type": "boolean",
"description": "Relationship between objects",
"example": false
}
}
}
}
}
}
},
"included": {
"type": "array",
"description": "List of included objects",
"items": {
"type": "object",
"javaType": "java.lang.Object"
}
}
}
}
},
"meta": {
"type": "object",
"description": "metadata containing total results in resources collection",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata total results Schema",
"javaType": "org.folio.rest.jaxrs.model.MetaTotalResults",
"additionalProperties": false,
"properties": {
"totalResults": {
"type": "integer",
"description": "Total number of results",
"example": 2
}
},
"required": [
"totalResults"
]
},
"jsonapi": {
"type": "object",
"description": "version of json api",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
},
"required": [
"data",
"jsonapi"
]
}Example:
{
"data": [{
"id": "19-6581-581242",
"type": "resources",
"attributes": {
"description": null,
"edition": null,
"isPeerReviewed": null,
"isTitleCustom": false,
"publisherName": "Wroclaw University of Environmental & Life Sciences",
"titleId": 581242,
"contributors": [],
"identifiers": [{
"id": "1644-065X",
"type": "ISSN",
"subtype": "Print"
},
{
"id": "2083-8654",
"type": "ISSN",
"subtype": "Online"
},
{
"id": "97C7",
"type": "Mid",
"subtype": "Empty"
},
{
"id": "581242",
"type": "BHM",
"subtype": "Empty"
}
],
"name": "Acta Scientiarum Polonorum. Biotechnologia",
"publicationType": "Journal",
"subjects": [{
"type": "TLI",
"subject": "Biological Engineering"
}],
"coverageStatement": null,
"customEmbargoPeriod": {
"embargoUnit": null,
"embargoValue": 0
},
"isPackageCustom": false,
"isSelected": false,
"isTokenNeeded": false,
"locationId": 4829613,
"managedEmbargoPeriod": {
"embargoUnit": null,
"embargoValue": 0
},
"packageId": "19-6581",
"packageName": "EBSCO Biotechnology Collection: India",
"url": "http://search.ebscohost.com/direct.asp?db=bti&jid=97C7&scope=site",
"vendorId": 19,
"vendorName": "EBSCO",
"providerId": 19,
"providerName": "EBSCO",
"visibilityData": {
"isHidden": false,
"reason": ""
},
"managedCoverages": [{
"beginCoverage": "2008-12-01",
"endCoverage": ""
}],
"customCoverages": [],
"proxy": null
},
"relationships": {
"provider": {
"meta": {
"included": false
}
},
"title": {
"meta": {
"included": false
}
},
"package": {
"meta": {
"included": false
}
}
}
},
{
"id": "19-6581-2467485",
"type": "resources",
"attributes": {
"description": null,
"edition": null,
"isPeerReviewed": null,
"isTitleCustom": false,
"publisherName": "AVS: Science & Technology of Materials, Interfaces, and Processing",
"titleId": 2467485,
"contributors": [],
"identifiers": [{
"id": "1934-8630",
"type": "ISSN",
"subtype": "Print"
},
{
"id": "1559-4106",
"type": "ISSN",
"subtype": "Online"
},
{
"id": "102667066",
"type": "SPID",
"subtype": "Empty"
},
{
"id": "122153798",
"type": "SPID",
"subtype": "Empty"
},
{
"id": "714936",
"type": "EjsJournalID",
"subtype": "Empty"
},
{
"id": "2F7L",
"type": "Mid",
"subtype": "Empty"
},
{
"id": "2248363",
"type": "BHM",
"subtype": "Empty"
}
],
"name": "Biointerphases",
"publicationType": "Journal",
"subjects": [{
"type": "TLI",
"subject": "Physics"
}],
"coverageStatement": null,
"customEmbargoPeriod": {
"embargoUnit": null,
"embargoValue": 0
},
"isPackageCustom": false,
"isSelected": false,
"isTokenNeeded": false,
"locationId": 4829582,
"managedEmbargoPeriod": {
"embargoUnit": null,
"embargoValue": 0
},
"packageId": "19-6581",
"packageName": "EBSCO Biotechnology Collection: India",
"url": "http://search.ebscohost.com/direct.asp?db=bti&jid=2F7L&scope=site",
"vendorId": 19,
"vendorName": "EBSCO",
"providerId": 19,
"providerName": "EBSCO",
"visibilityData": {
"isHidden": false,
"reason": ""
},
"managedCoverages": [{
"beginCoverage": "2006-12-01",
"endCoverage": ""
}],
"customCoverages": [],
"proxy": null
},
"relationships": {
"vendor": {
"meta": {
"included": false
}
},
"provider": {
"meta": {
"included": false
}
},
"title": {
"meta": {
"included": false
}
},
"package": {
"meta": {
"included": false
}
}
}
}
],
"meta": {
"totalResults": 157
},
"jsonapi": {
"version": "1.0"
}
}
Bad Request
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response Schema",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiError",
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"description": "Error Response List",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response object",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Error Message Title",
"example": "Invalid KB API Credentials"
},
"detail": {
"type": "string",
"description": "Error Message Detail",
"example": "Kb api credentials are invalid"
},
"source": {
"type": "object",
"description": "Source of Error Message",
"example": {}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "JSON API Version",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
}
}Example:
{
"errors": [
{
"title": "Package or provider id are invalid"
}
],
"jsonapi": {
"version": "1.0"
}
}
Not Found
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response Schema",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiError",
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"description": "Error Response List",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response object",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Error Message Title",
"example": "Invalid KB API Credentials"
},
"detail": {
"type": "string",
"description": "Error Message Detail",
"example": "Kb api credentials are invalid"
},
"source": {
"type": "object",
"description": "Source of Error Message",
"example": {}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "JSON API Version",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
}
}Example:
{
"errors": [
{
"title": "Package not found"
}
],
"jsonapi": {
"version": "1.0"
}
}
POST /eholdings/packages/bulk/fetchExample:
application/vnd.api+jsonMedia type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Bulk Fetch object schema",
"description": "Package Bulk Fetch object schema",
"javaType": "org.folio.rest.jaxrs.model.PackagePostBulkFetchRequest",
"type": "object",
"additionalProperties": false,
"properties": {
"packages": {
"type": "array",
"uniqueItems": true,
"maxItems": 20,
"description": "A list of package ids",
"items": {
"type": "string",
"description": "Package id",
"pattern": "\\d+-\\d+",
"examples": [
"123-12354",
"12-34467879"
]
}
}
},
"required": [
"packages"
]
}Example:
{
"packages": ["186-3150130", "413-3757", "19-2320561", "19-2561032"]
}
OK
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Bulk Fetch object schema",
"description": "Package Bulk Fetch object schema",
"javaType": "org.folio.rest.jaxrs.model.PackageBulkFetchCollection",
"type": "object",
"additionalProperties": false,
"properties": {
"included": {
"type": "array",
"description": "List of included package items",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Bulk Fetch object schema for a collection",
"description": "Package Bulk Fetch object schema for a collection",
"javaType": "org.folio.rest.jaxrs.model.PackageBulkFetchCollectionItem",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of package - combination of providerId-packageId",
"example": "583-43450027"
},
"type": {
"type": "string",
"description": "Type of resource",
"enum": [
"packages"
],
"example": "packages"
},
"attributes": {
"type": "object",
"description": "Package object data attributes",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Bulk Fetch Object Data Attributes Schema",
"javaType": "org.folio.rest.jaxrs.model.PackageBulkFetchDataAttributes",
"additionalProperties": false,
"properties": {
"packageId": {
"type": "integer",
"description": "Package Id",
"example": 1152699
},
"name": {
"type": "string",
"description": "Package name",
"example": "American Journal of Undergraduate Research"
},
"providerId": {
"type": "integer",
"readonly": true,
"description": "Provider Id",
"example": 19
},
"providerName": {
"type": "string",
"readonly": true,
"description": "Provider name",
"example": "EBSCO"
},
"packageType": {
"type": "string",
"description": "Package type",
"example": "Complete"
},
"contentType": {
"type": "string",
"description": "Content Type of Package",
"example": "Online Reference",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Content Type Schema",
"javaType": "org.folio.rest.jaxrs.model.ContentType",
"additionalProperties": false,
"enum": [
"Aggregated Full Text",
"Abstract and Index",
"E-Book",
"E-Journal",
"Print",
"Unknown",
"Online Reference",
"Streaming Media",
"Mixed Content"
]
},
"customCoverage": {
"type": "object",
"description": "Custom Coverage",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Coverage Schema",
"javaType": "org.folio.rest.jaxrs.model.Coverage",
"additionalProperties": false,
"properties": {
"beginCoverage": {
"type": "string",
"description": "Begin Coverage Date",
"example": "2003-01-01"
},
"endCoverage": {
"type": "string",
"description": "End Coverage Date",
"example": "2003-12-01"
}
}
},
"isCustom": {
"type": "boolean",
"description": "Whether this package is custom or not",
"example": false
},
"isSelected": {
"type": "boolean",
"description": "Whether this package is selected or not",
"example": false
},
"selectedCount": {
"type": "integer",
"description": "Selected count",
"example": 0
},
"titleCount": {
"type": "integer",
"description": "Title count",
"example": 1
}
}
}
}
}
},
"meta": {
"type": "object",
"description": "Metadata of failed packages",
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Packages Metadata Schema",
"javaType": "org.folio.rest.jaxrs.model.FailedPackagesInformation",
"properties": {
"failed": {
"type": "object",
"description": "Metadata of failed packages",
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Package Failed Ids Schema",
"javaType": "org.folio.rest.jaxrs.model.FailedPackageIds",
"properties": {
"packages": {
"type": "array",
"description": "List of failed package ids",
"items": {
"type": "string",
"description": "Failed package id"
}
}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "version of json api",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
},
"required": [
"included",
"jsonapi"
]
}Example:
{
"included" : [ {
"id" : "19-13964",
"type" : "packages",
"attributes" : {
"packageId" : 13964,
"name" : "America and World War I: American Military Camp Newspapers",
"providerId" : 19,
"providerName" : "EBSCO",
"packageType" : "Complete",
"contentType" : "Aggregated Full Text",
"customCoverage" : {
"beginCoverage" : "",
"endCoverage" : ""
},
"isCustom" : false,
"isSelected" : false,
"selectedCount" : 0,
"titleCount" : 156
}
}, {
"id" : "19-3964",
"type" : "packages",
"attributes" : {
"packageId" : 3964,
"name" : "EBSCO Biotechnology Collection: India",
"providerId" : 19,
"providerName" : "EBSCO",
"packageType" : "Complete",
"contentType" : "Aggregated Full Text",
"customCoverage" : {
"beginCoverage" : "",
"endCoverage" : ""
},
"isCustom" : false,
"isSelected" : false,
"selectedCount" : 0,
"titleCount" : 156
}
} ],
"meta" : {
"failed" : {
"packages" : [ "19-9999999" ]
}
},
"jsonapi" : {
"version" : "1.0"
}
}
Unprocessable Entity
Media type: application/vnd.api+json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response Schema",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiError",
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"description": "Error Response List",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response object",
"description": "Error Response Schema for JSON API",
"javaType": "org.folio.rest.jaxrs.model.JsonapiErrorResponse",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Error Message Title",
"example": "Invalid KB API Credentials"
},
"detail": {
"type": "string",
"description": "Error Message Detail",
"example": "Kb api credentials are invalid"
},
"source": {
"type": "object",
"description": "Source of Error Message",
"example": {}
}
}
}
},
"jsonapi": {
"type": "object",
"description": "JSON API Version",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JSON API Version Schema",
"javaType": "org.folio.rest.jaxrs.model.JsonAPI",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Version of json api being used",
"example": "1.0"
}
},
"required": [
"version"
]
}
}
}Example:
{
"errors": [
{
"message": "elements in list must match pattern",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "packages",
"value": "[19-3964, 18s-3150130]"
}
]
}
]
}