orcid_client 0.8 → 0.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/build.yml +39 -0
- data/.github/workflows/changelog.yml +36 -0
- data/.github/workflows/release.yml +49 -0
- data/Gemfile.lock +124 -104
- data/lib/orcid_client/api.rb +1 -1
- data/lib/orcid_client/external_identifier.rb +1 -1
- data/lib/orcid_client/version.rb +1 -1
- data/lib/orcid_client/work.rb +1 -1
- data/orcid_client.gemspec +1 -1
- data/resources/README.md +48 -43
- data/resources/common_3.0/common-3.0.xsd +998 -0
- data/resources/common_3.0/samples/common-3.0.xml +8 -0
- data/resources/common_3.0/samples/common-3.0_external-identifier.xml +11 -0
- data/resources/notification_3.0/README.md +130 -0
- data/resources/notification_3.0/images/notification-intro.jpg +0 -0
- data/resources/notification_3.0/images/notification-subject.jpg +0 -0
- data/resources/notification_3.0/notification-custom-3.0.xsd +38 -0
- data/resources/notification_3.0/notification-permission-3.0.xsd +134 -0
- data/resources/notification_3.0/samples/notification-custom-3.0.xml +27 -0
- data/resources/notification_3.0/samples/notification-permission-3.0.xml +58 -0
- data/resources/record_3.0/README.md +408 -0
- data/resources/record_3.0/activities-3.0.xsd +456 -0
- data/resources/record_3.0/address-3.0.xsd +73 -0
- data/resources/record_3.0/bulk-3.0.xsd +57 -0
- data/resources/record_3.0/distinction-3.0.xsd +51 -0
- data/resources/record_3.0/education-3.0.xsd +51 -0
- data/resources/record_3.0/email-3.0.xsd +76 -0
- data/resources/record_3.0/employment-3.0.xsd +51 -0
- data/resources/record_3.0/error-3.0.xsd +84 -0
- data/resources/record_3.0/expanded-search-3.0.xsd +114 -0
- data/resources/record_3.0/funding-3.0.xsd +204 -0
- data/resources/record_3.0/history-3.0.xsd +185 -0
- data/resources/record_3.0/invited-position-3.0.xsd +50 -0
- data/resources/record_3.0/keyword-3.0.xsd +72 -0
- data/resources/record_3.0/membership-3.0.xsd +51 -0
- data/resources/record_3.0/other-name-3.0.xsd +78 -0
- data/resources/record_3.0/peer-review-3.0.xsd +263 -0
- data/resources/record_3.0/person-3.0.xsd +85 -0
- data/resources/record_3.0/person-external-identifier-3.0.xsd +63 -0
- data/resources/record_3.0/personal-details-3.0.xsd +162 -0
- data/resources/record_3.0/preferences-3.0.xsd +50 -0
- data/resources/record_3.0/qualification-3.0.xsd +50 -0
- data/resources/record_3.0/record-3.0.xsd +91 -0
- data/resources/record_3.0/research-resource-3.0.xsd +144 -0
- data/resources/record_3.0/researcher-url-3.0.xsd +86 -0
- data/resources/record_3.0/samples/read_samples/activities-3.0.xml +742 -0
- data/resources/record_3.0/samples/read_samples/address-3.0.xml +16 -0
- data/resources/record_3.0/samples/read_samples/addresses-3.0.xml +32 -0
- data/resources/record_3.0/samples/read_samples/biography-3.0.xml +10 -0
- data/resources/record_3.0/samples/read_samples/bulk-work-err.xml +45 -0
- data/resources/record_3.0/samples/read_samples/credit-name-3.0.xml +5 -0
- data/resources/record_3.0/samples/read_samples/distinction-3.0.xml +55 -0
- data/resources/record_3.0/samples/read_samples/distinctions-3.0.xml +106 -0
- data/resources/record_3.0/samples/read_samples/education-3.0.xml +55 -0
- data/resources/record_3.0/samples/read_samples/education-full-3.0.xml +55 -0
- data/resources/record_3.0/samples/read_samples/educations-3.0.xml +118 -0
- data/resources/record_3.0/samples/read_samples/email-3.0.xml +16 -0
- data/resources/record_3.0/samples/read_samples/emails-3.0.xml +31 -0
- data/resources/record_3.0/samples/read_samples/employment-3.0.xml +55 -0
- data/resources/record_3.0/samples/read_samples/employment-full-3.0.xml +55 -0
- data/resources/record_3.0/samples/read_samples/employments-3.0.xml +108 -0
- data/resources/record_3.0/samples/read_samples/error-3.0.xml +8 -0
- data/resources/record_3.0/samples/read_samples/external-identifier-3.0.xml +21 -0
- data/resources/record_3.0/samples/read_samples/external-identifiers-3.0.xml +38 -0
- data/resources/record_3.0/samples/read_samples/full-record-3.0.json +2332 -0
- data/resources/record_3.0/samples/read_samples/funding-3.0.xml +75 -0
- data/resources/record_3.0/samples/read_samples/funding-full-3.0.xml +75 -0
- data/resources/record_3.0/samples/read_samples/fundings-3.0.xml +139 -0
- data/resources/record_3.0/samples/read_samples/history-3.0.xml +22 -0
- data/resources/record_3.0/samples/read_samples/invited-position-3.0.xml +55 -0
- data/resources/record_3.0/samples/read_samples/invited-positions-3.0.xml +106 -0
- data/resources/record_3.0/samples/read_samples/keyword-3.0.xml +18 -0
- data/resources/record_3.0/samples/read_samples/keywords-3.0.xml +34 -0
- data/resources/record_3.0/samples/read_samples/membership-3.0.xml +55 -0
- data/resources/record_3.0/samples/read_samples/memberships-3.0.xml +106 -0
- data/resources/record_3.0/samples/read_samples/name-3.0.xml +12 -0
- data/resources/record_3.0/samples/read_samples/other-name-3.0.xml +16 -0
- data/resources/record_3.0/samples/read_samples/other-names-3.0.xml +31 -0
- data/resources/record_3.0/samples/read_samples/peer-review-3.0.xml +59 -0
- data/resources/record_3.0/samples/read_samples/peer-review-full-3.0.xml +59 -0
- data/resources/record_3.0/samples/read_samples/peer-reviews-3.0.xml +76 -0
- data/resources/record_3.0/samples/read_samples/person-3.0.xml +122 -0
- data/resources/record_3.0/samples/read_samples/personal-details-3.0.xml +47 -0
- data/resources/record_3.0/samples/read_samples/preferences-3.0.xml +4 -0
- data/resources/record_3.0/samples/read_samples/qualification-3.0.xml +55 -0
- data/resources/record_3.0/samples/read_samples/qualifications-3.0.xml +106 -0
- data/resources/record_3.0/samples/read_samples/record-3.0.xml +770 -0
- data/resources/record_3.0/samples/read_samples/research-resource-3.0.xml +138 -0
- data/resources/record_3.0/samples/read_samples/research-resources-3.0.xml +143 -0
- data/resources/record_3.0/samples/read_samples/researcher-url-3.0.xml +19 -0
- data/resources/record_3.0/samples/read_samples/researcher-urls-3.0.xml +21 -0
- data/resources/record_3.0/samples/read_samples/search-3.0.xml +14 -0
- data/resources/record_3.0/samples/read_samples/service-3.0.xml +55 -0
- data/resources/record_3.0/samples/read_samples/services-3.0.xml +106 -0
- data/resources/record_3.0/samples/read_samples/work-3.0.xml +65 -0
- data/resources/record_3.0/samples/read_samples/work-full-3.0.xml +65 -0
- data/resources/record_3.0/samples/read_samples/works-3.0.xml +148 -0
- data/resources/record_3.0/samples/write_samples/address-3.0.xml +6 -0
- data/resources/record_3.0/samples/write_samples/bulk-work-3.0.json +53 -0
- data/resources/record_3.0/samples/write_samples/bulk-work-3.0.xml +47 -0
- data/resources/record_3.0/samples/write_samples/distinction-3.0.xml +46 -0
- data/resources/record_3.0/samples/write_samples/education-3.0.xml +45 -0
- data/resources/record_3.0/samples/write_samples/employment-3.0.xml +45 -0
- data/resources/record_3.0/samples/write_samples/external-identifier-3.0.xml +11 -0
- data/resources/record_3.0/samples/write_samples/funding-3.0.xml +44 -0
- data/resources/record_3.0/samples/write_samples/invited-position-3.0.xml +45 -0
- data/resources/record_3.0/samples/write_samples/keyword-3.0.xml +7 -0
- data/resources/record_3.0/samples/write_samples/membership-3.0.xml +45 -0
- data/resources/record_3.0/samples/write_samples/other-name-3.0.xml +6 -0
- data/resources/record_3.0/samples/write_samples/peer-review-full-3.0.xml +48 -0
- data/resources/record_3.0/samples/write_samples/peer-review-full-award-subject-type-3.0.xml +48 -0
- data/resources/record_3.0/samples/write_samples/peer-review-simple-3.0.xml +32 -0
- data/resources/record_3.0/samples/write_samples/qualification-3.0.xml +45 -0
- data/resources/record_3.0/samples/write_samples/research-resource-3.0.xml +110 -0
- data/resources/record_3.0/samples/write_samples/researcher-url-3.0-no-name.xml +6 -0
- data/resources/record_3.0/samples/write_samples/researcher-url-3.0.xml +7 -0
- data/resources/record_3.0/samples/write_samples/service-3.0.xml +45 -0
- data/resources/record_3.0/samples/write_samples/work-full-3.0.xml +60 -0
- data/resources/record_3.0/samples/write_samples/work-simple-3.0.xml +18 -0
- data/resources/record_3.0/search-3.0.xsd +62 -0
- data/resources/record_3.0/service-3.0.xsd +51 -0
- data/resources/record_3.0/work-3.0.xsd +269 -0
- data/spec/api_spec.rb +2 -2
- data/spec/external_identifier_spec.rb +2 -2
- data/spec/fixtures/external_identifier.xml +1 -1
- data/spec/fixtures/vcr_cassettes/OrcidClient/works/get/should_get_works.yml +19 -10
- data/spec/fixtures/vcr_cassettes/OrcidClient/works/post/should_create_work.yml +52 -38
- data/spec/fixtures/vcr_cassettes/OrcidClient_Notification/data.yml +35 -28
- data/spec/fixtures/vcr_cassettes/OrcidClient_Notification/schema/validates_data.yml +34 -27
- data/spec/fixtures/vcr_cassettes/OrcidClient_Notification/schema/validates_item_type_work.yml +29 -37
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/contributors/literal.yml +45 -32
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/contributors/multiple_titles.yml +35 -28
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/contributors/valid.yml +35 -28
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/contributors/with_ORCID_IDs.yml +28 -22
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/data.yml +34 -27
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/publication_date.yml +35 -28
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/schema/validates_ORCID_IDs_for_contributors.yml +29 -23
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/schema/validates_data.yml +34 -27
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/schema/validates_work_from_DataCite_test_system.yml +28 -22
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/schema/validates_work_type_data-set.yml +29 -37
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/user_example/fail/valid.yml +28 -22
- data/spec/fixtures/work.xml +1 -1
- data/spec/notification_spec.rb +2 -2
- data/spec/work_spec.rb +2 -2
- metadata +126 -6
@@ -0,0 +1,50 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
+
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
3
|
+
xmlns:sch="http://purl.oclc.org/dsdl/schematron" elementFormDefault="qualified"
|
4
|
+
targetNamespace="http://www.orcid.org/ns/invited-position" xmlns:invited-position="http://www.orcid.org/ns/invited-position"
|
5
|
+
xmlns:common="http://www.orcid.org/ns/common">
|
6
|
+
<xs:annotation>
|
7
|
+
<xs:documentation>
|
8
|
+
=============================================================================
|
9
|
+
|
10
|
+
ORCID (R) Open Source
|
11
|
+
http://orcid.org
|
12
|
+
|
13
|
+
Copyright (c) 2012-2018 ORCID,
|
14
|
+
Inc.
|
15
|
+
Licensed under an MIT-Style License (MIT)
|
16
|
+
http://orcid.org/open-source-license
|
17
|
+
|
18
|
+
This copyright and license
|
19
|
+
information (including a link to the full
|
20
|
+
license)
|
21
|
+
shall be included in
|
22
|
+
its entirety in all copies or substantial portion of
|
23
|
+
the software.
|
24
|
+
|
25
|
+
=============================================================================
|
26
|
+
The schema describes the message format used for ORCID API requests
|
27
|
+
and responses.
|
28
|
+
</xs:documentation>
|
29
|
+
<xs:appinfo>
|
30
|
+
<sch:title>Schematron validation</sch:title>
|
31
|
+
<sch:ns prefix="orcid" uri="http://www.orcid.org/ns/orcid" />
|
32
|
+
</xs:appinfo>
|
33
|
+
</xs:annotation>
|
34
|
+
|
35
|
+
<xs:import namespace="http://www.orcid.org/ns/common"
|
36
|
+
schemaLocation="../common_3.0/common-3.0.xsd" />
|
37
|
+
|
38
|
+
<xs:element name="invited-position" type="common:affiliation">
|
39
|
+
<xs:annotation>
|
40
|
+
<xs:documentation>An invited position the researcher served.
|
41
|
+
Invited Position is defined as an invited non-employment affiliation. This includes formal acknowledgements of an individual’s academic efforts through honorary titles and/or positions which require no specific service. May be paid or unpaid.
|
42
|
+
* The put-code attribute is returned when reading this element.
|
43
|
+
When updating the item, the put-code attribute must be included to indicate the specific item to be updated.
|
44
|
+
</xs:documentation>
|
45
|
+
</xs:annotation>
|
46
|
+
</xs:element>
|
47
|
+
|
48
|
+
<xs:element name="invited-position-summary" type="common:affiliation-summary" />
|
49
|
+
|
50
|
+
</xs:schema>
|
@@ -0,0 +1,72 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
+
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
3
|
+
xmlns:sch="http://purl.oclc.org/dsdl/schematron" elementFormDefault="qualified"
|
4
|
+
targetNamespace="http://www.orcid.org/ns/keyword" xmlns:keyword="http://www.orcid.org/ns/keyword"
|
5
|
+
xmlns:common="http://www.orcid.org/ns/common">
|
6
|
+
<xs:annotation>
|
7
|
+
<xs:documentation>
|
8
|
+
=============================================================================
|
9
|
+
|
10
|
+
ORCID (R) Open Source
|
11
|
+
http://orcid.org
|
12
|
+
|
13
|
+
Copyright (c) 2012-2018 ORCID,
|
14
|
+
Inc.
|
15
|
+
Licensed under an MIT-Style License (MIT)
|
16
|
+
http://orcid.org/open-source-license
|
17
|
+
|
18
|
+
This copyright and license
|
19
|
+
information (including a link to the full
|
20
|
+
license)
|
21
|
+
shall be included in
|
22
|
+
its entirety in all copies or substantial portion of
|
23
|
+
the software.
|
24
|
+
|
25
|
+
=============================================================================
|
26
|
+
The schema describes the message format used for ORCID API requests
|
27
|
+
and responses.
|
28
|
+
</xs:documentation>
|
29
|
+
<xs:appinfo>
|
30
|
+
<sch:title>Schematron validation</sch:title>
|
31
|
+
<sch:ns prefix="keyword" uri="http://www.orcid.org/ns/keyword" />
|
32
|
+
</xs:appinfo>
|
33
|
+
</xs:annotation>
|
34
|
+
|
35
|
+
<xs:import namespace="http://www.orcid.org/ns/common"
|
36
|
+
schemaLocation="../common_3.0/common-3.0.xsd" />
|
37
|
+
|
38
|
+
<xs:element name="keywords">
|
39
|
+
<xs:complexType>
|
40
|
+
<xs:annotation>
|
41
|
+
<xs:documentation>Keyworks container</xs:documentation>
|
42
|
+
</xs:annotation>
|
43
|
+
<xs:sequence>
|
44
|
+
<xs:element ref="common:last-modified-date" minOccurs="0" maxOccurs="1" />
|
45
|
+
<xs:element name="keyword" type="keyword:keyword" minOccurs="0"
|
46
|
+
maxOccurs="unbounded" />
|
47
|
+
</xs:sequence>
|
48
|
+
<xs:attribute name="path" type="common:element-path" use="optional" />
|
49
|
+
</xs:complexType>
|
50
|
+
</xs:element>
|
51
|
+
|
52
|
+
<xs:element name="keyword">
|
53
|
+
<xs:annotation>
|
54
|
+
<xs:documentation>Keyword</xs:documentation>
|
55
|
+
</xs:annotation>
|
56
|
+
<xs:complexType>
|
57
|
+
<xs:complexContent>
|
58
|
+
<xs:extension base="keyword:keyword" />
|
59
|
+
</xs:complexContent>
|
60
|
+
</xs:complexType>
|
61
|
+
</xs:element>
|
62
|
+
|
63
|
+
<xs:complexType name="keyword">
|
64
|
+
<xs:complexContent>
|
65
|
+
<xs:extension base="common:element-summary">
|
66
|
+
<xs:sequence>
|
67
|
+
<xs:element minOccurs="1" name="content" type="common:string-255" />
|
68
|
+
</xs:sequence>
|
69
|
+
</xs:extension>
|
70
|
+
</xs:complexContent>
|
71
|
+
</xs:complexType>
|
72
|
+
</xs:schema>
|
@@ -0,0 +1,51 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
+
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
3
|
+
xmlns:sch="http://purl.oclc.org/dsdl/schematron" elementFormDefault="qualified"
|
4
|
+
targetNamespace="http://www.orcid.org/ns/membership" xmlns:membership="http://www.orcid.org/ns/membership"
|
5
|
+
xmlns:common="http://www.orcid.org/ns/common">
|
6
|
+
<xs:annotation>
|
7
|
+
<xs:documentation>
|
8
|
+
=============================================================================
|
9
|
+
|
10
|
+
ORCID (R) Open Source
|
11
|
+
http://orcid.org
|
12
|
+
|
13
|
+
Copyright (c) 2012-2018 ORCID,
|
14
|
+
Inc.
|
15
|
+
Licensed under an MIT-Style License (MIT)
|
16
|
+
http://orcid.org/open-source-license
|
17
|
+
|
18
|
+
This copyright and license
|
19
|
+
information (including a link to the full
|
20
|
+
license)
|
21
|
+
shall be included in
|
22
|
+
its entirety in all copies or substantial portion of
|
23
|
+
the software.
|
24
|
+
|
25
|
+
=============================================================================
|
26
|
+
The schema describes the message format used for ORCID API requests
|
27
|
+
and responses.
|
28
|
+
</xs:documentation>
|
29
|
+
<xs:appinfo>
|
30
|
+
<sch:title>Schematron validation</sch:title>
|
31
|
+
<sch:ns prefix="orcid" uri="http://www.orcid.org/ns/orcid" />
|
32
|
+
</xs:appinfo>
|
33
|
+
</xs:annotation>
|
34
|
+
|
35
|
+
<xs:import namespace="http://www.orcid.org/ns/common"
|
36
|
+
schemaLocation="../common_3.0/common-3.0.xsd" />
|
37
|
+
|
38
|
+
<xs:element name="membership" type="common:affiliation">
|
39
|
+
<xs:annotation>
|
40
|
+
<xs:documentation>A membership associated with the researcher.
|
41
|
+
Membership is defined as paid or gratis membership of a society or association (i.e. does not include honorary memberships and fellowships as defined under Invited Position and Distinctions)
|
42
|
+
* The put-code attribute is returned when reading this element.
|
43
|
+
When updating the item, the put-code attribute must be included to indicate the specific item to be updated.
|
44
|
+
|
45
|
+
</xs:documentation>
|
46
|
+
</xs:annotation>
|
47
|
+
</xs:element>
|
48
|
+
|
49
|
+
<xs:element name="membership-summary" type="common:affiliation-summary" />
|
50
|
+
|
51
|
+
</xs:schema>
|
@@ -0,0 +1,78 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
+
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
3
|
+
xmlns:sch="http://purl.oclc.org/dsdl/schematron" elementFormDefault="qualified"
|
4
|
+
targetNamespace="http://www.orcid.org/ns/other-name" xmlns:other-name="http://www.orcid.org/ns/other-name"
|
5
|
+
xmlns:common="http://www.orcid.org/ns/common">
|
6
|
+
<xs:annotation>
|
7
|
+
<xs:documentation>
|
8
|
+
=============================================================================
|
9
|
+
|
10
|
+
ORCID (R) Open Source
|
11
|
+
http://orcid.org
|
12
|
+
|
13
|
+
Copyright (c) 2012-2018 ORCID,
|
14
|
+
Inc.
|
15
|
+
Licensed under an MIT-Style License (MIT)
|
16
|
+
http://orcid.org/open-source-license
|
17
|
+
|
18
|
+
This copyright and license
|
19
|
+
information (including a link to the full
|
20
|
+
license)
|
21
|
+
shall be included in
|
22
|
+
its entirety in all copies or substantial portion of
|
23
|
+
the software.
|
24
|
+
|
25
|
+
=============================================================================
|
26
|
+
The schema describes the message format used for ORCID API requests
|
27
|
+
and responses.
|
28
|
+
</xs:documentation>
|
29
|
+
<xs:appinfo>
|
30
|
+
<sch:title>Schematron validation</sch:title>
|
31
|
+
<sch:ns prefix="other-name" uri="http://www.orcid.org/ns/other-name" />
|
32
|
+
</xs:appinfo>
|
33
|
+
</xs:annotation>
|
34
|
+
<xs:import namespace="http://www.orcid.org/ns/common"
|
35
|
+
schemaLocation="../common_3.0/common-3.0.xsd" />
|
36
|
+
|
37
|
+
<xs:element name="other-names">
|
38
|
+
<xs:complexType>
|
39
|
+
<xs:annotation>
|
40
|
+
<xs:documentation>Container for other names.
|
41
|
+
</xs:documentation>
|
42
|
+
</xs:annotation>
|
43
|
+
<xs:sequence>
|
44
|
+
<xs:element ref="common:last-modified-date" minOccurs="0" maxOccurs="1" />
|
45
|
+
<xs:element name="other-name" type="other-name:other-name"
|
46
|
+
minOccurs="0" maxOccurs="unbounded" />
|
47
|
+
</xs:sequence>
|
48
|
+
<xs:attribute name="path" type="common:element-path" use="optional" />
|
49
|
+
</xs:complexType>
|
50
|
+
</xs:element>
|
51
|
+
|
52
|
+
<xs:element name="other-name">
|
53
|
+
<xs:annotation>
|
54
|
+
<xs:documentation>Other name(s) that the researcher is or was known by. Max length is 255 characters
|
55
|
+
</xs:documentation>
|
56
|
+
</xs:annotation>
|
57
|
+
<xs:complexType>
|
58
|
+
<xs:complexContent>
|
59
|
+
<xs:extension base="other-name:other-name"></xs:extension>
|
60
|
+
</xs:complexContent>
|
61
|
+
</xs:complexType>
|
62
|
+
</xs:element>
|
63
|
+
|
64
|
+
<xs:complexType name="other-name">
|
65
|
+
<xs:complexContent>
|
66
|
+
<xs:extension base="common:element-summary">
|
67
|
+
<xs:sequence>
|
68
|
+
<xs:element minOccurs="1" name="content" type="common:string-255">
|
69
|
+
<xs:annotation>
|
70
|
+
<xs:documentation>A name for the researcher.
|
71
|
+
</xs:documentation>
|
72
|
+
</xs:annotation>
|
73
|
+
</xs:element>
|
74
|
+
</xs:sequence>
|
75
|
+
</xs:extension>
|
76
|
+
</xs:complexContent>
|
77
|
+
</xs:complexType>
|
78
|
+
</xs:schema>
|
@@ -0,0 +1,263 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
+
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
3
|
+
xmlns:sch="http://purl.oclc.org/dsdl/schematron" elementFormDefault="qualified"
|
4
|
+
targetNamespace="http://www.orcid.org/ns/peer-review"
|
5
|
+
xmlns:common="http://www.orcid.org/ns/common"
|
6
|
+
xmlns:peer-review="http://www.orcid.org/ns/peer-review">
|
7
|
+
<xs:annotation>
|
8
|
+
<xs:documentation>
|
9
|
+
=============================================================================
|
10
|
+
|
11
|
+
ORCID (R) Open Source
|
12
|
+
http://orcid.org
|
13
|
+
|
14
|
+
Copyright (c) 2012-2018 ORCID,
|
15
|
+
Inc.
|
16
|
+
Licensed under an MIT-Style License (MIT)
|
17
|
+
http://orcid.org/open-source-license
|
18
|
+
|
19
|
+
This copyright and license
|
20
|
+
information (including a link to the full
|
21
|
+
license)
|
22
|
+
shall be included in
|
23
|
+
its entirety in all copies or substantial portion of
|
24
|
+
the software.
|
25
|
+
|
26
|
+
=============================================================================
|
27
|
+
The schema describes the message format used for ORCID API requests
|
28
|
+
and responses.
|
29
|
+
The top level element is orcid-message.
|
30
|
+
</xs:documentation>
|
31
|
+
<xs:appinfo>
|
32
|
+
<sch:title>Schematron validation</sch:title>
|
33
|
+
<sch:ns prefix="orcid" uri="http://www.orcid.org/ns/orcid" />
|
34
|
+
</xs:appinfo>
|
35
|
+
</xs:annotation>
|
36
|
+
|
37
|
+
<xs:import namespace="http://www.orcid.org/ns/common"
|
38
|
+
schemaLocation="../common_3.0/common-3.0.xsd" />
|
39
|
+
|
40
|
+
<xs:element name="peer-review">
|
41
|
+
<xs:complexType>
|
42
|
+
<xs:complexContent>
|
43
|
+
<xs:extension base="common:element-summary">
|
44
|
+
<xs:sequence>
|
45
|
+
<xs:element name="reviewer-role" type="peer-review:role" minOccurs="1" maxOccurs="1">
|
46
|
+
<xs:annotation>
|
47
|
+
<xs:documentation>The role played by a person in their contribution to a review.
|
48
|
+
Options for this field are: chair, editor, member, organizer, reviewer
|
49
|
+
</xs:documentation>
|
50
|
+
</xs:annotation>
|
51
|
+
</xs:element>
|
52
|
+
<xs:element name="review-identifiers" type="common:external-ids"
|
53
|
+
minOccurs="1">
|
54
|
+
<xs:annotation>
|
55
|
+
<xs:documentation>Unique identifier(s) of the review. <i>This identifier refers to the review itself, NOT to the item that was reviewed.</i> 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.
|
56
|
+
Identifier types must be selected from the list at https://pub.orcid.org/v2.0/identifiers
|
57
|
+
</xs:documentation>
|
58
|
+
</xs:annotation>
|
59
|
+
</xs:element>
|
60
|
+
<xs:element name="review-url" type="common:url" minOccurs="0">
|
61
|
+
<xs:annotation>
|
62
|
+
<xs:documentation>A link to a representation of the review on the web. <i>This URL refers to the review itself, NOT to the item that was reviewed.</i>
|
63
|
+
</xs:documentation>
|
64
|
+
</xs:annotation>
|
65
|
+
</xs:element>
|
66
|
+
<xs:element name="review-type" type="peer-review:type"
|
67
|
+
minOccurs="1" maxOccurs="1">
|
68
|
+
<xs:annotation>
|
69
|
+
<xs:documentation>The kind of review. Options for this field are: evaluation, review
|
70
|
+
</xs:documentation>
|
71
|
+
</xs:annotation>
|
72
|
+
</xs:element>
|
73
|
+
<xs:element name="review-completion-date" type="common:fuzzy-date"
|
74
|
+
minOccurs="1" maxOccurs="1">
|
75
|
+
<xs:annotation>
|
76
|
+
<xs:documentation>The date on which the review was completed. Allowable values: yyyy; yyyy-mm; yyyy-mm-dd, formatted using the ORCID fuzzy date format.
|
77
|
+
</xs:documentation>
|
78
|
+
</xs:annotation>
|
79
|
+
</xs:element>
|
80
|
+
<xs:element name="review-group-id" type="common:group-id" minOccurs="1" maxOccurs="1">
|
81
|
+
<xs:annotation>
|
82
|
+
<xs:documentation>Identifier for the group that this review should be a part of for aggregation purposes
|
83
|
+
</xs:documentation>
|
84
|
+
</xs:annotation>
|
85
|
+
</xs:element>
|
86
|
+
<xs:element name="subject-external-identifier" type="common:external-id"
|
87
|
+
minOccurs="0">
|
88
|
+
<xs:annotation>
|
89
|
+
<xs:documentation>The unique identifier of the subject being reviewed.
|
90
|
+
Identifier types must be selected from the list at https://pub.orcid.org/v2.0/identifiers
|
91
|
+
</xs:documentation>
|
92
|
+
</xs:annotation>
|
93
|
+
</xs:element>
|
94
|
+
<xs:element name="subject-container-name" type="common:string-1000"
|
95
|
+
minOccurs="0" maxOccurs="1">
|
96
|
+
<xs:annotation>
|
97
|
+
<xs:documentation>The name of the journal, conference, grant review panel, or other applicable object of which the review subject was a part.
|
98
|
+
</xs:documentation>
|
99
|
+
</xs:annotation>
|
100
|
+
</xs:element>
|
101
|
+
<xs:element name="subject-type" type="peer-review:subject-type" minOccurs="0" maxOccurs="1">
|
102
|
+
<xs:annotation>
|
103
|
+
<xs:documentation>The type of object that the review subject is (for example, a journal article, grant, etc).
|
104
|
+
</xs:documentation>
|
105
|
+
</xs:annotation>
|
106
|
+
</xs:element>
|
107
|
+
<xs:element name="subject-name" type="peer-review:subject-name"
|
108
|
+
minOccurs="0" maxOccurs="1">
|
109
|
+
<xs:annotation>
|
110
|
+
<xs:documentation>The name/title of the object that was reviewed.
|
111
|
+
</xs:documentation>
|
112
|
+
</xs:annotation>
|
113
|
+
</xs:element>
|
114
|
+
<xs:element name="subject-url" type="common:url" minOccurs="0" maxOccurs="1">
|
115
|
+
<xs:annotation>
|
116
|
+
<xs:documentation>The URL of the object that was reviewed.
|
117
|
+
</xs:documentation>
|
118
|
+
</xs:annotation>
|
119
|
+
</xs:element>
|
120
|
+
<!-- orcid orgs doesn't match specification -->
|
121
|
+
<xs:element name="convening-organization" type="common:organization"
|
122
|
+
minOccurs="1" maxOccurs="1">
|
123
|
+
<xs:annotation>
|
124
|
+
<xs:documentation>Information about the organization convening the review (journal publisher, conference organizer, funding agency, etc). A valid organizational identifier (Ringgold ID, GRID ID or FundRef ID is required).
|
125
|
+
</xs:documentation>
|
126
|
+
</xs:annotation>
|
127
|
+
</xs:element>
|
128
|
+
</xs:sequence>
|
129
|
+
</xs:extension>
|
130
|
+
</xs:complexContent>
|
131
|
+
</xs:complexType>
|
132
|
+
</xs:element>
|
133
|
+
|
134
|
+
<xs:element name="peer-review-summary">
|
135
|
+
<xs:complexType>
|
136
|
+
<xs:complexContent>
|
137
|
+
<xs:extension base="common:element-summary">
|
138
|
+
<xs:sequence>
|
139
|
+
<!-- orcid orgs doesn't match specification -->
|
140
|
+
<xs:element name="reviewer-role" type="peer-review:role" minOccurs="1" maxOccurs="1">
|
141
|
+
<xs:annotation>
|
142
|
+
<xs:documentation>The role played by a person in their
|
143
|
+
contribution to a review.
|
144
|
+
</xs:documentation>
|
145
|
+
</xs:annotation>
|
146
|
+
</xs:element>
|
147
|
+
<xs:element ref="common:external-ids"
|
148
|
+
minOccurs="0">
|
149
|
+
<xs:annotation>
|
150
|
+
<xs:documentation>The unique identifier of the review.
|
151
|
+
</xs:documentation>
|
152
|
+
</xs:annotation>
|
153
|
+
</xs:element>
|
154
|
+
<xs:element name="review-url" type="common:url" minOccurs="0">
|
155
|
+
<xs:annotation>
|
156
|
+
<xs:documentation>A link to a representation of the review on the web. <i>This URL refers to the review itself, NOT to the item that was reviewed.</i>
|
157
|
+
</xs:documentation>
|
158
|
+
</xs:annotation>
|
159
|
+
</xs:element>
|
160
|
+
<xs:element name="review-type" type="peer-review:type"
|
161
|
+
minOccurs="1" maxOccurs="1">
|
162
|
+
<xs:annotation>
|
163
|
+
<xs:documentation>The kind of review applied to the subject type
|
164
|
+
reviewed
|
165
|
+
</xs:documentation>
|
166
|
+
</xs:annotation>
|
167
|
+
</xs:element>
|
168
|
+
<xs:element name="completion-date" type="common:fuzzy-date"
|
169
|
+
minOccurs="1" maxOccurs="1">
|
170
|
+
<xs:annotation>
|
171
|
+
<xs:documentation>The date on which the review was completed. Allowable values: yyyy; yyyy-mm; yyyy-mm-dd, formatted using the ORCID fuzzy date format.
|
172
|
+
</xs:documentation>
|
173
|
+
</xs:annotation>
|
174
|
+
</xs:element>
|
175
|
+
<xs:element name="review-group-id" type="common:group-id" minOccurs="1" maxOccurs="1">
|
176
|
+
<xs:annotation>
|
177
|
+
<xs:documentation>Identifier for the group that this review should be a part of for aggregation purposes
|
178
|
+
</xs:documentation>
|
179
|
+
</xs:annotation>
|
180
|
+
</xs:element>
|
181
|
+
<xs:element name="convening-organization" type="common:organization"
|
182
|
+
minOccurs="1" maxOccurs="1">
|
183
|
+
<xs:annotation>
|
184
|
+
<xs:documentation>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.
|
185
|
+
</xs:documentation>
|
186
|
+
</xs:annotation>
|
187
|
+
</xs:element>
|
188
|
+
</xs:sequence>
|
189
|
+
</xs:extension>
|
190
|
+
</xs:complexContent>
|
191
|
+
</xs:complexType>
|
192
|
+
</xs:element>
|
193
|
+
|
194
|
+
<xs:simpleType name="subject-type">
|
195
|
+
<xs:annotation>
|
196
|
+
<xs:documentation>The type of object that the review subject is, from the list of supported work types in https://members.orcid.org/api/resources/work-types as well as the following types:
|
197
|
+
* award: Peer-reviewed funding providing direct research costs through competitions
|
198
|
+
* 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
|
199
|
+
* grant: Peer-reviewed funding providing direct research costs through competitions
|
200
|
+
* salary-award: A competitive, peer-reviewed award that is paid as salary to the awardee/faculty member
|
201
|
+
* research-resource-proposal: A peer-reviewed proposal of use of a research resource
|
202
|
+
* undefined
|
203
|
+
ORCID will validate this value against the enumeration
|
204
|
+
https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/PeerReviewSubjectType.java and other rules when necessary.
|
205
|
+
</xs:documentation>
|
206
|
+
</xs:annotation>
|
207
|
+
<xs:restriction base="xs:string" />
|
208
|
+
</xs:simpleType>
|
209
|
+
|
210
|
+
<xs:simpleType name="role">
|
211
|
+
<xs:annotation>
|
212
|
+
<xs:documentation>
|
213
|
+
The role performed by the reviewer, selected from the following options:
|
214
|
+
* reviewer: A person who formally assess or examines an
|
215
|
+
output with a view to
|
216
|
+
commenting and evaluating it.
|
217
|
+
* editor: A person who coordinates reviews and/or is
|
218
|
+
responsible for decision making on the content of a publication.
|
219
|
+
* member: A person participating in a process, committee or
|
220
|
+
activity.
|
221
|
+
* chair: A person who coordinates reviews and/or is
|
222
|
+
responsible for decision making on the content of a conference.
|
223
|
+
* organizer: A person who makes arrangements or preparations
|
224
|
+
for an event or activity.
|
225
|
+
ORCID will validate this value against the enumeration
|
226
|
+
https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/Role.java and other rules when necessary
|
227
|
+
</xs:documentation>
|
228
|
+
</xs:annotation>
|
229
|
+
<xs:restriction base="xs:string" />
|
230
|
+
</xs:simpleType>
|
231
|
+
|
232
|
+
<xs:simpleType name="type">
|
233
|
+
<xs:annotation>
|
234
|
+
<xs:documentation>
|
235
|
+
The type of review this is, selected from the following options:
|
236
|
+
* review: An expert assessment of a scholarly output that
|
237
|
+
contributes to a decision regarding on the object of the review.
|
238
|
+
* evaluation: A post-peer review, expert evaluation of a
|
239
|
+
scholarly output.
|
240
|
+
ORCID will validate this value against the enumeration
|
241
|
+
https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/PeerReviewType.java and other rules when necessary
|
242
|
+
</xs:documentation>
|
243
|
+
</xs:annotation>
|
244
|
+
<xs:restriction base="xs:string" />
|
245
|
+
</xs:simpleType>
|
246
|
+
|
247
|
+
<xs:complexType name="subject-name">
|
248
|
+
<xs:annotation>
|
249
|
+
<xs:documentation>Container for peer-review subject name.
|
250
|
+
</xs:documentation>
|
251
|
+
</xs:annotation>
|
252
|
+
<xs:sequence>
|
253
|
+
<xs:element ref="common:title">
|
254
|
+
<xs:annotation>
|
255
|
+
<xs:documentation>The main name or title of the subject.
|
256
|
+
</xs:documentation>
|
257
|
+
</xs:annotation>
|
258
|
+
</xs:element>
|
259
|
+
<xs:element ref="common:subtitle" minOccurs="0" />
|
260
|
+
<xs:element ref="common:translated-title" minOccurs="0" />
|
261
|
+
</xs:sequence>
|
262
|
+
</xs:complexType>
|
263
|
+
</xs:schema>
|