1.2 XML for orcid-works (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 document for the 2.0 Message Schema.

orcid-work

Within <orcid-works> each individual work is contained in the tag <orcid-work>. That tag and its contents can be repeated as many times as needed for each individual work.

In each <orcid-work>, each child element must occur in the order that it is addressed in this article.

Work title

<work-title> is a container for titles of the work, the titles themselves go in the child elements <title> and <subtitle>. The element <translated-title> can be used to provide a translation of the title into another language, if it is used, it must have the language-code attribute set.

Publication title

<journal-title> is used for the name of the publication the work was original published in (e.g. a book, a journal), if applicable.

Short description

<short-description> is used for a few sentences describing the work, such as an abstract.

Work citation

<work-citation> is a container for <citation-type> and <citation> elements. Only one citation per work is allowed. We recommend that all API users provide citations in BibTeX format as it is machine readable, and it will be included if researchers use the BibTeX export feature.

<citation-type> options:

  • formatted-unspecified
  • bibtex

  • formatted-apa
  • formatted-harvard
  • formatted-ieee
  • formatted-mla
  • formatted-vancouver
  • formatted-chicago

Work type

<work-type> is used to identify the type of the work and is required, and the contents must be selected from the list of Supported Work Types.

Publication date

<publication-date> is a container for the fields <year>, <month>, <day>. <year> is the only required field; <month> and <day> are optional.

External identifiers

<work-external-identifiers> is required and serves as a container for <work-external-identifier>. <work-external-identifier> is itself a container for <work-external-identifier-type> and <work-external-identifier-id>.  <work-external-identifier> and its children can be repeated for additional identifiers.

<work-external-identifier-type> describes the type of identifier and must be selected from the list of Supported Work Identifiers<work-external-identifier-id> is where the identifier itself is recorded.

If a persistent, globally-recognized identifier is not know for the work, a local identifier must be supplied with the type source_work_id.

URL

<url> is used to provide a link to the work.

Contributors

<work-contributors> is a container for <contributor>, which should be repeated for each contributor to the work. The contributor tag includes the following children used to provide information about the individual contributor.

<contributor-orcid>
The ORCID iD of the contributor, expressed in either the <uri> tag or with the <host> and <path> tags. It should only be an ORCID iD that has been collected via authenticated.
<credit-name>
The name of the contributor. If an ORCID iD is included, the credit name from the researcher's ORCID record is used if this field is left blank.
<contributor-email>
The email for the contributor. This field is optional, and always private.
<contributor-attributes>
<contributor-role>
Describes the contribution, and can be selected from the following list:
author,  assignee,  editor,  chair-or-translator,  co-investigator,  co-inventor,  graduate-student,  other-inventor,  principal-investigator,  postdoctoral-researcher,  support-staff,  lead,  co-lead,  supported-by
<contributor-sequence>
Describes the sequence in the contributor list, and can be selected from the following list:
first,  additional

Source

Source information about how and when the work was added to the record is captured automatically by the ORCID Registry in the <source> element. The <source> element contains <source-orcid>, <source-date> and <source-name>. <source-orcid> has 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.  <source-name> holds the client's name, or the user's credit name for works added manually. <source-date> records when this work was added or updated. As these elements are generated by the system when you load the file, you do not need to add them to your XML document.

Language Code

<language-code> is used to record the language used in the other fields describing the work. The value for this field should be an ISO-639-1 code.

EXCEPTION: for Chinese, use zh_CN (Simplified) or zh_TW (Traditional)

Country

<country> is used to record the country the original work was published in when relevant, using the two-letter ISO-3166 country code.