common_3.0.common-3.0.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.
Schematron validation
The date time when the element was last modified.
The date time when element was created.
The date time when element was first read by the user.
The date time when element was archived.
The date time when element was sent to the user.
The date time when element was approved.
The client application (Member organization's
system) or user that created the item. XSD VERSION 1.2 UPDATE: the
identifier for the source may be either an ORCID iD (representing
individuals and legacy client applications) or a Client ID
(representing all newer client applications)
The ORCID identifier for the individual user (or
legacy client application) that created the item. For identifiers
of
individual users, it may be used to look up ORCID record
details via
the API.
The client ID for the client application (Member
organization system) that created the item.
The ORCID identifier for the individual user (or
legacy client application) made the assertion.
If missing, source is the same as assertion origin.
The client ID for the client application (Member
organization system) that made the assertion.
If missing, source is the same as assertion origin.
The human-readable name of the client application
(Member organization system) or individual user that created the
item. Value for the same person/organization could change over time.
source-orcid or source-client-id fields are more appropriate for
disambiguated matching.
A reference to an organization. An organization should
contain a disambiguated organization, which uniquely identifies the
organization. While the schema does not enforce the presence of a
disambiguated organization, it is only optional for peer review
convening organizations. A disambiguated organization is mandatory in
all other cases where organization is required in the schema.
Container for organization location information
City
Region within a country
A reference to a disambiguated version the
organization to which the researcher or contributor is affiliated.
The list of disambiguated organizations come from ORCID partners
such as Ringgold, ISNI and FundRef.
The disambiguated organization identifier.
The source for providing the disambiguated
organization ID. For the list of allowed sources see https://github.com/ORCID/ORCID-Source/blob/master/orcid-core/src/main/java/org/orcid/core/orgs/OrgDisambiguatedSourceType.java
For the up to date supported locale list see https://github.com/ORCID/ORCID-Source/SUPPORTED_LOCALES.md
Must contain one or more charaters that are not a
space, carriage return or linefeed
A string that is flagged as transient
i.e. populated by ORCID, not the source.
An error that populated by ORCID when record is read
The funding amount.
The currency code used for funding amounts, from the ISO 4217 list
https://www.iso.org/iso-4217-currency-codes.html .
ORCID will validate this value against the enumeration
java.util.Currency (https://docs.oracle.com/javase/8/docs/api/java/util/Currency.html) and other rules when necessary.
Container for a organization defined type for an
external identifier.
A code to identify the language
that a field value is expressed in, selected from the following options:
ab, aa, af, ak, sq, am, ar, an, hy, as, av, ae, ay, az, bm, ba, eu, be, bn, bh, bi, bs, br, bg, my, ca, ch, ce, zh_CN, zh_TW, cu, cv, kw, co, cr, hr, cs, da, dv, nl, dz, en, eo, et, ee, fo, fj, fi, fr, fy, ff, gl, lg, ka, de, el, kl, gn, gu, ht, ha, iw, hz, hi, ho, hu, is, io, ig, in, ia, ie, iu, ik, ga, it, ja, jv, kn, kr, ks, kk, km, ki, rw, ky, kv, kg, ko, ku, kj, lo, la, lv, li, ln, lt, lu, lb, mk, mg, ms, ml, mt, gv, mi, mr, mh, mo, mn, na, nv, ng, ne, nd, se, no, nb, nn, ny, oc, oj, or, om, os, pi, pa, fa, pl, pt, ps, qu, rm, ro, rn, ru, sm, sg, sa, sc, gd, sr, sn, ii, sd, si, sk, sl, so, nr, st, es, su, sw, ss, sv, tl, ty, tg, ta, tt, te, th, bo, ti, to, ts, tn, tr, tk, tw, ug, uk, ur, uz, ve, vi, vo, wa, cy, wo, xh, ji, yo, za, zu
ORCID will validate this value against the enumeration https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/LanguageCode.java and other rules when necessary.
Represents a URL in the XML anyURI format
Container for address information. Only country
information is included at this time.
Country represented by its ISO 3611 code. The
visibility attribute (private, limited or public) can be set at
record creation, and indicates who can see this section of
information.
Path for the ORCID iD.
ORCID URI for the ORCID iD.
The identifier of the researcher or contributor in
ORCID (the ORCID iD). At least one of uri or path must be given.
NOTE: this type is also used for legacy client IDs.
ORCID iD in URI form (preferred).
ORCID path (16-character identifier) of the
ORCID iD.
ORCID path (16-character identifier) of the
ORCID iD.
ORCID host (base URL) of the ORCID iD.
Path for the API client ID.
ORCID URI for the API client ID.
The identifier of an ORCID API client app. At least
one of uri or path must be given. NOTE: legacy API clients still may
be identified by the orcid-id type.
ORCID host (base URL) of the ORCID iD.
The put-code attribute is present only when reading
elements. The code must be used when PUTing (updating) items that
contain the attribute (works, affiliations, etc) to ensure that the
existing item's history is retained.
The activity-path attribute is present only when
reading elements. It will be of the form /{orcid}/{activity-name}/{put-code} for
activity elements or /{orcid}/person/{element-name}/{put-code} for person element
Indicates who can see the value of the element when
reading the ORCID record. See the enumerations for definitions of
each value, private, limited, public, registered-only.
The data can only be seen by the researcher or
contributor. This data may be used internally by ORCID for Record
disambiguation purposes.
The data can only be seen by trusted parties
(organizations or people) as indicated by the researcher or
contributor. This information is only shared with systems that the
researcher or contributor has specifically granted authorization
(using OAuth).
The data can be seen by anyone. It is publically
available via the ORCID Registry website and the public API
without further authroization by the researcher or contributor.
The data is shared only with the registered user.
Type to represent an email address.
4-digit integer representing a year of a date.
2-digit integer representing a month of a date.
2-digit integer representing a day of a date.
In some places the full date is not required.
Used with the fuzzy-date type. Represents the
year
of the date.
Used with the fuzzy-date type. Represents the
month
of the date.
Used with the fuzzy-date type. Represents the
day
of the date.
ISO 3166-1 alpha-2 country code from https://www.iso.org/iso-3166-country-codes.html .
Contains either a country code or an empty value
An empty string
A non-empty string that has a maximum size of 500
characters
A non-empty string that has a maximum size of 150
characters
A non-empty string that has a maximum size of 200
characters
A non-empty string that has a maximum size of 255
characters
A non-empty string that has a maximum size of 350
characters
A non-empty string that has a maximum size of 1000
characters
A non-empty string that has a maximum size of 2084
characters
A non-empty string that includes a language code to
indicate the language used for the string's value.
A short narrative (few sentences) describing the
item.
Must contain one or more charaters that are not a
space, carriage return or linefeed
The name to use for the researcher or contributor
when credited or cited, for example, in an article or index, or as a
funding contributor. The value of this field also is used as the
display name for the researcher or contributor in the ORCID Registry
in their ORCID Record, or when listed as a contributor on other
ORCID Records. If this element is NULL, given-name family-name will
be used for display purposes, with a visibility of "public". The
visibility attribute (private, limited or public) can be set at
record creation, and indicates who can see this section of
information.
The main name or title of the work. For a
spin-off
company, include use the company name
If the work has a subtitle, include it here.
The main title of the work or funding translated
into another language. The translated language will be included in
the <language-code> attribute.
Email of the collaborator or other contributor.
When provided during creation or update, the email address is used
to look up and add the contributor's ORCID iD.
Provides detail of the nature of the contribution
by the collaborator or other contirbutor.
Indication of where in the contributor list the
collaborator or other contributor's name should appear, selected from the following options:
* first
* additional
ORCID will validate this value against the enumeration
https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/SequenceType.java
The role performed by the collaborator or other contributor.
There are two controlled vocabularies that can be used. Any value not on these lists will be rejected by the API.
Original role values
--------------
author
assignee
editor
chair-or-translator
co-investigator
co-inventor
graduate-student
other-inventor
principal-investigator
postdoctoral-researcher
support-staff
Note: support for original roles will be removed in future versions of the API.
CREDIT role values
------------
http://credit.niso.org/contributor-roles/conceptualization/
http://credit.niso.org/contributor-roles/data-curation/
http://credit.niso.org/contributor-roles/formal-analysis/
http://credit.niso.org/contributor-roles/funding-acquisition/
http://credit.niso.org/contributor-roles/investigation/
http://credit.niso.org/contributor-roles/methodology/
http://credit.niso.org/contributor-roles/project-administration/
http://credit.niso.org/contributor-roles/resources/
http://credit.niso.org/contributor-roles/software/
http://credit.niso.org/contributor-roles/supervision/
http://credit.niso.org/contributor-roles/validation/
http://credit.niso.org/contributor-roles/visualization/
http://credit.niso.org/contributor-roles/writing-original-draft/
http://credit.niso.org/contributor-roles/writing-review-editing/
Note: these roles use URIs as terms, so that they have a distinct namespace from the original roles.
More information on roles can be found in our documentation at https://info.orcid.org/documentation/integration-and-api-faq/#easy-faq-2721
Indicates the relationship type, selected from the following options:
* part-of
* self
* version-of
* funded-by
ORCID will validate this value against the enumeration
https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/Relationship.java and other rules when necessary.
A reference to an external identifier, suitable for works, people and funding.
Supported external-id-type values can be found at https://pub.orcid.org/v2.0/identifiers
Container for storing external ids
Identifier for the group that this review should be a part of for aggregation purposes