record_3.0.peer-review-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-2018 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 role played by a person in their contribution to a review.
Options for this field are: chair, editor, member, organizer, reviewer
Unique identifier(s) of the review. This identifier refers to the review itself, NOT to the item that was reviewed. At least one identifier is required. In the case where there is no persistent unique identifier for the review, the source providing the data should generate a locally-sourced unique identifier for the review (e.g., type "organization-defined-type"). This field will be checked when adding new reviews to prevent double counting of review activity.
Identifier types must be selected from the list at https://pub.orcid.org/v2.0/identifiers
A link to a representation of the review on the web. This URL refers to the review itself, NOT to the item that was reviewed.
The kind of review. Options for this field are: evaluation, review
The date on which the review was completed. Allowable values: yyyy; yyyy-mm; yyyy-mm-dd, formatted using the ORCID fuzzy date format.
Identifier for the group that this review should be a part of for aggregation purposes
The unique identifier of the subject being reviewed.
Identifier types must be selected from the list at https://pub.orcid.org/v2.0/identifiers
The name of the journal, conference, grant review panel, or other applicable object of which the review subject was a part.
The type of object that the review subject is (for example, a journal article, grant, etc).
The name/title of the object that was reviewed.
The URL of the object that was reviewed.
Information about the organization convening the review (journal publisher, conference organizer, funding agency, etc). A valid organizational identifier (Ringgold ID, ROR ID, GRID ID or FundRef ID is required).
The role played by a person in their
contribution to a review.
The unique identifier of the review.
A link to a representation of the review on the web. This URL refers to the review itself, NOT to the item that was reviewed.
The kind of review applied to the subject type
reviewed
The date on which the review was completed. Allowable values: yyyy; yyyy-mm; yyyy-mm-dd, formatted using the ORCID fuzzy date format.
Identifier for the group that this review should be a part of for aggregation purposes
Information about the organization convening the review (journal publisher, conference organizer, funding agency, etc). Whenever possible, this organization is identified by a unique identifier like the Ringgold ID or FundRef ID.
The type of object that the review subject is, from the list of supported work types in https://members.orcid.org/api/resources/work-types as well as the following types:
* award: Peer-reviewed funding providing direct research costs through competitions
* contract: Works commissioned by external public agencies or industry building on research expertise and aimed at deliverables. Include research contracts awarded by federal agencies for both direct and indirect costs, and honoraria
* grant: Peer-reviewed funding providing direct research costs through competitions
* salary-award: A competitive, peer-reviewed award that is paid as salary to the awardee/faculty member
* research-resource-proposal: A peer-reviewed proposal of use of a research resource
* undefined
ORCID will validate this value against the enumeration
https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/PeerReviewSubjectType.java and other rules when necessary.
The role performed by the reviewer, selected from the following options:
* reviewer: A person who formally assess or examines an
output with a view to
commenting and evaluating it.
* editor: A person who coordinates reviews and/or is
responsible for decision making on the content of a publication.
* member: A person participating in a process, committee or
activity.
* chair: A person who coordinates reviews and/or is
responsible for decision making on the content of a conference.
* organizer: A person who makes arrangements or preparations
for an event or activity.
ORCID will validate this value against the enumeration
https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/Role.java and other rules when necessary
The type of review this is, selected from the following options:
* review: An expert assessment of a scholarly output that
contributes to a decision regarding on the object of the review.
* evaluation: A post-peer review, expert evaluation of a
scholarly output.
ORCID will validate this value against the enumeration
https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/PeerReviewType.java and other rules when necessary
Container for peer-review subject name.
The main name or title of the subject.