Site Section

Resources

URI

EnvironmentURL
Productionhttps://api.freewheel.tv/services/v4/site_sections/[FW_ID]?[parameter1]=[query1]&...

Attributes

NameTypeDescriptionCreatable?Updatable?Showable?Validations
idFW_IDID of the Site Section in FreeWheelNoNoYes
nameStringThe name of the Site SectionReqYesYesMust be unique on the network and should be at least 3 characters long
tagStringA unique tag of the Site SectionReqYesYesMust be unique on the network and should be at least 3 characters long
descriptionStringDescription of the Site SectionYesYesYes
rating['G', 'PG', 'PG-13', 'R', 'Mature', 'Unrated']Rating of the Site Section. Defaults to 'Unrated'.YesYesYes
customized_metadataCustom Data Type 3Site section customized metadataYesYes
content_partner_idsInteger ArrayThe network IDs for which content partner visibility is grantedYesYesYesMust be among the CROs whose distributor is the current network
metadataStringSite Section metadataYesYesYes
status('ACTIVE', 'INACTIVE')Site Section status. Must be provided in ALL CAPITAL letters.NoYesYes
external_idStringThe Site Section's External IDYesYesYes
updated_atDateTimeLast updated timeNoNoYes
created_atDateTimeCreated timeNoNoYes

Custom Data Type 3: customized_metadata

NameTypeDescriptionCreatable?Updatable?Showable?Validations
keyStringYesYesYesUnique
valueStringYesYesYes

JSON Sample

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

XML Sample

<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>