XSD 1.1 Update

XSD 1.1 is now available on the ORCID Registry and sandbox as a release version XSD. On March 1, 2014 we will updated the API messages schema to version 1.1. This article describes this update and outlines changes that API users will need to put in place for this version.  Until March 1, 2014 the previous version of the XSD (1.0.23) will still be available as the default XSD. After March 1st integrations that have not updated to 1.1.0 may not work correctly.

For more information about the Schema updating process and how release candidates work see ORCID XSD Versioning.

The new XSD for Version 1.1 can be found at:
https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/orcid-message-1.1.xsd

Calls can be made with the API using 1.1 immediately by adding "/v1.1" after the path in the url being use on call (for example http://api.orcid.org/v1.1/0000-0002-1982-1816/orcid-profile, or http://api.sandbox.orcid.org/v1.1/0000-0002-1825-0097/orcid-works/).

Who is affected?

All integrations that read ORCID iDs will need to update their system to use the new <orcid-identifier> field.

All integrations that add or read works in ORICD records will need to update to the new work-type options.

Work-type change (incompatible with previous versions)

With version 1.1 ORCID is moving to a work-type list as defined by CASRAI as part of our effort to use defined and supported vocabularies. The new list of work-types, with the mapping to the old work-types is below. For more information about the categories see CASRAI Output Standard.

Works entered with the old work-type using 1.0.23 will be automatically migrated to the corresponding new work-type, works entered on 1.1 must use the new vocabulary

new work-type old work-type
journal-article journal-article
journal-issue  
book book
book-review review
book-chapter chapter-anthology
translation  
dissertation dissertation-abstract, dissertation
supervised-student-publication thesis
newspaper-article newspaper-article
newsletter-article newsletter
encyclopedia-article encyclopedia-article
magazine-article editorial, magazine-article
dictionary-entry dictionary-entry
report report
research-tool  
manual  
online-resource digital-image, electronic-only, software
web-site web-site
test  
reports-working-papers reports-working-papers
conference-poster  
conference-abstract  
conference-paper conference-proceedings
patent patent
license  
disclosure  
registered-copyright  
standards-policy congressional-publication, executive-order, federal-bill, federal-report, federal-rule, federalstatue, government-publication, standards
invention  
data-set database, map-chart, raw-data
research-technique  
spin-off-company  
technical-standard  
artistic-performance cartoon-comic, film-movie, live-performance, musical-recording, painting, photograph, television-radio
other advertisement, audiovisual, bible, brochure, court-case, e-mail, federal-testimony, interview, legal, letter, mailing-list, manuscript, newsgroup, other, pamphlet, press-release, religious-text, undefined

 

    <orcid-identifier> for recording iDs in XML (incompatible with previous versions)

    We are updating the element used to record the ORCID iD of users to more correctly hold the identifiers and define the path separately from the identifier itself.  All integrations that read ORCID records must upgrade to continue accessing the iD.  The new <orcid-identifier> element will replace <orcid-id> and <orcid>. Within <orcid-identifier> the iD will be recorded in the following child elements:

    • <uri> the full path to the ORCID record
    • <path> just the 16 digit ORCID identifier
    • <host> the domain of the uri

    An example of how this element will appear in a record:

    <orcid-identifier>
      <uri>https://orcid.org/0000-0002-1825-0097</uri>
      <path>0000-0002-1825-0097</path>
      <host>orcid.org</host>
    </orcid-identifier>

    Integrations that include iDs in the XML they send to ORCID can just provide the <uri> or the <path> element.

     

    Migration Plan

    For the time from now until March 1, 2014 either version 1.0.23 or 1.1 of the API can be used with version 1.0.23 remaining the default API. After March 1st versions 1.1 will be the default version and the updated XSD must be used.

    Integrations affected by these changes are encouraged to contact us at support@orcid.org for assistance in making this transition.

     

    Migration Checklist:

    • If you are reading identifiers prepare your system to use the <orcid-identifier> elements
    • If you are adding works, prepare your integration to supply the new work-types.
    • If you are reading works, have your system accept the additional work-type fields.
    • As soon as your system is updated start using v1.1/ in your API calls

     

    Questions?

    Please contact us at support@orcid.org with questions or concerns.