Class: InsertToSeries

InsertToSeries(seriesId, itemType, itemId, time, optional)

Inserts an existing item/series into series of given seriesId at position determined by time.

Constructor

new InsertToSeries(seriesId, itemType, itemId, time, optional)

Construct the request

Parameters:

Name	Type	Description
`seriesId`	string	ID of the series to be inserted into.
`itemType`	string	`item` iff the regular item from the catalog is to be inserted, `series` iff series is inserted as the item.
`itemId`	string	ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.
`time`	number	Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time.
`optional`	Object	Optional parameters given as an object with structure name of the parameter: value - Allowed parameters: - cascadeCreate - Type: boolean - Description: Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either item or series may be created if not present in the database.

Source:

requests/insert-to-series.js, line 11

Methods

bodyParameters() → {Object}

Get body parameters

Source:

requests/insert-to-series.js, line 39

Returns:

The values of body parameters (name of parameter: value of the parameter)

Type: Object

queryParameters() → {Object}

Get query parameters

Source:

requests/insert-to-series.js, line 55

Returns:

The values of query parameters (name of parameter: value of the parameter)

Type: Object