Basic tutorial: Reading ORCID record XML (2.0)

This page annotates example XML returned when reading a complete ORCID record with the 2.0 API. The example record annotated in this document can be found at https://sandbox.orcid.org/0000-0002-9227-8514

For more on reading a record using the API, see our tutorial on reading data on an ORCID record.

Common Elements

Item attributes

  <work:work-summary put-code="733535" path="/0000-0002-9227-8514/work/733535" visibility="public" display-index="0">

Put code

Each item in the ORCID iD is assigned a put code which uniquely identifies it. When reading an entire record or section, the put code can be found as an attribute of the item. When calling a specific item on a record, the put code is used to identify the item. Put codes are unique within the type of item they refer to. Using this example, only one work in the ORCID Registry will have the put code 733535, though 733535 may also used as a put code for a funding item or a keyword.

Path

The path is the ORCID iD, section, and put-code and is used when reading the individual item.

Display index

Display index is the order of the item on the ORCID record. In the activities section, display index is the order of an item within its group; the preferred version has the highest display index. In the person section, display index is the order in which the researcher has ranked the item with the section; the first item in a personal information section has the highest display index. Items added via the API have a default display index of 0 and appear at the bottom of the section until moved by the researcher.

Visibility

Visibility indicates the privacy setting of the item. Public items can be read by anyone via the API and are shown on the researcher's public record, Limited items are only returned via the API to clients who have read-limited access; they are not on the researcher's public record. Private items are visible only to the researcher and the source of the item- the only private items returned via the API are those which were added to the record via your integration. More about visibility settings in the ORCID Registry.

Create and last modified dates

All items on the ORCID record include metadata about when they were created and when they were modified. These dates are hierarchical; the create date for the section is set to when an item was first added to that section, and the last modified date of sections and groups will match the latest last modified date of any item within the section or group. Created and last modified dates will be returned even if the information they refer to is private. The date is presented as year, month, day, followed by the time given in UCT. Information which has not been edited since it was created will have the same create date and last modified date.

  <common:created-date>2012-10-26T08:18:30.165Z</common:created-date>
  <common:last-modified-date>2016-04-20T16:37:30.195Z</common:last-modified-date>

Source

Fields which can be edited by either the API or the user include the ORCID iD and the name of the client which added the information.

<common:source>
      <common:source-client-id>
            <common:uri>http://orcid.org/client/0000-0003-1377-5676</common:uri>
            <common:path>0000-0003-1377-5676</common:path>
            <common:host>orcid.org</common:host>
      </common:source-client-id>
      <common:source-name>ResearcherID</common:source-name>
</common:source>

If the user is the source, the user's ORCID iD and name will be returned. (If the user has their name's visibility setting as "private" or "limited" the <common:source-name> tag will not be returned.)

<common:source>
      <common:source-orcid>
            <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
            <common:path>0000-0002-9227-8514</common:path>
            <common:host>sandbox.orcid.org</common:host>
      </common:source-orcid>
      <common:source-name>Sofia Maria Hernandez Garcia</common:source-name>
</common:source>

External ids

Identifiers for items on the ORCID record are recorded using the common external-ids tag, this includes identifiers in the person, works, funding, and peer review sections. The identifier is described in four fields:

  • External id type is required and records the type of identifier (identifiers in the works, funding, and peer review sections must a supported identifiers).
  • External id value is required and contains the identifier itself.
  • External id URL is optional and contains a link the identifier will resolve to.
  • External id relationship is required and indicates if the identifier refers to the item itself (such as a DOI for an article or a person identifier) or is the identifier is for a whole that the item is a part of (such as an ISSN for a journal article, or an ISBN for a book chapter); part of identifiers are not used when grouping items.
  <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>https://doi.org/10.1087/20120404</common:external-id-url>
      <common:external-id-relationship>self</common:external-id-relationship>
    </common:external-id>
  </common:external-ids>

Dates

Dates are recorded with the year, month, and day in separate tags. Date tags are optional and can be used as a combination of all three tags, or just year and month, or just year. Adding a start date without an end date indicates that the item is ongoing and the end date will display "to present" on the record.

        <common:start-date>
          <common:year>2012</common:year>
          <common:month>10</common:month>
          <common:day>18</common:day>
        </common:start-date>
        <common:end-date>
          <common:year>2016</common:year>
          <common:month>05</common:month>
        </common:end-date>

ORCID iDs

All ORCID iDs expressed in a record use the same elements: uri, which is the full URI to the record; path, which is just the 16-digit ORCID identifier; and host, which is the domain the record is on.

    <common:orcid-identifier>
        <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
        <common:path>0000-0002-9227-8514</common:path>
        <common:host>sandbox.orcid.org</common:host>
    </common:orcid-identifier>

Organization tags

These common tags are used to record the name, location, and identifiers for organizations in the education, employment, funding, and peer-review sections. When referencing an organization, the city and country under the address are required. When adding an organization, a disambiguated identifier is highly recommended; we suggest using either a Ringgold ID or a FundeRef ID.

    <common:name>Massachusetts Institute of Technology</common:name>
    <common:address>
      <common:city>Cambridge</common:city>
      <common:region>MA</common:region>
      <common:country>US</common:country>
    </common:address>
    <common:disambiguated-organization>
      <common:disambiguated-organization-identifier>2167</common:disambiguated-organization-identifier>
      <common:disambiguation-source>RINGGOLD</common:disambiguation-source>
    </common:disambiguated-organization>

 

Record metadata

ORCID iD

The first element when calling a record is the ORCID iD. It is returned in the standard format for all ORCID iDs.

<record:record>
  <common:orcid-identifier>
    <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
    <common:path>0000-0002-9227-8514</common:path>
    <common:host>sandbox.orcid.org</common:host>
  </common:orcid-identifier>

Preferences

The preferences section records the language the user selected when viewing their ORCID record. The languages are listed in ISO 639-1 Code.
   

  <preferences:preferences>
    <preferences:locale>en</preferences:locale>
  </preferences:preferences>

History

The history section has information about the creation and state of the record:

  • creation-method: How the record was created. The options are "Direct" or "Website" - when a user signed up for the record directly at https://orcid.org/register; "Member-referred" - when the user was sent to the ORCID OAuth registration page by a client integration and signed up as part of granting authorization; or "API" - when the record was created on behalf of the researcher by their institution (The API create process is no longer supported by ORCID).
  • creation-date: This field is only on records that were created using the API on behalf of the researcher by their institution; it is the date the institution created the record.
  • submission-date: The date the record was created by the user if the creation method is Direct, Website, or Member-referred, or if the creation method is API; it is the date the researcher claimed the record.
  • claimed: Shows that the record has been claimed by the researcher. All records created by the researcher will have this field set to true. Only records created by an institution for a researcher and which have not been accessed by the researcher will have the claimed status set to false.
  • verified-email: If any email address on the record has been verified, this will be set to true (to verify an email address the user must prove they have access to that email address inbox by following a link sent to them).
  • verified-primary-email: If the primary email address on the record has been verified.
  <history:history>
    <history:creation-method>Member-referred</history:creation-method>
    <history:submission-date>2015-02-04T07:03:21.286Z</history:submission-date>
    <common:last-modified-date>2016-10-25T19:34:46.154Z</common:last-modified-date>
    <history:claimed>true</history:claimed>
    <history:verified-email>true</history:verified-email>
    <history:verified-primary-email>true</history:verified-primary-email>
  </history:history>

Person

  <person:person path="/0000-0002-9227-8514/person">
    <common:last-modified-date>2016-10-25T19:31:23.379Z</common:last-modified-date>

Names

The given-names, family-name and credit-name are the names the researcher goes by, and can only be edited by the researcher (which is why no source information is returned in this section). While given-names is a required field on all records, this section can be set to private by the researcher. More about names in the ORCID registry.

   <person:name visibility="public">
      <common:created-date>2016-04-14T21:28:00.210Z</common:created-date>
      <common:last-modified-date>2016-10-25T19:31:41.141Z</common:last-modified-date>
      <personal-details:given-names>Sofia</personal-details:given-names>
      <personal-details:family-name>Garcia</personal-details:family-name>
      <personal-details:credit-name>Sofia Maria Hernandez Garcia</personal-details:credit-name>
    </person:name>

Other names

Other names is a repeatable field to capture other names the researcher may be known by. In this example, the record has three other names, all of which were added by the researcher. As with all sections in the record, there is a last-modified-date which matches the latest last modified date of the most recently edited item in the section.

    <other-name:other-names path="/0000-0002-9227-8514/other-names">
      <common:last-modified-date>2016-04-20T16:37:30.195Z</common:last-modified-date>
      <other-name:other-name put-code="15812" visibility="public" path="/0000-0002-9227-8514/other-names/15812" display-index="0">
        <common:created-date>2016-04-20T16:37:30.190Z</common:created-date>
        <common:last-modified-date>2016-04-20T16:37:30.190Z</common:last-modified-date>
        <common:source>
          <common:source-orcid>
            <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
            <common:path>0000-0002-9227-8514</common:path>
            <common:host>sandbox.orcid.org</common:host>
            <common:source-name>Sofia Maria Hernandez Garcia</common:source-name>
          </common:source-orcid>
        </common:source>
        <other-name:content>Sofia Maria Garcia</other-name:content>
      </other-name:other-name>
      <other-name:other-name put-code="15813" visibility="public" path="/0000-0002-9227-8514/other-names/15813" display-index="0">
        <common:created-date>2016-04-20T16:37:30.195Z</common:created-date>
        <common:last-modified-date>2016-04-20T16:37:30.195Z</common:last-modified-date>
        <common:source>
          <common:source-orcid>
            <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
            <common:path>0000-0002-9227-8514</common:path>
            <common:host>sandbox.orcid.org</common:host>
            <common:source-name>Sofia Maria Hernandez Garcia</common:source-name>
          </common:source-orcid>
        </common:source>
        <other-name:content>София Мария Эрнандес Гарсия</other-name:content>
      </other-name:other-name>
      <other-name:other-name put-code="15814" visibility="public" path="/0000-0002-9227-8514/other-names/15814" display-index="0">
        <common:created-date>2016-04-20T16:37:30.195Z</common:created-date>
        <common:last-modified-date>2016-04-20T16:37:30.195Z</common:last-modified-date>
        <common:source>
          <common:source-orcid>
            <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
            <common:path>0000-0002-9227-8514</common:path>
            <common:host>sandbox.orcid.org</common:host>
            <common:source-name>Sofia Maria Hernandez Garcia</common:source-name>
          </common:source-orcid>
        </common:source>
        <other-name:content>索菲亚玛丽亚 加西亚</other-name:content>
      </other-name:other-name>
    </other-name:other-names>

Biography

The biography field is non-repeatable and can only be edited by the researcher. Since only the researcher can edit this field, no source information is included.

    <person:biography visibility="public" path="/0000-0002-9227-8514/biography">
      <common:created-date>2016-04-14T21:28:00.211Z</common:created-date>
      <common:last-modified-date>2016-04-14T21:28:00.211Z</common:last-modified-date>
      <personal-details:content>Sofia Maria Hernandez Garcia is the researcher that is used as an example ORCID record holder.</personal-details:content>
    </person:biography>

Researcher URLS

Researcher URLs (labeled as websites on the record) link to other webpages about the researcher. Each webpage has a url tag, which is the link to the webpage itself, and an optional url-name tag. In this example, the first website, which has the name "Wikipedia Page," has been added by an API client which is reflected in the source. The display index lets us know the researcher has sorted this website to appear at the top of the websites list on the record, but the researcher has also given this website a limited visibility so it is not shown on the public record.

    <researcher-url:researcher-urls path="/0000-0002-9227-8514/researcher-urls">
      <common:last-modified-date>2016-10-25T19:26:19.805Z</common:last-modified-date>
      <researcher-url:researcher-url put-code="41094" visibility="limited" path="/0000-0002-9227-8514/researcher-urls/41094" display-index="2">
        <common:created-date>2016-04-20T16:37:30.259Z</common:created-date>
        <common:last-modified-date>2016-10-25T19:26:19.790Z</common:last-modified-date>
          <common:source>
          <common:source-client-id>
            <common:uri>http://sandbox.orcid.org/client/APP-2UX70ON5NEEMCGCV</common:uri>
            <common:path>APP-2UX70ON5NEEMCGCV</common:path>
            <common:host>sandbox.orcid.org</common:host>
          </common:source-client-id>
        <common:source-name>Frontiers ORCID Sandbox</common:source-name>
      </common:source>
      <researcher-url:url-name>Wikipedia Page</researcher-url:url-name>
      <researcher-url:url>http://en.wikipedia.org/wiki/ORCID</researcher-url:url>
    </researcher-url:researcher-url>
    <researcher-url:researcher-url put-code="41387" visibility="public" path="/0000-0002-9227-8514/researcher-urls/41387" display-index="1">
      <common:created-date>2016-10-25T19:26:13.347Z</common:created-date>
      <common:last-modified-date>2016-10-25T19:26:19.805Z</common:last-modified-date>
        <common:source>
          <common:source-orcid>
            <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
            <common:path>0000-0002-9227-8514</common:path>
            <common:host>sandbox.orcid.org</common:host>
            <common:source-name>Sofia Maria Hernandez Garcia</common:source-name>
          </common:source-orcid>
        </common:source>
        <researcher-url:url-name>Twitter</researcher-url:url-name>
        <researcher-url:url>https://twitter.com/ORCIDsofia</researcher-url:url>
      </researcher-url:researcher-url>
    </researcher-url:researcher-urls>

Email addresses

Email addresses can only be edited by the researcher. Keep in mind that email addresses default to private and most users do not change that status, so often when reading a record an email address will not be returned.

 <email:emails path="/0000-0002-9227-8514/email">
	            <common:last-modified-date>2016-10-25T18:02:02.891Z</common:last-modified-date>
	            <email:email visibility="public" verified="true" primary="false">
	                <common:created-date>2016-10-25T18:02:02.891Z</common:created-date>
	                <common:last-modified-date>2016-10-25T18:02:02.891Z</common:last-modified-date>
	                <common:source>
	                    <common:source-orcid>
	                        <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
	                        <common:path>0000-0002-9227-8514</common:path>
	                        <common:host>sandbox.orcid.org</common:host>
	                    </common:source-orcid>
	                </common:source>
	                <email:email>sofiag@gmail.com</email:email>
	            </email:email>
	            <email:email visibility="public">
	                <common:created-date>2015-02-05T07:32:28.227Z</common:created-date>
	                <common:last-modified-date>2015-02-05T07:32:28.227Z</common:last-modified-date>
	                <common:source>
	                    <common:source-client-id>
	                        <common:uri>http://sandbox.orcid.org/client/APP-IBZ1JV163H00MDJ2</common:uri>
	                        <common:path>APP-IBZ1JV163H00MDJ2</common:path>
	                        <common:host>sandbox.orcid.org</common:host>
	                    </common:source-client-id>
	                    <common:source-name>City University of Hong Kong</common:source-name>
	                </common:source>
	                <email:email>s.garcia@orcid.org</email:email>
	            </email:email>
	        </email:emails>

Address

The address field records countries or regions that the researcher works or has worked in. The countries are returned in ISO 3166-1 alpha-2 format. In this example one country has been added by the user and one by a client integration.

    <address:addresses path="/0000-0002-9227-8514/address">
      <common:last-modified-date>2016-10-26T18:26:07.602Z</common:last-modified-date>
      <address:address put-code="4556" visibility="public" path="/0000-0002-9227-8514/address/4556" display-index="2">
        <common:created-date>2016-10-25T19:25:04.065Z</common:created-date>
        <common:last-modified-date>2016-10-26T18:26:07.566Z</common:last-modified-date>
        <common:source>
          <common:source-orcid>
            <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
            <common:path>0000-0002-9227-8514</common:path>
            <common:host>sandbox.orcid.org</common:host>
            <common:source-name>Sofia Maria Hernandez Garcia</common:source-name>
          </common:source-orcid>
        </common:source>
        <address:country>GB</address:country>
      </address:address>
      <address:address put-code="4560" visibility="public" path="/0000-0002-9227-8514/address/4560" display-index="0">
        <common:created-date>2016-10-26T18:25:37.295Z</common:created-date>
        <common:last-modified-date>2016-10-26T18:26:07.602Z</common:last-modified-date>
        <common:source>
          <common:source-client-id>
            <common:uri>http://sandbox.orcid.org/client/APP-674MCQQR985VZZQ2</common:uri>
            <common:path>APP-674MCQQR985VZZQ2</common:path>
            <common:host>sandbox.orcid.org</common:host>
          </common:source-client-id>
          <common:source-name>State University</common:source-name>
        </common:source>
        <address:country>US</address:country>
      </address:address>
    </address:addresses>

Keywords

The keywords sections is for words and phrases that describe the areas of study the researchers works in. In this example there are three keywords: two added by the researcher, and one by a client integration. The client integration and the researcher have entered the same keyword, "QA and testing", on the public ORCID record. This keyword will only appear once, with both sources listed. Using the API, both keywords and all associated metadata are returned separately.

    <keyword:keywords path="/0000-0002-9227-8514/keywords">
      <common:last-modified-date>2016-10-25T19:25:27.039Z</common:last-modified-date>
      <keyword:keyword put-code="4504" visibility="public" path="/0000-0002-9227-8514/keywords/4504" display-index="3">
        <common:created-date>2016-04-20T16:37:30.189Z</common:created-date>
        <common:last-modified-date>2016-10-25T19:25:27.029Z</common:last-modified-date>
        <common:source>
          <common:source-client-id>
            <common:uri>http://sandbox.orcid.org/client/APP-2UX70ON5NEEMCGCV</common:uri>
            <common:path>APP-2UX70ON5NEEMCGCV</common:path>
            <common:host>sandbox.orcid.org</common:host>
          </common:source-client-id>
          <common:source-name>Frontiers ORCID Sandbox</common:source-name>
        </common:source>
        <keyword:content>QA and testing</keyword:content>
      </keyword:keyword>
      <keyword:keyword put-code="4603" visibility="public" path="/0000-0002-9227-8514/keywords/4603" display-index="2">
        <common:created-date>2016-10-25T19:25:15.476Z</common:created-date>
        <common:last-modified-date>2016-10-25T19:25:27.037Z</common:last-modified-date>
         <common:source>
          <common:source-orcid>
            <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
            <common:path>0000-0002-9227-8514</common:path>
            <common:host>sandbox.orcid.org</common:host>
            <common:source-name>Sofia Maria Hernandez Garcia</common:source-name>
          </common:source-orcid>
        </common:source>                
        <keyword:content>QA and testing</keyword:content>
      </keyword:keyword>
      <keyword:keyword put-code="4604" visibility="public" path="/0000-0002-9227-8514/keywords/4604" display-index="1">
        <common:created-date>2016-10-25T19:25:27.039Z</common:created-date>
        <common:last-modified-date>2016-10-25T19:25:27.039Z</common:last-modified-date>
        <common:source>
          <common:source-orcid>
            <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
            <common:path>0000-0002-9227-8514</common:path>
            <common:host>sandbox.orcid.org</common:host>
            <common:source-name>Sofia Maria Hernandez Garcia</common:source-name>
          </common:source-orcid>
        </common:source>                
        <keyword:content>Additional keyword</keyword:content>
      </keyword:keyword>
    </keyword:keywords>

External Identifiers

Person external identifiers record identifiers and links to the researcher in other systems. Like all identifiers, the personal external identifier is described using the for tags: type, value, url, and relationship, however, personal identifiers should always have the relationship set to "self." The researcher cannot add external identifiers to the record manually, they must be added by a client integration using the API. In this example, the researcher has not sorted the identifiers added to her record, so the display index on both is "0."

    <external-identifier:external-identifiers path="/0000-0002-9227-8514/external-identifiers">
      <common:last-modified-date>2016-10-25T19:31:23.379Z</common:last-modified-date>
        <external-identifier:external-identifier put-code="3193" visibility="public" path="/0000-0002-9227-8514/external-identifiers/3193" display-index="0">
          <common:created-date>2016-04-20T16:37:30.171Z</common:created-date>
          <common:last-modified-date>2016-10-25T19:26:59.621Z</common:last-modified-date>
          <common:source>
          <common:source-client-id>
            <common:uri>http://sandbox.orcid.org/client/APP-2UX70ON5NEEMCGCV</common:uri>
            <common:path>APP-2UX70ON5NEEMCGCV</common:path>
            <common:host>sandbox.orcid.org</common:host>
          </common:source-client-id>
          <common:source-name>Frontiers ORCID Sandbox</common:source-name>
        </common:source>
        <common:external-id-type>Loop profile</common:external-id-type>
        <common:external-id-value>558</common:external-id-value>
        <common:external-id-url>http://loop.frontiers-sandbox-int.info/people/559/overview?referrer=orcid_profile</common:external-id-url>
        <common:external-id-relationship>self</common:external-id-relationship>
      </external-identifier:external-identifier>
      <external-identifier:external-identifier put-code="3294" visibility="public" path="/0000-0002-9227-8514/external-identifiers/3294" display-index="0">
        <common:created-date>2016-10-25T19:31:23.378Z</common:created-date>
        <common:last-modified-date>2016-10-25T19:31:23.379Z</common:last-modified-date>
        <common:source>
          <common:source-client-id>
          <common:uri>http://sandbox.orcid.org/client/APP-674MCQQR985VZZQ2</common:uri>
          <common:path>APP-674MCQQR985VZZQ2</common:path>
          <common:host>sandbox.orcid.org</common:host>
        </common:source-client-id>
        <common:source-name>State University</common:source-name>
        </common:source>
        <common:external-id-type>Personal External Identifier</common:external-id-type>
        <common:external-id-value>506</common:external-id-value>
        <common:external-id-url>www.6.com</common:external-id-url>
        <common:external-id-relationship>self</common:external-id-relationship>
      </external-identifier:external-identifier>
    </external-identifier:external-identifiers>
  </person:person>

 

Activities

The activities sections record information about the researcher's work and outcomes. It is divided into five sections.

  <activities:activities-summary  path="/0000-0002-9227-8514/activities">
    <common:last-modified-date>2016-10-25T18:33:37.267Z</common:last-modified-date>

Education

The education section records where a researcher went to school. It uses the same fields as the Employment section: department-name and role-title for specific information about the area the researcher studied and what degree the education lead to, the common date tags to identify when the researcher was affiliated with this organization, and the organization tags to identify the education institution. We recommend using the highest level organization when adding an education item (i.e. not listing the organization at the department level) and always including the disambiguated organization information. This example has one education item added by a client application.

    <activities:educations path="/0000-0002-9227-8514/educations">
      <common:last-modified-date>2016-10-27T15:54:34.474Z</common:last-modified-date>
      <education:education-summary put-code="22423" path="/0000-0002-9227-8514/education/22423" visibility="public">
        <common:created-date>2016-10-27T15:54:34.474Z</common:created-date>
        <common:last-modified-date>2016-10-27T15:54:34.474Z</common:last-modified-date>
        <common:source>
          <common:source-client-id>
            <common:uri>http://sandbox.orcid.org/client/APP-674MCQQR985VZZQ2</common:uri>
            <common:path>APP-674MCQQR985VZZQ2</common:path>
            <common:host>sandbox.orcid.org</common:host>
          </common:source-client-id>
          <common:source-name>State University</common:source-name>
        </common:source>
        <education:department-name>Testing Department</education:department-name>
        <education:role-title>BA</education:role-title>
        <common:start-date>
          <common:year>1997</common:year>
          <common:month>09</common:month>
          <common:day>02</common:day>
        </common:start-date>
        <common:end-date>
          <common:year>2001</common:year>
          <common:month>05</common:month>
          <common:day>15</common:day>
        </common:end-date>
        <education:organization>
          <common:name>Massachusetts Institute of Technology</common:name>
          <common:address>
            <common:city>Cambridge</common:city>
            <common:region>MA</common:region>
            <common:country>US</common:country>
          </common:address>
          <common:disambiguated-organization>
            <common:disambiguated-organization-identifier>2167</common:disambiguated-organization-identifier>
            <common:disambiguation-source>RINGGOLD</common:disambiguation-source>
          </common:disambiguated-organization>
        </education:organization>
      </education:education-summary>
    </activities:educations>

Employment

The employment section records where the researcher has been employed. It uses the same fields as the education section: department-name and role-title for specific information about the department the researcher worked in and their role, the common date tags to identify when the researcher was affiliated with this organization, and the organization tags to identify the education institution. We recommend using the highest level organization when adding an employment item (i.e. not listing the organization at the department level) and always including the disambiguated organization information. This example has one employment item added by the user.

    <activities:employments  path="/0000-0002-9227-8514/employments">
      <common:last-modified-date>2016-10-25T18:03:25.431Z</common:last-modified-date>
      <employment:employment-summary put-code="22411" path="/0000-0002-9227-8514/employment/22411" visibility="public">
        <common:created-date>2016-10-25T18:03:25.431Z</common:created-date>
        <common:last-modified-date>2016-10-25T18:03:25.431Z</common:last-modified-date>
         <common:source>
          <common:source-orcid>
            <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
            <common:path>0000-0002-9227-8514</common:path>
            <common:host>sandbox.orcid.org</common:host>
            <common:source-name>Sofia Maria Hernandez Garcia</common:source-name>
          </common:source-orcid>
        </common:source>  
        <employment:department-name>QA and Testing</employment:department-name>
        <employment:role-title>Test account holder</employment:role-title>
        <common:start-date>
          <common:year>2012</common:year>
          <common:month>10</common:month>
        </common:start-date>
        <employment:organization>
          <common:name>ORCID</common:name>
          <common:address>
            <common:city>Bethesda</common:city>
            <common:region>MD</common:region>
            <common:country>US</common:country>
          </common:address>
          <common:disambiguated-organization>
            <common:disambiguated-organization-identifier>385488</common:disambiguated-organization-identifier>
            <common:disambiguation-source>RINGGOLD</common:disambiguation-source>
          </common:disambiguated-organization>
        </employment:organization>
      </employment:employment-summary>
    </activities:employments>

Funding

The funding section records monetary awards the researcher has received to support their work. As with works and peer review, funding items that share a common external identifier are grouped together under a single activities:group tag, with the display index indicating their order within the group. Not all details of a funding item are returned when reading an entire record; to get the details of a particular item, use the put code to call it individually. This example has just one funding item added by the user.

See our user documentation for a full description of each tag in of the funding field.

<activities:fundings  path="/0000-0002-9227-8514/fundings">
	            <common:last-modified-date>2016-10-27T14:28:56</common:last-modified-date>
	            <activities:group>
	                <common:last-modified-date>2016-10-27T14:28:56.846Z</common:last-modified-date>
	                <common:external-ids>
	                    <common:external-id>
	                        <common:external-id-type>grant_number</common:external-id-type>
	                        <common:external-id-value>12345</common:external-id-value>
	                        <common:external-id-relationship>self</common:external-id-relationship>
	                    </common:external-id>
	                </common:external-ids>
	                <funding:summary put-code="4413" path="/0000-0002-9227-8514/funding/4413" visibility="public" display-index="0">
	                    <common:created-date>2016-10-27T14:28:56.846Z</common:created-date>
	                    <common:last-modified-date>2016-10-27T14:28:56.846Z</common:last-modified-date>
	                    <common:source>
	                        <common:source-client-id>
	                            <common:uri>http://sandbox.orcid.org/client/APP-DAM7BV5YGLGHWOCH</common:uri>
	                            <common:path>APP-DAM7BV5YGLGHWOCH</common:path>
	                            <common:host>sandbox.orcid.org</common:host>
	                        </common:source-client-id>
	                        <common:source-name>Grant System Sandbox Test</common:source-name>
	                    </common:source>
	                    <funding:title>
	                        <common:title>Grant title</common:title>
	                    </funding:title>
	                    <common:external-ids>
	                        <common:external-id>
	                            <common:external-id-type>grant_number</common:external-id-type>
	                            <common:external-id-value>12345</common:external-id-value>
	                            <common:external-id-relationship>self</common:external-id-relationship>
	                        </common:external-id>
	                    </common:external-ids>
	                    <funding:type>grant</funding:type>
	                    <common:start-date>
	                        <common:year>1999</common:year>
	                        <common:month>02</common:month>
	                        <common:day>02</common:day>
	                    </common:start-date>
	                    <common:end-date>
	                        <common:year>2001</common:year>
	                        <common:month>02</common:month>
	                        <common:day>02</common:day>
	                    </common:end-date>
	                </funding:summary>
	            </activities:group>
	        </activities:fundings>

Peer Review

The peer review section of the record captures the researcher's review and service activity. As with funding and works, peer review items are grouped together using the group tag. The group can be a journal, publisher, or organization and is assigned when the peer review item is added to ORCID. Peer review items can only be added by the API; the user is not able to enter new items in this section. Not all details of a peer review item are returned when reading an entire record; to get the details of a particular item, >use the put code to call it individually. In this example, there is one peer review item added by a client integration.

For more about the peer review and the individual fields, see our peer review workflow.

    <activities:peer-reviews  path="/0000-0002-9227-8514/peer-reviews">
      <common:last-modified-date>2016-10-25T18:33:37</common:last-modified-date>
      <activities:group>
        <common:last-modified-date>2016-10-25T18:33:37.267Z</common:last-modified-date>
        <common:external-ids>
          <common:external-id>
            <common:external-id-type>PEER-REVIEW</common:external-id-type>
            <common:external-id-value>issn:1234=1234</common:external-id-value>
          </common:external-id>
        </common:external-ids>
        <peer-review:summary put-code="1374" path="/0000-0002-9227-8514/peer-review/1374" visibility="public" display-index="0">
          <common:created-date>2016-10-25T18:33:37.267Z</common:created-date>
          <common:last-modified-date>2016-10-25T18:33:37.267Z</common:last-modified-date>
          <common:source>
            <common:source-client-id>
              <common:uri>http://sandbox.orcid.org/client/APP-674MCQQR985VZZQ2</common:uri>
              <common:path>APP-674MCQQR985VZZQ2</common:path>
              <common:host>sandbox.orcid.org</common:host>
            </common:source-client-id>
            <common:source-name>State University</common:source-name>
          </common:source>
          <common:external-ids>
            <common:external-id>
              <common:external-id-type>source-work-id</common:external-id-type>
              <common:external-id-value>12345</common:external-id-value>
              <common:external-id-relationship>self</common:external-id-relationship>
            </common:external-id>
          </common:external-ids>
          <peer-review:completion-date>
            <common:year>2016</common:year>
            <common:month>02</common:month>
            <common:day>02</common:day>
          </peer-review:completion-date>
          <peer-review:review-group-id>issn:1234=1234</peer-review:review-group-id>
          <peer-review:convening-organization>
            <common:name>Journal of Psychoceramics</common:name>
            <common:address>
              <common:city>Providence</common:city>
              <common:region>RI</common:region>
              <common:country>US</common:country>
            </common:address>
          </peer-review:convening-organization>
        </peer-review:summary>
      </activities:group>
    </activities:peer-reviews>

Works

The works section records the professional outputs of the researcher. As with funding and peer review, works are grouped together by matching external identifiers using the activites:group tag. Not all details of a work are returned when reading an entire record; to get the details of a particular item, use the put code to call it individually. In this example, two versions of the same work (both with DOI 10.1087/20120404) are on the record, one added by the researcher and another by a client application. The two versions are grouped together and the display-index lets us know the version added by the researcher is the preferred version.

See our user documentation for a full description of each tag in of the works field.

    <activities:works  path="/0000-0002-9227-8514/works">
      <common:last-modified-date>2016-10-25T18:22:26</common:last-modified-date>
      <activities:group>
        <common:last-modified-date>2016-10-25T18:22:26.444Z</common:last-modified-date>
        <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-relationship>self</common:external-id-relationship>
          </common:external-id>
        </common:external-ids>
      <work:work-summary put-code="733536" path="/0000-0002-9227-8514/work/733536" visibility="public" display-index="1">
        <common:created-date>2016-10-25T18:22:26.443Z</common:created-date>
        <common:last-modified-date>2016-10-25T18:22:26.444Z</common:last-modified-date>
          <common:source>
           <common:source-orcid>
             <common:uri>http://sandbox.orcid.org/0000-0002-9227-8514</common:uri>
             <common:path>0000-0002-9227-8514</common:path>
             <common:host>sandbox.orcid.org</common:host>
             <common:source-name>Sofia Maria Hernandez Garcia</common:source-name>
           </common:source-orcid>
         </common:source>
         <work:title>
           <common:title>ORCID: a system to uniquely identify researchers</common:title>
         </work:title>
         <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-relationship>self</common:external-id-relationship>
         </common:external-id>
         <common:external-id>
           <common:external-id-type>issn</common:external-id-type>
           <common:external-id-value>1741-4857</common:external-id-value>
           <common:external-id-relationship>part-of</common:external-id-relationship>
         </common:external-id>
       </common:external-ids>
       <work:type>journal-article</work:type>
         <common:publication-date>
           <common:year>2012</common:year>
           <common:month>10</common:month>
           <common:day>01</common:day>
         </common:publication-date>
       </work:work-summary>
       <work:work-summary put-code="733535" path="/0000-0002-9227-8514/work/733535" visibility="public" display-index="0">
         <common:created-date>2016-10-25T18:19:25.672Z</common:created-date>
            <common:last-modified-date>2016-10-25T18:19:25.672Z</common:last-modified-date>
            <common:source>
              <common:source-client-id>
                <common:uri>http://sandbox.orcid.org/client/APP-674MCQQR985VZZQ2</common:uri>
                <common:path>APP-674MCQQR985VZZQ2</common:path>
                <common:host>sandbox.orcid.org</common:host>
              </common:source-client-id>
              <common:source-name>State University</common:source-name>
            </common:source>
            <work:title>
              <common:title>ORCID: a system to uniquely identify researchers</common:title>
            </work:title>
            <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-relationship>self</common:external-id-relationship>
                </common:external-id>
              </common:external-ids>
             <work:type>journal-article</work:type>
          <common:publication-date>
           <common:year>2012</common:year>
           <common:month>10</common:month>
           <common:day>01</common:day>
         </common:publication-date>
       </work:work-summary>            </activities:group>
        </activities:works>
    </activities:activities-summary>
</record:record>