Permalink
Switch branches/tags
sudoWorkAccord release-webpackPaths3 release-webpackPaths2 release-webpackPaths release-1.245.0 release-1.244.3 release-1.244.2 release-1.244.1 release-1.244.0 release-1.243.5 release-1.243.4 release-1.243.3 release-1.243.2 release-1.243.1 release-1.243.0 release-1.242.0 release-1.241.2 release-1.241.2_patch_1 release-1.241.1 release-1.241.0 release-1.240.2 release-1.240.1 release-1.240.0 release-1.239.6 release-1.239.6_patch_1 release-1.239.5 release-1.239.4 release-1.239.3 release-1.239.2 release-1.239.1 release-1.239.0 release-1.238.3 release-1.238.3_patch_1 release-1.238.2 release-1.238.1 release-1.238.0 release-1.237.9 release-1.237.8 release-1.237.7 release-1.237.6 release-1.237.5 release-1.237.4 release-1.237.3 release-1.237.2 release-1.237.1 release-1.237.0 release-1.236.0 release-1.235.6 release-1.235.6_patch_1 release-1.235.5 release-1.235.4 release-1.235.3 release-1.235.2 release-1.235.1 release-1.235.0 release-1.234.17 release-1.234.16 release-1.234.15 release-1.234.14 release-1.234.13 release-1.234.12 release-1.234.11 release-1.234.10 release-1.234.9 release-1.234.8 release-1.234.7 release-1.234.6 release-1.234.5 release-1.234.4 release-1.234.3 release-1.234.3_patch_2 release-1.234.3_patch_1 release-1.234.2 release-1.234.1 release-1.234.0 release-1.233.5 release-1.233.4 release-1.233.3 release-1.233.2 release-1.233.1 release-1.233.0 release-1.232.2 release-1.232.1 release-1.232.0 release-1.231.4 release-1.231.3 release-1.231.2 release-1.231.1 release-1.230.4 release-1.230.3 release-1.230.2 release-1.230.1 release-1.230.0 release-1.229.1 release-1.229.1_patch_1 release-1.229.0 release-1.228.1 release-1.228.0 release-1.227.1 release-1.227.0
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
67 lines (33 sloc) 2.75 KB

GROUP-ID-RECORD API

The group-id-record API allows a client to view, add, update, delete the group-id records. A client can access the records with the following 2 scopes :

/group-id-record/read : GET

/group-id-record/update : GET, POST, PUT, DELETE

Generate the input XML >>>

The maximum length of the following fields should not exceed :

Name : 1000 chars Groupid : 1000 chars Decription : 1000 chars

To use the API >>>
  1. Get the access_token :

curl -i -L -H 'Accept: application/json' -d 'client_id=APP-OAGL07C5YB6GP2L0' -d 'client_secret=ead57be0-cf91-47f7-a673-a154cbab7d3f' -d 'scope=/group-id-record/update' -d 'grant_type=client_credentials' 'https://sandbox.orcid.org/oauth/token'

{"access_token":"**a9bae4e9-fdf4-4f18-beaa-08e7629a5ec0**","token_type":"bearer","expires_in":631138518,"scope":"/group-id-record/update","orcid":null}

  1. Use the token to perform the GET, POST, PUT, DELETE.

Create Group-id-record

Creates a new record

curl -i -L -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer a9bae4e9-fdf4-4f18-beaa-08e7629a5ec0' -d '@/Documents/groupid2.0.xml' -X POST 'https://api.sandbox.orcid.org/v2.0/group-id-record'

View Group-id-record

Returns a record with put-code 1000

curl -i -L -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer a9bae4e9-fdf4-4f18-beaa-08e7629a5ec0' -X GET 'https://api.sandbox.orcid.org/v2.0/group-id-record/1000'

Update Group-id-record

Updates and replaces the updated values for the record with put-code 1000

curl -i -L -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer a9bae4e9-fdf4-4f18-beaa-08e7629a5ec0' -d '@/Documents/groupid2.0.xml' -X PUT 'https://api.sandbox.orcid.org/v2.0/group-id-record/1000'

Delete Group-id-record

Deletes the record with put-code 1000

curl -i -L -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer a9bae4e9-fdf4-4f18-beaa-08e7629a5ec0' -X DELETE 'https://api.sandbox.orcid.org/v2.0/group-id-record/1000'

View Group-id-records-Paging

Returns a list of group-id-records which belong to the page number 1, when the given page-size is 5. Also returns other fields('total', 'page', 'page-size') along with the group-id-record list. page-size defaults to 100, page defaults to 1.

curl -i -L -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer a9bae4e9-fdf4-4f18-beaa-08e7629a5ec0' -X GET 'https://api.sandbox.orcid.org/v2.0/group-id-record?page-size=5&page=1'

View Group-id-records-by-name

Returns a list of group-id-records with name "my-name".

curl -i -L -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer a9bae4e9-fdf4-4f18-beaa-08e7629a5ec0' -X GET 'https://api.sandbox.orcid.org/v2.0/group-id-record?name=my-name'