This tutorial goes over editing information in the affiliations section of an ORCID record. Versions of the ORCID API before 3.0 include the Education and Employment affiliation sections. Versions 3.0 and greater include the following sections: Education, Employment, Distinction, Invited position, Membership, Qualification and Service.

These calls can be used with Member API credentials on sandbox or the production servers.

Distinction: An honorary or other award, distinction, or prize in recognition of your achievements, e.g. trophy, medal, honorary degree.

Education: Participation in an academic higher education program to receive an undergraduate, graduate, or other degree, may be in progress or unfinished.

Employment: formal employment relationship with an organization, e.g. staff, intern, researcher, contractor. Employment can be paid or unpaid.

Invited position: An invited non-employment affiliation, e.g. honorary fellow, guest researcher, emeritus professor.

Membership: Membership in a society or association, not including honorary memberships and fellowships.

Qualification: Participation in a professional or vocational accreditation, certification, or training program, may be in progress or unfinished.

Service: A significant donation of time, money, or other resource, e.g. volunteer society officer, elected board position, extension work.

Scopes: /activities/update and /read-limited

Method: 3 step OAuth

Endpoints:

• For education items: /education and /educations
• For employment items: /employment and /employments
• For distinction items (3.0+ only): /distinction and /distinctions
• For invited position items (3.0+ only): /invited-position and /invited-positions
• For membership items (3.0+ only): /membership and /membership
• For qualification items (3.0+ only): /qualification and /qualifications
• For service items (3.0+ only): /service and /services

Sample XML files:

• reading the education section summary in 2.1
• reading an education item in 2.1
• writing an education item in 2.1
• reading the employment section summary in 2.1
• reading an employment item in 2.1
• writing an employment item in 2.1
• Examples for reading affiliations sections in 3.0
• Examples writing affiliation sections in 3.0

Editing the affiliations sections of a record requires a 3 step OAuth token with the /activities/update scope, the /read-limited scope should also be requested for reading items. See Authenticating using OAuth for steps to obtain a token.

• department-name (optional) The department or subdivision of the organization the affiliation is associated with

• role-title (optional) The title given for the position, or the degree earned

• start-date (optional) The date the affiliation began

• end-date (optional) The date the affiliation ended or will end

• organization (required 1) Information about the organization the affiliation was with. A ROR, or Crossref Funder Registry organization identifier is required in 3.0+

• address (required 1) Information about the physical location of the organization the affiliation is with. A city and country are required (region is optional)

• url (optional in 3.0+ only) A URL to a resource about the affiliation

• external-ids (optional 1 in 3.0+ only) An identifier for the affiliation itself

Example request in curl

Example response

Example request in curl

Example request in curl

Example response

Example request in curl

Example request in curl

Example response HTTP/1.1 204 No Content

Footnotes

1. *organization and address fields on distinctions, intived-positions, memberships, services and qualifications are not required as long as an external-id is provided ↩ ↩2 ↩3