id-model.3.3.1.source-code.orcid-message-1.0.2.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of orcid-model Show documentation
Show all versions of orcid-model Show documentation
Container for all classes that will be used to marshal and unmarshal XML/JSON from the API
The newest version!
=============================================================================
ORCID (R) Open Source
http://orcid.org
Copyright (c) 2012-2014 ORCID, Inc.
Licensed under an MIT-Style License (MIT)
http://orcid.org/open-source-license
This copyright and license information (including a link to the full license)
shall be included in its entirety in all copies or substantial portion of
the software.
=============================================================================
The schema
describes the message format used for ORCID API requests and responses. The top level
element is orcid-message.
The overall container for all ORCID requests and responses.
The version of ORCID message schema that the orcid-message
uses.
The highest value is the latest version of the schema. If lower
values are shown, this means that documents that are valid against the older
version are also valid against the later version of the schema.
A human readable error message, when the request was unsuccessful.
The container element for a researcher or contributor profile.
A simple history of the researcher or contributor's ORCID profile.
The method used to create the profile.
The profile was created using the Tier 2 API.
The profile was created manually using the ORCID web user
interface.
The date and time when the profile set up was completed.
The date time when the profile was first submitted to ORCID.
True if the researcher or contributor has confirmed that their profile
is correct, after bulk creation by their institution.
The client application that created the profile via the API (if any).
The name of the client application that created the profile.
The ORCID identifier for the client application that created the
profile. Note this is a normal ORCID identifier, so can be used to look up the full
details of the client application.
The identifier of the researcher or contributor in a sponsor's
system.
The biographical details of the researcher or contributor.
Container for the personal details of the researcher or contributor.
Container for URLs of the researcher or contributor's sites.
Container for details of how to contact the researcher or contributor.
A few sentences describing the work of the researcher or contributor
Container for links to the reasearcher or contributor in other
systems.
A link to an external system
Container for the works published by the researcher or contributor.
A work published by the researcher or contributor.
The 13-digit ISBN of a book.
The date that the work was first published.
The cover date exactly as it appeared on the journal issue, in which a
journal article was published.
The name of the publisher that published the work.
Container for titles of the work.
The main title of the work.
The book title if the work is a chapter, or the journal title if the
work is a journal article.
The page range of the work.
The volume in which the work was published, if any.
The issue number in which the work was published, if any.
Container for URLs related to the work.
Container for the contributors to the work (including the
researcher or contributor that this is the list of works for).
The identifier of the researcher or contributor in ORCID.
The given name(s) of the researcher or contributor as it generally
appears on their published works.
The family name of the researcher or contributor as it generally
appears on their published works. This element is optional, because some cultures
only use given names.
The name by which the researcher or contributor would like to be
addressed, for example in an email or on a welcome page.
The name by which the researcher or contributor would prefer to be
indexed by when credited or cited, for example, in an article or index.
Container for variations of the researcher or contributor's name, that
may have appeared on their published works. This could include variations because of
transliterations of their names into different alphabets.
The role of the researcher or contributor at an institution.
The name of the institution.
Container for data that are strictly for internal use only.
The authorization scope that the API client has on this section of
data.
The visiblity that the researcher or contributor has assigned to
this section of data.
The data should only be used internally by ORCID.
The data should only be shared with systems that the
researcher or contributor has specifically granted authorization (using
OAuth).
The data should be publically available.
The data should be shared only with registered users.
Digital Object Identifier
PubMed ID
GenBank number
MIM number
Enzyme Commission number