Series Resource

Introduction

The Series resource provides a structured representation of a collection of related works, such as books or articles, that share a common theme, storyline, characters, or branding. These works are typically organized sequentially or under a unified title, making it easy for readers to follow the series' progression.

Series Object

The Series resource includes the following fields:

Field	Type	Description	Possible values	Default
`_id`	Integer	Unique identifier for the series.
`_links`	Object	Links to related resources such as self or metrics.
`_links`	Object	Links to related resources, such as self or metrics (s. series metrics).
`contributors`	Array	List of contributors associated with the series, including their IDs and names.
`description`	String	A detailed description of the series, including purpose and focus areas.		`Null`
`external_identifiers`	Array	External identifiers linked to the series (s. typed value objects).
`href`	String	URL to access the set in the storefront (read only value).		`null`
`identifier`	String	Unique identifier for the series within the system.		`Null`
`issn_online`	String	Online ISSN (International Standard Serial Number) of the series.		`Null`
`issn_print`	String	Print ISSN of the series.		`Null`
`name`	String (required)	Title of the series.
`realm`	Object	Information about the realm associated with the series, including its ID, name, and links.
`subtitle`	String	Subtitle or additional title information for the series.		`Null`
`visible`	Boolean	Indicates whether the series is visible.	`true`, `false`
`vlb_series_id`	String	VLB (Verzeichnis Lieferbarer Bücher) series identifier.		`Null`

Managing Series Resources

GET: Retrieving a Series

A series can be fetched by its unique ID using an HTTP GET request.

Endpoint

GET https://api.openpublishing.com/resource/v3/series/[ID]

Response Structure

The response is a JSON object with the Series object.

POST: Creating a New Series

New series resources can be added using an HTTP POST request. The request must include all required fields for the resource in the body.

Endpoint

POST https://api.openpublishing.com/resource/v3/series

Request Body Example

{
    "_id": 16077,
    "_links": {
        "metrics": "https://api.openpublishing.com/resource/v3/series/16077/metrics",
        "self": "https://api.openpublishing.com/resource/v3/series/16077"
    },
    "contributors": [
        {
            "_id": 5162375,
            "name": "Michael Andrews"
        }
    ],
    "description": "A series of illustrated travel reports on Eastern and Central Europe/GUS.",
    "external_identifiers": [
        {"type": "klopotek", "value": "12345"}
    ],
    "href": "https://www.goldenpage.com/series/16077",
    "identifier": "LSOER",
    "issn_online": "2195-3821",
    "issn_print": "1865-665X",
    "name": "Travel East",
    "realm": {
        "_id": 334,
        "_links": {
            "self": "https://api.openpublishing.com/resource/v3/realms/334"
        },
        "name": "goldenpage",
        "screenname": "Golden Page Press"
    },
    "subtitle": "Oriental University Studies",
    "visible": true,
    "vlb_series_id": "TF745"
}

PUT: Updating an Existing Series

Existing series resources can be updated using an HTTP PUT request. The request body should contain the updated fields.

Endpoint

PUT https://api.openpublishing.com/resource/v3/series/[ID]

Request Body Example

{
   "description": "Updated description of the series.",
   "visible": false
}

DELETE: Deleting a Series

Series resources can be deleted using an HTTP DELETE request. This action permanently removes the resource.

Endpoint

DELETE https://api.openpublishing.com/resource/v3/series/[ID]

Resource Queries

Querying Series (GET)

Endpoint

GET https://api.openpublishing.com/resource/v3/series

This endpoint supports filters and pagination for querying series data.

Response Structure

Field	Type	Description
`_links`	Object	Links to related resources
`items`	Array	An array of individual series objects

Each item in the items array represents a single series.

Query Parameters

Parameter	Description	Notes
`name`	Filter by name	Exact matching
`indentifier`	Filter by indentifier	Exact matching
`issn`	Filter by ISSN	Exact matching (filters by ISSN or ISSN_PRINT)
`q`	Fulltext search

Examples

Example 1: Querying Series with Filters

GET https://api.openpublishing.com/resource/v3/series?name=Travel%20East

Example 2: Querying Series by Identifier

GET https://api.openpublishing.com/resource/v3/series?identifier=LSOER

Example 3: Querying Series by Fulltext

GET https://api.openpublishing.com/resource/v3/series?q=travel