id-model.3.0.10.source-code.orcid-message-1.0.17.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
=============================================================================
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.
Schematron validation
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 date and time when the profile set up was completed.
The date time when the profile was first submitted to ORCID.
The date time when the profile was last modified.
True if the researcher or contributor has confirmed that their profile
is correct, after bulk creation by their institution.
The date and time when the profile was deactivated
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 source's
system.
The date time that the source created/attempted to create the ORCID.
The biographical details of the researcher or contributor.
Container for the personal details of the researcher or contributor.
Description of the researcher's professional career
Container for URLs of the researcher or contributor's sites.
Container for details of how to contact the researcher or contributor.
Wrong number of primary emails
Contain for words or phrases describing areas of research
A few sentences describing the element in question
Container for the list of affiliations associated with the researcher or contributor
Container for links to the reasearcher or contributor in other
systems.
A link to an external system
ORCID identifier used for external
Contain for functionality that has not yet been built
Container for Authorizations. Not used by the API.
Container for the works, grants and patents published by the researcher or contributor.
Container for the works published by the researcher or contributor.
A work published by the researcher or contributor.
Element containing the type and content of the citation for this work
Container for storing the external references to the work.
Supported locales
The type of work, e.g DOI, PMID etc.
Value for the identifier
Container for the source of a work.
Must contain one or more charaters that are not a space, carage return or linefeed
Container for the contributors of a patent.
Container for the grants received by the researcher or contributor
A grant received by the researcher or contributor.
Agency providing the funding
Name of funding agency
The ORCID identifier for the agency providing the funding associated with this
profile. Note this is a normal ORCID identifier, so can be used to look up the full
details of the client application.
A link to an external system
The program that created the id
Value for the identifier
Grant number
The date the grant was provided.
Container for the contributors of a grant.
A link to an external system
Container for the sources of a grant.
Container for the patents invented by the researcher or contributor
The date the patent was issued.
Container for the contributors of a patent.
Container for the sources of a patent.
The date that the work was first published.
Container for titles of the work.
Text field for the individual's title.
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 identifier of the researcher or contributor in ORCID.
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 to when credited or cited, for example, in an article or index, or as a
grant contributor.
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.
Container for location information
Country of the Institution
Container for data that are strictly for internal use only.
Preferences externally exposed
Preferences only for internal use
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 code to be used when PUTing a collection of works, grants or patents to ensure
that the existing item's history is retained
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.
The profile was created using the Tier 2 API.
The profile was created manually using the ORCID web user
interface.
Element to contain a citation of a given type
The types of citation allowed in this element. Note that this must be selected