orcid_client 0.8 → 0.9

data/resources/record_3.0/samples/write_samples/researcher-url-3.0-no-name.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<researcher-url:researcher-url xmlns:researcher-url="http://www.orcid.org/ns/researcher-url"
+	xmlns:common="http://www.orcid.org/ns/common" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://www.orcid.org/ns/researcher-url ../researcher-url-3.0.xsd">
+	<researcher-url:url>https://site1.com/</researcher-url:url>	
+</researcher-url:researcher-url>

data/resources/record_3.0/samples/write_samples/researcher-url-3.0.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<researcher-url:researcher-url xmlns:researcher-url="http://www.orcid.org/ns/researcher-url"
+	xmlns:common="http://www.orcid.org/ns/common" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://www.orcid.org/ns/researcher-url ../researcher-url-3.0.xsd">
+	<researcher-url:url-name>Site # 1</researcher-url:url-name>
+	<researcher-url:url>https://site1.com/</researcher-url:url>	
+</researcher-url:researcher-url>

data/resources/record_3.0/samples/write_samples/service-3.0.xml

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?> 
+<service:service 
+	xmlns:service="http://www.orcid.org/ns/service" xmlns:common="http://www.orcid.org/ns/common"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://www.orcid.org/ns/service ../service-3.0.xsd ">	
+	<common:department-name>department-name</common:department-name>
+	<common:role-title>role-title</common:role-title>
+	<common:start-date>
+		<common:year>1948</common:year>
+		<common:month>02</common:month>
+		<common:day>02</common:day>
+	</common:start-date>
+	<common:end-date>
+		<common:year>1948</common:year>
+		<common:month>02</common:month>
+		<common:day>02</common:day>
+	</common:end-date>
+	<common:organization>
+		<common:name>common:name</common:name>
+		<common:address>
+			<common:city>common:city</common:city>
+			<common:region>common:region</common:region>
+			<common:country>AF</common:country>
+		</common:address>
+		<common:disambiguated-organization>
+            <common:disambiguated-organization-identifier>http://dx.doi.org/10.13039/100000001</common:disambiguated-organization-identifier>
+			<common:disambiguation-source>FUNDREF</common:disambiguation-source>
+        </common:disambiguated-organization>
+	</common:organization>		
+	<common:url>http://tempuri.org</common:url>  	
+	<common:external-ids>
+        <common:external-id>
+            <common:external-id-type>grant_number</common:external-id-type>
+            <common:external-id-value>external-identifier-value</common:external-id-value>          
+            <common:external-id-url>http://tempuri.org</common:external-id-url>
+            <common:external-id-relationship>self</common:external-id-relationship>
+        </common:external-id>
+        <common:external-id>
+            <common:external-id-type>grant_number</common:external-id-type>
+            <common:external-id-value>external-identifier-value2</common:external-id-value>         
+            <common:external-id-url>http://tempuri.org/2</common:external-id-url>
+            <common:external-id-relationship>self</common:external-id-relationship>
+        </common:external-id>
+    </common:external-ids>
+</service:service>

data/resources/record_3.0/samples/write_samples/work-full-3.0.xml

@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<work:work
+	xmlns:common="http://www.orcid.org/ns/common" xmlns:work="http://www.orcid.org/ns/work"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://www.orcid.org/ns/work /work-3.0.xsd ">	
+	<work:title>
+		<common:title>Work Title</common:title>
+		<common:subtitle>Sub title</common:subtitle>
+		<common:translated-title language-code="en">Translated-title</common:translated-title>
+	</work:title>
+	<work:journal-title>Journal Title</work:journal-title>
+	<work:short-description>Short description</work:short-description>
+	<work:citation>
+		<work:citation-type>bibtex</work:citation-type>
+		<work:citation-value>
+			@article {ORCID2012,
+			title = "ORCID: a system to uniquely identify researchers",
+			journal = "Learned Publishing",
+			year = "2012",
+			doi = "doi:10.1087/20120404"
+			}</work:citation-value>
+	</work:citation>
+	<work:type>journal-article</work:type>
+	<common:publication-date>
+		<common:year>2012</common:year>
+		<common:month>10</common:month>
+		<common:day>01</common:day>
+	</common:publication-date>
+	<common:external-ids>
+		<common:external-id>
+			<common:external-id-type>doi</common:external-id-type>
+			<common:external-id-value>10.1087/20120404</common:external-id-value>			
+			<common:external-id-url>https://doi.org/10.1087/20120404</common:external-id-url>
+			<common:external-id-relationship>version-of</common:external-id-relationship>
+		</common:external-id>
+		<common:external-id>
+			<common:external-id-type>doi</common:external-id-type>
+			<common:external-id-value>work:doi</common:external-id-value>			
+			<common:external-id-url>http://orcid.org</common:external-id-url>
+			<common:external-id-relationship>self</common:external-id-relationship>
+		</common:external-id>
+	</common:external-ids>
+	<common:url>http://alt-uri.org</common:url>
+	<work:contributors>
+		<work:contributor>
+			<common:contributor-orcid>
+				<common:uri>https://orcid.org/0000-0001-5109-3700</common:uri>
+				<common:path>0000-0001-5109-3700</common:path>
+				<common:host>orcid.org</common:host>
+			</common:contributor-orcid>
+			<work:credit-name>Laure L. Haak</work:credit-name>
+			<work:contributor-attributes>
+				<work:contributor-sequence>first</work:contributor-sequence>
+				<work:contributor-role>author</work:contributor-role>
+			</work:contributor-attributes>
+		</work:contributor>
+	</work:contributors>
+	<common:language-code>en</common:language-code>
+	<common:country>US</common:country>	
+</work:work>

data/resources/record_3.0/samples/write_samples/work-simple-3.0.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<work:work
+	xmlns:common="http://www.orcid.org/ns/common" xmlns:work="http://www.orcid.org/ns/work"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://www.orcid.org/ns/work /work-3.0.xsd ">	
+	<work:title>
+		<common:title>Work Title</common:title>
+	</work:title>
+	<work:type>journal-article</work:type>
+	<common:external-ids>
+		<common:external-id>
+			<common:external-id-type>doi</common:external-id-type>
+			<common:external-id-value>10.1087/20120404</common:external-id-value>			
+			<common:external-id-url>https://doi.org/10.1087/20120404</common:external-id-url>
+			<common:external-id-relationship>self</common:external-id-relationship>
+		</common:external-id>
+	</common:external-ids>
+</work:work>

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

@@ -0,0 +1,62 @@
+<?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/search"
+	xmlns:search="http://www.orcid.org/ns/search"
+	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:annotation>
+    <xs:import namespace="http://www.orcid.org/ns/common"
+        schemaLocation="../common_3.0/common-3.0.xsd" />
+
+	<xs:element name="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="result" type="search:result" minOccurs="0"
+					maxOccurs="unbounded" />
+			</xs:sequence>
+			<xs:attribute name="num-found" type="xs:integer" default="0" />
+		</xs:complexType>
+	</xs:element>
+
+	<xs:complexType name="result">
+		<xs:annotation>
+			<xs:documentation>A single result when performing a search on the
+				ORCID Registry.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element ref="common:orcid-identifier" maxOccurs="1" />
+		</xs:sequence>
+	</xs:complexType>
+
+</xs:schema>

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

@@ -0,0 +1,51 @@
+<?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/service" xmlns:service="http://www.orcid.org/ns/service"
+	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.
+		</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="service" type="common:affiliation">
+		<xs:annotation>
+			<xs:documentation>A service associated with the researcher.
+			Service is defined as significant donations of time, money, or other resources to an organization or community
+				* 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:element>
+
+	<xs:element name="service-summary" type="common:affiliation-summary" />
+	
+</xs:schema>

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

@@ -0,0 +1,269 @@
+<?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/work" xmlns:work="http://www.orcid.org/ns/work"
+	xmlns:common="http://www.orcid.org/ns/common" xmlns:error="http://www.orcid.org/ns/error">
+	<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:import namespace="http://www.orcid.org/ns/error"
+ 		schemaLocation="error-3.0.xsd" />
+
+	<xs:element name="work">
+		<xs:complexType>
+			<xs:annotation>
+				<xs:documentation>A work is any research output that the researcher produced or contributed to
+					* 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:complexContent>
+				<xs:extension base="common:element-summary">
+					<xs:sequence>
+
+						<xs:element name="title" type="work:work-title"
+							minOccurs="1" />
+						<xs:element name="journal-title" type="common:string-1000"
+							minOccurs="0" maxOccurs="1">
+							<xs:annotation>
+                                <xs:documentation>The title of the publication or group under which
+                                    the work was published.
+                                    * If a journal, include the journal title of the work.
+                                    * If a book chapter, use the book title.
+                                    * If a translation or a manual, use the series title.
+                                    * If a dictionary entry, use the dictionary title.
+                                    * If a conference poster, abstract or paper, use the conference name.
+                                </xs:documentation>
+                            </xs:annotation>
+						</xs:element>
+						<xs:element name="short-description" type="common:short-description"
+							minOccurs="0" />
+						<xs:element name="citation" minOccurs="0" type="work:citation">
+							<xs:annotation>
+								<xs:documentation>Element containing the type and content of the
+									citation for this work
+								</xs:documentation>
+							</xs:annotation>
+						</xs:element>
+						<xs:element name="type" type="work:work-type">
+							<xs:annotation>
+								<xs:documentation>Required. The type of work
+								</xs:documentation>
+							</xs:annotation>
+						</xs:element>
+						<xs:element ref="common:publication-date" minOccurs="0" />
+						<xs:element ref="common:external-ids"
+							minOccurs="0">
+							<xs:annotation>
+								<xs:documentation>Required when writing work items. The list of supported identifier types is at https://pub.qa.orcid.org/v2.0/identifiers
+								</xs:documentation>
+							</xs:annotation>
+						</xs:element>
+						<xs:element ref="common:url" minOccurs="0" maxOccurs="1"/>
+						<xs:element name="contributors" type="work:work-contributors"
+							minOccurs="0" />
+						<xs:element ref="common:language-code" minOccurs="0"
+							maxOccurs="1">
+							<xs:annotation>
+								<xs:documentation>The language used for the metadata provided about the work
+								</xs:documentation>
+							</xs:annotation>
+						</xs:element>
+						<xs:element ref="common:country" minOccurs="0" />
+					</xs:sequence>
+				</xs:extension>
+			</xs:complexContent>
+		</xs:complexType>
+	</xs:element>
+
+	<xs:element name="work-summary">
+		<xs:complexType>
+			<xs:complexContent>
+				<xs:extension base="common:element-summary">
+					<xs:sequence>
+						<xs:element name="title" type="work:work-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="work:work-type" />
+						<xs:element ref="common:publication-date" minOccurs="0" />
+						<xs:element name="journal-title" type="common:string-1000"
+                            minOccurs="0" maxOccurs="1">
+                            <xs:annotation>
+					            <xs:documentation>The title of the publication or group under which
+					                the work was published.
+					                * If a journal, include the journal title of the work.
+					                * If a book chapter, use the book title.
+					                * If a translation or a manual, use the series title.
+					                * If a dictionary entry, use the dictionary title.
+					                * If a conference poster, abstract or paper, use the conference name.
+					            </xs:documentation>
+					        </xs:annotation>
+                        </xs:element>
+					</xs:sequence>
+				</xs:extension>
+			</xs:complexContent>
+		</xs:complexType>
+	</xs:element>
+
+	<xs:simpleType name="work-type">
+		<xs:annotation>
+			<xs:documentation>The type of object that the work is, from the list of supported types in https://members.orcid.org/api/resources/work-types
+			ORCID will validate this value against the enumeration 
+			https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/WorkType.java and other rules when necessary
+			</xs:documentation>
+		</xs:annotation>
+		<xs:restriction base="xs:string" />				
+	</xs:simpleType>
+	
+	<xs:complexType name="work-contributors">
+		<xs:annotation>
+			<xs:documentation>Container for the contributors of a Work.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element maxOccurs="unbounded" minOccurs="0" name="contributor"
+				type="work: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:annotation>
+					<xs:documentation>ORCID iD for the contributor - only add if you have collected an authenticated iD for the contributor</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="credit-name" type="common:credit-name"
+				minOccurs="0" maxOccurs="1" />
+			<xs:element name="contributor-email" type="work:contributor-email"
+				minOccurs="0" maxOccurs="1" />
+			<xs:element name="contributor-attributes" type="work:contributor-attributes"
+				minOccurs="0" maxOccurs="1" />
+		</xs:sequence>
+	</xs:complexType>
+	<xs:complexType name="contributor-email">
+		<xs:annotation>
+			<xs:documentation>Email of the contributor. This field is not returned when reading a work
+			</xs:documentation>
+		</xs:annotation>
+
+		<xs:simpleContent>
+			<xs:extension base="common:email" />
+		</xs:simpleContent>
+	</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-sequence" type="work:contributor-sequence"
+				minOccurs="0" />
+			<xs:element name="contributor-role" type="common:contributor-role" 
+				minOccurs="0" />
+		</xs:sequence>
+	</xs:complexType>
+	<xs:simpleType name="contributor-sequence">
+		<xs:annotation>
+			<xs:documentation>Indication of where in the contributor list the
+				collaborator or other contributor's name would appear
+			</xs:documentation>
+		</xs:annotation>
+
+		<xs:restriction base="xs:string">
+			<xs:enumeration value="first" />
+			<xs:enumeration value="additional" />
+		</xs:restriction>
+	</xs:simpleType>
+
+	<xs:complexType name="work-title">
+		<xs:annotation>
+			<xs:documentation>Container for titles of the work.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element ref="common:title">
+				<xs:annotation>
+					<xs:documentation>The main name or title of the work. For a
+						spin-off company, include use the company name
+					</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element ref="common:subtitle" minOccurs="0" />
+			<xs:element ref="common:translated-title" minOccurs="0" />
+		</xs:sequence>
+	</xs:complexType>
+	
+	<xs:complexType name="citation">
+		<xs:annotation>
+			<xs:documentation>Container for a work citation. Citations may be
+				fielded (e.g., RIS, BibTeX - preferred citation type), or may be
+				textual (APA, MLA, Chicago, etc.) The required work-citation-type
+				element indicates the format of the citation.
+			</xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element name="citation-type" default="formatted-unspecified"
+				type="work:citation-type" maxOccurs="1" minOccurs="1" />
+			<xs:element name="citation-value" type="xs:string" maxOccurs="1"
+				minOccurs="1" />
+		</xs:sequence>
+	</xs:complexType>
+
+	<xs:simpleType name="citation-type">
+		<xs:annotation>
+			<xs:documentation>The type (format) of the citation, selected from the following options (bibtex is preferred):
+		    * bibtex
+		    * formatted-apa
+		    * formatted-chicago
+		    * formatted-harvard
+		    * formatted-ieee 
+		    * formatted-mla 
+		    * formatted-vancouver
+		    * formatted-unspecified
+		    * ris
+			ORCID will validate this value against the enumeration 
+			https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/CitationType.java and other rules when necessary
+			</xs:documentation>
+		</xs:annotation>
+		<xs:restriction base="xs:string" />
+	</xs:simpleType>
+</xs:schema>