orcid_client 0.6.0 → 0.9.3

data/resources/record_3.0/expanded-search-3.0.xsd

@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+	elementFormDefault="qualified" targetNamespace="http://www.orcid.org/ns/expanded-search"
+	xmlns:expanded-search="http://www.orcid.org/ns/expanded-search">
+	<xs:annotation>
+		<xs:documentation>
+			=============================================================================
+
+			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.
+		</xs:documentation>
+	</xs:annotation>
+
+	<xs:element name="expanded-search">
+		<xs:complexType>
+			<xs:annotation>
+				<xs:documentation>The container element for the results when
+					performing a search on the ORCID Registry. the num-found attribute
+					indicates the number of successful matches.
+				</xs:documentation>
+			</xs:annotation>
+			<xs:sequence>
+				<xs:element name="expanded-result" type="expanded-search:expanded-result"
+					minOccurs="0" maxOccurs="unbounded" />
+			</xs:sequence>
+			<xs:attribute name="num-found" type="xs:integer"
+				default="0" />
+		</xs:complexType>
+	</xs:element>
+
+	<xs:complexType name="expanded-result">
+		<xs:annotation>
+			<xs:documentation>A single expanded search result when performing a
+				search on the
+				ORCID Registry.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element name="orcid-id" type="xs:string" minOccurs="1">
+				<xs:annotation>
+					<xs:documentation>ORCID iD.
+					</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="given-names" type="xs:string" minOccurs="0">
+				<xs:annotation>
+					<xs:documentation>Given names.
+					</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="family-names" type="xs:string"
+				minOccurs="0">
+				<xs:annotation>
+					<xs:documentation>Family names.
+					</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="credit-name" type="xs:string" minOccurs="0">
+				<xs:annotation>
+					<xs:documentation>Credit name.
+					</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="other-name" type="expanded-search:other-name"
+				minOccurs="0" maxOccurs="unbounded">
+				<xs:annotation>
+					<xs:documentation>Other names
+					</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="email" type="expanded-search:email"
+                minOccurs="0" maxOccurs="unbounded">
+                <xs:annotation>
+                    <xs:documentation>Emails
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
+			<xs:element name="institution-name" type="expanded-search:institution-name"
+				minOccurs="0" maxOccurs="unbounded">
+				<xs:annotation>
+					<xs:documentation>Other names
+					</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+		</xs:sequence>
+	</xs:complexType>
+
+	<xs:simpleType name="other-name">
+		<xs:restriction base="xs:string" />
+	</xs:simpleType>
+	<xs:simpleType name="institution-name">
+		<xs:restriction base="xs:string" />
+	</xs:simpleType>
+	<xs:simpleType name="email">
+        <xs:restriction base="xs:string" />
+    </xs:simpleType>
+</xs:schema>

data/resources/record_3.0/funding-3.0.xsd

@@ -0,0 +1,204 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+	xmlns:sch="http://purl.oclc.org/dsdl/schematron" elementFormDefault="qualified"
+	targetNamespace="http://www.orcid.org/ns/funding" xmlns:funding="http://www.orcid.org/ns/funding"
+	xmlns:common="http://www.orcid.org/ns/common">
+	<xs:annotation>
+		<xs:documentation>
+			=============================================================================
+
+			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.
+		</xs:documentation>
+		<xs:appinfo>
+			<sch:title>Schematron validation</sch:title>
+			<sch:ns prefix="orcid" uri="http://www.orcid.org/ns/orcid" />
+		</xs:appinfo>
+	</xs:annotation>
+
+	<xs:import namespace="http://www.orcid.org/ns/common"
+		schemaLocation="../common_3.0/common-3.0.xsd" />
+
+	<xs:element name="funding">
+		<xs:annotation>
+			<xs:documentation>Funding received by the researcher or contributor.
+				* REQUIRED FIELDS: Funding-type, Funding-title, Funding Agency
+				(organization)
+				* The put-code attribute is returned when reading this element. 
+				When updating the item, the put-code attribute must be included to indicate the specific item to be updated.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:complexType>
+			<xs:complexContent>
+				<xs:extension base="common:element-summary">
+					<xs:sequence>
+						<xs:element name="type" type="funding:funding-type"
+							minOccurs="1" maxOccurs="1" />
+						<xs:element name="organization-defined-type" type="common:organization-defined-type"
+							minOccurs="0" maxOccurs="1" />
+						<xs:element name="title" type="funding:funding-title"
+							minOccurs="0" />
+						<xs:element name="short-description" type="common:short-description"
+							minOccurs="0" />
+						<xs:element name="amount" type="common:amount"
+							minOccurs="0" maxOccurs="1" />
+						<xs:element ref="common:url" minOccurs="0" maxOccurs="1"/>
+						<xs:element ref="common:start-date" minOccurs="0"
+							maxOccurs="1">
+							<xs:annotation>
+								<xs:documentation>Start date for the funding.</xs:documentation>
+							</xs:annotation>
+						</xs:element>
+						<xs:element ref="common:end-date" minOccurs="0"
+							maxOccurs="1">
+							<xs:annotation>
+								<xs:documentation>End date for the funding.</xs:documentation>
+							</xs:annotation>
+						</xs:element>
+						<xs:element ref="common:external-ids"
+							minOccurs="0" />
+						<xs:element name="contributors" type="funding:contributors"
+							minOccurs="0" />
+						<xs:element ref="common:organization" minOccurs="1" maxOccurs="1"/>
+					</xs:sequence>
+				</xs:extension>
+			</xs:complexContent>
+		</xs:complexType>
+	</xs:element>
+
+	<xs:element name="funding-summary">
+		<xs:complexType>
+			<xs:complexContent>
+				<xs:extension base="common:element-summary">
+					<xs:sequence>
+						<xs:element name="title" type="funding:funding-title"
+							minOccurs="1" />
+						<xs:element ref="common:external-ids"
+							minOccurs="0" />
+						<xs:element ref="common:url" minOccurs="0" maxOccurs="1"/>
+						<xs:element name="type" type="funding:funding-type"
+							minOccurs="1" maxOccurs="1" />
+						<xs:element ref="common:start-date" minOccurs="0"
+							maxOccurs="1">
+							<xs:annotation>
+								<xs:documentation>Start date for the funding.</xs:documentation>
+							</xs:annotation>
+						</xs:element>
+						<xs:element ref="common:end-date" minOccurs="0"
+							maxOccurs="1">
+							<xs:annotation>
+								<xs:documentation>End date for the funding.</xs:documentation>
+							</xs:annotation>
+						</xs:element>
+						<xs:element ref="common:organization" minOccurs="1" maxOccurs="1"/>
+					</xs:sequence>
+				</xs:extension>
+			</xs:complexContent>
+		</xs:complexType>
+	</xs:element>
+
+	<xs:complexType name="funding-title">
+		<xs:annotation>
+			<xs:documentation>Container for titles of the funding.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element ref="common:title">
+				<xs:annotation>
+					<xs:documentation>The main name or title of the funding.
+					</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element ref="common:translated-title" minOccurs="0" />
+		</xs:sequence>
+	</xs:complexType>
+
+	<xs:simpleType name="funding-type">
+		<xs:annotation>
+			<xs:documentation>
+			The type of funding, selected from the following options:
+    		* 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
+    		ORCID will validate this value against the enumeration 
+			https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/FundingType.java and other rules when necessary
+			</xs:documentation>
+		</xs:annotation>
+
+		<xs:restriction base="xs:string" />
+	</xs:simpleType>
+	
+	<xs:complexType name="contributors">
+		<xs:annotation>
+			<xs:documentation>Container for the contributors of a funding.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element maxOccurs="unbounded" minOccurs="0" name="contributor"
+				type="funding:contributor" />
+		</xs:sequence>
+	</xs:complexType>
+
+	<xs:complexType name="contributor">
+		<xs:annotation>
+			<xs:documentation>A collaborator or other contributor to the funding.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element ref="common:contributor-orcid" minOccurs="0"
+				maxOccurs="1" />
+			<xs:element name="credit-name" type="common:credit-name"
+				minOccurs="0" maxOccurs="1" />
+			<xs:element name="contributor-email" type="common:contributor-email"
+				minOccurs="0" maxOccurs="1" />
+			<xs:element name="contributor-attributes" type="funding:contributor-attributes"
+				minOccurs="0" maxOccurs="1" />
+		</xs:sequence>
+	</xs:complexType>
+
+	<xs:complexType name="contributor-attributes">
+		<xs:annotation>
+			<xs:documentation>Provides detail of the nature of the contribution
+				by the collaborator or other contirbutor.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element name="contributor-role" type="funding:contributor-role"
+				minOccurs="0" />
+		</xs:sequence>
+	</xs:complexType>
+
+	<xs:simpleType name="contributor-role">
+		<xs:annotation>
+			<xs:documentation>The role performed by the collaborator or other
+				contributor, selected from the following options:
+    			* lead
+    			* co-lead:
+    			* supported-by
+    			* other-contribution
+				ORCID will validate this value against the enumeration 
+				https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/FundingContributorRole.java and other rules when necessary
+			</xs:documentation>
+		</xs:annotation>
+		<xs:restriction base="xs:string" />
+	</xs:simpleType>
+
+</xs:schema>

data/resources/record_3.0/history-3.0.xsd

@@ -0,0 +1,185 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+	xmlns:sch="http://purl.oclc.org/dsdl/schematron" elementFormDefault="qualified"
+	targetNamespace="http://www.orcid.org/ns/history" xmlns:history="http://www.orcid.org/ns/history"
+	xmlns:common="http://www.orcid.org/ns/common">
+	<xs:annotation>
+		<xs:documentation>
+			=============================================================================
+
+			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.
+		</xs:documentation>
+		<xs:appinfo>
+			<sch:title>Schematron validation</sch:title>
+			<sch:ns prefix="orcid" uri="http://www.orcid.org/ns/orcid" />
+		</xs:appinfo>
+	</xs:annotation>
+	
+	<xs:import namespace="http://www.orcid.org/ns/common"
+		schemaLocation="../common_3.0/common-3.0.xsd" />
+	
+	<xs:element name="history">
+		<xs:complexType>
+			<xs:annotation>
+				<xs:documentation>The history of the researcher's ORCID record
+				</xs:documentation>
+			</xs:annotation>
+			<xs:sequence>
+				<xs:element name="creation-method" type="history:creation-method"
+					minOccurs="0" maxOccurs="1">
+					<xs:annotation>
+						<xs:documentation>The method used to create the ORCID Record
+							* API method - Institution created the record on behalf of the
+							individual
+							* Direct/website methods - Individual registered directly at
+							orcid.org
+							* Member-referred method - Individual registered as
+							part of the OAuth workflow
+						</xs:documentation>
+					</xs:annotation>
+				</xs:element>
+				<xs:element name="completion-date" type="history:completion-date"
+					minOccurs="0" maxOccurs="1" />
+				<xs:element name="submission-date" type="history:submission-date"
+					minOccurs="0" maxOccurs="1" />
+				<xs:element ref="common:last-modified-date"
+					minOccurs="0" maxOccurs="1" />
+				<xs:element name="claimed" type="history:claimed" minOccurs="0"
+					maxOccurs="1" />
+				<xs:element ref="common:source" minOccurs="0" maxOccurs="1" />
+				<xs:element name="deactivation-date" type="history:deactivation-date"
+					minOccurs="0" maxOccurs="1" />
+				<xs:element name="verified-email" type="xs:boolean"
+					minOccurs="1" maxOccurs="1">
+					<xs:annotation>
+						<xs:documentation>True if the user has a verified email
+						</xs:documentation>
+					</xs:annotation>
+				</xs:element>
+				<xs:element name="verified-primary-email" type="xs:boolean"
+					minOccurs="1" maxOccurs="1">
+					<xs:annotation>
+						<xs:documentation>True if the user's current primary email is verified
+						</xs:documentation>
+					</xs:annotation>
+				</xs:element>
+			</xs:sequence>
+			<xs:attribute name="visibility" type="common:visibility" />
+		</xs:complexType>
+	</xs:element>
+	
+	<xs:complexType name="completion-date">
+		<xs:annotation>
+			<xs:documentation>Only returned on records with a creation method of API, this date is when the user took control of the record and set a password
+			</xs:documentation>
+		</xs:annotation>
+		<xs:simpleContent>
+			<xs:extension base="xs:dateTime" />
+		</xs:simpleContent>
+	</xs:complexType>
+	
+	<xs:complexType name="submission-date">
+		<xs:annotation>
+			<xs:documentation>The date time when the ORCID record was first created.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:simpleContent>
+			<xs:extension base="xs:dateTime" />
+		</xs:simpleContent>
+	</xs:complexType>
+	
+	<xs:complexType name="claimed">
+		<xs:annotation>
+			<xs:documentation>True for all records created via direct/website or member-referred. 
+			If the record was created via the API this will be set to True when the user takes control of the record and sets a password.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:simpleContent>
+			<xs:extension base="xs:boolean" />
+		</xs:simpleContent>
+	</xs:complexType>
+	
+	<xs:complexType name="deactivation-date">
+		<xs:annotation>
+			<xs:documentation>The date and time when the ORCID Record was
+				deactivated. (If the account is active, this field will be NULL.)
+			</xs:documentation>
+		</xs:annotation>
+		<xs:simpleContent>
+			<xs:extension base="xs:dateTime" />
+		</xs:simpleContent>
+	</xs:complexType>
+	
+	<xs:complexType mixed="true" name="source-reference">
+		<xs:annotation>
+			<xs:documentation>(UNUSED) The identifier or other reference
+				information for the researcher or contributor in the source client
+				application (Member Organization's) system.
+			</xs:documentation>
+		</xs:annotation>
+	</xs:complexType>
+	
+	<xs:complexType name="source-date">
+		<xs:annotation>
+			<xs:documentation>The date time that the source client application
+				(Member organization system) or individual user created/attempted to
+				create the item.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:simpleContent>
+			<xs:extension base="xs:dateTime" />
+		</xs:simpleContent>
+	</xs:complexType>
+	
+	<xs:simpleType name="creation-method">
+		<xs:annotation>
+			<xs:documentation>Indicates how the ORCID record was created.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:restriction base="common:non-empty-string">
+			<xs:enumeration value="API">
+				<xs:annotation>
+					<xs:documentation>The ORCID Record was created using the ORCID Member API.
+					</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
+			<xs:enumeration value="Direct">
+				<xs:annotation>
+					<xs:documentation>The user registered on the ORCID website.
+					</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
+			<xs:enumeration value="Member-referred">
+				<xs:annotation>
+					<xs:documentation>The user registered as part of the OAuth process.
+					</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
+			<xs:enumeration value="website">
+				<xs:annotation>
+					<xs:documentation>DEPRECATED use Direct instead.
+					</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
+		</xs:restriction>
+	</xs:simpleType>
+
+</xs:schema>