mod-kb-ebsco-java (v1)

https://github.com/folio-org/mod-kb-ebsco-java

Table of contents

Titles

Collection of available titles in eholdings.

GET /eholdings/titles

Get a set of titles matching the given search criteria.

GET /eholdings/titles
Query Parameters
  • filter[tags]: (array of string)

    Filter to narrow down results based on assigned tags. Contains list of required tags.

  • filter[access-type]: (array of string)

    Filter to narrow down results based on assigned access type.

  • filter[selected]: (string)

    Filter to narrow down results based on selection status. Defaults to all. Possible values are all, true, false, ebsco.

    Example:

    ebsco
  • filter[type]: (string)

    Filter 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.

  • filter[name]: (string)

    String to search title name to get a collection of titles

    Example:

    War and Peace
  • filter[isxn]: (string)

    String to search ISSN and ISBN to get a collection of titles

    Example:

    1050-3331
  • filter[subject]: (string)

    String to search subjects to get a collection of titles

    Example:

    history
  • filter[publisher]: (string)

    String to search publishers to get a collection of titles

    Example:

    academic
  • include: (string)

    Include related resource objects, each representing a partnering of this title with a package. Any bogus value, like include=deciduousTrees, will be silently ignored.

    Example:

    resources
  • sort: (string - default: relevance)

    Option by which results are sorted. Possible values are name, relevance.

  • page: (integer - default: 1 - minimum: 1 - maximum: 2147483647)

    Page number

    Example:

    1
  • count: (integer - default: 25 - minimum: 1 - maximum: 100)

    Page size

    Example:

    100

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Titles Collection Schema",
  "description": "Titles Collection Schema",
  "javaType": "org.folio.rest.jaxrs.model.TitleCollection",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "description": "List of titles",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Title object schema in titles collection",
        "description": "Title object schema in titles collection",
        "javaType": "org.folio.rest.jaxrs.model.TitleCollectionItem",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of title",
            "example": "100130"
          },
          "type": {
            "type": "string",
            "description": "Type of resource",
            "enum": [
              "titles"
            ],
            "example": "titles"
          },
          "attributes": {
            "type": "object",
            "description": "Title object data attributes",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Attributes object schema in titles collection",
            "javaType": "org.folio.rest.jaxrs.model.TitleCollectionItemDataAttributes",
            "additionalProperties": false,
            "properties": {
              "identifiers": {
                "type": "array",
                "description": "List of title identifiers",
                "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"
                    }
                  }
                }
              },
              "isTitleCustom": {
                "type": "boolean",
                "description": "Defines if the title is custom",
                "example": false
              },
              "name": {
                "type": "string",
                "description": "Title name",
                "example": "A call to action: Changing the culture of drinking at U.S. colleges"
              },
              "publicationType": {
                "type": "string",
                "description": "Type of publication",
                "$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"
              },
              "publisherName": {
                "type": "string",
                "description": "Publisher name",
                "example": "Elsevier"
              },
              "subjects": {
                "type": "array",
                "description": "List of title subjects",
                "items": {
                  "type": "object",
                  "description": "List of title subjects",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "title": "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"
                    }
                  }
                }
              },
              "contributors": {
                "type": "array",
                "description": "List of contributors",
                "items": {
                  "type": "object",
                  "description": "The contributor's 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"
                    }
                  }
                }
              },
              "relationships": {
                "type": "object",
                "description": "Displays title relationships",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Metadata of relationships for a given object",
                "javaType": "org.folio.rest.jaxrs.model.Relationships",
                "additionalProperties": false,
                "properties": {
                  "packages": {
                    "type": "object",
                    "description": "Relationship of packages for a given object",
                    "properties": {
                      "data": {
                        "type": "array",
                        "description": "packages Data Information",
                        "items": {
                          "type": "object",
                          "description": "Resources Data",
                          "$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": "Relationship of resources for a given object",
                    "properties": {
                      "data": {
                        "type": "array",
                        "description": "Resources Data Information",
                        "items": {
                          "type": "object",
                          "description": "Resources Data",
                          "$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
                          }
                        }
                      }
                    }
                  },
                  "provider": {
                    "type": "object",
                    "description": "Relationship of provider for a given object",
                    "$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 resources for a given title",
            "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": {
                    "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 Schema",
                      "javaType": "org.folio.rest.jaxrs.model.Proxy",
                      "additionalProperties": false,
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Proxy Id",
                          "example": "EZProxy"
                        },
                        "inherited": {
                          "type": "boolean",
                          "description": "Whether this proxy is inherited",
                          "example": true
                        }
                      }
                    },
                    "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
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "description": "metadata containing total results in providers 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"
  ]
}

Example:

{
  "data": [
    {
      "attributes": {
        "identifiers": [
          {
            "id": "100130",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A call to action: Changing the culture of drinking at U.S. colleges",
        "publicationType": "Journal",
        "publisherName": "National Institute on Alcohol Abuse and Alcoholism",
        "subjects": [
          {
            "subject": "Social Services",
            "type": "TLI"
          }
        ]
      },
      "id": "100130",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "125590",
            "subtype": "Empty",
            "type": "BHM"
          },
          {
            "id": "1093-9253",
            "subtype": "Print",
            "type": "ISSN"
          }
        ],
        "isTitleCustom": false,
        "name": "A and WMA Environmental Compliance News",
        "publicationType": "Journal",
        "publisherName": "Elsevier",
        "subjects": [
          {
            "subject": "Pollution Control & Waste Management",
            "type": "TLI"
          }
        ]
      },
      "id": "125590",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "169441",
            "subtype": "Empty",
            "type": "BHM"
          },
          {
            "id": "978-92-64-18255-4",
            "subtype": "Print",
            "type": "ISBN"
          },
          {
            "id": "978-1-280-03078-9",
            "subtype": "Online",
            "type": "ISBN"
          },
          {
            "id": "978-92-64-18256-1",
            "subtype": "Online",
            "type": "ISBN"
          }
        ],
        "isTitleCustom": false,
        "name": "A Better World for All: Progress Towards the International Development Goals",
        "publicationType": "Book",
        "publisherName": "OECD Publications Centre",
        "subjects": [
          {
            "subject": "Development Economics",
            "type": "TLI"
          }
        ]
      },
      "id": "169441",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "169442",
            "subtype": "Empty",
            "type": "BHM"
          },
          {
            "id": "978-92-64-17007-0",
            "subtype": "Print",
            "type": "ISBN"
          },
          {
            "id": "978-1-280-08397-6",
            "subtype": "Online",
            "type": "ISBN"
          },
          {
            "id": "978-92-64-17259-3",
            "subtype": "Online",
            "type": "ISBN"
          }
        ],
        "isTitleCustom": false,
        "name": "A Caring World: The New Social Policy Agenda",
        "publicationType": "Book",
        "publisherName": "OECD Publications Centre",
        "subjects": [
          {
            "subject": "Social Services",
            "type": "TLI"
          }
        ]
      },
      "id": "169442",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "200200065",
            "subtype": "Empty",
            "type": "Mid"
          },
          {
            "id": "183204",
            "subtype": "Empty",
            "type": "BHM"
          },
          {
            "id": "978-1-55798-843-0",
            "subtype": "Print",
            "type": "ISBN"
          }
        ],
        "isTitleCustom": false,
        "name": "A beginner's guide to the MCMI-III",
        "publicationType": "Book",
        "publisherName": "American Psychological Association",
        "subjects": []
      },
      "id": "183204",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "149900",
            "subtype": "Empty",
            "type": "EPBookID"
          },
          {
            "id": "2S63",
            "subtype": "Empty",
            "type": "Mid"
          },
          {
            "id": "210886",
            "subtype": "Empty",
            "type": "BHM"
          },
          {
            "id": "978-0-471-65128-4",
            "subtype": "Print",
            "type": "ISBN"
          },
          {
            "id": "978-0-471-75812-9",
            "subtype": "Online",
            "type": "ISBN"
          },
          {
            "id": "978-0-471-75813-6",
            "subtype": "Online",
            "type": "ISBN"
          },
          {
            "id": "978-1-280-34968-3",
            "subtype": "Online",
            "type": "ISBN"
          }
        ],
        "isTitleCustom": false,
        "name": "A Basic Introduction to Pollutant Fate and Transport: An Integrated Approach with Chemistry, Modeling, Risk Assessment, and Environmental Legislation",
        "publicationType": "Book",
        "publisherName": "John Wiley & Sons Incorporated",
        "subjects": [
          {
            "subject": "Environmental Engineering",
            "type": "TLI"
          },
          {
            "subject": "SCIENCE / Chemistry / Organic",
            "type": "BISAC"
          }
        ]
      },
      "id": "210886",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "517665",
            "subtype": "Empty",
            "type": "EPBookID"
          },
          {
            "id": "2R31",
            "subtype": "Empty",
            "type": "Mid"
          },
          {
            "id": "210887",
            "subtype": "Empty",
            "type": "BHM"
          },
          {
            "id": "978-0-471-22490-7",
            "subtype": "Print",
            "type": "ISBN"
          },
          {
            "id": "978-0-471-22758-8",
            "subtype": "Online",
            "type": "ISBN"
          },
          {
            "id": "978-0-471-46118-0",
            "subtype": "Online",
            "type": "ISBN"
          },
          {
            "id": "978-1-280-55646-3",
            "subtype": "Online",
            "type": "ISBN"
          }
        ],
        "isTitleCustom": false,
        "name": "A Biologist's Guide to Analysis of DNA Microarray Data",
        "publicationType": "Book",
        "publisherName": "John Wiley & Sons Incorporated",
        "subjects": [
          {
            "subject": "Physiology",
            "type": "TLI"
          },
          {
            "subject": "SCIENCE / Life Sciences / Molecular Biology",
            "type": "BISAC"
          }
        ]
      },
      "id": "210887",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "ZCAA",
            "subtype": "Empty",
            "type": "NewsbankID"
          },
          {
            "id": "272942",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A & G Information Service",
        "publicationType": "Newspaper",
        "publisherName": "New World Publishing",
        "subjects": [
          {
            "subject": "News",
            "type": "TLI"
          }
        ]
      },
      "id": "272942",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "286087",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A bill to amend the law relating to the employment of waitresses in restaurants.",
        "publicationType": "Book",
        "publisherName": "London, Eyre & Spottiswoode",
        "subjects": [
          {
            "subject": "Women's Interest",
            "type": "TLI"
          }
        ]
      },
      "id": "286087",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "287713",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A bill to limit the hours of employment of women as bar assistants on premises where intoxicating liquors may be sold for consumption on the premises.",
        "publicationType": "Book",
        "publisherName": "London, Eyre & Spottiswoode",
        "subjects": [
          {
            "subject": "Women's Interest",
            "type": "TLI"
          }
        ]
      },
      "id": "287713",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "287714",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A boarding home for working girls.",
        "publicationType": "Book",
        "publisherName": "Unspecified",
        "subjects": [
          {
            "subject": "Women's Interest",
            "type": "TLI"
          }
        ]
      },
      "id": "287714",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "287715",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A book of duchesses : studies in personality",
        "publicationType": "Book",
        "publisherName": "A. Melrose",
        "subjects": [
          {
            "subject": "Personality",
            "type": "TLI"
          }
        ]
      },
      "id": "287715",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "287716",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A book of noble women",
        "publicationType": "Book",
        "publisherName": "Small, Maynard",
        "subjects": [
          {
            "subject": "Women's Interest",
            "type": "TLI"
          }
        ]
      },
      "id": "287716",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "287717",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A brief history of the movement for woman suffrage in the United States",
        "publicationType": "Book",
        "publisherName": "National Woman Suffrage Pub. Co.",
        "subjects": [
          {
            "subject": "United States History",
            "type": "TLI"
          },
          {
            "subject": "Women's Interest",
            "type": "TLI"
          }
        ]
      },
      "id": "287717",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "287718",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A brief history of the Rhode Island Woman Suffrage Association during twenty-four years, from 1868 to 1893.",
        "publicationType": "Book",
        "publisherName": "E.L. Freeman",
        "subjects": [
          {
            "subject": "United States History",
            "type": "TLI"
          },
          {
            "subject": "Women's Interest",
            "type": "TLI"
          }
        ]
      },
      "id": "287718",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "287719",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A brief memoir of Maria Fox, late of Tottenham.",
        "publicationType": "Book",
        "publisherName": "Association of Friends for the Diffusion of Religious and Useful Knowledge",
        "subjects": [
          {
            "subject": "Christianity",
            "type": "TLI"
          }
        ]
      },
      "id": "287719",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "2882",
            "subtype": "Empty",
            "type": "Mid"
          },
          {
            "id": "287720",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A brief memoir with portions of the diary, letters, and other remains, of Eliza Southall, late of Birmingham, England.",
        "publicationType": "Book",
        "publisherName": "Book Association of Friends",
        "subjects": [
          {
            "subject": "Women's Interest",
            "type": "TLI"
          }
        ]
      },
      "id": "287720",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "287721",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A brief summary, in plain language, of the most important laws concerning women : together with a few observations thereon.",
        "publicationType": "Book",
        "publisherName": "J. Chapman",
        "subjects": [
          {
            "subject": "Women's Interest",
            "type": "TLI"
          }
        ]
      },
      "id": "287721",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "287722",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A brief summary, in plain language, of the most important laws of England concerning women : together with a few observations thereon",
        "publicationType": "Book",
        "publisherName": "Trubner",
        "subjects": [
          {
            "subject": "Law",
            "type": "TLI"
          },
          {
            "subject": "Women's Interest",
            "type": "TLI"
          }
        ]
      },
      "id": "287722",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "305515",
            "subtype": "Empty",
            "type": "BHM"
          },
          {
            "id": "978-1-885073-83-9",
            "subtype": "Print",
            "type": "ISBN"
          },
          {
            "id": "978-1-60780-124-5",
            "subtype": "Online",
            "type": "ISBN"
          }
        ],
        "isTitleCustom": false,
        "name": "A basic guide to exporting, 3rd edition",
        "publicationType": "Book",
        "publisherName": "World Trade Press",
        "subjects": [
          {
            "subject": "Exportation & Importation",
            "type": "TLI"
          }
        ]
      },
      "id": "305515",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "309698",
            "subtype": "Empty",
            "type": "BHM"
          },
          {
            "id": "978-1-60566-500-9",
            "subtype": "Print",
            "type": "ISBN"
          },
          {
            "id": "978-1-60566-500-9",
            "subtype": "Online",
            "type": "ISBN"
          }
        ],
        "isTitleCustom": false,
        "name": "A Case Study on a Security Maturity Assessment of a Business-to-Business Electronic Commerce Organization",
        "publicationType": "Book",
        "publisherName": "IGI Global",
        "subjects": [
          {
            "subject": "Electronic Commerce",
            "type": "TLI"
          }
        ]
      },
      "id": "309698",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "309725",
            "subtype": "Empty",
            "type": "BHM"
          },
          {
            "id": "978-1-59904-434-7",
            "subtype": "Online",
            "type": "ISBN"
          }
        ],
        "isTitleCustom": false,
        "name": "A Case Study on Assessing the Readiness of Professional Services Company to Build an Organizational Memory Information Systems",
        "publicationType": "Book",
        "publisherName": "IGI Global",
        "subjects": [
          {
            "subject": "Information Technology",
            "type": "TLI"
          },
          {
            "subject": "Knowledge Management",
            "type": "TLI"
          }
        ]
      },
      "id": "309725",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "403769",
            "subtype": "Empty",
            "type": "EPBookID"
          },
          {
            "id": "315155",
            "subtype": "Empty",
            "type": "BHM"
          },
          {
            "id": "978-0-7735-2694-5",
            "subtype": "Print",
            "type": "ISBN"
          },
          {
            "id": "978-0-7735-7182-2",
            "subtype": "Online",
            "type": "ISBN"
          },
          {
            "id": "978-1-282-86176-3",
            "subtype": "Online",
            "type": "ISBN"
          }
        ],
        "isTitleCustom": false,
        "name": "A Bare and Impolitic Right: Internment and Ukrainian-Canadian Redress",
        "publicationType": "Book",
        "publisherName": "McGill-Queen's University Press",
        "subjects": [
          {
            "subject": "World War I",
            "type": "TLI"
          },
          {
            "subject": "HISTORY / Canada / General",
            "type": "BISAC"
          }
        ]
      },
      "id": "315155",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "317428",
            "subtype": "Empty",
            "type": "BHM"
          }
        ],
        "isTitleCustom": false,
        "name": "A Case Study of Sustainable Development: Brownfields",
        "publicationType": "Book",
        "publisherName": "Environmental Law Institute",
        "subjects": [
          {
            "subject": "Land Use Planning",
            "type": "TLI"
          }
        ]
      },
      "id": "317428",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    },
    {
      "attributes": {
        "identifiers": [
          {
            "id": "142423",
            "subtype": "Empty",
            "type": "EPBookID"
          },
          {
            "id": "318444",
            "subtype": "Empty",
            "type": "BHM"
          },
          {
            "id": "978-1-349-50750-4",
            "subtype": "Print",
            "type": "ISBN"
          },
          {
            "id": "978-1-4039-0112-5",
            "subtype": "Print",
            "type": "ISBN"
          },
          {
            "id": "978-0-230-00589-1",
            "subtype": "Online",
            "type": "ISBN"
          },
          {
            "id": "978-1-280-28270-6",
            "subtype": "Online",
            "type": "ISBN"
          }
        ],
        "isTitleCustom": false,
        "name": "A Brontë Family Chronology (Author Chronologies)",
        "publicationType": "Book",
        "publisherName": "Institute for Urban Design (US)",
        "subjects": [
          {
            "subject": "English Literature",
            "type": "TLI"
          },
          {
            "subject": "Women Authors",
            "type": "TLI"
          },
          {
            "subject": "LITERARY CRITICISM / European / English, Irish, Scottish, Welsh",
            "type": "BISAC"
          }
        ]
      },
      "id": "318444",
      "relationships": {
        "resources": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "titles"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "totalResults": 8987
  }
}

POST /eholdings/titles

Create a new Custom Title.

POST /eholdings/titles
Headers
  • Content-Type: required (string)

    Example:

    application/vnd.api+json
Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Titles POST Request Schema",
  "description": "Titles Post Request Schema using JSON API",
  "javaType": "org.folio.rest.jaxrs.model.TitlePostRequest",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "description": "Data object of title post request",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Title Post Data Schema",
      "javaType": "org.folio.rest.jaxrs.model.TitlePostData",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Data type",
          "type": "string",
          "example": "titles"
        },
        "attributes": {
          "description": "Data type attributes",
          "type": "object",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Title attributes schema",
          "javaType": "org.folio.rest.jaxrs.model.TitlePostDataAttributes",
          "javaInterfaces": [
            "org.folio.rest.model.TitleCommonRequestAttributes"
          ],
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "description": "Title Name",
              "example": "A call to action: Changing the culture of drinking at U.S. colleges"
            },
            "description": {
              "type": "string",
              "description": "Description",
              "example": "Provides information about all areas of American Studies."
            },
            "publicationType": {
              "type": "string",
              "description": "Type of publication. Valid values are 'Audiobook', 'Book', 'Book Series', 'Database', 'Journal', 'Newsletter', 'Newspaper', 'Proceedings', 'Report', 'Streaming Audio', 'Streaming Video', 'Thesis & Dissertation', 'Website', 'Unspecified'.",
              "$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"
            },
            "publisherName": {
              "type": "string",
              "description": "Publisher name",
              "example": "Elsevier"
            },
            "isPeerReviewed": {
              "type": "boolean",
              "description": "Field to indicate if title is peer reviewed.",
              "example": false
            },
            "edition": {
              "type": "string",
              "description": "Title Edition",
              "example": "Second edition"
            },
            "contributors": {
              "type": "array",
              "description": "Contributor ID List",
              "items": {
                "type": "object",
                "description": "The Identifiers 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": "Identifiers",
              "items": {
                "type": "object",
                "description": "The Custom 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"
                  }
                }
              }
            },
            "tags": {
              "type": "object",
              "description": "Title 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"
            },
            "userDefinedField2": {
              "type": "string",
              "description": "User defined field 2"
            },
            "userDefinedField3": {
              "type": "string",
              "description": "User defined field 3"
            },
            "userDefinedField4": {
              "type": "string",
              "description": "User defined field 4"
            },
            "userDefinedField5": {
              "type": "string",
              "description": "User defined field 5"
            }
          },
          "required": [
            "name",
            "publicationType"
          ]
        }
      },
      "required": [
        "type",
        "attributes"
      ]
    },
    "included": {
      "description": "Resource used to create new title",
      "type": "array",
      "items": {
        "type": "object",
        "description": "Titles included packages",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Titles POST Included Schema",
        "javaType": "org.folio.rest.jaxrs.model.TitlePostIncluded",
        "additionalProperties": false,
        "properties": {
          "type": {
            "type": "string",
            "description": "The Type Schema",
            "example": "resources"
          },
          "attributes": {
            "type": "object",
            "description": "The Attributes Schema",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Titles POST Included Package Id Schema",
            "javaType": "org.folio.rest.jaxrs.model.TitlePostIncludedPackageId",
            "additionalProperties": false,
            "properties": {
              "packageId": {
                "type": "string",
                "description": "The Package id Schema",
                "example": "123355-2868997"
              }
            },
            "required": [
              "packageId"
            ]
          }
        },
        "required": [
          "type",
          "attributes"
        ]
      }
    }
  },
  "required": [
    "data",
    "included"
  ]
}

Example:

{
  "data": {
    "type": "titles",
    "attributes": {
      "name": "Your Brand New Title",
      "publicationType": "Book"
    }
  },
  "included": [
    {
      "type": "resources",
      "attributes": {
        "packageId": "123355-2868997"
      }
    }
  ]
}

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Title object schema",
  "description": "Title object schema",
  "javaType": "org.folio.rest.jaxrs.model.Title",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "The Data Schema",
      "properties": {
        "id": {
          "type": "string",
          "description": "The Id Schema",
          "example": "100130"
        },
        "type": {
          "type": "string",
          "description": "Title Type",
          "example": "titles"
        },
        "attributes": {
          "type": "object",
          "description": "The Attributes Schema",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Title attributes schema",
          "javaType": "org.folio.rest.jaxrs.model.TitleAttributes",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "description": "Title name",
              "example": "A call to action: Changing the culture of drinking at U.S. colleges"
            },
            "publisherName": {
              "type": "string",
              "description": "Publisher name",
              "example": "Elsevier"
            },
            "isTitleCustom": {
              "type": "boolean",
              "description": "Defines if the title is custom",
              "example": false
            },
            "hasSelectedResources": {
              "type": "boolean",
              "description": "Indicate that the title has selected resources",
              "example": true
            },
            "subjects": {
              "type": "array",
              "description": "List of title subjects",
              "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"
                  }
                }
              }
            },
            "identifiers": {
              "type": "array",
              "description": "List of title identifiers",
              "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"
                  }
                }
              }
            },
            "publicationType": {
              "type": "string",
              "description": "Type of publication",
              "$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"
            },
            "edition": {
              "type": "string",
              "description": "The Edition Schema",
              "example": "Second edition"
            },
            "description": {
              "type": "string",
              "description": "The Description Schema",
              "example": "Provides information about all areas of American Studies."
            },
            "isPeerReviewed": {
              "type": "boolean",
              "description": "Defines if peer reviewed",
              "example": false
            },
            "contributors": {
              "type": "array",
              "description": "The Contributors Schema",
              "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"
                  }
                }
              }
            },
            "tags": {
              "type": "object",
              "description": "Title 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
            }
          },
          "required": [
            "name",
            "publicationType"
          ]
        },
        "relationships": {
          "type": "object",
          "description": "Displays title relationships",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Metadata of relationships for a given object",
          "javaType": "org.folio.rest.jaxrs.model.Relationships",
          "additionalProperties": false,
          "properties": {
            "packages": {
              "type": "object",
              "description": "Relationship of packages for a given object",
              "properties": {
                "data": {
                  "type": "array",
                  "description": "packages Data Information",
                  "items": {
                    "type": "object",
                    "description": "Resources Data",
                    "$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": "Relationship of resources for a given object",
              "properties": {
                "data": {
                  "type": "array",
                  "description": "Resources Data Information",
                  "items": {
                    "type": "object",
                    "description": "Resources Data",
                    "$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
                    }
                  }
                }
              }
            },
            "provider": {
              "type": "object",
              "description": "Relationship of provider for a given object",
              "$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 resources for a given title",
      "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": {
              "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 Schema",
                "javaType": "org.folio.rest.jaxrs.model.Proxy",
                "additionalProperties": false,
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Proxy Id",
                    "example": "EZProxy"
                  },
                  "inherited": {
                    "type": "boolean",
                    "description": "Whether this proxy is inherited",
                    "example": true
                  }
                }
              },
              "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
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "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"
  ]
}

Example:

{
  "data": {
    "attributes": {
      "contributors": [],
      "description": null,
      "edition": null,
      "identifiers": [],
      "isPeerReviewed": false,
      "isTitleCustom": true,
      "name": "Your Brand New Title",
      "publicationType": "Book",
      "publisherName": null,
      "subjects": []
    },
    "id": "17649810",
    "relationships": {
      "resources": {
        "meta": {
          "included": false
        }
      }
    },
    "type": "titles"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Response 400

Bad Request

Body

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"
  }
}

Response 422

Bad

Body

Media type: application/vnd.api+json

Type: any

Example:

{
  "errors": [{
    "title": "Invalid IdentifierSubType",
    "detail": "Identifiersubtype :Invalid Identifier subtype",
    "source": {}
  }],
  "jsonapi": {
    "version": "1.0"
  }
}

GET /eholdings/titles/{titleId}

Get the title by its unique identifier.

GET /eholdings/titles/{titleId}
URI Parameters
  • titleId: required (string)
Query Parameters
  • include: (string)

    Include related resource objects, each representing a partnering of this title with a package. Any bogus value, like include=deciduousTrees, will be silently ignored.

    Example:

    resources

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Title object schema",
  "description": "Title object schema",
  "javaType": "org.folio.rest.jaxrs.model.Title",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "The Data Schema",
      "properties": {
        "id": {
          "type": "string",
          "description": "The Id Schema",
          "example": "100130"
        },
        "type": {
          "type": "string",
          "description": "Title Type",
          "example": "titles"
        },
        "attributes": {
          "type": "object",
          "description": "The Attributes Schema",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Title attributes schema",
          "javaType": "org.folio.rest.jaxrs.model.TitleAttributes",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "description": "Title name",
              "example": "A call to action: Changing the culture of drinking at U.S. colleges"
            },
            "publisherName": {
              "type": "string",
              "description": "Publisher name",
              "example": "Elsevier"
            },
            "isTitleCustom": {
              "type": "boolean",
              "description": "Defines if the title is custom",
              "example": false
            },
            "hasSelectedResources": {
              "type": "boolean",
              "description": "Indicate that the title has selected resources",
              "example": true
            },
            "subjects": {
              "type": "array",
              "description": "List of title subjects",
              "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"
                  }
                }
              }
            },
            "identifiers": {
              "type": "array",
              "description": "List of title identifiers",
              "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"
                  }
                }
              }
            },
            "publicationType": {
              "type": "string",
              "description": "Type of publication",
              "$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"
            },
            "edition": {
              "type": "string",
              "description": "The Edition Schema",
              "example": "Second edition"
            },
            "description": {
              "type": "string",
              "description": "The Description Schema",
              "example": "Provides information about all areas of American Studies."
            },
            "isPeerReviewed": {
              "type": "boolean",
              "description": "Defines if peer reviewed",
              "example": false
            },
            "contributors": {
              "type": "array",
              "description": "The Contributors Schema",
              "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"
                  }
                }
              }
            },
            "tags": {
              "type": "object",
              "description": "Title 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
            }
          },
          "required": [
            "name",
            "publicationType"
          ]
        },
        "relationships": {
          "type": "object",
          "description": "Displays title relationships",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Metadata of relationships for a given object",
          "javaType": "org.folio.rest.jaxrs.model.Relationships",
          "additionalProperties": false,
          "properties": {
            "packages": {
              "type": "object",
              "description": "Relationship of packages for a given object",
              "properties": {
                "data": {
                  "type": "array",
                  "description": "packages Data Information",
                  "items": {
                    "type": "object",
                    "description": "Resources Data",
                    "$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": "Relationship of resources for a given object",
              "properties": {
                "data": {
                  "type": "array",
                  "description": "Resources Data Information",
                  "items": {
                    "type": "object",
                    "description": "Resources Data",
                    "$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
                    }
                  }
                }
              }
            },
            "provider": {
              "type": "object",
              "description": "Relationship of provider for a given object",
              "$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 resources for a given title",
      "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": {
              "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 Schema",
                "javaType": "org.folio.rest.jaxrs.model.Proxy",
                "additionalProperties": false,
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Proxy Id",
                    "example": "EZProxy"
                  },
                  "inherited": {
                    "type": "boolean",
                    "description": "Whether this proxy is inherited",
                    "example": true
                  }
                }
              },
              "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
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "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"
  ]
}

Example:

{
  "data": {
    "attributes": {
      "contributors": [],
      "description": null,
      "edition": null,
      "identifiers": [
        {
          "id": "100130",
          "subtype": "Empty",
          "type": "BHM"
        }
      ],
      "isPeerReviewed": false,
      "isTitleCustom": false,
      "name": "A call to action: Changing the culture of drinking at U.S. colleges",
      "publicationType": "Journal",
      "publisherName": "National Institute on Alcohol Abuse and Alcoholism",
      "subjects": [
        {
          "subject": "Social Services",
          "type": "TLI"
        }
      ]
    },
    "id": "100130",
    "relationships": {
      "resources": {
        "meta": {
          "included": false
        }
      }
    },
    "type": "titles"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Response 404

Not Found

Body

Media type: application/vnd.api+json

Type: any

Example:

{
  "errors": [
    {
      "title": "Title not found"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

PUT /eholdings/titles/{titleId}

Update Custom Title.

PUT /eholdings/titles/{titleId}
URI Parameters
  • titleId: required (string)
Headers
  • Content-Type: required (string)

    Example:

    application/vnd.api+json
Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Titles PUT Request Schema",
  "description": "Titles Put Request Schema using JSON API",
  "javaType": "org.folio.rest.jaxrs.model.TitlePutRequest",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "description": "Data object of title put request",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Title Put Data Schema",
      "javaType": "org.folio.rest.jaxrs.model.TitlePutData",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "readonly": true,
          "description": "Unique title id",
          "example": "394579"
        },
        "type": {
          "description": "Data type",
          "type": "string",
          "example": "titles"
        },
        "attributes": {
          "description": "Data type attributes",
          "type": "object",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Title attributes schema",
          "javaType": "org.folio.rest.jaxrs.model.TitlePutDataAttributes",
          "javaInterfaces": [
            "org.folio.rest.model.TitleCommonRequestAttributes"
          ],
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "description": "Title Name",
              "example": "A call to action: Changing the culture of drinking at U.S. colleges"
            },
            "description": {
              "type": "string",
              "description": "Description",
              "example": "Provides information about all areas of American Studies."
            },
            "publicationType": {
              "type": "string",
              "description": "Type of publication. Valid values are 'Audiobook', 'Book', 'Book Series', 'Database', 'Journal', 'Newsletter', 'Newspaper', 'Proceedings', 'Report', 'Streaming Audio', 'Streaming Video', 'Thesis & Dissertation', 'Website', 'Unspecified'.",
              "$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"
            },
            "publisherName": {
              "type": "string",
              "description": "Publisher name",
              "example": "Elsevier"
            },
            "isPeerReviewed": {
              "type": "boolean",
              "description": "Field to indicate if title is peer reviewed.",
              "example": false
            },
            "edition": {
              "type": "string",
              "description": "Title Edition",
              "example": "Second edition"
            },
            "contributors": {
              "type": "array",
              "description": "Contributor ID List",
              "items": {
                "type": "object",
                "description": "The Identifiers 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": "Identifiers",
              "items": {
                "type": "object",
                "description": "The Custom 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"
                  }
                }
              }
            },
            "tags": {
              "type": "object",
              "description": "Title 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
            }
          },
          "required": [
            "name",
            "publicationType"
          ]
        }
      },
      "required": [
        "type",
        "attributes"
      ]
    }
  },
  "required": [
    "data"
  ]
}

Example:

{
  "data": {
    "type": "titles",
    "attributes": {
      "name": "Updated Custom Title Name",
      "isPeerReviewed": true,
      "publicationType": "Newspaper",
      "publisherName": "Updated Publisher",
      "edition": "5",
      "description": "Updated Description",
      "contributors": [
        {
          "type":"Author",
          "contributor":"smith, john"
        },
        {
          "type":"Illustrator",
          "contributor":"smith, ralph"
        }
      ],
      "identifiers": [
        {
          "id":"11-2222-3333",
          "type":"ISSN",
          "subtype":"Online"
        }
      ],
      "isSelected": true
    }
  }
}

Response 200

OK

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Title object schema",
  "description": "Title object schema",
  "javaType": "org.folio.rest.jaxrs.model.Title",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "The Data Schema",
      "properties": {
        "id": {
          "type": "string",
          "description": "The Id Schema",
          "example": "100130"
        },
        "type": {
          "type": "string",
          "description": "Title Type",
          "example": "titles"
        },
        "attributes": {
          "type": "object",
          "description": "The Attributes Schema",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Title attributes schema",
          "javaType": "org.folio.rest.jaxrs.model.TitleAttributes",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "description": "Title name",
              "example": "A call to action: Changing the culture of drinking at U.S. colleges"
            },
            "publisherName": {
              "type": "string",
              "description": "Publisher name",
              "example": "Elsevier"
            },
            "isTitleCustom": {
              "type": "boolean",
              "description": "Defines if the title is custom",
              "example": false
            },
            "hasSelectedResources": {
              "type": "boolean",
              "description": "Indicate that the title has selected resources",
              "example": true
            },
            "subjects": {
              "type": "array",
              "description": "List of title subjects",
              "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"
                  }
                }
              }
            },
            "identifiers": {
              "type": "array",
              "description": "List of title identifiers",
              "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"
                  }
                }
              }
            },
            "publicationType": {
              "type": "string",
              "description": "Type of publication",
              "$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"
            },
            "edition": {
              "type": "string",
              "description": "The Edition Schema",
              "example": "Second edition"
            },
            "description": {
              "type": "string",
              "description": "The Description Schema",
              "example": "Provides information about all areas of American Studies."
            },
            "isPeerReviewed": {
              "type": "boolean",
              "description": "Defines if peer reviewed",
              "example": false
            },
            "contributors": {
              "type": "array",
              "description": "The Contributors Schema",
              "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"
                  }
                }
              }
            },
            "tags": {
              "type": "object",
              "description": "Title 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
            }
          },
          "required": [
            "name",
            "publicationType"
          ]
        },
        "relationships": {
          "type": "object",
          "description": "Displays title relationships",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "title": "Metadata of relationships for a given object",
          "javaType": "org.folio.rest.jaxrs.model.Relationships",
          "additionalProperties": false,
          "properties": {
            "packages": {
              "type": "object",
              "description": "Relationship of packages for a given object",
              "properties": {
                "data": {
                  "type": "array",
                  "description": "packages Data Information",
                  "items": {
                    "type": "object",
                    "description": "Resources Data",
                    "$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": "Relationship of resources for a given object",
              "properties": {
                "data": {
                  "type": "array",
                  "description": "Resources Data Information",
                  "items": {
                    "type": "object",
                    "description": "Resources Data",
                    "$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
                    }
                  }
                }
              }
            },
            "provider": {
              "type": "object",
              "description": "Relationship of provider for a given object",
              "$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 resources for a given title",
      "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": {
              "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 Schema",
                "javaType": "org.folio.rest.jaxrs.model.Proxy",
                "additionalProperties": false,
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Proxy Id",
                    "example": "EZProxy"
                  },
                  "inherited": {
                    "type": "boolean",
                    "description": "Whether this proxy is inherited",
                    "example": true
                  }
                }
              },
              "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
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "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"
  ]
}

Example:

{
  "data": {
    "attributes": {
      "contributors": [],
      "description": null,
      "edition": null,
      "identifiers": [
        {
          "id": "100130",
          "subtype": "Empty",
          "type": "BHM"
        }
      ],
      "isPeerReviewed": false,
      "isTitleCustom": false,
      "name": "A call to action: Changing the culture of drinking at U.S. colleges",
      "publicationType": "Journal",
      "publisherName": "National Institute on Alcohol Abuse and Alcoholism",
      "subjects": [
        {
          "subject": "Social Services",
          "type": "TLI"
        }
      ]
    },
    "id": "100130",
    "relationships": {
      "resources": {
        "meta": {
          "included": false
        }
      }
    },
    "type": "titles"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Response 422

Unprocessable Entity

Body

Media type: application/vnd.api+json

Type: any

Example:

{
  "errors": [{
    "title": "Invalid IdentifierSubType",
    "detail": "Identifiersubtype :Invalid Identifier subtype",
    "source": {}
  }],
  "jsonapi": {
    "version": "1.0"
  }
}