Step 5 (of 5)
5. Read an ORCID Record (GET)
After writing and updating information on an ORCID record, now it is time to read a summary of everything that is on that record by using GET method.
In this final step we are going to retrieve a summary of everything that is on the ORCID record that we previously added and updated. For this, we are going to use GET method and receive an XML of the record summary.
Return to the browser tab for Google Developers OAuth2 Playground. If you didn’t keep the tab open, you can re-initialize the session with the URL you saved earlier (Clicking OK on the warning that comes up). Or you can set up for the call again by filling all the relevant fields, making sure they look like the screenshots below:
Make sure the configuration has your client ID and client secret
In Step 2 of the Google Devlopers OAuth 2 Playground you should have your access token filled in
It should either still have the token from earlier or you can fill it in from the previous exercise like so:
In Step 3 of the Google Devlopers OAuth 2 Playground click Add headers, enter the values below, then click Add and Close
Header name: Accept
Header value: application/vnd.orcid+xml
The step 3 Configurations should look like the screenshot below:
Set the HTTP Method to GET.
In the request URI field enter :
https://api.sandbox.orcid.org/v3.0/0000-XXXX-XXXX-XXXX/record
Replace [ORCID ID] with the iD for your Sandbox record, format XXXX-XXXX-XXXX-XXXX
Note: the endpoint is the word at the end of the URI. In this case we are reading a summary of the whole record so we end the URL with /record as shown above.
Click Send the request
In the Request/Response field you should see an XML summary of the whole record. It will show all the information on the record including the affiliation you added in step 3 of this tutorial. It will look a bit like the example below which shows the first part of the response.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0003-1481-3160" xmlns:internal="http://www.orcid.org/ns/internal" xmlns:education="http://www.orcid.org/ns/education" xmlns:distinction="http://www.orcid.org/ns/distinction" xmlns:deprecated="http://www.orcid.org/ns/deprecated" xmlns:other-name="http://www.orcid.org/ns/other-name" xmlns:membership="http://www.orcid.org/ns/membership" xmlns:error="http://www.orcid.org/ns/error" xmlns:common="http://www.orcid.org/ns/common" xmlns:record="http://www.orcid.org/ns/record" xmlns:personal-details="http://www.orcid.org/ns/personal-details" xmlns:keyword="http://www.orcid.org/ns/keyword" xmlns:email="http://www.orcid.org/ns/email" xmlns:external-identifier="http://www.orcid.org/ns/external-identifier" xmlns:funding="http://www.orcid.org/ns/funding" xmlns:preferences="http://www.orcid.org/ns/preferences" xmlns:address="http://www.orcid.org/ns/address" xmlns:invited-position="http://www.orcid.org/ns/invited-position" xmlns:work="http://www.orcid.org/ns/work" xmlns:history="http://www.orcid.org/ns/history" xmlns:employment="http://www.orcid.org/ns/employment" xmlns:qualification="http://www.orcid.org/ns/qualification" xmlns:service="http://www.orcid.org/ns/service" xmlns:person="http://www.orcid.org/ns/person" xmlns:activities="http://www.orcid.org/ns/activities" xmlns:researcher-url="http://www.orcid.org/ns/researcher-url" xmlns:peer-review="http://www.orcid.org/ns/peer-review" xmlns:bulk="http://www.orcid.org/ns/bulk" xmlns:research-resource="http://www.orcid.org/ns/research-resource">
<common:orcid-identifier>
<common:uri>https://sandbox.orcid.org/0000-0003-1481-3160</common:uri>
<common:path>0000-0003-1481-3160</common:path>
<common:host>sandbox.orcid.org</common:host>
</common:orcid-identifier>
<preferences:preferences>
<preferences:locale>en</preferences:locale>
</preferences:preferences>
<history:history>
<history:creation-method>Direct</history:creation-method>
<history:submission-date>2017-10-11T08:29:24.481Z</history:submission-date>
<common:last-modified-date>2021-09-14T10:54:02.786Z</common:last-modified-date>
<history:claimed>true</history:claimed>
<history:verified-email>true</history:verified-email>
<history:verified-primary-email>true</history:verified-primary-email>
</history:history>
<person:person path="/0000-0003-1481-3160/person">
<person:name visibility="public" path="0000-0003-1481-3160">
<common:created-date>2017-10-11T08:29:24.481Z</common:created-date>
<common:last-modified-date>2017-10-11T08:29:24.703Z</common:last-modified-date>
<personal-details:given-names>Paula</personal-details:given-names>
<personal-details:family-name>Demain</personal-details:family-name>
</person:name>
<other-name:other-names path="/0000-0003-1481-3160/other-names"/>
<researcher-url:researcher-urls path="/0000-0003-1481-3160/researcher-urls"/>
<email:emails path="/0000-0003-1481-3160/email"/>
<address:addresses path="/0000-0003-1481-3160/address"/>
<keyword:keywords path="/0000-0003-1481-3160/keywords"/>
<external-identifier:external-identifiers path="/0000-0003-1481-3160/external-identifiers"/>
</person:person>
<activities:activities-summary path="/0000-0003-1481-3160/activities">
<common:last-modified-date>2021-09-14T10:53:56.813Z</common:last-modified-date>
<activities:distinctions path="/0000-0003-1481-3160/distinctions"/>
<activities:educations path="/0000-0003-1481-3160/educations">
<common:last-modified-date>2021-09-14T10:53:56.813Z</common:last-modified-date>
<activities:affiliation-group>
<common:last-modified-date>2021-09-14T10:53:56.813Z</common:last-modified-date>
<common:external-ids/>
<education:education-summary put-code="28758" display-index="1" path="/0000-0003-1481-3160/education/28758" visibility="public">
<common:created-date>2017-10-11T08:30:52.610Z</common:created-date>
<common:last-modified-date>2021-09-14T10:53:56.813Z</common:last-modified-date>
<common:source>
<common:source-orcid>
<common:uri>https://sandbox.orcid.org/0000-0003-1481-3160</common:uri>
<common:path>0000-0003-1481-3160</common:path>
<common:host>sandbox.orcid.org</common:host>
</common:source-orcid>
<common:source-name>Paula Demain</common:source-name>
</common:source>
<common:organization>
<common:name>ORCID</common:name>
<common:address>
<common:city>Bethesda</common:city>
<common:region>MD</common:region>
<common:country>US</common:country>
</common:address>
<common:disambiguated-organization>
<common:disambiguated-organization-identifier>385488</common:disambiguated-organization-identifier>