orcid_client 0.1

data/resources/record_2.0_rc3/error-2.0_rc3.xsd

@@ -0,0 +1,84 @@
+<?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/error" xmlns:error="http://www.orcid.org/ns/error"
+	xmlns:common="http://www.orcid.org/ns/common">
+	<xs:annotation>
+		<xs:documentation>
+			=============================================================================
+
+			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.
+		</xs:documentation>
+		<xs:appinfo>
+			<sch:title>Schematron validation</sch:title>
+			<sch:ns prefix="error" uri="http://www.orcid.org/ns/error" />
+		</xs:appinfo>
+	</xs:annotation>
+
+	<xs:element name="error">
+		<xs:complexType>
+			<xs:sequence>
+				<xs:element name="response-code" type="xs:int">
+					<xs:annotation>
+						<xs:documentation>
+							The HTTP response code that was also used in the response header.
+						</xs:documentation>
+					</xs:annotation>
+				</xs:element>
+				<xs:element name="developer-message" type="xs:string">
+					<xs:annotation>
+						<xs:documentation>
+							Debugging information for the API client developer, e.g. schema validation
+							error message.
+						</xs:documentation>
+					</xs:annotation>
+				</xs:element>
+				<xs:element name="user-message" type="xs:string"
+					minOccurs="0">
+					<xs:annotation>
+						<xs:documentation>
+							An error message that would be suitable to display to the user in
+							the application using the ORCID API.
+							If possible, this will be in the language of the locale specified
+							by the user in ORCID.
+						</xs:documentation>
+					</xs:annotation>
+				</xs:element>
+				<xs:element name="error-code" type="xs:integer" minOccurs="0">
+					<xs:annotation>
+						<xs:documentation>
+							The ORCID error code that defines the specific type of error. A full
+							list of codes can be found at
+							http://support.orcid.org/knowledgebase/articles/....
+						</xs:documentation>
+					</xs:annotation>
+				</xs:element>
+				<xs:element name="more-info" type="xs:anyURI" minOccurs="0">
+					<xs:annotation>
+						<xs:documentation>
+							A URL of a page giving more info about the error.
+						</xs:documentation>
+					</xs:annotation>
+				</xs:element>
+			</xs:sequence>
+		</xs:complexType>
+	</xs:element>
+</xs:schema>

data/resources/record_2.0_rc3/funding-2.0_rc3.xsd

@@ -0,0 +1,257 @@
+<?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-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.
+		</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_2.0_rc3/common-2.0_rc3.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 visibility attribute (private, limited or
+				public) can be set at
+				record creation, and indicates who can see this
+				section of
+				information.
+				* The put-code attribute is used only when
+				reading this element. When
+				updating the item, the put-code attribute
+				must be included to
+				indicate the specific record 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 name="url" type="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 name="organization" type="common:organization"
+							minOccurs="1" maxOccurs="1" />
+					</xs:sequence>
+				</xs:extension>
+			</xs:complexContent>
+		</xs:complexType>
+	</xs:element>
+
+	<xs:element name="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 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: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, it could be grant, contract,
+				award or salary-award.
+			</xs:documentation>
+		</xs:annotation>
+
+		<xs:restriction base="xs:string">
+			<xs:enumeration value="grant" />
+			<xs:enumeration value="contract" />
+			<xs:enumeration value="award" />
+			<xs:enumeration value="salary-award" />
+		</xs:restriction>
+	</xs:simpleType>
+<!--
+	<xs:complexType name="external-identifiers">
+		<xs:annotation>
+			<xs:documentation>Container for storing the external references to
+				the funding.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element maxOccurs="unbounded" minOccurs="0"
+				name="externalIdentifier" type="funding:external-identifier" />
+		</xs:sequence>
+	</xs:complexType>
+ 
+	<xs:complexType name="external-identifier">
+		<xs:annotation>
+			<xs:documentation>An external identifier that uniquely represents the
+				funding. Includes an identifier type and value as well as a URL for
+				a link to more information about the funding.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:complexContent>
+			<xs:extension base="common:external-identifier">
+				<xs:sequence>
+					<xs:element name="external-identifier-type" type="funding:external-identifier-type"
+						minOccurs="1" maxOccurs="1" />
+					<xs:element name="external-identifier-value" type="common:string-2084"
+						minOccurs="0" maxOccurs="1">
+						<xs:annotation>
+							<xs:documentation>Value of the external identifier.</xs:documentation>
+						</xs:annotation>
+					</xs:element>			
+				</xs:sequence>
+			</xs:extension>
+		</xs:complexContent>		
+	</xs:complexType>
+
+	<xs:simpleType name="external-identifier-type">
+		<xs:annotation>
+			<xs:documentation>The type of the funding external identifier.
+				Currently only grant number is supported.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:restriction base="xs:string">
+			<xs:enumeration value="grant_number" />
+		</xs:restriction>
+	</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 a work or
+				other orcid-activity
+			</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.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:restriction base="xs:string">
+			<xs:enumeration value="lead" />
+			<xs:enumeration value="co-lead" />
+			<xs:enumeration value="supported-by" />
+			<xs:enumeration value="other-contribution" />
+		</xs:restriction>
+	</xs:simpleType>
+
+</xs:schema>

data/resources/record_2.0_rc3/history-2.0_rc3.xsd

@@ -0,0 +1,203 @@
+<?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-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.
+		</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_2.0_rc3/common-2.0_rc3.xsd" />
+	
+	<xs:element name="history">
+		<xs:complexType>
+			<xs:annotation>
+				<xs:documentation>A simple history of the researcher or
+					contributor's
+					ORCID Record. The visibility attribute (private, limited or public)
+					can be set at record creation, and indicates who can see this
+					section of information.
+				</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 method - Individual registered directly at
+							orcid.org
+							* Member-referrred method - Individual registered as
+							part
+							of a workflow such as submitting a manuscript or applying
+							for a
+							grant
+						</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>The date and time when the ORCID Record set up was
+				completed.
+			</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 and iD 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 if the researcher or contributor has added a
+				password
+				to assume ownership of their ORCID Record after bulk
+				creation
+				by their institution.
+			</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 and iD were 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 /register page.
+					</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
+			<xs:enumeration value="Member-referred">
+				<xs:annotation>
+					<xs:documentation>The registered on the /oauth/signin.
+					</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
+			<xs:enumeration value="website">
+				<xs:annotation>
+					<xs:documentation>DEPRECATED use Direct or Member-referred
+						instead.
+						The method used to create the ORCID Record (Website or
+						API).
+					</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
+		</xs:restriction>
+	</xs:simpleType>
+
+</xs:schema>