Video Series

General Resource Uniform Resource Identifier (URI)

Environment	URI
Production	`https://api.freewheel.tv/services/v4/series/[FW_ID]?[parameter1]=[query1]&...`

📘
Note
The Update Child Video Relations endpoint has been deprecated. There is no active development on it and no feature requests can be made. It will soon be removed, at which time it will no longer function nor be supported.

Attributes

Name	Type	Description	Creatable?	Updatable?	Validations
id	FW_ID	ID of the Series in FreeWheel	No	No
network_id	Integer	ID of the Series' network	No	No
name	String	Series name	Req	Yes	Unique
external_id	String	The Series' External ID	Yes	Yes
description	String	Description of the Series	Yes	Yes
rating	['G', 'PG', 'PG-13', 'R', 'Mature', 'Unrated']	Series rating. Default value is 'Unrated'.	Yes	Yes
customized_metadata	Custom Data Type 3	Custom metadata for the Series	Yes	Yes
vod_metadata	String	VOD metadata	Yes	Yes
metadata	String	Series metadata	Yes	Yes
status	['ACTIVE', 'INACTIVE'] Must be provided in ALL CAPITAL letters.	Series status	Yes	Yes
updated_at	DateTime	Last updated time	No	No
created_at	DateTime	Created time	No	No

Custom Data Type 3: customized_metadata

Name	Type	Creatable?	Updatable?	Validations
key	String	Yes	Yes	Unique
value	String	Yes	Yes

JSON Sample Request

{
      "customized_metadata":{
          "key1":"value1",
          "key2":"value2"
      }
  }

XML Sample Request

<series>
  ...
    <customized_metadata>
        <key_value>
            <key>key1</key>
            <value>value1</value>
        </key_value>
        <key_value>
            <key>key2</key>
            <value>value2</value>
        </key_value>
    </customized_metadata>
  </series>

General Resource Uniform Resource Identifier (URI)

📘Note

Attributes

Custom Data Type 3: customized_metadata

JSON Sample Request

XML Sample Request

📘
Note