Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
219 lines (189 sloc) 25.8 KB

ORCID API v2.0_rc4 Guide

Current State (Release Candidate Stable)

v2.0_rc4 is in current development and should be avoided.

XSDs and current state (all stable)

Changes:

Post bulk works

  • Addition of endpoint /works for bulk posting works
  • Update to schema of bulk element in works
  • Update to schema of error section for returning errors with bulk added works

Sample files:

Note: These files contain system-generated elements/attributes that are returned when reading items from ORCID, but should not be included when posting items to ORCID

  • put-code (exception: include put-code when updating items using the PUT method)
  • source
  • created-date
  • last-modified-date

REST API Reference

Swagger

The swagger interfaces to the API available at:

Activities summary

Item HTTP method Scope URL
Read activities summary GET /read-limited https://api.sandbox.orcid.org/v2.0_rc4/[ORCID]/activities

Individual activities

Action HTTP method Scope URL
Add an activity POST /activities/update https://api.sandbox.orcid.org/v2.0_rc4/[ORCID]/[ACTIVITY-TYPE]
Read an activity GET /read-limited https://api.sandbox.orcid.org/v2.0_rc4/[ORCID]/[ACTIVITY-TYPE]/[PUT-CODE]
Update an activity PUT /activities/update https://api.sandbox.orcid.org/v2.0_rc4/[ORCID]/[ACTIVITY-TYPE]/[PUT-CODE]
Delete an activity DELETE /activities/update https://api.sandbox.orcid.org/v2.0_rc4/[ORCID]/[ACTIVITY-TYPE]/[PUT-CODE]

Bulk activities

Action HTTP method Scope URL
Add works POST /activities/update https://api.sandbox.orcid.org/v2.0_rc4/[ORCID]/works

Biography details

Action HTTP method Scope URL
Add section POST /person/update https://api.sandbox.orcid.org/v2.0_rc4/[ORCID]/[SECTION]
Read section GET /read-limited https://api.sandbox.orcid.org/v2.0_rc4/[ORCID]/[SECTION]/[PUT-CODE]
Update section PUT /person/update https://api.sandbox.orcid.org/v2.0_rc4/[ORCID]/[SECTION]/[PUT-CODE]
Delete section DELETE /person/update https://api.sandbox.orcid.org/v2.0_rc4/[ORCID]/[SECTION]/[PUT-CODE]

[ORCID] is the ORCID iD for the record.

[ACTIVITY-TYPE] can be one of the following:

  • education
  • employment
  • work
  • funding
  • peer-review

[SECTION] can be one of the following:

  • address
  • email *
  • external-identifiers
  • keywords
  • other-names
  • researcher-urls
  • person *
  • personal-details *

Note: email, person and personal-details sections are only for reading purposes

Search

Action HTTP method Scope URL
Search records GET /read-only https://api.sandbox.orcid.org/v2.0_rc4/search?q=[SOLR-QUERY]

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.

Examples

Read Record Items

Item v2.0 Scope v1.2 Scope (deprecated) Example cURL Statement
Activities summary /read-limited /orcid-profile/read-limited curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/activities'
Address /read-limited /orcid-bio/read-limited curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/address'
Education /read-limited /orcid-profile/read-limited /affiliations/read-limited curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/education/14613'
Email /read-limited /orcid-bio/read-limited curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/email'
Employment /read-limited /orcid-profile/read-limited /affiliations/read-limited curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/employment/14612'
External Identifiers /read-limited /orcid-bio/read-limited curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/external-identifiers'
Funding /read-limited /orcid-profile/read-limited /funding/read-limited curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/funding/2629'
Keywords /read-limited /orcid-bio/read-limited curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/keywords'
Other names /read-limited /orcid-bio/read-limited curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/other-names'
Peer review /read-limited NONE curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/peer-review/1579'
Personal details /read-limited /orcid-bio/read-limited curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/personal-details'
Person /read-limited /orcid-bio/read-limited curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/person'
Researcher URL /read-limited /orcid-bio/read-limited curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/researcher-urls'
Work /read-limited /orcid-profile/read-limited
/orcid-works/read-limited
curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/work/469271'

Add Record Items

Item v2.0 Scope v1.2 Scope (deprecated) Example cURL Statement
Address /person/update /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/address.xml' -X POST 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/address
Education /activities/update /affiliations/create curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/education-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/education'
Employment /activities/update /affiliations/create curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/employment-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/employment'
External Identifiers /person/update /orcid-bio/external-identifiers/create curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/external_identifier.xml' -X POST 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/external-identifiers
Funding /activities/update /funding/create curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/funding-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/funding'
Keywords /person/update /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/keyword.xml' -X POST 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/keywords
Other names /person/update /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/other-name.xml' -X POST 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/other-names'
Peer review /activities/update NONE curl -i -H 'Content-type: application/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.0_rc4/0000-0002-1306-4180/peer-review'
Researcher URL /person/update /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/researcher-url.xml' -X POST 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/researcher-urls'
Work /activities/update /orcid-works/create curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/work.xml' -X POST 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/work'
Bulk works /activities/update /orcid-works/create curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/works.xml' -X POST 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/works'

Update Record Items

Item v2.0 Scope v1.2 Scope (deprecated) Example cURL Statement
Address /person/update /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/address.xml' -X PUT 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/address/[PUT-CODE]
Education /activities/update /affiliations/update curl -i -H 'Content-type: application/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.0_rc4/0000-0002-1306-4180/education/[PUT-CODE]'
Employment /activities/update /affiliations/update curl -i -H 'Content-type: application/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.0_rc4/0000-0002-1306-4180/employment/[PUT-CODE]'
External Identifiers /person/update /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/external_identifier.xml' -X PUT 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/external-identifiers/[PUT-CODE]
Funding /activities/update /funding/update curl -i -H 'Content-type: application/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.0_rc4/0000-0002-1306-4180/funding/[PUT-CODE]'
Keywords /person/update /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/keyword.xml' -X PUT 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/keywords/[PUT-CODE]
Other names /person/update /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/other-name.xml' -X PUT 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/other-names/[PUT-CODE]'
Peer review /activities/update NONE curl -i -H 'Content-type: application/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.0_rc4/0000-0002-1306-4180/peer-review/[PUT-CODE]'
Researcher URL /person/update /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/researcher-url.xml' -X PUT 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/researcher-urls/[PUT-CODE]'
Work /activities/update /orcid-works/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/work-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/work/[PUT-CODE]'

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.0_rc4.xsd ">

Delete Record Items

Item v2.0 Scope v1.2 Scope (deprecated) Example cURL Statement
Address /read-limited /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/address/[PUT-CODE]
Education /activities/update /affiliations/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/education/[PUT-CODE]'
Employment /activities/update /affiliations/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/employment/[PUT-CODE]'
External Identifiers /read-limited /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/external-identifiers/[PUT-CODE]
Funding /activities/update /funding/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/funding/[PUT-CODE]'
Keywords /read-limited /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/keywords/[PUT-CODE]
Other names /person/update /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/researcher-urls/[PUT-CODE]'
Peer review /activities/update NONE curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/peer-review/[PUT-CODE]'
Researcher URL /person/update /orcid-bio/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/researcher-urls/[PUT-CODE]'
Work /activities/update /orcid-works/update curl -i -H 'Content-type: application/orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v2.0_rc4/0000-0002-1306-4180/work/[PUT-CODE]'

Search

Item v2.0 Scope v1.2 Scope Example cURL Statement
Search records /read-public /read-public curl -i -H "Accept: application/orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v2.0_rc4/search?q=Simpson'