orcid_client 0.2.3 → 0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +120 -43
- data/lib/orcid_client/api.rb +1 -1
- data/lib/orcid_client/author.rb +2 -49
- data/lib/orcid_client/date.rb +3 -3
- data/lib/orcid_client/external_identifier.rb +1 -1
- data/lib/orcid_client/notification.rb +3 -5
- data/lib/orcid_client/version.rb +1 -1
- data/lib/orcid_client/work.rb +23 -28
- data/lib/orcid_client.rb +2 -0
- data/orcid_client.gemspec +5 -4
- data/resources/{common_2.0_rc3/common-2.0_rc3.xsd → common_2.0/common-2.0.xsd} +68 -49
- data/resources/{common_2.0_rc3/samples/common-2.0_rc3.xml → common_2.0/samples/common-2.0.xml} +1 -1
- data/resources/notification_2.0/README.md +123 -0
- data/resources/notification_2.0/notification-custom-2.0.xsd +38 -0
- data/resources/notification_2.0/notification-permission-2.0.xsd +134 -0
- data/resources/{notification_2.0_rc3/samples/notification-custom-2.0_rc3.xml → notification_2.0/samples/notification-custom-2.0.xml} +3 -3
- data/resources/{notification_2.0_rc3/samples/notification-permission-2.0_rc3.xml → notification_2.0/samples/notification-permission-2.0.xml} +2 -2
- data/resources/record_2.0/README.md +304 -0
- data/resources/{record_2.0_rc3/activities-2.0_rc3.xsd → record_2.0/activities-2.0.xsd} +79 -46
- data/resources/{record_2.0_rc3/address-2.0_rc3.xsd → record_2.0/address-2.0.xsd} +1 -1
- data/resources/{record_2.0_rc3/bulk-2.0_rc3.xsd → record_2.0/bulk-2.0.xsd} +12 -12
- data/resources/{record_2.0_rc3/education-2.0_rc3.xsd → record_2.0/education-2.0.xsd} +5 -5
- data/resources/{record_2.0_rc3/email-2.0_rc3.xsd → record_2.0/email-2.0.xsd} +3 -1
- data/resources/{record_2.0_rc3/employment-2.0_rc3.xsd → record_2.0/employment-2.0.xsd} +5 -5
- data/resources/{record_2.0_rc3/error-2.0_rc3.xsd → record_2.0/error-2.0.xsd} +0 -0
- data/resources/{record_2.0_rc3/funding-2.0_rc3.xsd → record_2.0/funding-2.0.xsd} +5 -49
- data/resources/{record_2.0_rc3/history-2.0_rc3.xsd → record_2.0/history-2.0.xsd} +1 -1
- data/resources/{record_2.0_rc3/keyword-2.0_rc3.xsd → record_2.0/keyword-2.0.xsd} +2 -2
- data/resources/{record_2.0_rc3/other-name-2.0_rc3.xsd → record_2.0/other-name-2.0.xsd} +2 -2
- data/resources/{record_2.0_rc3/peer-review-2.0_rc3.xsd → record_2.0/peer-review-2.0.xsd} +4 -4
- data/resources/record_2.0/peer-review-guide-v2.0.md +131 -0
- data/resources/{record_2.0_rc3/person-2.0_rc3.xsd → record_2.0/person-2.0.xsd} +8 -21
- data/resources/{record_2.0_rc3/person-external-identifier-2.0_rc3.xsd → record_2.0/person-external-identifier-2.0.xsd} +1 -1
- data/resources/{record_2.0_rc3/personal-details-2.0_rc3.xsd → record_2.0/personal-details-2.0.xsd} +5 -7
- data/resources/{record_2.0_rc3/preferences-2.0_rc3.xsd → record_2.0/preferences-2.0.xsd} +1 -1
- data/resources/{record_2.0_rc3/record-2.0_rc3.xsd → record_2.0/record-2.0.xsd} +16 -23
- data/resources/{record_2.0_rc3/researcher-url-2.0_rc3.xsd → record_2.0/researcher-url-2.0.xsd} +2 -2
- data/resources/{record_2.0_rc3/samples/activities-2.0_rc3.xml → record_2.0/samples/read_samples/activities-2.0.xml} +24 -12
- data/resources/{record_2.0_rc3/samples/address-2.0_rc3.xml → record_2.0/samples/read_samples/address-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/addresses-2.0_rc3.xml → record_2.0/samples/read_samples/addresses-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/biography-2.0_rc3.xml → record_2.0/samples/read_samples/biography-2.0.xml} +2 -2
- data/resources/record_2.0/samples/read_samples/bulk-work-error.xml +45 -0
- data/resources/{record_2.0_rc3/samples/credit-name-2.0_rc3.xml → record_2.0/samples/read_samples/credit-name-2.0.xml} +2 -2
- data/resources/{record_2.0_rc3/samples/education-full-2.0_rc3.xml → record_2.0/samples/read_samples/education-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/education-2.0_rc3.xml → record_2.0/samples/read_samples/education-full-2.0.xml} +12 -2
- data/resources/record_2.0/samples/read_samples/educations-2.0.xml +52 -0
- data/resources/{record_2.0_rc3/samples/email-2.0_rc3.xml → record_2.0/samples/read_samples/email-2.0.xml} +2 -2
- data/resources/{record_2.0_rc3/samples/emails-2.0_rc3.xml → record_2.0/samples/read_samples/emails-2.0.xml} +3 -3
- data/resources/{record_2.0_rc3/samples/employment-full-2.0_rc3.xml → record_2.0/samples/read_samples/employment-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/employment-2.0_rc3.xml → record_2.0/samples/read_samples/employment-full-2.0.xml} +14 -4
- data/resources/record_2.0/samples/read_samples/employments-2.0.xml +52 -0
- data/resources/{record_2.0_rc3/samples/error-2.0_rc3.xml → record_2.0/samples/read_samples/error-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/external-identifier-2.0_rc3.xml → record_2.0/samples/read_samples/external-identifier-2.0.xml} +3 -2
- data/resources/{record_2.0_rc3/samples/external-identifiers-2.0_rc3.xml → record_2.0/samples/read_samples/external-identifiers-2.0.xml} +5 -3
- data/resources/{record_2.0_rc3/samples/funding-full-2.0_rc3.xml → record_2.0/samples/read_samples/funding-2.0.xml} +2 -2
- data/resources/{record_2.0_rc3/samples/funding-2.0_rc3.xml → record_2.0/samples/read_samples/funding-full-2.0.xml} +13 -3
- data/resources/record_2.0/samples/read_samples/fundings-2.0.xml +138 -0
- data/resources/{record_2.0_rc3/samples/history-2.0_rc3.xml → record_2.0/samples/read_samples/history-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/keyword-2.0_rc3.xml → record_2.0/samples/read_samples/keyword-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/keywords-2.0_rc3.xml → record_2.0/samples/read_samples/keywords-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/name-2.0_rc3.xml → record_2.0/samples/read_samples/name-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/other-name-2.0_rc3.xml → record_2.0/samples/read_samples/other-name-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/other-names-2.0_rc3.xml → record_2.0/samples/read_samples/other-names-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/peer-review-full-2.0_rc3.xml → record_2.0/samples/read_samples/peer-review-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/peer-review-2.0_rc3.xml → record_2.0/samples/read_samples/peer-review-full-2.0.xml} +18 -8
- data/resources/record_2.0/samples/read_samples/peer-reviews-2.0.xml +73 -0
- data/resources/{record_2.0_rc3/samples/person-2.0_rc3.xml → record_2.0/samples/read_samples/person-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/personal-details-2.0_rc3.xml → record_2.0/samples/read_samples/personal-details-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/preferences-2.0_rc3.xml → record_2.0/samples/read_samples/preferences-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/record-2.0_rc3.xml → record_2.0/samples/read_samples/record-2.0.xml} +73 -85
- data/resources/{record_2.0_rc3/samples/researcher-url-2.0_rc3.xml → record_2.0/samples/read_samples/researcher-url-2.0.xml} +1 -1
- data/resources/{record_2.0_rc3/samples/researcher-urls-2.0_rc3.xml → record_2.0/samples/read_samples/researcher-urls-2.0.xml} +1 -1
- data/resources/record_2.0/samples/read_samples/search-2.0.xml +14 -0
- data/resources/{record_2.0_rc3/samples/work-full-2.0_rc3.xml → record_2.0/samples/read_samples/work-2.0.xml} +5 -5
- data/resources/{record_2.0_rc3/samples/work-2.0_rc3.xml → record_2.0/samples/read_samples/work-full-2.0.xml} +14 -4
- data/resources/record_2.0/samples/read_samples/works-2.0.xml +146 -0
- data/resources/record_2.0/samples/write_sample/address-2.0.xml +6 -0
- data/resources/{record_2.0_rc3/samples/bulk-work-2.0_rc3.json → record_2.0/samples/write_sample/bulk-work-2.0.json} +55 -55
- data/resources/{record_2.0_rc3/samples/bulk-work-2.0_rc3.xml → record_2.0/samples/write_sample/bulk-work-2.0.xml} +18 -11
- data/resources/record_2.0/samples/write_sample/education-2.0.xml +30 -0
- data/resources/record_2.0/samples/write_sample/employment-2.0.xml +30 -0
- data/resources/record_2.0/samples/write_sample/external-identifier-2.0.xml +11 -0
- data/resources/record_2.0/samples/write_sample/funding-2.0.xml +44 -0
- data/resources/record_2.0/samples/write_sample/keyword-2.0.xml +7 -0
- data/resources/record_2.0/samples/write_sample/other-name-2.0.xml +6 -0
- data/resources/record_2.0/samples/write_sample/peer-review-full-2.0.xml +48 -0
- data/resources/record_2.0/samples/write_sample/peer-review-simple-2.0.xml +32 -0
- data/resources/record_2.0/samples/write_sample/researcher-url-2.0.xml +7 -0
- data/resources/record_2.0/samples/write_sample/work-full-2.0.xml +54 -0
- data/resources/record_2.0/samples/write_sample/work-simple-2.0.xml +18 -0
- data/resources/{record_2.0_rc3/search-2.0_rc3.xsd → record_2.0/search-2.0.xsd} +6 -26
- data/resources/{record_2.0_rc3/work-2.0_rc3.xsd → record_2.0/work-2.0.xsd} +8 -129
- data/spec/api_spec.rb +3 -3
- data/spec/external_identifier_spec.rb +2 -2
- data/spec/fixtures/external_identifier.xml +1 -1
- data/spec/fixtures/vcr_cassettes/OrcidClient/external_identifier/delete/should_delete_external_identifier.yml +17 -5
- data/spec/fixtures/vcr_cassettes/OrcidClient/external_identifier/post/should_create_external_identifier.yml +19 -7
- data/spec/fixtures/vcr_cassettes/OrcidClient/notifications/delete/should_delete_notification.yml +19 -6
- data/spec/fixtures/vcr_cassettes/OrcidClient/notifications/get/should_get_notification.yml +20 -6
- data/spec/fixtures/vcr_cassettes/OrcidClient/notifications/post/should_create_notification.yml +90 -25
- data/spec/fixtures/vcr_cassettes/OrcidClient/works/delete/should_delete_work.yml +17 -5
- data/spec/fixtures/vcr_cassettes/OrcidClient/works/get/should_get_works.yml +554 -543
- data/spec/fixtures/vcr_cassettes/OrcidClient/works/post/should_create_work.yml +90 -25
- data/spec/fixtures/vcr_cassettes/OrcidClient/works/put/should_update_work.yml +99 -28
- data/spec/fixtures/vcr_cassettes/OrcidClient_Notification/data.yml +72 -17
- data/spec/fixtures/vcr_cassettes/OrcidClient_Notification/schema/validates_data.yml +70 -17
- data/spec/fixtures/vcr_cassettes/OrcidClient_Notification/schema/validates_item_type_work.yml +72 -14
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/contributors/literal.yml +72 -20
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/contributors/multiple_titles.yml +72 -20
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/contributors/valid.yml +72 -23
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/contributors/with_ORCID_IDs.yml +75 -133
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/data.yml +72 -23
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/publication_date.yml +72 -23
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/schema/validates_ORCID_IDs_for_contributors.yml +75 -133
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/schema/validates_data.yml +72 -23
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/schema/validates_work_type_data-set.yml +72 -20
- data/spec/fixtures/work.xml +4 -2
- data/spec/notification_spec.rb +4 -4
- data/spec/work_spec.rb +6 -6
- metadata +122 -80
- data/lib/orcid_client/metadata.rb +0 -128
- data/resources/notification_2.0_rc3/notification-custom-2.0_rc3.xsd +0 -32
- data/resources/notification_2.0_rc3/notification-permission-2.0_rc3.xsd +0 -128
- data/resources/record_2.0_rc3/deprecated-2.0_rc3.xsd +0 -80
- data/resources/record_2.0_rc3/internal-2.0_rc3.xsd +0 -199
- data/resources/record_2.0_rc3/samples/deprecated-2.0_rc3.xml +0 -13
- data/resources/record_2.0_rc3/samples/search-2.0_rc3.xml +0 -368
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/citation.yml +0 -50
@@ -34,7 +34,7 @@
|
|
34
34
|
</xs:annotation>
|
35
35
|
|
36
36
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
37
|
-
schemaLocation="../common_2.
|
37
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
38
38
|
|
39
39
|
<xs:element name="education">
|
40
40
|
<xs:annotation>
|
@@ -56,9 +56,9 @@
|
|
56
56
|
<xs:complexContent>
|
57
57
|
<xs:extension base="common:element-summary">
|
58
58
|
<xs:sequence>
|
59
|
-
<xs:element name="department-name" type="common:
|
59
|
+
<xs:element name="department-name" type="common:long-text"
|
60
60
|
minOccurs="0" maxOccurs="1" />
|
61
|
-
<xs:element name="role-title" type="common:
|
61
|
+
<xs:element name="role-title" type="common:long-text"
|
62
62
|
minOccurs="0" maxOccurs="1" />
|
63
63
|
<xs:element ref="common:start-date" minOccurs="0"
|
64
64
|
maxOccurs="1" />
|
@@ -77,9 +77,9 @@
|
|
77
77
|
<xs:complexContent>
|
78
78
|
<xs:extension base="common:element-summary">
|
79
79
|
<xs:sequence>
|
80
|
-
<xs:element name="department-name" type="common:
|
80
|
+
<xs:element name="department-name" type="common:long-text"
|
81
81
|
minOccurs="0" maxOccurs="1" />
|
82
|
-
<xs:element name="role-title" type="common:
|
82
|
+
<xs:element name="role-title" type="common:long-text"
|
83
83
|
minOccurs="0" maxOccurs="1" />
|
84
84
|
<xs:element ref="common:start-date" minOccurs="0"
|
85
85
|
maxOccurs="1" />
|
@@ -32,7 +32,7 @@
|
|
32
32
|
</xs:appinfo>
|
33
33
|
</xs:annotation>
|
34
34
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
35
|
-
schemaLocation="../common_2.
|
35
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
36
36
|
<xs:element name="emails">
|
37
37
|
<xs:complexType>
|
38
38
|
<xs:annotation>
|
@@ -68,6 +68,8 @@
|
|
68
68
|
<xs:sequence>
|
69
69
|
<xs:element name="email" type="common:email" />
|
70
70
|
</xs:sequence>
|
71
|
+
<xs:attribute name="verified" type="xs:boolean" />
|
72
|
+
<xs:attribute name="primary" type="xs:boolean" />
|
71
73
|
</xs:extension>
|
72
74
|
</xs:complexContent>
|
73
75
|
</xs:complexType>
|
@@ -34,7 +34,7 @@
|
|
34
34
|
</xs:annotation>
|
35
35
|
|
36
36
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
37
|
-
schemaLocation="../common_2.
|
37
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
38
38
|
|
39
39
|
<xs:element name="employment">
|
40
40
|
<xs:annotation>
|
@@ -56,9 +56,9 @@
|
|
56
56
|
<xs:complexContent>
|
57
57
|
<xs:extension base="common:element-summary">
|
58
58
|
<xs:sequence>
|
59
|
-
<xs:element name="department-name" type="common:
|
59
|
+
<xs:element name="department-name" type="common:long-text"
|
60
60
|
minOccurs="0" maxOccurs="1" />
|
61
|
-
<xs:element name="role-title" type="common:
|
61
|
+
<xs:element name="role-title" type="common:long-text"
|
62
62
|
minOccurs="0" maxOccurs="1" />
|
63
63
|
<xs:element ref="common:start-date" minOccurs="0"
|
64
64
|
maxOccurs="1" />
|
@@ -77,9 +77,9 @@
|
|
77
77
|
<xs:complexContent>
|
78
78
|
<xs:extension base="common:element-summary">
|
79
79
|
<xs:sequence>
|
80
|
-
<xs:element name="department-name" type="common:
|
80
|
+
<xs:element name="department-name" type="common:long-text"
|
81
81
|
minOccurs="0" maxOccurs="1" />
|
82
|
-
<xs:element name="role-title" type="common:
|
82
|
+
<xs:element name="role-title" type="common:long-text"
|
83
83
|
minOccurs="0" maxOccurs="1" />
|
84
84
|
<xs:element ref="common:start-date" minOccurs="0"
|
85
85
|
maxOccurs="1" />
|
File without changes
|
@@ -34,7 +34,7 @@
|
|
34
34
|
</xs:annotation>
|
35
35
|
|
36
36
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
37
|
-
schemaLocation="../common_2.
|
37
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
38
38
|
|
39
39
|
<xs:element name="funding">
|
40
40
|
<xs:annotation>
|
@@ -93,7 +93,7 @@
|
|
93
93
|
</xs:complexType>
|
94
94
|
</xs:element>
|
95
95
|
|
96
|
-
<xs:element name="summary">
|
96
|
+
<xs:element name="funding-summary">
|
97
97
|
<xs:complexType>
|
98
98
|
<xs:complexContent>
|
99
99
|
<xs:extension base="common:element-summary">
|
@@ -116,6 +116,8 @@
|
|
116
116
|
<xs:documentation>End date for the funding.</xs:documentation>
|
117
117
|
</xs:annotation>
|
118
118
|
</xs:element>
|
119
|
+
<xs:element name="organization" type="common:organization"
|
120
|
+
minOccurs="1" maxOccurs="1" />
|
119
121
|
</xs:sequence>
|
120
122
|
</xs:extension>
|
121
123
|
</xs:complexContent>
|
@@ -152,53 +154,7 @@
|
|
152
154
|
<xs:enumeration value="salary-award" />
|
153
155
|
</xs:restriction>
|
154
156
|
</xs:simpleType>
|
155
|
-
|
156
|
-
<xs:complexType name="external-identifiers">
|
157
|
-
<xs:annotation>
|
158
|
-
<xs:documentation>Container for storing the external references to
|
159
|
-
the funding.
|
160
|
-
</xs:documentation>
|
161
|
-
</xs:annotation>
|
162
|
-
<xs:sequence>
|
163
|
-
<xs:element maxOccurs="unbounded" minOccurs="0"
|
164
|
-
name="externalIdentifier" type="funding:external-identifier" />
|
165
|
-
</xs:sequence>
|
166
|
-
</xs:complexType>
|
167
|
-
|
168
|
-
<xs:complexType name="external-identifier">
|
169
|
-
<xs:annotation>
|
170
|
-
<xs:documentation>An external identifier that uniquely represents the
|
171
|
-
funding. Includes an identifier type and value as well as a URL for
|
172
|
-
a link to more information about the funding.
|
173
|
-
</xs:documentation>
|
174
|
-
</xs:annotation>
|
175
|
-
<xs:complexContent>
|
176
|
-
<xs:extension base="common:external-identifier">
|
177
|
-
<xs:sequence>
|
178
|
-
<xs:element name="external-identifier-type" type="funding:external-identifier-type"
|
179
|
-
minOccurs="1" maxOccurs="1" />
|
180
|
-
<xs:element name="external-identifier-value" type="common:string-2084"
|
181
|
-
minOccurs="0" maxOccurs="1">
|
182
|
-
<xs:annotation>
|
183
|
-
<xs:documentation>Value of the external identifier.</xs:documentation>
|
184
|
-
</xs:annotation>
|
185
|
-
</xs:element>
|
186
|
-
</xs:sequence>
|
187
|
-
</xs:extension>
|
188
|
-
</xs:complexContent>
|
189
|
-
</xs:complexType>
|
190
|
-
|
191
|
-
<xs:simpleType name="external-identifier-type">
|
192
|
-
<xs:annotation>
|
193
|
-
<xs:documentation>The type of the funding external identifier.
|
194
|
-
Currently only grant number is supported.
|
195
|
-
</xs:documentation>
|
196
|
-
</xs:annotation>
|
197
|
-
<xs:restriction base="xs:string">
|
198
|
-
<xs:enumeration value="grant_number" />
|
199
|
-
</xs:restriction>
|
200
|
-
</xs:simpleType>
|
201
|
-
-->
|
157
|
+
|
202
158
|
<xs:complexType name="contributors">
|
203
159
|
<xs:annotation>
|
204
160
|
<xs:documentation>Container for the contributors of a funding.
|
@@ -33,7 +33,7 @@
|
|
33
33
|
</xs:annotation>
|
34
34
|
|
35
35
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
36
|
-
schemaLocation="../common_2.
|
36
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
37
37
|
|
38
38
|
<xs:element name="keywords">
|
39
39
|
<xs:complexType>
|
@@ -64,7 +64,7 @@
|
|
64
64
|
<xs:complexContent>
|
65
65
|
<xs:extension base="common:element-summary">
|
66
66
|
<xs:sequence>
|
67
|
-
<xs:element minOccurs="1" name="content" type="common:
|
67
|
+
<xs:element minOccurs="1" name="content" type="common:string-255" />
|
68
68
|
</xs:sequence>
|
69
69
|
</xs:extension>
|
70
70
|
</xs:complexContent>
|
@@ -32,7 +32,7 @@
|
|
32
32
|
</xs:appinfo>
|
33
33
|
</xs:annotation>
|
34
34
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
35
|
-
schemaLocation="../common_2.
|
35
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
36
36
|
|
37
37
|
<xs:element name="other-names">
|
38
38
|
<xs:complexType>
|
@@ -75,7 +75,7 @@
|
|
75
75
|
<xs:complexContent>
|
76
76
|
<xs:extension base="common:element-summary">
|
77
77
|
<xs:sequence>
|
78
|
-
<xs:element minOccurs="1" name="content" type="common:
|
78
|
+
<xs:element minOccurs="1" name="content" type="common:string-255">
|
79
79
|
<xs:annotation>
|
80
80
|
<xs:documentation>A short display name describing the URL.
|
81
81
|
</xs:documentation>
|
@@ -1,4 +1,4 @@
|
|
1
|
-
<?xml version="1.0" encoding="UTF-8"?>
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
2
|
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
3
3
|
xmlns:sch="http://purl.oclc.org/dsdl/schematron" elementFormDefault="qualified"
|
4
4
|
targetNamespace="http://www.orcid.org/ns/peer-review"
|
@@ -37,9 +37,9 @@
|
|
37
37
|
</xs:annotation>
|
38
38
|
|
39
39
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
40
|
-
schemaLocation="../common_2.
|
40
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
41
41
|
<xs:import namespace="http://www.orcid.org/ns/work"
|
42
|
-
schemaLocation="work-2.
|
42
|
+
schemaLocation="work-2.0.xsd" />
|
43
43
|
|
44
44
|
<xs:element name="peer-review">
|
45
45
|
<xs:complexType>
|
@@ -135,7 +135,7 @@
|
|
135
135
|
</xs:complexType>
|
136
136
|
</xs:element>
|
137
137
|
|
138
|
-
<xs:element name="summary">
|
138
|
+
<xs:element name="peer-review-summary">
|
139
139
|
<xs:complexType>
|
140
140
|
<xs:complexContent>
|
141
141
|
<xs:extension base="common:element-summary">
|
@@ -0,0 +1,131 @@
|
|
1
|
+
|
2
|
+
#ORCID API v2.0 Peer Review Guide
|
3
|
+
Starting in v2.0, the ORCID API now supports a new activity type: ```peer-review```.
|
4
|
+
|
5
|
+
The ```peer-review``` activity type is intended to allow for recognition of and exchange of data about peer review service contributed by researchers.
|
6
|
+
|
7
|
+
The ```peer-review``` activity type follows the [CASRAI Peer Review Services data profile](http://dictionary.casrai.org/Peer_Review_Services), which was developed by the [Peer Review Services Working Group (PRS-WG)](http://casrai.org/standards/subject-groups/peer-review-services), led by [ORCID](http://orcid.org) and [F1000](http://f1000.com/). More details about ORCID's implementation of this recommendation, and the Early Adopter program for Peer Review can be found on the [Peer Review Early Adopter page](http://orcid.org/content/peer-review-early-adopter-program).
|
8
|
+
|
9
|
+
##Peer Review XML
|
10
|
+
XML for the ```peer-review``` activity follows the [peer-review-2.0.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.0/peer-review-2.0.xsd) and consists of the following sections:
|
11
|
+
|
12
|
+
###The fields
|
13
|
+
|
14
|
+
**DESCRIBING THE REVIEWER**
|
15
|
+
|
16
|
+
- **reviewer-role** _(required)_ The role played by a person in their contribution to a review. This field is selected from a list containing the following values: _chair, editor, member, organizer, reviewer_
|
17
|
+
|
18
|
+
**DESCRIBING THE REVIEW**
|
19
|
+
|
20
|
+
- **review-identifiers** _(required)_ 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.
|
21
|
+
|
22
|
+
- **review-url** _(optional)_ 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.*
|
23
|
+
|
24
|
+
- **review-type** _(required)_ The kind of review applied to the subject type reviewed. This field is selected from a list containing the following values: _evaluation, review_
|
25
|
+
|
26
|
+
|
27
|
+
- **review-completion-date** _(required)_ The date on which the review was completed (formatted to ISO 8601). Allowable values: yyyy; yyyy-mm; yyyy-mm-dd, formatted using the ORCID fuzzy date format.
|
28
|
+
|
29
|
+
- **review-group-id** _(required)_ Identifier for the group that this review should be a part of for aggregation purposes. The Group ID must be pre-registered before use. (see [Group ID Registration]() below for more information.)
|
30
|
+
|
31
|
+
**DESCRIBING THE SUBJECT OF THE REVIEW**
|
32
|
+
|
33
|
+
- **subject-external-identifier** _(optional)_ The unique ID of the object that was reviewed. *This identifier refers to the SUBJECT of the review, not of the review itself.*
|
34
|
+
|
35
|
+
- **subject-container-name** _(optional)_ The name of the journal, conference, grant review panel, or other applicable object of which the review subject was a part.
|
36
|
+
|
37
|
+
- **subject-type** _(optional)_ The type of object that the review subject is (for example, a journal article, grant, etc)
|
38
|
+
|
39
|
+
- **subject-name** _(optional)_ The name/title of the subject object that was reviewed.
|
40
|
+
|
41
|
+
- **subject-url** _(optional)_ The URL of the subject object that was reviewed. *This URL points to the SUBJECT of the review, not to the review itself.*
|
42
|
+
|
43
|
+
**DESCRIBING THE ORGANIZATION THAT THE REVIEW WAS DONE FOR**
|
44
|
+
|
45
|
+
- **convening-organization** _(required)_ 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.
|
46
|
+
|
47
|
+
###Example file
|
48
|
+
|
49
|
+
For an example XML file, see [peer-review-2.0.xml](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.0/samples/peer-review-2.0.xml )
|
50
|
+
|
51
|
+
***Note:*** *Sample files contain system-generated elements/attributes that are returned when reading items from ORCID. The following items should not be included when posting items to ORCID:*
|
52
|
+
|
53
|
+
- *put-code (exception: include put-code when updating items using the PUT method)*
|
54
|
+
- *source*
|
55
|
+
- *created-date*
|
56
|
+
- *last-modified-date*
|
57
|
+
|
58
|
+
|
59
|
+
##Peer Review API Reference
|
60
|
+
```peer-review``` is available only in ORCID API v2.0_rcX, which uses a slightly different data structure from previous API versions.
|
61
|
+
|
62
|
+
In v2.0_rcX, activities are read, added, and modified on an individual basis (rather than as a list), using a ```put-code```, which is a system-generated identifier used within the ORCID database.
|
63
|
+
|
64
|
+
The ```put-code``` for a specific item can be obtained by reading a summary of a user's ORCID record.
|
65
|
+
|
66
|
+
Other notable differences between v2.0_rcX previous versions include:
|
67
|
+
|
68
|
+
- Only 2 scopes are used: ```/read-limited``` and ```/activities/update```
|
69
|
+
- An explicit ```DELETE``` method is used to remove record items
|
70
|
+
|
71
|
+
###Read Activities Summary
|
72
|
+
| Action | HTTP method | Scope | URL |
|
73
|
+
|-------------------------|-------------|--------------------------|----------------------------------------------------------|
|
74
|
+
| Read activities summary | GET | /read-limited | https://api.sandbox.orcid.org/v2.0/[ORCID-iD]/activities |
|
75
|
+
|
76
|
+
###Read/Modifiy Peer Review Activities
|
77
|
+
| Action | HTTP method | Scope | URL |
|
78
|
+
|--------------------|-------------|--------------------------|--------------------------------------------------------------------------|
|
79
|
+
| Add peer-review item | POST | /activities/update | https://api.sandbox.orcid.org/v2.0/[ORCID-iD]/peer-review |
|
80
|
+
| Read peer-review item | GET | /read-limited | https://api.sandbox.orcid.org/v2.0/[ORCID-iD]/peer-review/[PUT-CODE] |
|
81
|
+
| Update peer-review item | PUT | /activities/update | https://api.sandbox.orcid.org/v2.0/[ORCID-iD]/peer-review/[PUT-CODE] |
|
82
|
+
| Delete peer-review item | DELETE | /activities/update | https://api.sandbox.orcid.org/v2.0/[ORCID-iD]/peer-review/[PUT-CODE] |
|
83
|
+
|
84
|
+
|
85
|
+
- **[ORCID-iD]** is the ORCID iD for the record, formatted as XXXX-XXXX-XXXX-XXXX
|
86
|
+
- **[PUT-CODE]** is the ```put-code``` attribute for the specific ```peer-review``` activity that you wish to read or modify.
|
87
|
+
|
88
|
+
###Example cURL Statements
|
89
|
+
####Read Activities Summary
|
90
|
+
|
91
|
+
```shell
|
92
|
+
curl -i -H "Accept: application/orcid+xml" \
|
93
|
+
-H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' \
|
94
|
+
'https://api.sandbox.orcid.org/v2.0/0000-0002-1306-4180/activities'
|
95
|
+
```
|
96
|
+
|
97
|
+
####Add Peer-Review Activity
|
98
|
+
|
99
|
+
```shell
|
100
|
+
curl -i -H 'Content-type: application/orcid+xml’ \
|
101
|
+
-H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' \
|
102
|
+
-d '@[FILE-PATH]/peer-review-item.xml' \
|
103
|
+
-X POST 'https://api.sandbox.orcid.org/v2.0/[ORCID]/peer-review'
|
104
|
+
```
|
105
|
+
|
106
|
+
####Read Peer-Review Activity
|
107
|
+
|
108
|
+
```
|
109
|
+
curl -i -H "Accept: application/orcid+xml" \
|
110
|
+
-H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' \
|
111
|
+
'https://api.sandbox.orcid.org/v2.0/[ORCID]/peer-review/[PUT-CODE]'
|
112
|
+
```
|
113
|
+
|
114
|
+
####Update Peer-Review Activity
|
115
|
+
|
116
|
+
```shell
|
117
|
+
curl -i -H 'Content-type: application/orcid+xml’ \
|
118
|
+
-H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' \
|
119
|
+
-d '@[FILE-PATH]/peer-review-item-updated.xml' \
|
120
|
+
-X PUT 'https://api.sandbox.orcid.org/v2.0/[ORCID]/peer-review/[PUT-CODE]'
|
121
|
+
```
|
122
|
+
|
123
|
+
####Delete Peer-Review Activity
|
124
|
+
|
125
|
+
```shell
|
126
|
+
curl -i -H 'Content-type: application/orcid+xml’ \
|
127
|
+
-H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' \
|
128
|
+
-X DELETE 'https://api.sandbox.orcid.org/v2.0/[ORCID]/peer-review/[PUT-CODE]'
|
129
|
+
```
|
130
|
+
|
131
|
+
|
@@ -37,21 +37,21 @@
|
|
37
37
|
</xs:annotation>
|
38
38
|
|
39
39
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
40
|
-
schemaLocation="../common_2.
|
40
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
41
41
|
<xs:import namespace="http://www.orcid.org/ns/personal-details"
|
42
|
-
schemaLocation="../record_2.
|
42
|
+
schemaLocation="../record_2.0/personal-details-2.0.xsd" />
|
43
43
|
<xs:import namespace="http://www.orcid.org/ns/other-name"
|
44
|
-
schemaLocation="../record_2.
|
44
|
+
schemaLocation="../record_2.0/other-name-2.0.xsd" />
|
45
45
|
<xs:import namespace="http://www.orcid.org/ns/researcher-url"
|
46
|
-
schemaLocation="../record_2.
|
46
|
+
schemaLocation="../record_2.0/researcher-url-2.0.xsd" />
|
47
47
|
<xs:import namespace="http://www.orcid.org/ns/email"
|
48
|
-
schemaLocation="../record_2.
|
48
|
+
schemaLocation="../record_2.0/email-2.0.xsd" />
|
49
49
|
<xs:import namespace="http://www.orcid.org/ns/address"
|
50
|
-
schemaLocation="../record_2.
|
50
|
+
schemaLocation="../record_2.0/address-2.0.xsd" />
|
51
51
|
<xs:import namespace="http://www.orcid.org/ns/keyword"
|
52
|
-
schemaLocation="../record_2.
|
52
|
+
schemaLocation="../record_2.0/keyword-2.0.xsd" />
|
53
53
|
<xs:import namespace="http://www.orcid.org/ns/external-identifier"
|
54
|
-
schemaLocation="../record_2.
|
54
|
+
schemaLocation="../record_2.0/person-external-identifier-2.0.xsd" />
|
55
55
|
|
56
56
|
<xs:element name="person">
|
57
57
|
<xs:annotation>
|
@@ -82,17 +82,4 @@
|
|
82
82
|
</xs:complexType>
|
83
83
|
</xs:element>
|
84
84
|
|
85
|
-
<xs:complexType name="credit-name">
|
86
|
-
<xs:simpleContent>
|
87
|
-
<xs:extension base="personal-details:credit-name" />
|
88
|
-
</xs:simpleContent>
|
89
|
-
</xs:complexType>
|
90
|
-
|
91
|
-
<xs:complexType name="scope-paths">
|
92
|
-
<xs:sequence>
|
93
|
-
<xs:element name="scope-path" type="common:scope-path-type"
|
94
|
-
minOccurs="1" maxOccurs="unbounded" />
|
95
|
-
</xs:sequence>
|
96
|
-
</xs:complexType>
|
97
|
-
|
98
85
|
</xs:schema>
|
@@ -33,7 +33,7 @@
|
|
33
33
|
</xs:appinfo>
|
34
34
|
</xs:annotation>
|
35
35
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
36
|
-
schemaLocation="../common_2.
|
36
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
37
37
|
|
38
38
|
<xs:element name="external-identifiers">
|
39
39
|
<xs:annotation>
|
data/resources/{record_2.0_rc3/personal-details-2.0_rc3.xsd → record_2.0/personal-details-2.0.xsd}
RENAMED
@@ -34,9 +34,9 @@
|
|
34
34
|
</xs:annotation>
|
35
35
|
|
36
36
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
37
|
-
schemaLocation="../common_2.
|
37
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
38
38
|
<xs:import namespace="http://www.orcid.org/ns/other-name"
|
39
|
-
schemaLocation="../record_2.
|
39
|
+
schemaLocation="../record_2.0/other-name-2.0.xsd" />
|
40
40
|
|
41
41
|
<xs:element name="personal-details">
|
42
42
|
<xs:annotation>
|
@@ -115,7 +115,7 @@
|
|
115
115
|
</xs:annotation>
|
116
116
|
<xs:complexType>
|
117
117
|
<xs:simpleContent>
|
118
|
-
<xs:extension base="common:
|
118
|
+
<xs:extension base="common:string-150" />
|
119
119
|
</xs:simpleContent>
|
120
120
|
</xs:complexType>
|
121
121
|
</xs:element>
|
@@ -128,7 +128,7 @@
|
|
128
128
|
</xs:annotation>
|
129
129
|
<xs:complexType>
|
130
130
|
<xs:simpleContent>
|
131
|
-
<xs:extension base="common:
|
131
|
+
<xs:extension base="common:string-150" />
|
132
132
|
</xs:simpleContent>
|
133
133
|
</xs:complexType>
|
134
134
|
</xs:element>
|
@@ -178,9 +178,7 @@
|
|
178
178
|
|
179
179
|
<xs:complexType name="credit-name">
|
180
180
|
<xs:simpleContent>
|
181
|
-
<xs:extension base="common:
|
182
|
-
<xs:attribute name="visibility" type="common:visibility" use="optional"/>
|
183
|
-
</xs:extension>
|
181
|
+
<xs:extension base="common:credit-name" />
|
184
182
|
</xs:simpleContent>
|
185
183
|
</xs:complexType>
|
186
184
|
</xs:schema>
|
@@ -33,7 +33,7 @@
|
|
33
33
|
</xs:appinfo>
|
34
34
|
</xs:annotation>
|
35
35
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
36
|
-
schemaLocation="../common_2.
|
36
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
37
37
|
<xs:element name="preferences">
|
38
38
|
<xs:complexType>
|
39
39
|
<xs:annotation>
|
@@ -1,13 +1,13 @@
|
|
1
|
-
<?xml version="1.0" encoding="UTF-8"?>
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
2
|
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
3
3
|
xmlns:sch="http://purl.oclc.org/dsdl/schematron" elementFormDefault="qualified"
|
4
4
|
targetNamespace="http://www.orcid.org/ns/record" xmlns:internal="http://www.orcid.org/ns/internal"
|
5
5
|
xmlns:person="http://www.orcid.org/ns/person" xmlns:common="http://www.orcid.org/ns/common"
|
6
6
|
xmlns:work="http://www.orcid.org/ns/work" xmlns:funding="http://www.orcid.org/ns/funding"
|
7
7
|
xmlns:education="http://www.orcid.org/ns/education" xmlns:employment="http://www.orcid.org/ns/employment"
|
8
|
-
xmlns:
|
9
|
-
xmlns:
|
10
|
-
xmlns:
|
8
|
+
xmlns:activities="http://www.orcid.org/ns/activities" xmlns:history="http://www.orcid.org/ns/history"
|
9
|
+
xmlns:record="http://www.orcid.org/ns/record" xmlns:preferences="http://www.orcid.org/ns/preferences"
|
10
|
+
xmlns:peer-review="http://www.orcid.org/ns/peer-review">
|
11
11
|
<xs:annotation>
|
12
12
|
<xs:documentation>
|
13
13
|
=============================================================================
|
@@ -39,29 +39,25 @@
|
|
39
39
|
</xs:annotation>
|
40
40
|
|
41
41
|
<xs:import namespace="http://www.orcid.org/ns/activities"
|
42
|
-
schemaLocation="activities-2.
|
42
|
+
schemaLocation="activities-2.0.xsd" />
|
43
43
|
<xs:import namespace="http://www.orcid.org/ns/person"
|
44
|
-
schemaLocation="person-2.
|
45
|
-
|
46
|
-
|
47
|
-
<xs:import namespace="http://www.orcid.org/ns/deprecated"
|
48
|
-
schemaLocation="deprecated-2.0_rc3.xsd" />
|
44
|
+
schemaLocation="person-2.0.xsd" />
|
45
|
+
<xs:import namespace="http://www.orcid.org/ns/common"
|
46
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
49
47
|
<xs:import namespace="http://www.orcid.org/ns/history"
|
50
|
-
schemaLocation="history-2.
|
51
|
-
<xs:import namespace="http://www.orcid.org/ns/internal"
|
52
|
-
schemaLocation="internal-2.0_rc3.xsd" />
|
48
|
+
schemaLocation="history-2.0.xsd" />
|
53
49
|
<xs:import namespace="http://www.orcid.org/ns/preferences"
|
54
|
-
schemaLocation="preferences-2.
|
50
|
+
schemaLocation="preferences-2.0.xsd" />
|
55
51
|
<xs:import namespace="http://www.orcid.org/ns/work"
|
56
|
-
schemaLocation="work-2.
|
52
|
+
schemaLocation="work-2.0.xsd" />
|
57
53
|
<xs:import namespace="http://www.orcid.org/ns/funding"
|
58
|
-
schemaLocation="funding-2.
|
54
|
+
schemaLocation="funding-2.0.xsd" />
|
59
55
|
<xs:import namespace="http://www.orcid.org/ns/education"
|
60
|
-
schemaLocation="education-2.
|
56
|
+
schemaLocation="education-2.0.xsd" />
|
61
57
|
<xs:import namespace="http://www.orcid.org/ns/employment"
|
62
|
-
schemaLocation="employment-2.
|
58
|
+
schemaLocation="employment-2.0.xsd" />
|
63
59
|
<xs:import namespace="http://www.orcid.org/ns/peer-review"
|
64
|
-
schemaLocation="peer-review-2.
|
60
|
+
schemaLocation="peer-review-2.0.xsd" />
|
65
61
|
|
66
62
|
<xs:element name="record">
|
67
63
|
<xs:complexType>
|
@@ -87,8 +83,6 @@
|
|
87
83
|
<xs:sequence>
|
88
84
|
<xs:element ref="common:orcid-identifier" minOccurs="0"
|
89
85
|
maxOccurs="1" />
|
90
|
-
<xs:element ref="deprecated:deprecated" minOccurs="0"
|
91
|
-
maxOccurs="1" />
|
92
86
|
<xs:element ref="preferences:preferences" minOccurs="0"
|
93
87
|
maxOccurs="1" />
|
94
88
|
<xs:element ref="history:history" minOccurs="0"
|
@@ -96,9 +90,8 @@
|
|
96
90
|
<xs:element ref="person:person" minOccurs="0" maxOccurs="1" />
|
97
91
|
<xs:element ref="activities:activities-summary"
|
98
92
|
minOccurs="0" maxOccurs="1" />
|
99
|
-
<xs:element ref="internal:internal" minOccurs="0"
|
100
|
-
maxOccurs="1" />
|
101
93
|
</xs:sequence>
|
94
|
+
<xs:attribute name="path" type="common:element-path" use="optional" />
|
102
95
|
</xs:complexType>
|
103
96
|
</xs:element>
|
104
97
|
|
data/resources/{record_2.0_rc3/researcher-url-2.0_rc3.xsd → record_2.0/researcher-url-2.0.xsd}
RENAMED
@@ -33,7 +33,7 @@
|
|
33
33
|
</xs:appinfo>
|
34
34
|
</xs:annotation>
|
35
35
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
36
|
-
schemaLocation="../common_2.
|
36
|
+
schemaLocation="../common_2.0/common-2.0.xsd" />
|
37
37
|
<xs:element name="researcher-urls">
|
38
38
|
<xs:complexType>
|
39
39
|
<xs:annotation>
|
@@ -70,7 +70,7 @@
|
|
70
70
|
<xs:extension base="common:element-summary">
|
71
71
|
<xs:sequence>
|
72
72
|
<xs:element minOccurs="1" maxOccurs="1" name="url-name"
|
73
|
-
type="common:
|
73
|
+
type="common:string-350">
|
74
74
|
<xs:annotation>
|
75
75
|
<xs:documentation>A short display name describing the URL.
|
76
76
|
</xs:documentation>
|