1.2 record XML structure (archive)

This guide is an archived document related to the 1.2 version of the ORCID Message Schema, which is no longer supported by ORCID. The current supported version is 2.0 documentation. Go to the 2.0 documentation.

This article describes the structure for the XML that is returned when you call an ORCID record using the 1.2 version of the API.

Root element and headers

The root element of an ORCID record is <orcid-message>. Within <orcid-message> the element <orcid-profile> contains the information you will want to add about the researcher.

<?xml version="1.0" encoding="UTF-8"?>
<orcid-message xmlns="http://www.orcid.org/ns/orcid"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.orcid.org/ns/orcid https://raw.github.com/ORCID/ORCID-Source/master/orcid-model/src/main/resources/orcid-message-1.2.xsd">
    <message-version>1.2</message-version>
    <orcid-profile>... </orcid-profile>

 

ORCID identifier

This element is used to record the ORCID iD of users. The ORCID iD is formed of a 16-digit number

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
 <orcid-identifier>
    <uri>http://orcid.org/0000-0001-5727-2427</uri>
    <path>0000-0001-5727-2427</path>
    <host>orcid.org</host>
 </orcid-identifier>

 

Language Preference

The default language will be English, but it can be changed when the user sets the language selector menu into their ORCID record to their preferred language

<orcid-preferences>
   <locale>en</locale>
</orcid-preferences>

 

History Details

This part of the xml shows how the ORCID record was created. It can be either "website" or "direct", when the record was created through the ORCID Registry directly, "member-referred" when a member sent a user to the Registry and the sign up was done as part of an OAuth connection and "API" when it was created with a batch create process on behalf of the user. (n.b. The batch create process is being phased out by ORCID.) You can also see the date it was created and the last date it was modified. The verified-email filed indicates in any email addresses on the record are verified and verified-primary-email indicates if the primary email address has been verified. The claimed section indicates if the record has been claimed and accesses by the researcher- it will only be set to false for records created by the API which the user never took control of.

Example of record via website or direct

  <orcid-history>
       <creation-method>website</creation-method>
       <submission-date>2013-10-03T00:06:05.744Z</submission-date>
       <last-modified-date>2015-11-11T21:45:39.077Z</last-modified-date>
       <claimed>true</claimed>
       <verified-email>true</verified-email>
       <verified-primary-email>true</verified-primary-email>
  </orcid-history>

Example of record via member-referred

  <orcid-history>
       <creation-method>Member-referred</creation-method>
       <submission-date>2015-11-24T10:13:40.451Z</submission-date>
       <last-modified-date>2015-11-24T14:10:41.831Z</last-modified-date>
       <claimed>true</claimed>
       <deactivation-date>2015-11-24T14:10:41.708Z</deactivation-date>
       <verified-email>true</verified-email>
       <verified-primary-email>true</verified-primary-email>
  </orcid-history>

Example of record created via API

  </orcid-history>
       <creation-method>API</creation-method>
       <submission-date>2015-09-16T22:59:08.724Z</submission-date>
       <last-modified-date>2015-09-26T23:25:25.032Z</last-modified-date>
       <claimed>false</claimed>
       <source>
              <source-client-id>
                <uri>http://sandbox.orcid.org/client/APP-KWTDOE3CX69FH7FD</uri>
                <path>APP-KWTDOE3CX69FH7FD</path>
                <host>sandbox.orcid.org</host>
              </source-client-id>
              <source-name>Anas Client</source-name>
       </source>
       <verified-email>false</verified-email>
       <verified-primary-email>false</verified-primary-email>
  </orcid-history>

 

Biographical information

Personal and biographical information is included under <orcid-bio>... </orcid-bio> is included under <orcid-profile>...</orcid-profile> and cannot be repeated, it serves as a container for all the fields capturing personal information about a researcher.

See XML for orcid-bio for more information

 

Orcid-Activities element

<orcid-activities> is a high level tag. It came after the biographical information and under it we can have: the affiliations, works and/or funding items

<orcid-profile>
    <orcid-activities>
      <affiliations> … </affiliations>
      <orcid-works> … </orcid-works>
      <funding-list> … </funding-list>
    </orcid-activities>
  </orcid-profile>
 </orcid-message>

 

Organization Affiliation

The affiliations section of an ORCID record in XML is recorded under <orcid-activities>. This area is separate from the <orcid-bio> fields.

See XML for Affiliations for more information

 

Works information

You can add works in to an ORCID record using the API.   For information on the XML to include this information see XML for orcid-works

 

Funding information

The Funding section of an ORCID record is recorded under <orcid-activities>.  For information about adding funding via the API see XML for funding.

 

** Before showing the example of the final code, there are other elements that the system assigns and shows in many elements. This are: <source>, <create-date> and <last-modified-date>

Source

Every elements of the record that source information, is going to use the <source> element. It contains information about how and when the element was added to the record. The elements are: <orcid-history>, <external-identifier>, <affiliation>, <orcid-work> and <funding>. The exception to this is the <email> field where source is recorded as an attribute. The source element is system generated and should not be included when writing information to a record.

The <source> element contains <source-orcid>, <source-name> and <source-date>. Inside <source-orcid> are the elements <uri>, <path>, and <host> which record the client iD of the integration that added the work or the user's ORCID iD if the work was added manually.  The <source-name> has the client's name, or the user's credit name for works added manually. And <source-date> that expresses when does the work was added or updated

 <source>
   <source-orcid>
      <uri>http://orcid.org/APP-8G94N5BVOKGV2Z0P</uri>
       <path>APP-8G94N5BVOKGV2Z0P</path>
       <host>orcid.org</host>
   </source-orcid>
   <source-name>Staff Credentials</source-name>
   <source-date>2015-12-05T08:33:57.153Z</source-date>
 </source>

 

Create-Date

The date the element was created.

<created-date>2015-01-20T15:07:43.141Z</created-date>

 

Last-Modified-Date

The date and time the record was last modified.

<last-modified-date>2015-07-24T00:29:29.530Z</last-modified-date>

 

Final Code

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orcid-message xmlns="http://www.orcid.org/ns/orcid">
    <message-version>1.2</message-version>
    <orcid-profile type="user">
        <orcid-identifier>
            <uri>http://orcid.org/0000-0001-5727-2427</uri>
            <path>0000-0001-5727-2427</path>
            <host>orcid.org</host>
        </orcid-identifier>
        <orcid-preferences>
            <locale>en</locale>
        </orcid-preferences>
        <orcid-history>
            <creation-method>website</creation-method>
            <submission-date>2013-10-03T00:06:05.744Z</submission-date>
            <last-modified-date>2015-11-11T21:45:39.077Z</last-modified-date>
            <claimed>true</claimed>
            <verified-email>true</verified-email>
            <verified-primary-email>true</verified-primary-email>
        </orcid-history>
        <orcid-bio>
            <personal-details>
                <given-names>Sofia</given-names>
                <family-name>Garcia</family-name>
                <credit-name visibility="public">Sofia Maria Hernandez Garcia</credit-name>
                <other-names visibility="public">
                    <other-name>S. M. Garcia</other-name>
                    <other-name>Sofia Maria Garcia</other-name>
                </other-names>
            </personal-details>
            <biography visibility="public">Sofia Maria Hernandez Garcia is used for testing and demonstrating how ORCID records work.</biography>
            <contact-details>
                <email primary="true" current="true" verified="true" visibility="public" source="0000-0001-5727-2427">s.garcia@orcid.org</email>
            </contact-details>
                <external-identifier>
                    <external-id-common-name>Scopus Author ID</external-id-common-name>
                    <external-id-reference>56030991900</external-id-reference>
                    <external-id-url>http://www.scopus.com/inward/authorDetails.url?authorID=56030991900&amp;partnerID=MN8TOARS</external-id-url>
                    <source>
                        <source-orcid>
                            <uri>http://orcid.org/0000-0002-5982-8983</uri>
                            <path>0000-0002-5982-8983</path>
                            <host>orcid.org</host>
                        </source-orcid>
                    </source>
                </external-identifier>
        </orcid-bio>
        <orcid-activities>
            <affiliations>
                <affiliation visibility="public" put-code="679622">
                    <type>employment</type>
                    <department-name>Support &amp; Testing</department-name>
                    <start-date>
                        <year>2012</year>
                        <month>10</month>
                    </start-date>
                    <organization>
                        <name>ORCID</name>
                        <address>
                            <city>Bethesda</city>
                            <region>MD</region>
                            <country>US</country>
                        </address>
                    </organization>
                    <source>
                        <source-orcid>
                            <uri>http://orcid.org/0000-0001-5727-2427</uri>
                            <path>0000-0001-5727-2427</path>
                            <host>orcid.org</host>
                        </source-orcid>
                        <source-name>Sofia Maria Hernandez Garcia</source-name>
                        <source-date>2015-01-20T15:01:22.952Z</source-date>
                    </source>
                    <created-date>2015-01-20T15:01:22.952Z</created-date>
                    <last-modified-date>2015-03-25T18:47:53.931Z</last-modified-date>
                </affiliation>
            </affiliations>
            <orcid-works>
              <orcid-work put-code="15087747" visibility="public">
                  <work-title>
                    <title>CASRAI and ORCID: Putting the Pieces together to Collaboratively Support </title>
                    </work-title>
                    <journal-title>Procedia Computer Science</journal-title>
                    <work-citation>
                        <work-citation-type>bibtex</work-citation-type>
                        <citation>@article{Haak_2014,doi = {10.1016/j.procs.2014.06.045},url = {http://dx.doi.org/10.1016/j.procs.2014.06.045},year = 2014,publisher = {Elsevier {BV}},volume = {33},pages = {284--288},author = {Laure Haak and David Baker and Thorsten Hoellrigl},title = {{CASRAI} and {ORCID}: Putting the Pieces together to Collaboratively Support the Research Community},journal = {Procedia Computer Science}}</citation>
                    </work-citation>
                    <work-type>journal-article</work-type>
                    <publication-date>
                        <year>2014</year>
                    </publication-date>
                    <work-external-identifiers>
                        <work-external-identifier>
                            <work-external-identifier-type>doi</work-external-identifier-type>
                            <work-external-identifier-id>10.1016/j.procs.2014.06.045</work-external-identifier-id>
                        </work-external-identifier>
                    </work-external-identifiers>
                    <work-contributors>
                        <contributor>
                            <credit-name visibility="public">Laure Haak</credit-name>
                            <contributor-attributes>
                                <contributor-role>author</contributor-role>
                            </contributor-attributes>
                        </contributor>
                     </work-contributors>
                    <source>
                        <source-orcid>
                            <uri>http://orcid.org/0000-0002-3054-1567</uri>
                            <path>0000-0002-3054-1567</path>
                            <host>orcid.org</host>
                        </source-orcid>
                        <source-name>CrossRef Metadata Search</source-name>
                        <source-date>2015-01-20T15:06:35.002Z</source-date>
                    </source>
                    <created-date>2015-01-20T15:06:35.002Z</created-date>
                    <last-modified-date>2015-07-24T00:29:29.507Z</last-modified-date>
            </orcid-works>
            <funding-list>
                <funding put-code="59990" visibility="public">
                    <funding-type>grant</funding-type>
                    <funding-title>
                        <title>Grant for ORCID</title>
                    </funding-title>
                    <url></url>
                    <start-date>
                        <year>2014</year>
                    </start-date>
                    <organization>
                        <name>Wellcome Trust</name>
                        <address>
                            <city>London</city>
                            <country>GB</country>
                        </address>
                        <disambiguated-organization>
                         <disambiguated-organization-identifier>http://dx.doi.org/10.13039/100004440</disambiguated-organization-identifier>
                         <disambiguation-source>FUNDREF</disambiguation-source>
                        </disambiguated-organization>
                    </organization>
                    <source>
                        <source-orcid>
                            <uri>http://orcid.org/0000-0001-5727-2427</uri>
                            <path>0000-0001-5727-2427</path>
                            <host>orcid.org</host>
                        </source-orcid>
                        <source-name>Sofia Maria Hernandez Garcia</source-name>
                        <source-date>2015-01-20T15:02:30.501Z</source-date>
                    </source>
                    <created-date>2015-01-20T15:02:30.501Z</created-date>
                    <last-modified-date>2015-01-20T15:05:08.767Z</last-modified-date>
                </funding>
            </funding-list>
        </orcid-activities>
    </orcid-profile>
</orcid-message>