Release notes

2021r2.000

API version: v1.3.1

More custom attribute types

See release notes of version 2021r2.001.

Since version 2020r2.002, a number of types of custom attributes were already supported by the content API:

• Check boxes
• Drop-down lists
• String fields

They could be included in the body of the PUT and POST calls and included as parameters in the GET call.

From this version, support for the following types has been added:

• Date fields
• Number fields
• Reference fields
• Text fields
• Web fields

In the GET calls, the following suffixes can be added to the call to either get only specified attributes in the response or all custom attributes of the supported types:

• ?customAttributes=attributeName,attributeName
• ?customAttributes=allCustomAttributes

For each custom attribute on the product, the attribute name, value and type will be given. For the reference custom attributes, the referenced concept is also included:

{    "customAttributes": [
        {
            "attributeName": "cADate",
            "value": "2021-10-04",
            "type": "Date field"
        },
        {
            "attributeName": "cAMediaAsset",
            "value": "6111521000",
            "type": "Reference field",
            "concept": "Media asset"
        },
        {
            "attributeName": "cANumber",
            "value": 1,
            "type": "Number field"
        },
        {
            "attributeName": "cAText",
            "value": "Shaken, not stirred",
            "type": "Text field"
        },
        {
            "attributeName": "cAWeb",
            "value": "https://www.geekster.be/",
            "type": "Web field"
        }
    ]
}

In the POST and PUT calls, an array of custom attributes needs to be provided with their attribute name and value. If the value is left empty by using null or "" for some types, the custom attribute on the product is emptied.

{
    "contentId": "PGM001",
    "customAttributes": {
        "cADate": "2021-10-01",
        "cAMediaAsset": "3350456000",
        "cANumber": "10",
        "cAText": "I am inevitable",
        "cAWeb": "https://www.geekster.be"
    }
}

Debug parameters

See release notes of version 2021r2.001.

Using the GET calls in the content API, you can retrieve the metadata properties of products in WHATS'ON. However, it was not possible to retrieve more technical information such as the date the product was created or last modified.

From now on, a debug parameter can be added to the GET calls (but not search calls) for all product types in the content API.

It is possible to mention the specific parameters and separate them using commas or to include all:

• :contentId?debug=dateCreatedUTC,dateModifiedUTC
• :contentId?debug=all

An example:

basepath/content/v1/programs/6629341527?debug=dateCreatedUTC

The response of the GET call will then include these parameters in a separate attribute converted to UTC time.

The format will be [YYYY-MM-DD]T[HH:MM:SS.MSMSMS][+HH:00] where the final part represents the time difference to UTC time.

For example:

{
    "contentId": "6629341527",
    "contentType": "program",
    "title": "SHANG-CHI AND THE LEGEND OF THE TEN RINGS",
    "duration": "02:00:00",
    "debugInfo": {
        "dateCreatedUTC": "2021-10-01T11:45:27.900+02:00",
        "dateModifiedUTC": "2021-10-01T11:45:42.032+02:00"
    }
}

When the debug parameter is not in the call, it is not visible in the response. When it is in the call but it is not included correctly, the following response will be returned:

{
    "statusCode": "400",
    "message": "Bad Request",
    "timestamp": "2021-10-01T12:13:10Z",
    "concept": "Program",
    "id": "6629341527",
    "errors": [
        {
            "errorCode": "CORE-00007",
            "description": "Invalid debug attributes",
            "data": [
                "dateCreatedUT"
            ]
        }
    ]
}

2021r2.000

API version: v1.1.0

Custom attributes

From this version on, it is possible to include custom attributes in the calls of the content API.

• Check boxes
• Drop-down lists
• String fields

They could be included in the body of the PUT and POST calls and included as parameters in the GET call.

2021r1.000

Press sheets in content API

From this version, it is possible to create, update and delete press sheets via the content API.

New calls are added:

• POST pressSheets
• PUT pressSheets/{pressSheetId)
• GET pressSheets/{pressSheetId)
• DELETE pressSheets/{pressSheetId)
• GET pressTargets
• GET pressStatus
• GET parentalRatings

Some existing calls got an extra section in their response detailing the existing press sheets:

• GET programs/{contentId}
• GET series/{contentId}
• GET season/{contentId}
• GET episodes/{contentId}

2020r2.002

Improvements to content API

As from this version, the Description field of the Descriptions tab of the product navigator is also added to the content API. It is available for all POST, PUT and GET calls for content (programs, episodes, series, seasons). Also the Distributor number for episodes is added to POST, PUT and GET calls. Extra drop down fields have been added to the content schema as well:

• originalLanguage

• contentTargetGroup

• content

• form

• broadcastMedium

This makes them available for product, series, season & episode calls. Furthermore, support for TitleTypes, for custom attributes on the concept Program and for the cast list has been added to the content API.

2020r1.002.000

API version: v1.0.1

External reference cannot be cleared by BAPI

Within any POST and PUT call, if a an attribute is sent empty, WHATS'ON will clear that field. Previously, this was also possible with the external reference of content.

Now, this is fixed. When no external reference is provided but the attribute is sent empty or Null, we will ignore that tag and proceed as if there was no ID field (external reference) provided. This means that it should remain as is in a PUT call or return a new one in a POST call.

2017r1.005.000

API version: v1.0.0

Addition of Content API

From this version on, it is possible to manage content using the Content API.