Relationship required on identifiers in ALL 2.0 release candidates

[Wilmers, Catalina]

!! Attention 2.0+ API users !!

This announcement affects anyone using the 2.0 release candidate APIs to post or update works, funding, personal identifiers, and notifications. Starting on October 20th the relationship field will be required with all identifiers added to the API with version 2.0+.  As of today, all identifiers in the sandbox require the relationship field.

The relationship should be set to “self” for identifiers that refer to the object itself (such a DOI for an article or a personal identifier) and “part-of” when the identifier is for an object the item is a part of (such as a ISBN for a book chapter or an ISSN for a journal article).

Example identifiers with relationships:

        <common:external-ids>
          <common:external-id>
                <common:external-id-type>issn</common:external-id-type>
                <common:external-id-value>1234-5678</common:external-id-value>
                <common:external-id-relationship>part-of</common:external-id-relationship>
          </common:external-id>
        </common:external-ids>

        <common:external-ids>
          <common:external-id>
                <common:external-id-type>doi</common:external-id-type>
                <common:external-id-value>10.1087/20120404</common:external-id-value>
                <common:external-id-url>http://dx.doi.org/10.1087/20120404</common:external-id-url>
                <common:external-id-relationship>self</common:external-id-relationship>
          </common:external-id>
        </common:external-ids>

List of identifiers affected:

• Personal identifiers in the <external-identifier:external-identifier> tag
• Work identifiers in the <work:work> tag
• Funding identifiers in the <funding:funding> tag
• Peer-review identifiers in the <peer-review:review-identifiers> and <peer-review:subject-external-identifier> tags
• Identifiers supplied with notifications in the <notification:item> tag
  

Many of you may already be doing this. However we ask you verify relationship is being populated. While we try to avoid changes to release candidates, this change is required for the ongoing improvement of the ORCID Registry. Organizations using release candidates are expected to be able to deal with short release cycles in trade for the opportunity to provide feedback and suggestions before the final version of an API is released. 

Please let us know if you have any questions or concerns.

Best,

-Catalina