orcid_client 0.3.3 → 0.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.env.example +1 -1
- data/Gemfile.lock +85 -81
- data/lib/orcid_client/api.rb +1 -1
- data/lib/orcid_client/base.rb +3 -2
- data/lib/orcid_client/external_identifier.rb +1 -1
- data/lib/orcid_client/notification.rb +1 -1
- data/lib/orcid_client/version.rb +1 -1
- data/lib/orcid_client/work.rb +6 -5
- data/orcid_client.gemspec +3 -3
- data/resources/README.md +131 -0
- data/resources/{common_2.0/common-2.0.xsd → common_2.1/common-2.1.xsd} +2 -2
- data/resources/{common_2.0/samples/common-2.0.xml → common_2.1/samples/common-2.1.xml} +2 -2
- data/resources/{notification_2.0 → notification_2.1}/README.md +10 -10
- data/resources/{notification_2.0/notification-custom-2.0.xsd → notification_2.1/notification-custom-2.1.xsd} +1 -1
- data/resources/{notification_2.0/notification-permission-2.0.xsd → notification_2.1/notification-permission-2.1.xsd} +3 -3
- data/resources/{notification_2.0/samples/notification-custom-2.0.xml → notification_2.1/samples/notification-custom-2.1.xml} +2 -2
- data/resources/{notification_2.0/samples/notification-permission-2.0.xml → notification_2.1/samples/notification-permission-2.1.xml} +2 -2
- data/resources/orcid-error-1.0.xsd +69 -0
- data/resources/{record_2.0 → record_2.1}/README.md +154 -155
- data/resources/{record_2.0/activities-2.0.xsd → record_2.1/activities-2.1.xsd} +6 -6
- data/resources/{record_2.0/address-2.0.xsd → record_2.1/address-2.1.xsd} +1 -1
- data/resources/{record_2.0/bulk-2.0.xsd → record_2.1/bulk-2.1.xsd} +2 -2
- data/resources/{record_2.0/education-2.0.xsd → record_2.1/education-2.1.xsd} +1 -1
- data/resources/{record_2.0/email-2.0.xsd → record_2.1/email-2.1.xsd} +1 -1
- data/resources/{record_2.0/employment-2.0.xsd → record_2.1/employment-2.1.xsd} +1 -1
- data/resources/{record_2.0/error-2.0.xsd → record_2.1/error-2.1.xsd} +0 -0
- data/resources/{record_2.0/funding-2.0.xsd → record_2.1/funding-2.1.xsd} +1 -1
- data/resources/{record_2.0/history-2.0.xsd → record_2.1/history-2.1.xsd} +1 -1
- data/resources/{record_2.0/keyword-2.0.xsd → record_2.1/keyword-2.1.xsd} +1 -1
- data/resources/{record_2.0/other-name-2.0.xsd → record_2.1/other-name-2.1.xsd} +1 -1
- data/resources/{record_2.0/peer-review-2.0.xsd → record_2.1/peer-review-2.1.xsd} +2 -2
- data/resources/{record_2.0/peer-review-guide-v2.0.md → record_2.1/peer-review-guide-v2.1.md} +17 -17
- data/resources/{record_2.0/person-2.0.xsd → record_2.1/person-2.1.xsd} +9 -9
- data/resources/{record_2.0/person-external-identifier-2.0.xsd → record_2.1/person-external-identifier-2.1.xsd} +1 -1
- data/resources/{record_2.0/personal-details-2.0.xsd → record_2.1/personal-details-2.1.xsd} +3 -3
- data/resources/{record_2.0/preferences-2.0.xsd → record_2.1/preferences-2.1.xsd} +1 -1
- data/resources/{record_2.0/record-2.0.xsd → record_2.1/record-2.1.xsd} +11 -11
- data/resources/{record_2.0/researcher-url-2.0.xsd → record_2.1/researcher-url-2.1.xsd} +1 -1
- data/resources/{record_2.0/samples/read_samples/activities-2.0.xml → record_2.1/samples/read_samples/activities-2.1.xml} +12 -12
- data/resources/{record_2.0/samples/read_samples/address-2.0.xml → record_2.1/samples/read_samples/address-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/addresses-2.0.xml → record_2.1/samples/read_samples/addresses-2.1.xml} +3 -3
- data/resources/{record_2.0/samples/read_samples/biography-2.0.xml → record_2.1/samples/read_samples/biography-2.1.xml} +2 -2
- data/resources/{record_2.0 → record_2.1}/samples/read_samples/bulk-work-error.xml +2 -2
- data/resources/{record_2.0/samples/read_samples/credit-name-2.0.xml → record_2.1/samples/read_samples/credit-name-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/read_samples/education-2.0.xml → record_2.1/samples/read_samples/education-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/education-full-2.0.xml → record_2.1/samples/read_samples/education-full-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/educations-2.0.xml → record_2.1/samples/read_samples/educations-2.1.xml} +4 -4
- data/resources/{record_2.0/samples/read_samples/email-2.0.xml → record_2.1/samples/read_samples/email-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/emails-2.0.xml → record_2.1/samples/read_samples/emails-2.1.xml} +3 -3
- data/resources/{record_2.0/samples/read_samples/employment-2.0.xml → record_2.1/samples/read_samples/employment-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/employment-full-2.0.xml → record_2.1/samples/read_samples/employment-full-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/employments-2.0.xml → record_2.1/samples/read_samples/employments-2.1.xml} +4 -4
- data/resources/{record_2.0/samples/read_samples/error-2.0.xml → record_2.1/samples/read_samples/error-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/read_samples/external-identifier-2.0.xml → record_2.1/samples/read_samples/external-identifier-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/external-identifiers-2.0.xml → record_2.1/samples/read_samples/external-identifiers-2.1.xml} +3 -3
- data/resources/{record_2.0/samples/read_samples/funding-2.0.xml → record_2.1/samples/read_samples/funding-2.1.xml} +3 -3
- data/resources/{record_2.0/samples/read_samples/funding-full-2.0.xml → record_2.1/samples/read_samples/funding-full-2.1.xml} +3 -3
- data/resources/{record_2.0/samples/read_samples/fundings-2.0.xml → record_2.1/samples/read_samples/fundings-2.1.xml} +4 -4
- data/resources/{record_2.0/samples/read_samples/history-2.0.xml → record_2.1/samples/read_samples/history-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/keyword-2.0.xml → record_2.1/samples/read_samples/keyword-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/keywords-2.0.xml → record_2.1/samples/read_samples/keywords-2.1.xml} +3 -3
- data/resources/{record_2.0/samples/read_samples/name-2.0.xml → record_2.1/samples/read_samples/name-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/read_samples/other-name-2.0.xml → record_2.1/samples/read_samples/other-name-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/other-names-2.0.xml → record_2.1/samples/read_samples/other-names-2.1.xml} +3 -3
- data/resources/{record_2.0/samples/read_samples/peer-review-2.0.xml → record_2.1/samples/read_samples/peer-review-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/peer-review-full-2.0.xml → record_2.1/samples/read_samples/peer-review-full-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/peer-reviews-2.0.xml → record_2.1/samples/read_samples/peer-reviews-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/person-2.0.xml → record_2.1/samples/read_samples/person-2.1.xml} +7 -7
- data/resources/{record_2.0/samples/read_samples/personal-details-2.0.xml → record_2.1/samples/read_samples/personal-details-2.1.xml} +3 -3
- data/resources/{record_2.0/samples/read_samples/preferences-2.0.xml → record_2.1/samples/read_samples/preferences-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/read_samples/record-2.0.xml → record_2.1/samples/read_samples/record-2.1.xml} +14 -14
- data/resources/{record_2.0/samples/read_samples/researcher-url-2.0.xml → record_2.1/samples/read_samples/researcher-url-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/researcher-urls-2.0.xml → record_2.1/samples/read_samples/researcher-urls-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/search-2.0.xml → record_2.1/samples/read_samples/search-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/read_samples/work-2.0.xml → record_2.1/samples/read_samples/work-2.1.xml} +3 -3
- data/resources/{record_2.0/samples/read_samples/work-full-2.0.xml → record_2.1/samples/read_samples/work-full-2.1.xml} +3 -3
- data/resources/{record_2.0/samples/read_samples/works-2.0.xml → record_2.1/samples/read_samples/works-2.1.xml} +4 -4
- data/resources/{record_2.0/samples/write_sample/address-2.0.xml → record_2.1/samples/write_samples/address-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/write_sample/bulk-work-2.0.json → record_2.1/samples/write_samples/bulk-work-2.1.json} +0 -0
- data/resources/{record_2.0/samples/write_sample/bulk-work-2.0.xml → record_2.1/samples/write_samples/bulk-work-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/write_sample/education-2.0.xml → record_2.1/samples/write_samples/education-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/write_sample/employment-2.0.xml → record_2.1/samples/write_samples/employment-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/write_sample/external-identifier-2.0.xml → record_2.1/samples/write_samples/external-identifier-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/write_sample/funding-2.0.xml → record_2.1/samples/write_samples/funding-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/write_sample/keyword-2.0.xml → record_2.1/samples/write_samples/keyword-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/write_sample/other-name-2.0.xml → record_2.1/samples/write_samples/other-name-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/write_sample/peer-review-full-2.0.xml → record_2.1/samples/write_samples/peer-review-full-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/write_sample/peer-review-simple-2.0.xml → record_2.1/samples/write_samples/peer-review-simple-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/write_sample/researcher-url-2.0.xml → record_2.1/samples/write_samples/researcher-url-2.1.xml} +1 -1
- data/resources/{record_2.0/samples/write_sample/work-full-2.0.xml → record_2.1/samples/write_samples/work-full-2.1.xml} +2 -2
- data/resources/{record_2.0/samples/write_sample/work-simple-2.0.xml → record_2.1/samples/write_samples/work-simple-2.1.xml} +1 -1
- data/resources/{record_2.0/search-2.0.xsd → record_2.1/search-2.1.xsd} +1 -1
- data/resources/{record_2.0/work-2.0.xsd → record_2.1/work-2.1.xsd} +2 -2
- data/resources/xml.xsd +286 -0
- data/spec/api_spec.rb +9 -9
- data/spec/author_spec.rb +1 -1
- 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 +6 -6
- data/spec/fixtures/vcr_cassettes/OrcidClient/external_identifier/post/should_create_external_identifier.yml +8 -8
- data/spec/fixtures/vcr_cassettes/OrcidClient/notifications/delete/should_delete_notification.yml +11 -15
- data/spec/fixtures/vcr_cassettes/OrcidClient/notifications/get/should_get_notification.yml +10 -15
- data/spec/fixtures/vcr_cassettes/OrcidClient/notifications/post/should_create_notification.yml +48 -57
- data/spec/fixtures/vcr_cassettes/OrcidClient/works/delete/should_delete_work.yml +6 -6
- data/spec/fixtures/vcr_cassettes/OrcidClient/works/get/should_get_works.yml +6 -614
- data/spec/fixtures/vcr_cassettes/OrcidClient/works/post/should_create_work.yml +48 -55
- data/spec/fixtures/vcr_cassettes/OrcidClient/works/put/should_update_work.yml +51 -62
- data/spec/fixtures/vcr_cassettes/OrcidClient_Notification/data.yml +41 -52
- data/spec/fixtures/vcr_cassettes/OrcidClient_Notification/schema/validates_data.yml +41 -50
- data/spec/fixtures/vcr_cassettes/OrcidClient_Notification/schema/validates_item_type_work.yml +51 -52
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/contributors/literal.yml +41 -52
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/contributors/multiple_titles.yml +51 -52
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/contributors/valid.yml +41 -52
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/contributors/with_ORCID_IDs.yml +55 -52
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/data.yml +41 -52
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/publication_date.yml +41 -52
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/schema/validates_ORCID_IDs_for_contributors.yml +55 -52
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/schema/validates_data.yml +41 -52
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/schema/validates_work_from_DataCite_test_system.yml +41 -60
- data/spec/fixtures/vcr_cassettes/OrcidClient_Work/schema/validates_work_type_data-set.yml +51 -52
- data/spec/fixtures/work.xml +1 -1
- data/spec/notification_spec.rb +3 -3
- data/spec/work_spec.rb +16 -17
- metadata +100 -103
@@ -757,7 +757,7 @@
|
|
757
757
|
</xs:annotation>
|
758
758
|
<xs:restriction base="xs:string">
|
759
759
|
<xs:pattern
|
760
|
-
value="
|
760
|
+
value="https://([^/]*orcid\.org|localhost.*/orcid-web)/(\d{4}-){3,}\d{3}[\dX]" />
|
761
761
|
</xs:restriction>
|
762
762
|
</xs:simpleType>
|
763
763
|
|
@@ -827,7 +827,7 @@
|
|
827
827
|
</xs:annotation>
|
828
828
|
<xs:restriction base="xs:string">
|
829
829
|
<xs:pattern
|
830
|
-
value="
|
830
|
+
value="https://([^/]*orcid\.org|localhost.*/orcid-web)/client/(APP-[\da-zA-Z]{16}|(\d{4}-){3,}\d{3}[\dX])" />
|
831
831
|
</xs:restriction>
|
832
832
|
</xs:simpleType>
|
833
833
|
|
@@ -1,8 +1,8 @@
|
|
1
1
|
<?xml version="1.0" encoding="UTF-8"?>
|
2
2
|
<common:application-group-orcid
|
3
3
|
xmlns:common="http://www.orcid.org/ns/common" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
4
|
-
xsi:schemaLocation="http://www.orcid.org/ns/common ../common-2.
|
5
|
-
<common:uri>
|
4
|
+
xsi:schemaLocation="http://www.orcid.org/ns/common ../common-2.1.xsd ">
|
5
|
+
<common:uri>https://orcid.org/8888-8888-8888-8880</common:uri>
|
6
6
|
<common:path>8888-8888-8888-8880</common:path>
|
7
7
|
<common:host>orcid.org</common:host>
|
8
8
|
</common:application-group-orcid>
|
@@ -1,11 +1,11 @@
|
|
1
1
|
|
2
|
-
#ORCID API v2.
|
3
|
-
Starting in v2.
|
2
|
+
#ORCID API v2.1 Notifications Permission Guide
|
3
|
+
Starting in v2.1, the ORCID API supports new functionality to enable member organizations to add permission requests to a user's ORCID Inbox. These requests provide a "snapshot" example of the type of activities that will be added to the user's ORCID record as a result of granting the permission.
|
4
4
|
|
5
5
|
_**User-friendly implementation detail**: Several fields described below are displayed directly to the end user. The ORCID user interface is currently available in 10+ languages, and emails sent to the user are also presented in the user's language of choice. The language preference of the user is available via the ORCID API, and is always public. We strongly recommend that you read and consider the user's language when providing messages to them, providing user-displayed fields in their preferred language when feasible._
|
6
6
|
|
7
7
|
##Notifications Permission XML
|
8
|
-
XML for the ```permission``` notifications follows the [notification-permission-2.
|
8
|
+
XML for the ```permission``` notifications follows the [notification-permission-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/notification_2.1/notification-permission-2.1.xsd) and consists of the following sections:
|
9
9
|
|
10
10
|
- **notification:notification-type**: The type of notification - for this type of notification, the value is always ```permission```.
|
11
11
|
|
@@ -27,7 +27,7 @@ Consists of one or more ```notification:item``` elements, which contain the foll
|
|
27
27
|
|
28
28
|
- **notification:external-identifier**: DISPLAYED TO END USER. An external identifier for the item. While this field is not required, it is very helpful information to provide to the end user, as it distinguishes the item from others that may be similar. Note that, when adding the item to the ORCID record, at least one external identifier is required, even if an internal reference identifier is used for this purpose.
|
29
29
|
|
30
|
-
For an example XML file, see [notification-permission-2.
|
30
|
+
For an example XML file, see [notification-permission-2.1.xml](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/notification_2.1/samples/notification-permission-2.1.xml)
|
31
31
|
|
32
32
|
***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. These fields will be present when reading notifications using this API:*
|
33
33
|
|
@@ -82,9 +82,9 @@ _Please note that ORCID reserves the right to limit the client applications with
|
|
82
82
|
###REST API for notifications
|
83
83
|
| Action | HTTP method | Scope | URL |
|
84
84
|
|-------------------------|-------------|--------------------------|----------------------------------------------------------|
|
85
|
-
| Add a notification | POST | /premium-notification | http://api.sandbox.orcid.org/v2.
|
86
|
-
| Read a notification | GET | /premium-notification | http://api.sandbox.orcid.org/v2.
|
87
|
-
| Flag an unread notification as archived | DELETE | /premium-notification | http://api.sandbox.orcid.org/v2.
|
85
|
+
| Add a notification | POST | /premium-notification | http://api.sandbox.orcid.org/v2.1/[ORCID]/notification-permission |
|
86
|
+
| Read a notification | GET | /premium-notification | http://api.sandbox.orcid.org/v2.1/[ORCID]/notification-permission/[PUT-CODE] |
|
87
|
+
| Flag an unread notification as archived | DELETE | /premium-notification | http://api.sandbox.orcid.org/v2.1/[ORCID]/notification-permission/[PUT-CODE] |
|
88
88
|
|
89
89
|
- **[ORCID]** is the ORCID iD for the record, formatted as XXXX-XXXX-XXXX-XXXX
|
90
90
|
- **[PUT-CODE]** is the ```put-code``` attribute for the specific ```notification``` that you wish to read or modify.
|
@@ -105,19 +105,19 @@ curl -i -L -H 'Accept: application/json' \
|
|
105
105
|
curl -i -H 'Authorization: Bearer ...' \
|
106
106
|
-H 'Content-Type: application/orcid+xml' \
|
107
107
|
-X POST -d '@[FILE-PATH]/notification-permission.xml' \
|
108
|
-
https://api.sandbox.orcid.org/v2.
|
108
|
+
https://api.sandbox.orcid.org/v2.1/[ORCID]/notification-permission
|
109
109
|
```
|
110
110
|
|
111
111
|
####Read a notification
|
112
112
|
```
|
113
113
|
curl -i -H 'Authorization: Bearer ...' \
|
114
114
|
-H 'Content-Type: application/orcid+xml' \
|
115
|
-
https://api.sandbox.orcid.org/v2.
|
115
|
+
https://api.sandbox.orcid.org/v2.1/[ORCID]/notification-permission/[PUT-CODE]
|
116
116
|
```
|
117
117
|
|
118
118
|
####Flag an unread notification as archived
|
119
119
|
```
|
120
120
|
curl -i -H 'Authorization: Bearer ...' \
|
121
121
|
-H 'Content-Type: application/orcid+xml' \
|
122
|
-
-X DELETE https://api.sandbox.orcid.org/v2.
|
122
|
+
-X DELETE https://api.sandbox.orcid.org/v2.1/[ORCID]/notification-permission/[PUT-CODE]
|
123
123
|
```
|
@@ -4,7 +4,7 @@
|
|
4
4
|
xmlns:common="http://www.orcid.org/ns/common"
|
5
5
|
xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
6
6
|
xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" vc:minVersion="1.1">
|
7
|
-
<xs:import namespace="http://www.orcid.org/ns/common" schemaLocation="../common_2.
|
7
|
+
<xs:import namespace="http://www.orcid.org/ns/common" schemaLocation="../common_2.1/common-2.1.xsd" />
|
8
8
|
<xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="../xml.xsd"/>
|
9
9
|
<xs:element name="notification">
|
10
10
|
<xs:complexType>
|
@@ -5,11 +5,11 @@
|
|
5
5
|
xmlns:activities="http://www.orcid.org/ns/activities" xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
6
6
|
xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" vc:minVersion="1.1">
|
7
7
|
<xs:import namespace="http://www.orcid.org/ns/common"
|
8
|
-
schemaLocation="../common_2.
|
8
|
+
schemaLocation="../common_2.1/common-2.1.xsd" />
|
9
9
|
<xs:import namespace="http://www.orcid.org/ns/activities"
|
10
|
-
schemaLocation="../record_2.
|
10
|
+
schemaLocation="../record_2.1/activities-2.1.xsd" />
|
11
11
|
|
12
|
-
<xs:element name="notifications">
|
12
|
+
<xs:element name="notifications">
|
13
13
|
<xs:annotation>
|
14
14
|
<xs:documentation>Notification container</xs:documentation>
|
15
15
|
</xs:annotation>
|
@@ -19,7 +19,7 @@
|
|
19
19
|
-->
|
20
20
|
<notification:notification put-code="1"
|
21
21
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
22
|
-
xsi:schemaLocation="http://www.orcid.org/ns/notification ../notification-custom-2.
|
22
|
+
xsi:schemaLocation="http://www.orcid.org/ns/notification ../notification-custom-2.1.xsd"
|
23
23
|
xmlns:notification="http://www.orcid.org/ns/notification"
|
24
24
|
xmlns:common="http://www.orcid.org/ns/common"
|
25
25
|
xml:lang="en-gb">
|
@@ -36,7 +36,7 @@
|
|
36
36
|
<common:sent-date>2014-01-01T14:45:32</common:sent-date>
|
37
37
|
<common:source>
|
38
38
|
<common:source-orcid>
|
39
|
-
<common:uri>
|
39
|
+
<common:uri>https://orcid.org/2111-1111-1111-1114</common:uri>
|
40
40
|
<common:path>2111-1111-1111-1114</common:path>
|
41
41
|
<common:host>orcid.org</common:host>
|
42
42
|
</common:source-orcid>
|
@@ -17,7 +17,7 @@
|
|
17
17
|
=============================================================================
|
18
18
|
|
19
19
|
-->
|
20
|
-
<notification:notification put-code="1" xsi:schemaLocation="http://www.orcid.org/ns/notification ../notification-permission-2.
|
20
|
+
<notification:notification put-code="1" xsi:schemaLocation="http://www.orcid.org/ns/notification ../notification-permission-2.1.xsd" xmlns:common="http://www.orcid.org/ns/common" xmlns:notification="http://www.orcid.org/ns/notification" xmlns:activities="http://www.orcid.org/ns/activities" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
21
21
|
<notification:notification-type>permission</notification:notification-type>
|
22
22
|
<notification:authorization-url>
|
23
23
|
<!-- API user can specify just the path if they want, and leave out the uri element. -->
|
@@ -49,7 +49,7 @@
|
|
49
49
|
<common:source>
|
50
50
|
<!-- Read only for API user - will only be able to see notifications for which they are the source -->
|
51
51
|
<common:source-client-id>
|
52
|
-
<common:uri>
|
52
|
+
<common:uri>https://orcid.org/client/APP-U4UKCNSSIM1OCVQY</common:uri>
|
53
53
|
<common:path>APP-U4UKCNSSIM1OCVQY</common:path>
|
54
54
|
<common:host>orcid.org</common:host>
|
55
55
|
</common:source-client-id>
|
@@ -0,0 +1,69 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
+
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://www.orcid.org/ns/orcid" xmlns:orcid="http://www.orcid.org/ns/orcid"
|
3
|
+
xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" vc:minVersion="1.1">
|
4
|
+
<xs:annotation>
|
5
|
+
<xs:documentation>
|
6
|
+
=============================================================================
|
7
|
+
|
8
|
+
ORCID (R) Open Source
|
9
|
+
http://orcid.org
|
10
|
+
|
11
|
+
Copyright (c) 2012-2014 ORCID, Inc.
|
12
|
+
Licensed under an MIT-Style License (MIT)
|
13
|
+
http://orcid.org/open-source-license
|
14
|
+
|
15
|
+
This copyright and license information (including a link to the full
|
16
|
+
license)
|
17
|
+
shall be included in its entirety in all copies or substantial portion of
|
18
|
+
the software.
|
19
|
+
|
20
|
+
=============================================================================
|
21
|
+
The schema describes the message format used for ORCID API requests
|
22
|
+
and responses.
|
23
|
+
The top level element is orcid-message.
|
24
|
+
</xs:documentation>
|
25
|
+
</xs:annotation>
|
26
|
+
<xs:element name="error">
|
27
|
+
<xs:complexType>
|
28
|
+
<xs:sequence>
|
29
|
+
<xs:element name="responseCode" type="xs:int">
|
30
|
+
<xs:annotation>
|
31
|
+
<xs:documentation>
|
32
|
+
The HTTP response code that was also used in the response header.
|
33
|
+
</xs:documentation>
|
34
|
+
</xs:annotation>
|
35
|
+
</xs:element>
|
36
|
+
<xs:element name="developerMessage" type="xs:string">
|
37
|
+
<xs:annotation>
|
38
|
+
<xs:documentation>
|
39
|
+
Debugging information for the API client developer, e.g. schema validation error message.
|
40
|
+
</xs:documentation>
|
41
|
+
</xs:annotation>
|
42
|
+
</xs:element>
|
43
|
+
<xs:element name="userMessage" type="xs:string" minOccurs="0">
|
44
|
+
<xs:annotation>
|
45
|
+
<xs:documentation>
|
46
|
+
An error message that would be suitable to display to the user in the application using the ORCID API.
|
47
|
+
If possible, this will be in the language of the locale specified by the user in ORCID.
|
48
|
+
</xs:documentation>
|
49
|
+
</xs:annotation>
|
50
|
+
</xs:element>
|
51
|
+
<xs:element name="errorCode" type="xs:integer" minOccurs="0">
|
52
|
+
<xs:annotation>
|
53
|
+
<xs:documentation>
|
54
|
+
The ORCID error code that defines the specific type of error. A full list of codes can be found at
|
55
|
+
https://support.orcid.org/knowledgebase/articles/....
|
56
|
+
</xs:documentation>
|
57
|
+
</xs:annotation>
|
58
|
+
</xs:element>
|
59
|
+
<xs:element name="moreInfo" type="xs:anyURI" minOccurs="0">
|
60
|
+
<xs:annotation>
|
61
|
+
<xs:documentation>
|
62
|
+
A URL of a page giving more info about the error.
|
63
|
+
</xs:documentation>
|
64
|
+
</xs:annotation>
|
65
|
+
</xs:element>
|
66
|
+
</xs:sequence>
|
67
|
+
</xs:complexType>
|
68
|
+
</xs:element>
|
69
|
+
</xs:schema>
|
@@ -1,47 +1,47 @@
|
|
1
|
-
# ORCID API v2.
|
1
|
+
# ORCID API v2.1 Guide
|
2
2
|
|
3
3
|
## Current State (Release Stable)
|
4
|
-
v2.
|
4
|
+
v2.1 is the current release of the ORCID API and should be used for all development.
|
5
5
|
|
6
6
|
## XSDs and current state (all stable)
|
7
|
-
- [activities-2.
|
7
|
+
- [activities-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/activities-2.1.xsd)
|
8
8
|
**stable**
|
9
|
-
- [address-2.
|
9
|
+
- [address-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/address-2.1.xsd)
|
10
10
|
**stable**
|
11
|
-
- [bulk-2.
|
11
|
+
- [bulk-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/bulk-2.1.xsd)
|
12
12
|
**stable**
|
13
|
-
- [common-2.
|
13
|
+
- [common-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/common_2.1/common-2.1.xsd)
|
14
14
|
**stable**
|
15
|
-
- [education-2.
|
15
|
+
- [education-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/education-2.1.xsd)
|
16
16
|
**stable**
|
17
|
-
- [email-2.
|
17
|
+
- [email-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/email-2.1.xsd)
|
18
18
|
**stable**
|
19
|
-
- [employment-2.
|
19
|
+
- [employment-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/employment-2.1.xsd)
|
20
20
|
**not stable**
|
21
|
-
- [error-2.
|
21
|
+
- [error-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/error-2.1.xsd)
|
22
22
|
**stable**
|
23
|
-
- [external-identifier-2.
|
23
|
+
- [external-identifier-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/external-identifier-2.1.xsd)
|
24
24
|
**stable**
|
25
|
-
- [funding-2.
|
25
|
+
- [funding-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/funding-2.1.xsd)
|
26
26
|
**stable**
|
27
|
-
- [keyword-2.
|
27
|
+
- [keyword-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/keyword-2.1.xsd)
|
28
28
|
**stable**
|
29
|
-
- [other-names-2.
|
29
|
+
- [other-names-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/other-name-2.1.xsd)
|
30
30
|
**stable**
|
31
|
-
- [peer-review-2.
|
31
|
+
- [peer-review-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/peer-review-2.1.xsd)
|
32
32
|
**stable**
|
33
|
-
- [person-2.
|
33
|
+
- [person-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/person-2.1.xsd)
|
34
34
|
**stable**
|
35
|
-
- [personal-details-2.
|
35
|
+
- [personal-details-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/personal-details-2.1.xsd)
|
36
36
|
**stable**
|
37
|
-
- [researcher-url-2.
|
37
|
+
- [researcher-url-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/researcher-url-2.1.xsd)
|
38
38
|
**stable**
|
39
|
-
- [search-2.
|
39
|
+
- [search-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/search-2.1.xsd)
|
40
40
|
**stable**
|
41
|
-
- [work-2.
|
41
|
+
- [work-2.1.xsd](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/work-2.1.xsd)
|
42
42
|
**stable**
|
43
43
|
|
44
|
-
##
|
44
|
+
##Changes from Release candidate 2.1:
|
45
45
|
### Search
|
46
46
|
- Addition of search endpoints
|
47
47
|
|
@@ -53,19 +53,19 @@ v2.0 is the current release of the ORCID API and should be used for all developm
|
|
53
53
|
### Email addresses
|
54
54
|
- Include primary and verified status when reading an email address
|
55
55
|
|
56
|
-
##
|
56
|
+
##Changes from Version 1.2
|
57
57
|
A number of changes to the ORCID API have been made to improve on the existing 1.2 release, this section highlights the most notable changes.
|
58
58
|
|
59
|
-
###
|
59
|
+
###Multiple XSD
|
60
60
|
The ORCID Messages Schema has been broken down in to multiple files. Namespaces are now used and common elements are reused in multiple sections.
|
61
61
|
|
62
|
-
###
|
63
|
-
With version 2.
|
62
|
+
###Per item API
|
63
|
+
With version 2.1 the ORCID API information is now added, updated, and read as individual items, as compared to entire sections of a record as was the case with 1.2. Existing items are read, updated or deleted using their put-code, and new items must be posted individually (with the exception of works which can be added up to 100 at a time). To read an entire section of a record the activities summary can be accessed.
|
64
64
|
|
65
|
-
###
|
65
|
+
###Activities summary:
|
66
66
|
When reading the works, funding, and peer-review sections, a summary of each activity is returned. The summary is intended to provide basic information about the item, including title, type, date, organization, source and identifiers. The full item can be retrieved by accessing the individual item using the put-code provided.
|
67
67
|
|
68
|
-
###
|
68
|
+
###Activities group:
|
69
69
|
|
70
70
|
Funding, Works and Peer-review items are grouped together based on a common external identifier. In the schema, the group is the parent of the items and contains a last modified date for the group and the identifier(s) used to create the group.
|
71
71
|
|
@@ -82,67 +82,67 @@ Funding, Works and Peer-review items are grouped together based on a common exte
|
|
82
82
|
- *external-id-url* indicates how the identifier will resolve
|
83
83
|
- *external-id-relationship* indicates the relationship between the item and the identifier
|
84
84
|
|
85
|
-
###
|
85
|
+
###Peer-review
|
86
86
|
A new activities section, peer-review, captures the formal review activity of researchers.
|
87
87
|
|
88
|
-
###
|
89
|
-
The 2.
|
88
|
+
###Non-editable fields
|
89
|
+
The 2.1 API can not be used to edit the fields give-name, family-name or biography.
|
90
90
|
|
91
|
-
###
|
92
|
-
With 2.
|
91
|
+
###Repeatable address field
|
92
|
+
With 2.1 the address field can be repeated
|
93
93
|
|
94
94
|
|
95
95
|
## Sample files:
|
96
96
|
|
97
|
-
- [read activities-2.
|
98
|
-
- [read address-2.
|
99
|
-
- [write address-2.
|
100
|
-
- [write bulk-work xml-2.
|
101
|
-
- [write bulk-work-2.
|
102
|
-
- [read biography-2.
|
103
|
-
- [read education-2.
|
104
|
-
- [write education-2.
|
105
|
-
- [read educations-2.
|
106
|
-
- [read email-2.
|
107
|
-
- [read emails-2.
|
108
|
-
- [read employment-2.
|
109
|
-
- [write employment-2.
|
110
|
-
- [read employments-2.
|
111
|
-
- [error-message-2.
|
112
|
-
- [read external-identifier-2.
|
113
|
-
- [write external-identifier-2.
|
114
|
-
- [read external-identifiers-2.
|
115
|
-
- [read funding-2.
|
116
|
-
- [write funding-2.
|
117
|
-
- [read fundings-2.
|
118
|
-
- [read keyword-2.
|
119
|
-
- [write keyword-2.
|
120
|
-
- [keywords-2.
|
121
|
-
- [read other-name-2.
|
122
|
-
- [write other-name-2.
|
123
|
-
- [read other-names-2.
|
124
|
-
- [read peer-review-2.
|
125
|
-
- [write full peer-review-2.
|
126
|
-
- [write simple peer-review-2.
|
127
|
-
- [read peer-reviews-2.
|
128
|
-
- [read person-2.
|
129
|
-
- [read personal-details-2.
|
130
|
-
- [read researcher-url-2.
|
131
|
-
- [write researcher-url-2.
|
132
|
-
- [read researcher-urls-2.
|
133
|
-
- [search-2.
|
134
|
-
- [read work-2.
|
135
|
-
- [write full work-2.
|
136
|
-
- [write simple work-2.
|
137
|
-
- [read works-2.
|
97
|
+
- [read activities-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/activities-2.1.xml)
|
98
|
+
- [read address-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/address-2.1.xml)
|
99
|
+
- [write address-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/address-2.1.xml)
|
100
|
+
- [write bulk-work xml-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_samples/bulk-work-2.1.xml)
|
101
|
+
- [write bulk-work-2.1.json] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_samples/bulk-work-2.1.json)
|
102
|
+
- [read biography-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/biography-2.1.xml)
|
103
|
+
- [read education-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/education-2.1.xml)
|
104
|
+
- [write education-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/education-2.1.xml)
|
105
|
+
- [read educations-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/educations-2.1.xml)
|
106
|
+
- [read email-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/email-2.1.xml)
|
107
|
+
- [read emails-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/emails-2.1.xml)
|
108
|
+
- [read employment-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/employment-2.1.xml)
|
109
|
+
- [write employment-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/employment-2.1.xml)
|
110
|
+
- [read employments-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/employments-2.1.xml)
|
111
|
+
- [error-message-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/error-2.1.xml)
|
112
|
+
- [read external-identifier-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/external-identifier-2.1.xml)
|
113
|
+
- [write external-identifier-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/external-identifier-2.1.xml)
|
114
|
+
- [read external-identifiers-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/external-identifiers-2.1.xml)
|
115
|
+
- [read funding-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/funding-2.1.xml)
|
116
|
+
- [write funding-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/funding-2.1.xml)
|
117
|
+
- [read fundings-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/fundings-2.1.xml)
|
118
|
+
- [read keyword-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/keyword-2.1.xml)
|
119
|
+
- [write keyword-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/keyword-2.1.xml)
|
120
|
+
- [keywords-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/keywords-2.1.xml)
|
121
|
+
- [read other-name-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/other-name-2.1.xml)
|
122
|
+
- [write other-name-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/other-name-2.1.xml)
|
123
|
+
- [read other-names-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/other-names-2.1.xml)
|
124
|
+
- [read peer-review-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/peer-review-2.1.xml)
|
125
|
+
- [write full peer-review-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/peer-review-full-2.1.xml)
|
126
|
+
- [write simple peer-review-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/peer-review-simple-2.1.xml)
|
127
|
+
- [read peer-reviews-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/peer-reviews-2.1.xml)
|
128
|
+
- [read person-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/person-2.1.xml)
|
129
|
+
- [read personal-details-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/personal-details-2.1.xml)
|
130
|
+
- [read researcher-url-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/researcher-url-2.1.xml)
|
131
|
+
- [write researcher-url-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/researcher-url-2.1.xml)
|
132
|
+
- [read researcher-urls-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/researcher-urls-2.1.xml)
|
133
|
+
- [search-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/search-2.1.xml)
|
134
|
+
- [read work-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/work-2.1.xml)
|
135
|
+
- [write full work-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/work-full-2.1.xml)
|
136
|
+
- [write simple work-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/work-simple-2.1.xml)
|
137
|
+
- [read works-2.1.xml] (https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/works-2.1.xml)
|
138
138
|
|
139
139
|
## REST API Reference
|
140
140
|
|
141
141
|
### Swagger
|
142
142
|
|
143
143
|
The swagger interfaces to the API available at:
|
144
|
-
- [member](https://api.orcid.org/v2.
|
145
|
-
- [public](https://pub.orcid.org/v2.
|
144
|
+
- [member](https://api.orcid.org/v2.1/)
|
145
|
+
- [public](https://pub.orcid.org/v2.1/)
|
146
146
|
|
147
147
|
### Scopes
|
148
148
|
| Scope | Request method | Obtain Access Token Through | Expires In | API |
|
@@ -158,19 +158,19 @@ The swagger interfaces to the API available at:
|
|
158
158
|
### Calls
|
159
159
|
| Action | HTTP method | Scope | URL |
|
160
160
|
|-------------------------|-------------|--------------------------|----------------------------------------------------------|
|
161
|
-
| Read the entire record | GET | /read-limited or /read-public | https://[HOST]/v2.
|
162
|
-
| Read an activities section | GET | /read-limited or /read-public | https://[HOST]/v2.
|
163
|
-
| Read a person section | GET | /read-limited or /read-public | https://[HOST]/v2.
|
164
|
-
| Read a single item | GET | /read-limited or /read-public | https://[HOST]/v2.
|
165
|
-
| Add a person item | POST | /person/update | https://[HOST]/v2.
|
166
|
-
| Update a person item | PUT | /person/update | https://[HOST]/v2.
|
167
|
-
| Delete a person item | DELETE | /person/update | https://[HOST]/v2.
|
168
|
-
| Add an activity | POST | /activities/update | https://[HOST]/
|
169
|
-
| Update an activity | PUT | /activities/update | https://[HOST]/v2.
|
170
|
-
| Delete an activity | DELETE | /activities/update | https://[HOST]/v2.
|
171
|
-
| Add multiple works| POST | /read-limited or /read-public | https://[HOST]/v2.
|
172
|
-
| Read multiple works| GET | /activities/update | https://[HOST]/v2.
|
173
|
-
| Search records | GET | /read-public | https://[HOST]/v2.
|
161
|
+
| Read the entire record | GET | /read-limited or /read-public | https://[HOST]/v2.1/[ORCID]/record |
|
162
|
+
| Read an activities section | GET | /read-limited or /read-public | https://[HOST]/v2.1/[ORCID]/[SECTION]s |
|
163
|
+
| Read a person section | GET | /read-limited or /read-public | https://[HOST]/v2.1/[ORCID]/[SECTION] |
|
164
|
+
| Read a single item | GET | /read-limited or /read-public | https://[HOST]/v2.1/[ORCID]/[SECTION]/[PUT-CODE] |
|
165
|
+
| Add a person item | POST | /person/update | https://[HOST]/v2.1/[ORCID]/[SECTION] |
|
166
|
+
| Update a person item | PUT | /person/update | https://[HOST]/v2.1/[ORCID]/[SECTION]/[PUT-CODE] |
|
167
|
+
| Delete a person item | DELETE | /person/update | https://[HOST]/v2.1/[ORCID]/[SECTION]/[PUT-CODE] |
|
168
|
+
| Add an activity | POST | /activities/update | https://[HOST]/[ORCID]/[SECTION] |
|
169
|
+
| Update an activity | PUT | /activities/update | https://[HOST]/v2.1/[ORCID]/[SECTION]/[PUT-CODE] |
|
170
|
+
| Delete an activity | DELETE | /activities/update | https://[HOST]/v2.1/[ORCID]/[SECTION]/[PUT-CODE] |
|
171
|
+
| Add multiple works| POST | /read-limited or /read-public | https://[HOST]/v2.1/[ORCID]/works |
|
172
|
+
| Read multiple works| GET | /activities/update | https://[HOST]/v2.1/[ORCID]/works/[PUT-CODE1],[PUT-CODE2] |
|
173
|
+
| Search records | GET | /read-public | https://[HOST]/v2.1/search?q=[SOLR-QUERY]* |
|
174
174
|
|
175
175
|
[HOST] is the ORCID environment you are using
|
176
176
|
- api.sandbox.orcid.org for the Member API on the ORCID Sandbox
|
@@ -200,8 +200,7 @@ The swagger interfaces to the API available at:
|
|
200
200
|
**Notes:**
|
201
201
|
- biography, email, person and personal-details sections are read only
|
202
202
|
- when reading multiple works a maximum of 50 works can be accessed with a single call, when posting multiple works a maximum of 100 works can be posted with a single call.
|
203
|
-
- When searching by default a maximum of 100 results will be returned. The `rows` parameter can be used to increase the number or results, but only up to 200. The `start` parameter (integer pointing to the zero-based position of the first result to be returned) can be used to page through larger results sets.
|
204
|
-
- [Help with SOLR searching](https://cwiki.apache.org/confluence/display/solr/The+Standard+Query+Parser)
|
203
|
+
- When searching by default a maximum of 100 results will be returned. The `rows` parameter can be used to increase the number or results, but only up to 200. The `start` parameter (integer pointing to the zero-based position of the first result to be returned) can be used to page through larger results sets. For help with SOLR searching see [https://cwiki.apache.org/confluence/display/solr/The+Standard+Query+Parser](https://cwiki.apache.org/confluence/display/solr/The+Standard+Query+Parser)
|
205
204
|
|
206
205
|
## Examples
|
207
206
|
|
@@ -209,38 +208,38 @@ The swagger interfaces to the API available at:
|
|
209
208
|
|
210
209
|
| Item |Scope | Example cURL Statement |
|
211
210
|
|--------------------|--------------------------|----------------------------------------------------------------|
|
212
|
-
| Entire record | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
213
|
-
| Activities summary | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
214
|
-
| Addresses | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
215
|
-
| Education items | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
216
|
-
| Emails | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
217
|
-
| Employment items | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
218
|
-
| External identifiers | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
219
|
-
| Funding summary | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
220
|
-
| Keywords | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
221
|
-
| Other names | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
222
|
-
| Peer review summary| /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
223
|
-
| Personal details | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
224
|
-
| Person | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
225
|
-
| Researcher URLs | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
226
|
-
| Works summary | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
211
|
+
| Entire record | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/record'```|
|
212
|
+
| Activities summary | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/activities'```|
|
213
|
+
| Addresses | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/address'```|
|
214
|
+
| Education items | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/educations'```|
|
215
|
+
| Emails | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/email'```|
|
216
|
+
| Employment items | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/employments'```|
|
217
|
+
| External identifiers | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/external-identifiers'```|
|
218
|
+
| Funding summary | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/fundings'```|
|
219
|
+
| Keywords | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/keywords'```|
|
220
|
+
| Other names | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/other-names'```|
|
221
|
+
| Peer review summary| /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/peer-reviews'```|
|
222
|
+
| Personal details | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/personal-details'```|
|
223
|
+
| Person | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/person'```|
|
224
|
+
| Researcher URLs | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/researcher-urls'```|
|
225
|
+
| Works summary | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/works'```|
|
227
226
|
|
228
227
|
|
229
228
|
### Read Record Items
|
230
229
|
| Item |Scope | Example cURL Statement |
|
231
230
|
|--------------------|--------------------------|----------------------------------------------------------------|
|
232
|
-
| Address | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
233
|
-
| Biography | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
234
|
-
| Education | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
235
|
-
| Employment | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
236
|
-
| External identifier| /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
237
|
-
| Funding | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
238
|
-
| Keywords | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
239
|
-
| Other names | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
240
|
-
| Peer review | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
241
|
-
| Researcher URL | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
242
|
-
| Work | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
243
|
-
| Multiple Works | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
231
|
+
| Address | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/address/4556'```|
|
232
|
+
| Biography | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/biography'```|
|
233
|
+
| Education | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/education/22423'```|
|
234
|
+
| Employment | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/employment/22411'```|
|
235
|
+
| External identifier| /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/external-identifiers/3193'```|
|
236
|
+
| Funding | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/funding/4413'```|
|
237
|
+
| Keywords | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/keywords/4504'```|
|
238
|
+
| Other names | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/other-names/15812'```|
|
239
|
+
| Peer review | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/peer-review/1374'```|
|
240
|
+
| Researcher URL | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/researcher-urls/41387'```|
|
241
|
+
| Work | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/work/733536'```|
|
242
|
+
| Multiple Works | /read-limited or /read-public|```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/works/733535,733536'```|
|
244
243
|
|
245
244
|
When reading multiple works the contents of each work is returned or an error code is returned if there is an issue with a single work.
|
246
245
|
|
@@ -248,49 +247,49 @@ When reading multiple works the contents of each work is returned or an error co
|
|
248
247
|
### Add Record Items
|
249
248
|
|Item |Scope | Example cURL Statement |
|
250
249
|
|---------|----------------|-------------------------|
|
251
|
-
| Address |/person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/address.xml' -X POST 'https://api.sandbox.orcid.org/v2.
|
252
|
-
| Education |/activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/education-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.
|
253
|
-
| Employment | /activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/employment-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.
|
254
|
-
| External identifiers | /person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/external_identifier.xml' -X POST 'https://api.sandbox.orcid.org/v2.
|
255
|
-
| Funding |/activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/funding-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.
|
256
|
-
| Keywords |/person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/keyword.xml' -X POST 'https://api.sandbox.orcid.org/v2.
|
257
|
-
| Other names |/person/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/other-name.xml' -X POST 'https://api.sandbox.orcid.org/v2.
|
258
|
-
| Peer review |/activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/peer-review-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.
|
259
|
-
| Researcher URL |/person/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/researcher-url.xml' -X POST 'https://api.sandbox.orcid.org/v2.
|
260
|
-
| Work |/activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/work.xml' -X POST 'https://api.sandbox.orcid.org/v2.
|
261
|
-
| Multiple works |/activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/works.xml' -X POST 'https://api.sandbox.orcid.org/v2.
|
262
|
-
|
263
|
-
When posting multiple works the contents of each work is returned or an error code is returned if there is an issue with a single work, see [bulk work error sample](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.
|
250
|
+
| Address |/person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/address.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/address```|
|
251
|
+
| Education |/activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/education-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/education' ```|
|
252
|
+
| Employment | /activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/employment-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/employment' ```|
|
253
|
+
| External identifiers | /person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/external_identifier.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/external-identifiers```|
|
254
|
+
| Funding |/activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/funding-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/funding'```|
|
255
|
+
| Keywords |/person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/keyword.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/keywords```|
|
256
|
+
| Other names |/person/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/other-name.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/other-names'```|
|
257
|
+
| Peer review |/activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/peer-review-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/peer-review'```|
|
258
|
+
| Researcher URL |/person/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/researcher-url.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/researcher-urls'```|
|
259
|
+
| Work |/activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/work.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/work'```|
|
260
|
+
| Multiple works |/activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/works.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/works'```|
|
261
|
+
|
262
|
+
When posting multiple works the contents of each work is returned or an error code is returned if there is an issue with a single work, see [bulk work error sample](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/read_samples/bulk-work-error.xml).
|
264
263
|
|
265
264
|
### Update Record Items
|
266
265
|
|Item |Scope | Example cURL Statement |
|
267
266
|
|------|----------------|---------------------|
|
268
|
-
| Address |/person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/address.xml' -X PUT 'https://api.sandbox.orcid.org/v2.
|
269
|
-
| Education |/activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/education-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.
|
270
|
-
| Employment | /activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/employment-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.
|
271
|
-
| External identifiers |/person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/external_identifier.xml' -X PUT 'https://api.sandbox.orcid.org/v2.
|
272
|
-
| Funding |/activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/funding-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.
|
273
|
-
| Keywords |/person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/keyword.xml' -X PUT 'https://api.sandbox.orcid.org/v2.
|
274
|
-
| Other names |/person/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/other-name.xml' -X PUT 'https://api.sandbox.orcid.org/v2.
|
275
|
-
| Peer review |/activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/peer-review-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.
|
276
|
-
| Researcher URL |/person/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/researcher-url.xml' -X PUT 'https://api.sandbox.orcid.org/v2.
|
277
|
-
| Work |/activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/work-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.
|
278
|
-
|
279
|
-
When updating a record item, include the put code as an attribute in the root element, ex: ```<education:education put-code="14775" xmlns:common="http://www.orcid.org/ns/common" xmlns:education="http://www.orcid.org/ns/education" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.orcid.org/ns/education ../education-2.
|
267
|
+
| Address |/person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/address.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/address/[PUT-CODE]```|
|
268
|
+
| Education |/activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/education-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/education/[PUT-CODE]' ```|
|
269
|
+
| Employment | /activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/employment-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/employment/[PUT-CODE]' ```|
|
270
|
+
| External identifiers |/person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/external_identifier.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/external-identifiers/[PUT-CODE]```|
|
271
|
+
| Funding |/activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/funding-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/funding/[PUT-CODE]'```|
|
272
|
+
| Keywords |/person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/keyword.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/keywords/[PUT-CODE]```|
|
273
|
+
| Other names |/person/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/other-name.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/other-names/[PUT-CODE]'```|
|
274
|
+
| Peer review |/activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/peer-review-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/peer-review/[PUT-CODE]'```|
|
275
|
+
| Researcher URL |/person/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/researcher-url.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/researcher-urls/[PUT-CODE]'```|
|
276
|
+
| Work |/activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/work-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/work/[PUT-CODE]'```|
|
277
|
+
|
278
|
+
When updating a record item, include the put code as an attribute in the root element, ex: ```<education:education put-code="14775" xmlns:common="http://www.orcid.org/ns/common" xmlns:education="http://www.orcid.org/ns/education" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.orcid.org/ns/education ../education-2.1.xsd ">```
|
280
279
|
|
281
280
|
### Delete Record Items
|
282
281
|
|Item | Scope | Example cURL Statement |
|
283
282
|
|------|----------------|-------------------------|
|
284
|
-
| Address | /person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.
|
285
|
-
| Education | /activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.
|
286
|
-
| Employment | /activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.
|
287
|
-
| External identifiers | /person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.
|
288
|
-
| Funding | /activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.
|
289
|
-
| Keywords | /person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.
|
290
|
-
| Other names | /person/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.
|
291
|
-
| Peer review | /activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.
|
292
|
-
| Researcher URL | /person/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.
|
293
|
-
| Work |/activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.
|
283
|
+
| Address | /person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/address/[PUT-CODE]```|
|
284
|
+
| Education | /activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/education/[PUT-CODE]' ```|
|
285
|
+
| Employment | /activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/employment/[PUT-CODE]' ```|
|
286
|
+
| External identifiers | /person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/external-identifiers/[PUT-CODE]```|
|
287
|
+
| Funding | /activities/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/funding/[PUT-CODE]'```|
|
288
|
+
| Keywords | /person/update |```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/keywords/[PUT-CODE]```|
|
289
|
+
| Other names | /person/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/researcher-urls/[PUT-CODE]'```|
|
290
|
+
| Peer review | /activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/peer-review/[PUT-CODE]'```|
|
291
|
+
| Researcher URL | /person/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/researcher-urls/[PUT-CODE]'```|
|
292
|
+
| Work |/activities/update|```curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0000-0002-9227-8514/work/[PUT-CODE]'```|
|
294
293
|
|
295
294
|
### Webhooks
|
296
295
|
|Item | Scope | Example cURL Statement |
|
@@ -299,6 +298,6 @@ When updating a record item, include the put code as an attribute in the root el
|
|
299
298
|
| Delete a webhook | /webhook |```curl -v -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'http://api.sandbox.orcid.org/0000-0002-9227-8514/webhook/http%3A%2F%2Fencoded.url%2F0000-0002-9227-8514' ```|
|
300
299
|
|
301
300
|
### Search
|
302
|
-
| Item | Scope | Example cURL Statement
|
303
|
-
|
304
|
-
| Search records | /read-public | ```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.
|
301
|
+
| Item | Scope | Example cURL Statement |
|
302
|
+
|--------------------|--------------------------|-------------------------------------------------------|----------------------------------------------------------------|
|
303
|
+
| Search records | /read-public | ```curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.1/search?q=Simpson'```|
|