Release notes

2025r6

Simple material attributes in copyright API

In the copyright API, calls already existed to create and update simple materials. The simple material type is a one-size-fits-all type, meaning that you use the same properties for all materials, regardless of whether it is a song, an image, a film or anything else.

However, previously, the /simpleMaterials calls only contained the general properties shared by all material types, not those specific to the simple materials.

From this version, several calls have been adapted to include these properties.

POST and PUT /simpleMaterials

The missing properties were added as attributes to the body of both calls. None of the attributes are mandatory. They can be seen starting from the composer in the example of the full body of the POST call:

{
  "materialId": "08438748",
  "materialSubType": "string",
  "title": "MYSTERY",
  "code": "string",
  "source": "string",
  "live": false,
  "duration": "00:02:35",
  "remarks": "string",
  "cast": [
    {
      "personId": "string",
      "castFunction": "string",
      "castType": "string",
      "role": "string",
      "licence": "string"
    },
    {
      "personId": "string",
      "castFunction": "string",
      "castType": "string",
      "role": "string",
      "licence": "string"
    }
  ],
  "composer": "string",
  "productionCompany": "string",
  "albumTitle": "string",
  "scriptWriter": "string",
  "arranger": "string",
  "email": "string",
  "contactPerson": "string",
  "recordCompany": "stri",
  "country": "string",
  "isJingle": true,
  "recordingNumber": "string",
  "catalogueNumber": "string",
  "isInHouseProduction": false,
  "downloadSite": "string",
  "artist": "string",
  "person1": "string",
  "person2": "string",
  "person3": "string",
  "person4": "string",
  "company1": "string",
  "company2": "string",
  "description": "string"
}

The following attributes require extra calls or APIs:

• country:
  Uses the API reference of the country, which can be retrieved using the existing GET /countries call.

• person1-4:
  Uses the external reference of the person linked to the material. The person API can be used to retrieve this.

• company1-2:
  Uses the external reference of the company linked to the material. The company API can be used to retrieve this.

When references are provided which are not found in the system, a 404 error is returned.

GET /materials/{materialID}

The same attributes as above have been added to the response of the GET /materials call when the ID of a simple material is provided in the URL.

An example of the response:

{
    "materialId": "1602493579",
    "materialType": "PSISimpleMaterial",
    "materialSubType": null,
    "title": "Intra",
    "code": null,
    "source": null,
    "live": false,
    "duration": null,
    "remarks": null,
    "cast": [
        {
            "personId": "4495719517",
            "castFunction": "Composer",
            "castType": "Crew",
            "role": null,
            "license": "copyRight"
        }
    ],
    "composer": "John Williams",
    "productionCompany": "WB",
    "albumTitle": null,
    "scriptWriter": "David Koepp",
    "arranger": "string",
    "email": null,
    "contactPerson": "PR guy",
    "recordCompany": null,
    "country": null,
    "isJingle": true,
    "recordingNumber": null,
    "catalogueNumber": null,
    "isInHouseProduction": false,
    "downloadSite": null,
    "artist": "John Williams",
    "person1": null,
    "person2": null,
    "person3": null,
    "person4": null,
    "company1": null,
    "company2": null,
    "description": null
}

API developers

The YAML has been updated for these changes. The latest version can be retrieved by using the GET /api call.

Since the YAML contains both these changes and the changes for the custom attributes of a previous version, it is best to compare the new YAML with the previous one using TextCompare.