ISAN API 3.0 - new ISAN applications

/records service enables to register an ISAN record, i.e. a series, a group, an episode, a single work,  or a version: variant, manifestation,  related content, related item. 

The following topics are covered in this article:

• Single work applications: single record
• Episodic work applications: series, group, episode records
• Version applications: variant, manifestation, related content, related item records
• Get the status of the ISAN application
• Manage pending applications: deduplication process 
• Get the new ISAN

Single work applications: single record

The ISAN registration process involves several operations

Submit the single work data

POST /records Register or validate a record before registration

Refer to ISAN swagger interface for details and examples in json and xml

❗️The API user shall have a registrant role (X-ISAN-Authorization)

⚠️ Warning: when using the examples provided on the ISAN swagger site:

• The recordId and parenRecordId must be unique for the user, you might need to change the proposed values.

• "Fake" linked ISAN are proposed in all examples, these ISAN must be replaced with valid existing ISAN in the sandbox database, otherwise you will get a validation error.

• It is likely that examples will result in a pending application as other users might have already registered these examples.

Next steps:

1. after data submission, Get the status of the ISAN application
2. if the status is "pending", Manage pending applications: deduplication process 
3. Get the new ISAN

Episodic work applications: series, group, episode records

Principles:

• At validation, the parent record mut be submitted first for registration, otherwise the parentRecordId will not be recognized. 
• parents shall be registered before children:
  • A group can be registered only if the series has been registered first.
  • An episode can be registered only if the Series and/or the Group (it is attached to) is/are registered first
• ⚠️ Warning: The ISAN of a series is delivered only after the first group or first episode is registered.

[TBD]

Next step: after data submission, Get the status of the ISAN application

Version applications: variant, manifestation, related content, related item records

(parents need to be registered first)

[TBD]

Next step: after data submission, Get the status of the ISAN application

Get the status of the ISAN application

After submitting you application, you will check its status by invoking /myisan on the recordId. 

/myisan service enables to query the client catalogue in the ISAN Registry for retrieving registered ISAN and ISAN applications made by the client. The scope of the search is restricted to the client catalogue.

Use this service to check the status of a registration application after using the /record service for registering an ISAN

Query based search

GET /queries Build the search and query the client catalogue

Refer to ISAN swagger site for details and examples in json and xml

Set the field value to status when checking the status of a registration application

Note that some arguments of the query method can be repeated (i.e. for repeatable fields such as countries, languages, participants), forming a OR condition between the repeated arguments.

Record based search

POST /queries Query the the client catalogue using the record data that is provided

Refer to ISAN swagger site for details and examples in json and xml

Manage pending applications: deduplication process 

The status of the ISAN application is status = pending, this means that your application is matching with one or more active ISAN, and a manual deduplication is required to check wether the ISAN is already registered. In case of a real duplicate, the existing ISAN shall be used and the application will be linked to that ISAN. If none of the matching candidates are real duplicated, a new ISAN is issued.

In the current implementation of the API it is only possible to retrieve the pending status of the application. We are currently working on a deduplication service that will enable to list all potential duplicates with the current application and another service to submit a deduplication decision to issue a new ISAN or use an existing one. In the meantime, the manual deduplication shall be performed on the ISAN web interface.

Get the new ISAN

The status of the ISAN application is status = active . This indicates that the ISAN has been issued and can be retrieved in the status information of the same query as to obtain the status of the application.

If you wish to retrieve all information associated with that ISAN, renew the query for obtaining the status of the application but make sure you set  all the field value to all.