Agency Integration - Integrating via the REST API

The recommended approach for integrating with the new ISWC Database is to use the REST based API. This new API is being launched as part of the ISWC modernization project in July 2020. This approach is the only supported approach for those societies still assigning ISWCs from a local range after 1st January 2020.


Integrate ISWC Submission transactions via REST API

Societies can integrate their internal repertoire management system with the ISWC Database using the REST API operations tagged as "ISWC Submission". These operations are the basic transactions for ISWC integration and support the assignment and maintenance of an ISWC based on the submission of wor metadata, the update of information on previously submitted metadata and the deletion of a previously submitted metadata. The add and update operations are available in one-by-one and batch variants. The batch variants should always be used by societies when processing a batch of submissions.

In addition more complex operations may be used by societies for deeper integration with the ISWC Database. These include operations tagged as "ISWC merge", "ISWC Search" and "ISWC Workflow Tasks". These operations enable the merging of existing ISWCs, various search operations and the management of workflow tasks. Alternatively, societies may choose to use the ISWC Agency Portal for these more complex transactions.

Download the PDF REST API Specification here

Check out the REST API Documentation that describes how to use the REST based APIs and includes code samples in multiple languages. The API Console allows you to directly interact with the API right here in the developer portal.

Make manual transactions via the new ISWC Agency Portal

This web portal is available to all existing CIS-Net users and is authenticated through the same user name and password system. Key actions that can be carried out through this portal include:

  • Merging of two or more ISWCs where they have been identified as being associated with the same work
  • Viewing and approving / rejecting society workflow tasks
  • Searching and viewing existing ISWCs and associated metadata
  • Making once off submissions to assign new ISWCs where an ISWC is needed prior to the work being fully registered in a society's repertoire management system

Ingest Notification files from the ISWC Database to keep your society repertoire management system up-to-date

Other societies can make changes to ISWCs and associated metadata for works in your repertoire management system. These changes are made available in Notification files from the ISWC Database. These files should be ingested to ensure your repertoire management system is in-synch with the ISWC Database. Notifications are available in two supported file formats: ISWC JSON Format and ISWC EDI Format.

Download the PDF JSON File Format Specification here
Download the JSON File Format Developer Artefacts Zip File here