General Resource Uniform Resource Identifier (URI)
Environment | URL |
---|---|
Production | https://api.freewheel.tv/services/v4/site_sections/[FW_ID]?[parameter1]=[query1]&... |
Attributes
Name | Type | Description | Creatable? | Updatable? | Showable? | Validations |
---|---|---|---|---|---|---|
id | FW_ID | ID of the Site Section in FreeWheel | No | No | Yes | |
name | String | The name of the Site Section | Req | Yes | Yes | Must be unique on the network and should be at least 3 characters long |
tag | String | A unique tag of the Site Section | Req | Yes | Yes | Must be unique on the network and should be at least 3 characters long |
description | String | Description of the Site Section | Yes | Yes | Yes | |
rating | ['G', 'PG', 'PG-13', 'R', 'Mature', 'Unrated'] | Rating of the Site Section. Defaults to 'Unrated'. | Yes | Yes | Yes | |
customized_metadata | Custom Data Type 3 | Site section customized metadata | Yes | Yes | ||
content_partner_ids | Integer Array | The network IDs for which content partner visibility is granted | Yes | Yes | Yes | Must be among the CROs whose distributor is the current network |
metadata | String | Site Section metadata | Yes | Yes | Yes | |
status | ('ACTIVE', 'INACTIVE') | Site Section status. Must be provided in ALL CAPITAL letters. | No | Yes | Yes | |
external_id | String | The Site Section's External ID | Yes | Yes | Yes | |
updated_at | DateTime | Last updated time | No | No | Yes | |
created_at | DateTime | Created time | No | No | Yes |
Custom Data Type 3: customized_metadata
Name | Type | Description | Creatable? | Updatable? | Showable? | Validations |
---|---|---|---|---|---|---|
key | String | Yes | Yes | Yes | Unique | |
value | String | Yes | Yes | Yes |
JSON Sample Request
{
"customized_metadata":{
"key1":"value1",
"key2":"value2"
}
}
XML Sample Request
<site_section>
...
<customized_metadata>
<key_value>
<key>key1</key>
<value>value1</value>
</key_value>
<key_value>
<key>key2</key>
<value>value2</value>
</key_value>
</customized_metadata>
</site_section>