Skip to content

Series

AssociatedSeries

Bases: BaseModel

A data model representing an associated series.

ATTRIBUTE DESCRIPTION
id

The unique identifier of the associated series.

TYPE: int

name

The name of the associated series.

TYPE: str

CommonSeries

Bases: BaseModel

A data model representing a common series.

ATTRIBUTE DESCRIPTION
id

The unique identifier of the common series.

TYPE: int

year_began

The year the common series began.

TYPE: int

issue_count

The number of issues in the common series.

TYPE: int

volume

The volume number of the common series.

TYPE: int

modified

The date and time when the common series was last modified.

TYPE: datetime

BaseSeries

Bases: CommonSeries

A data model representing a base series that extends CommonSeries.

ATTRIBUTE DESCRIPTION
display_name

The display name of the base series.

TYPE: str

year_end

The year the series ended.

TYPE: int

Series

Bases: CommonSeries

A data model representing a series that extends CommonSeries.

ATTRIBUTE DESCRIPTION
name

The name of the series.

TYPE: str

sort_name

The name used for sorting the series.

TYPE: str

series_type

The type of the series.

TYPE: GenericItem

status

The status of the series.

TYPE: str

publisher

The publisher of the series.

TYPE: GenericItem

imprint

The imprint of the series or None.

TYPE: GenericItem

year_end

The year the series ended.

TYPE: int

desc

The description of the series.

TYPE: str

genres

The genres associated with the series.

TYPE: list[GenericItem]

associated

The associated series.

TYPE: list[AssociatedSeries]

cv_id

The Comic Vine ID of the series.

TYPE: int

gcd_id

The Grand Comics Database ID of the series.

TYPE: int

resource_url

The URL of the series resource.

TYPE: HttpUrl

SeriesPost

Bases: BaseModel

A data model representing a series to be created.

ATTRIBUTE DESCRIPTION
name

The name of the series.

TYPE: str

sort_name

The name used for sorting the series.

TYPE: str

volume

The volume number of the series.

TYPE: int

series_type

The ID of the series type.

TYPE: int

status

The ID of the series status.

TYPE: int

publisher

The ID of the publisher of the series.

TYPE: int

imprint

The ID of the imprint of the series.

TYPE: int

year_began

The year the series began.

TYPE: int

year_end

The year the series ended.

TYPE: int

desc

The description of the series.

TYPE: str

genres

The IDs of the genres associated with the series.

TYPE: list[int]

associated

The IDs of the associated series.

TYPE: list[int]

cv_id

The Comic Vine ID of the series.

TYPE: int

gcd_id

The Grand Comics Database ID of the series.

TYPE: int

SeriesPostResponse

Bases: BaseResource, SeriesPost

A data model representing the response from creating a series.

ATTRIBUTE DESCRIPTION
id

The unique identifier of the series.

TYPE: int

name

The name of the series.

TYPE: str

sort_name

The name used for sorting the series.

TYPE: str

volume

The volume number of the series.

TYPE: int

series_type

The ID of the series type.

TYPE: int

status

The ID of the series status.

TYPE: int

publisher

The ID of the publisher of the series.

TYPE: int

imprint

The ID of the imprint of the series.

TYPE: int

year_began

The year the series began.

TYPE: int

year_end

The year the series ended.

TYPE: int

desc

The description of the series.

TYPE: str

genres

The IDs of the genres associated with the series.

TYPE: list[int]

associated

The IDs of the associated series.

TYPE: list[int]

cv_id

The Comic Vine ID of the series.

TYPE: int

gcd_id

The Grand Comics Database ID of the series.

TYPE: int

resource_url

The URL of the series resource.

TYPE: HttpUrl