XSD 1.0.10 - Planning for the update

On Friday, February 15, 2013 we updated the API message from version 1.0.8 to 1.0.10. This article describes this update and outlines updates that you will need to put in place.

The new XSD for Version 1.0.10 can be found at:
http://orcid.github.com/ORCID-Parent/schemas/orcid-message/1.0.10/

Who is affected?

If you use the following elements in the XSD, you should plan for a migration to the new schema:

  • <orcid> - will be deprecated in June 2013
  • <alternative-emails> - will be deprecated immediately
  • <email> - targeted for migration to a new format by March 1

Summary of what has changed

  • New Element: <orcid-id> - orcid-id has been added to the schema. Previous version of the XSD failed to include the complete ORCID iD, which should be expressed as an URI. See Structure of the ORCID Identifier
  • Alternate Emails
    • alternative-emails has been removed from the XSD.
    • email now offically is unbounded you can add more then one.
    • email has had an attribute primary added. This the users preferred email.
    • email has had an attribute current added. User still can receive email at the listed address.
    • email has had an attribute verified added. The ORCID system has verified the email address exist.
    • an updated user interface for users to manage multiple emails will be part of an upcoming release

Examples of changes

orcid-id

 <orcid>0000-0002-1825-0097</orcid>
 <orcid-id>https://orcid.org/0000-0002-1825-0097</orcid-id>

Both elements are present in the current XSD. The <orcid> element will be deprecated in summer 2013.

email

USING A SINGLE EMAIL

  • For current backward compatibility, a single email address will still be accepted. This address will be considered to be primary.
<contact-details>
     <email>a.einstein@orcid.org</email>
</contact-details>

USING MULTIPLE EMAILS

  • Multiple email addresses can be added to the <contact-details> element.
  • Each email address must have a "primary" attribute, with EXACTLY one email marked with a true "primary" attribute.
  • Both current and past email addresses may be included, indicated by the "current" attribute.
<contact-details>
     <email primary="true">aeinstein@princeton.edu</email>
     <email primary="false" current="false">al.einstein@gmail.com</email>
     <email primary="false">a.einstein@orcid.org</email>
</contact-details>

Migration Plan

<orcid>

During this transition period you will see and must use both the <orcid> and <orcid-id> elements. In summer 2013 we will be removing the <orcid> element and only the <orcid-id> one will remain.

>> Migration Checklist:

  • Enable your system to read the orcid-id element (in URI format)
  • Plan to store the ORCID iD in this format you your systems.
  • Review the ORCID iD display format guidelines for guidance on how to display ORCID iDs on your sites and printed materials. (coming soon)
  • Include the orcid-id element (in URI format) when formatting API messages as per the new XSD

<alternative-emails>

The alternative-emails element is no longer available in the XSD. There has been no use of this element during API calls since the launch of the Registry, so we have removed it immediately. When formatting messages for the API, you should not include this element.

>> Migration Checklist:

  • Do not include <alternative-emails> in any API messages
  • If your system has any dependencies on this field, remove them

<email>

If there is more then one email listed exactly one email must be marked primary. At the moment We are hoping to get everyone migrated to marking the primary email in a few weeks.

>> Migration Checklist:

  • Start to use the "primary" and "current" attributes when creating and updating ORCID Record <orcid-bio> elements. Always include attributes when creating and updating email addresses.
  • When reading <email> fields enable the acceptance of more than one email address, or parse the "primary" attribute to find the currently-used email address

Questions?

Please contact us at support@orcid.org if you have any questions or concerns!