Release notes

2021r3.000

BAPI call for exploitation right

From this version, in the rights API, a new GET /exploitationRights/exploitationRightId call has been added. The call contains the same exploitation right information as you can find already today in the GET /contractEntries call, but also the contractId is returned.

The difference between the response bodies of GET calls /contracts/{contractId}/contractEntries/{productId} and /exploitationRights/{exploitationRightId} is that the GET /contractEntries call also returns the attribute additionalRights.

2019r3.003

API version: v1.4.0

Cost definitions and amortizations

From this version on, it is possible to work with cost definitions and their amortizations via new calls in the rights API.

Run status

From this version on, it is also possible to change the status of runs via new calls in the rights API.

More detailed error messages

Several improvements were done to return more specific error message in case of problems during a call.

Episode ID referring to other product type

When you update a series contract entry using the POST or PUT calls for contracts or contract entries, and one of the provided episodeIDs does not refer to an episode but a different product type, previously, the returned error message only said:

{

    "statusCode": "500",

    "message": "Message not understood: #,"

} 

Now, the error message indicates the specific problem:

{
    "statusCode": "422",
    "message": "Operation cannot be completed due to violations",
    "details": {
        "message": {
            "id": "CORE-00002",
            "description": "$_Operation cannot be completed due to violations",
            "parameters": []
        },
        "timestamp": "2021-04-23T07:14:33Z",
        "concept": "ContractEntry",
        "message": "INCONSISTENT FIELD - episodeIds",
        "data": "142205527 is not an episode"
    }
} 

Deleting a planned contract entry

When you update a contract using the POST or PUT calls, and a contract entry was left out while runs were already consumed, this meant the contract entry could not be removed. Previously, the returned error message only said:

{
       "statusCode": "422",
       "message": null,
       "details":
       {
              "message":
              {
                     "id": "RIGHTS-00001",
                     "description": "$_ContractEntry could not be removed",
                     "parameters": [
                     ]
              },
              "concept": "Contract"
       }

Now, the error message indicates the specific contract entry:

{
    "statusCode": "422",
    "message": null,
    "details": {
        "message": {
            "id": "RIGHTS-00001",
            "description": "$_ContractEntry could not be removed",
            "parameters": [
                "[Kine2] Knives Out (Disney)"
            ]
        },
        "concept": "Contract"
    }
}

Invalid episode ID

When you update a series contract entry using the POST or PUT calls for contracts or contract entries, and one of the provided episodeIDs is not correct, previously, the returned error message only said:

{
    "statusCode": "404",
    "message": "The specified resource does not exist.",
    "details": {
        "message": {
            "id": "CORE-00004",
            "description": "$_Referenced resource not found",
            "parameters": []
        },
        "concept": "ContractEntry"
    }
}

Now, the error message indicates which IDs are invalid in the parameters:

{
    "statusCode": "404",
    "message": "The specified resource does not exist.",
    "details": {
        "message": {
            "id": "CORE-00004",
            "description": "$_Referenced resource not found",
            "parameters": [
                "B357556527",
                "B357570527"
            ]
        },
        "concept": "Contract"
    }
}

2020r1.002.000

API version: v1.4.0

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 a contract, exploitation right, exploitation window or cost definition.

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.