============================================================================= ORCID (R) Open Source http://orcid.org Copyright (c) 2012-2014 ORCID, Inc. Licensed under an MIT-Style License (MIT) http://orcid.org/open-source-license This copyright and license information (including a link to the full license) shall be included in its entirety in all copies or substantial portion of the software. ============================================================================= The schema describes the message format used for ORCID API requests and responses. The top level element is orcid-message.
Properties
attribute form default
unqualified
element form default
qualified
Element orcid:orcid-message
Namespace
http://www.orcid.org/ns/orcid
Annotations
The overall container for all ORCID requests and responses.
<xs:element name="orcid-message"><xs:annotation><xs:documentation>The overall container for all ORCID requests and responses.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:message-version"/><xs:choice><xs:element ref="orcid:orcid-profile"/><xs:element ref="orcid:orcid-search-results"/><xs:element ref="orcid:error-desc"/></xs:choice></xs:sequence></xs:complexType></xs:element>
Element orcid:message-version
Namespace
http://www.orcid.org/ns/orcid
Annotations
The version of ORCID message schema that the orcid-message uses. Please refer to the ORCID XSD Information Readme documentation for more details. https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/README.md
<xs:element name="message-version"><xs:annotation><xs:documentation>The version of ORCID message schema that the orcid-message uses. Please refer to the ORCID XSD Information Readme documentation for more details. https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/README.md</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="1.2_rc6"/><xs:enumeration value="1.2_rc7"/><xs:enumeration value="1.2"/></xs:restriction></xs:simpleType></xs:element>
Element orcid:orcid-profile
Namespace
http://www.orcid.org/ns/orcid
Annotations
The container element for a researcher or contributor ORCID Record.* The type attribute can only be set by ORCID, and indicates the type of ORCID Record the information refers to. In most cases the value will be "user" to indicate an ORCID iD holder.* The client type attribute is set by ORCID, and is present when the type attribute is "group" or "client". This attribute indicates the API privledges held by the group as indicated by their ORCID Membership Agreement.
<xs:element name="orcid-profile"><xs:annotation><xs:documentation>The container element for a researcher or contributor ORCID Record. * The type attribute can only be set by ORCID, and indicates the type of ORCID Record the information refers to. In most cases the value will be "user" to indicate an ORCID iD holder. * The client type attribute is set by ORCID, and is present when the type attribute is "group" or "client". This attribute indicates the API privledges held by the group as indicated by their ORCID Membership Agreement.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:orcid-identifier" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:orcid-deprecated" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:orcid-preferences" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:orcid-history" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:orcid-bio" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:orcid-activities" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:orcid-internal" minOccurs="0" maxOccurs="1"/></xs:sequence><xs:attribute name="type" type="orcid:orcid-type" default="user"/><xs:attribute name="client-type" type="orcid:client-type" use="optional"/><xs:attribute name="group-type" type="orcid:group-type" use="optional"/></xs:complexType></xs:element>
<xs:element name="uri" type="orcid:orcid-uri"><xs:annotation><xs:documentation>ORCID iD in URI form (preferred).</xs:documentation></xs:annotation></xs:element>
<xs:element name="host" type="xs:string"><xs:annotation><xs:documentation>ORCID host (base URL) of the ORCID iD.</xs:documentation></xs:annotation></xs:element>
Element orcid:orcid-deprecated
Namespace
http://www.orcid.org/ns/orcid
Annotations
Element to contain the deprecation information of an ORCID iD and Record. Records are deprecated by researchers or contributors when multiple iDs are found that represent the same person.
<xs:element name="orcid-deprecated"><xs:annotation><xs:documentation>Element to contain the deprecation information of an ORCID iD and Record. Records are deprecated by researchers or contributors when multiple iDs are found that represent the same person.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:deprecated-date" minOccurs="1" maxOccurs="1"/><xs:element ref="orcid:primary-record" maxOccurs="1" minOccurs="1"/></xs:sequence></xs:complexType></xs:element>
Element orcid:deprecated-date
Namespace
http://www.orcid.org/ns/orcid
Annotations
The date and time when the ORCID Record was deprecated, and now points to a different, primary ORCID Record.
<xs:element name="deprecated-date"><xs:annotation><xs:documentation>The date and time when the ORCID Record was deprecated, and now points to a different, primary ORCID Record.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:dateTime"/></xs:simpleContent></xs:complexType></xs:element>
Element orcid:primary-record
Namespace
http://www.orcid.org/ns/orcid
Annotations
The new primary record for the ORCID iD. One should note this new value if the iD being read has been deprecated.
<xs:element name="primary-record"><xs:annotation><xs:documentation>The new primary record for the ORCID iD. One should note this new value if the iD being read has been deprecated.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:orcid-identifier"/></xs:sequence></xs:complexType></xs:element>
Element orcid:orcid-preferences
Namespace
http://www.orcid.org/ns/orcid
Annotations
Preferences set by the researcher or contributor. (currently language preference)
<xs:element name="orcid-preferences"><xs:annotation><xs:documentation>Preferences set by the researcher or contributor. (currently language preference)</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:locale"/></xs:sequence></xs:complexType></xs:element>
Element orcid:locale
Namespace
http://www.orcid.org/ns/orcid
Annotations
Supported locales for site translations/localizations
<xs:element name="locale"><xs:annotation><xs:documentation>Supported locales for site translations/localizations</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="en"/><xs:enumeration value="es"/><xs:enumeration value="fr"/><xs:enumeration value="ko"/><xs:enumeration value="pt"/><xs:enumeration value="ru"/><xs:enumeration value="zh_CN"/><xs:enumeration value="zh_TW"/></xs:restriction></xs:simpleType></xs:element>
Element orcid:orcid-history
Namespace
http://www.orcid.org/ns/orcid
Annotations
A simple history of the researcher or contributor's ORCID Record. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.
<xs:element name="orcid-history"><xs:annotation><xs:documentation>A simple history of the researcher or contributor's ORCID Record. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element name="creation-method" type="orcid:creation-method" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>The method used to create the ORCID Record * API method - Institution created the record on behalf of the individual * Direct method - Individual registered directly at orcid.org * Member-referrred method - Individual registered as part of a workflow such as submitting a manuscript or applying for a grant</xs:documentation></xs:annotation></xs:element><xs:element ref="orcid:completion-date" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:submission-date" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:last-modified-date" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:claimed" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:source" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:deactivation-date" minOccurs="0" maxOccurs="1"/><xs:element name="verified-email" type="xs:boolean" minOccurs="1" maxOccurs="1"><xs:annotation><xs:documentation>True if the user has a verified email</xs:documentation></xs:annotation></xs:element><xs:element name="verified-primary-email" type="xs:boolean" minOccurs="1" maxOccurs="1"><xs:annotation><xs:documentation>True if the user's current primary email is verified</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="orcid:visibility"/></xs:complexType></xs:element>
The method used to create the ORCID Record* API method - Institution created the record on behalf of the individual* Direct method - Individual registered directly at orcid.org* Member-referrred method - Individual registered as part of a workflow such as submitting a manuscript or applying for a grant
The ORCID Record was created using the ORCIDMember API.
enumeration
Direct
The user registered on the /register page.
enumeration
Member-referred
The registered on the /oauth/signin.
enumeration
website
DEPRECATED use Direct or Member-referredinstead. The method used to create the ORCID Record (Website orAPI).
pattern
[\s\S]*[^\s\n\r]+[\s\S]*
Source
<xs:element name="creation-method" type="orcid:creation-method" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>The method used to create the ORCID Record * API method - Institution created the record on behalf of the individual * Direct method - Individual registered directly at orcid.org * Member-referrred method - Individual registered as part of a workflow such as submitting a manuscript or applying for a grant</xs:documentation></xs:annotation></xs:element>
Element orcid:completion-date
Namespace
http://www.orcid.org/ns/orcid
Annotations
The date and time when the ORCID Record set up was completed.
<xs:element name="completion-date"><xs:annotation><xs:documentation>The date and time when the ORCID Record set up was completed.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:dateTime"/></xs:simpleContent></xs:complexType></xs:element>
Element orcid:submission-date
Namespace
http://www.orcid.org/ns/orcid
Annotations
The date time when the ORCID Record and iD was first created.
<xs:element name="submission-date"><xs:annotation><xs:documentation>The date time when the ORCID Record and iD was first created.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:dateTime"/></xs:simpleContent></xs:complexType></xs:element>
<xs:element name="last-modified-date"><xs:annotation><xs:documentation>The date time when the element was last modified.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:dateTime"/></xs:simpleContent></xs:complexType></xs:element>
Element orcid:claimed
Namespace
http://www.orcid.org/ns/orcid
Annotations
True if the researcher or contributor has added a passwordto assume ownership of their ORCID Record after bulk creation by their institution.
<xs:element name="claimed"><xs:annotation><xs:documentation>True if the researcher or contributor has added a password to assume ownership of their ORCID Record after bulk creation by their institution.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:boolean"/></xs:simpleContent></xs:complexType></xs:element>
Element orcid:source
Namespace
http://www.orcid.org/ns/orcid
Annotations
The client application (Member organization's system) or user that created the item. XSD VERSION 1.2 UPDATE: the identifier for the source may be either an ORCID iD (representing individuals and legacy client applications) or a Client ID (representing all newer client applications)
<xs:element name="source"><xs:annotation><xs:documentation>The client application (Member organization's system) or user that created the item. XSD VERSION 1.2 UPDATE: the identifier for the source may be either an ORCID iD (representing individuals and legacy client applications) or a Client ID (representing all newer client applications)</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:choice minOccurs="0"><xs:element ref="orcid:source-orcid"/><xs:element ref="orcid:source-client-id"/></xs:choice><xs:element ref="orcid:source-name" minOccurs="0"/><xs:element ref="orcid:source-date" minOccurs="0"/></xs:sequence></xs:complexType></xs:element>
Element orcid:source-orcid
Namespace
http://www.orcid.org/ns/orcid
Annotations
The ORCID identifier for the individual user (or legacy client application) that created the item. For identifiers of individual users, it may be used to look up ORCID record details via the API.
<xs:element name="source-orcid" type="orcid:orcid-id"><xs:annotation><xs:documentation>The ORCID identifier for the individual user (or legacy client application) that created the item. For identifiers of individual users, it may be used to look up ORCID record details via the API.</xs:documentation></xs:annotation></xs:element>
Element orcid:source-client-id
Namespace
http://www.orcid.org/ns/orcid
Annotations
The client ID for the client application (Member organization system) that created the item.
<xs:element name="source-client-id" type="orcid:client-id"><xs:annotation><xs:documentation>The client ID for the client application (Member organization system) that created the item.</xs:documentation></xs:annotation></xs:element>
The human-readable name of the client application (Member organization system) or individual user that created the item. Value for the same person/organization could change over time. source-orcid or source-client-id fields are more appropriate for disambiguated matching.
<xs:element name="source-name"><xs:annotation><xs:documentation>The human-readable name of the client application (Member organization system) or individual user that created the item. Value for the same person/organization could change over time. source-orcid or source-client-id fields are more appropriate for disambiguated matching.</xs:documentation></xs:annotation><xs:complexType mixed="true"/></xs:element>
Element orcid:source-date
Namespace
http://www.orcid.org/ns/orcid
Annotations
The date time that the source client application (Member organization system) or individual user created/attempted to create the item.
<xs:element name="source-date"><xs:annotation><xs:documentation>The date time that the source client application (Member organization system) or individual user created/attempted to create the item.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:dateTime"/></xs:simpleContent></xs:complexType></xs:element>
Element orcid:deactivation-date
Namespace
http://www.orcid.org/ns/orcid
Annotations
The date and time when the ORCID Record was deactivated. (If the account is active, this field will be NULL.)
<xs:element name="deactivation-date"><xs:annotation><xs:documentation>The date and time when the ORCID Record was deactivated. (If the account is active, this field will be NULL.)</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:dateTime"/></xs:simpleContent></xs:complexType></xs:element>
<xs:element name="verified-email" type="xs:boolean" minOccurs="1" maxOccurs="1"><xs:annotation><xs:documentation>True if the user has a verified email</xs:documentation></xs:annotation></xs:element>
True if the user's current primary email is verified
Diagram
Type
xs:boolean
Properties
content
simple
minOccurs
1
maxOccurs
1
Source
<xs:element name="verified-primary-email" type="xs:boolean" minOccurs="1" maxOccurs="1"><xs:annotation><xs:documentation>True if the user's current primary email is verified</xs:documentation></xs:annotation></xs:element>
Element orcid:orcid-bio
Namespace
http://www.orcid.org/ns/orcid
Annotations
The biographical details of the researcher or contributor.
<xs:element name="personal-details"><xs:annotation><xs:documentation>Container for the personal details (names) of the researcher or contributor.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element name="given-names" minOccurs="1" type="orcid:non-empty-string"><xs:annotation><xs:documentation>The given (first and middle) name(s) of the researcher or contributor.</xs:documentation></xs:annotation></xs:element><xs:element name="family-name" minOccurs="0" type="orcid:non-empty-string"><xs:annotation><xs:documentation>The family (last) name of the researcher or contributor. This element is optional, because some cultures only use given names.</xs:documentation></xs:annotation></xs:element><xs:element ref="orcid:credit-name" minOccurs="0"><xs:annotation><xs:documentation>The full name of the researcher or contributor as it generally appears on their published works. (see element for more details.) The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.</xs:documentation></xs:annotation></xs:element><xs:element ref="orcid:other-names" minOccurs="0"><xs:annotation><xs:documentation>(Optional) Container that includes other name(s) that the researcher or contributor may be known by. (see element for more details.) The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.</xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType></xs:element>
<xs:element name="given-names" minOccurs="1" type="orcid:non-empty-string"><xs:annotation><xs:documentation>The given (first and middle) name(s) of the researcher or contributor.</xs:documentation></xs:annotation></xs:element>
<xs:element name="family-name" minOccurs="0" type="orcid:non-empty-string"><xs:annotation><xs:documentation>The family (last) name of the researcher or contributor. This element is optional, because some cultures only use given names.</xs:documentation></xs:annotation></xs:element>
Element orcid:credit-name
Namespace
http://www.orcid.org/ns/orcid
Annotations
The name to use for the researcher or contributor when credited or cited, for example, in an article or index, or as a funding contributor. The value of this field also is used as the display name for the researcher or contributor in the ORCID Registry in their ORCID Record, or when listed as a contributor on other ORCID Records. If this element is NULL, given-name family-name will be used for display purposes, with a visibility of "public". The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.
<xs:element name="credit-name"><xs:annotation><xs:documentation>The name to use for the researcher or contributor when credited or cited, for example, in an article or index, or as a funding contributor. The value of this field also is used as the display name for the researcher or contributor in the ORCID Registry in their ORCID Record, or when listed as a contributor on other ORCID Records. If this element is NULL, given-name family-name will be used for display purposes, with a visibility of "public". The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="orcid:non-empty-string"><xs:attributeGroup ref="orcid:visibility"/></xs:extension></xs:simpleContent></xs:complexType></xs:element>
Element orcid:other-names
Namespace
http://www.orcid.org/ns/orcid
Annotations
Container for past names, or variations of the researcher or contributor's name, that may have appeared on their published works. This could include variations because of transliterations of their names into different alphabets. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.
<xs:element name="other-names"><xs:annotation><xs:documentation>Container for past names, or variations of the researcher or contributor's name, that may have appeared on their published works. This could include variations because of transliterations of their names into different alphabets. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element minOccurs="0" maxOccurs="unbounded" name="other-name" type="orcid:non-empty-string"><xs:annotation><xs:documentation>One alternate name for the individual represented by the ORCID record.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="orcid:visibility"/></xs:complexType></xs:element>
<xs:element minOccurs="0" maxOccurs="unbounded" name="other-name" type="orcid:non-empty-string"><xs:annotation><xs:documentation>One alternate name for the individual represented by the ORCID record.</xs:documentation></xs:annotation></xs:element>
Element orcid:biography
Namespace
http://www.orcid.org/ns/orcid
Annotations
Description of the researcher's professional career. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.
<xs:element name="biography"><xs:annotation><xs:documentation>Description of the researcher's professional career. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="orcid:bio-text"><xs:attributeGroup ref="orcid:visibility"/></xs:extension></xs:simpleContent></xs:complexType></xs:element>
Element orcid:researcher-urls
Namespace
http://www.orcid.org/ns/orcid
Annotations
Container for URLs of the researcher or contributor's sites. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.
<xs:element name="researcher-urls"><xs:annotation><xs:documentation>Container for URLs of the researcher or contributor's sites. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element minOccurs="0" maxOccurs="unbounded" ref="orcid:researcher-url"/></xs:sequence><xs:attributeGroup ref="orcid:visibility"/></xs:complexType></xs:element>
Element orcid:researcher-url
Namespace
http://www.orcid.org/ns/orcid
Annotations
The display name and URL for one of the researcher or contributor's sites.
<xs:element name="researcher-url"><xs:annotation><xs:documentation>The display name and URL for one of the researcher or contributor's sites.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element minOccurs="0" maxOccurs="1" name="url-name" type="orcid:non-empty-string"><xs:annotation><xs:documentation>A short display name describing the URL.</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" maxOccurs="1" ref="orcid:url"><xs:annotation><xs:documentation>The URL (including http:// or https://).</xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType></xs:element>
<xs:element minOccurs="0" maxOccurs="1" name="url-name" type="orcid:non-empty-string"><xs:annotation><xs:documentation>A short display name describing the URL.</xs:documentation></xs:annotation></xs:element>
<xs:element name="url"><xs:annotation><xs:documentation>Represents a URL in the XML anyURI format</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:anyURI"/></xs:simpleContent></xs:complexType></xs:element>
Element orcid:contact-details
Namespace
http://www.orcid.org/ns/orcid
Annotations
Container for the researcher or contributor's contact infomration. Includes email address(es) and country (address). While there can be an unlimited number of email addresses, only one may be designated as a primary email address.
<xs:element name="contact-details"><xs:annotation><xs:documentation>Container for the researcher or contributor's contact infomration. Includes email address(es) and country (address). While there can be an unlimited number of email addresses, only one may be designated as a primary email address.</xs:documentation></xs:annotation><xs:complexType><xs:annotation><xs:appinfo><sch:pattern><sch:title>Test of number of primary emails</sch:title><sch:rule context="orcid:contact-details"><sch:assert test="if(count(orcid:email) <= 1) then true() else count(orcid:email[@primary=true()]) + count(orcid:email[not(exists(@primary))]) = 1">Wrong number of primary emails</sch:assert></sch:rule></sch:pattern></xs:appinfo></xs:annotation><xs:sequence><xs:element ref="orcid:email" minOccurs="0" maxOccurs="unbounded"/><xs:element ref="orcid:address" minOccurs="0"/></xs:sequence></xs:complexType></xs:element>
Element orcid:email
Namespace
http://www.orcid.org/ns/orcid
Annotations
An email address for the researcher or contributor. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.
Indicates if the address is a current one for the user. The current attribute is assigned as TRUE to any email address currently used. Former addresses also may be associated with ORCID records, and should include a current attribute of FALSE.
Indicates (by a TRUE value) the address that the ORCID Registry will used to contact the researcher or contributor (based on user contact preferences). The primary attribute is assigned as TRUE to exactly one email address.
The ORCID identifier for the individual user (or legacy client application) that created the item. Either a source or source-client-id will be present. NOTE: value will be replaced by source element in future XSD versions.
The client ID for the client application (Member organization system) that created the item. Either a source or source-client-id will be present. NOTE: value will be replaced by source element in future XSD versions.
Indicates (with a TRUE value) if the researcher or contributor verified the email address by clicking on a link sent to the address. This field can not be set when adding an email address to an ORCID record.
<xs:element name="email"><xs:annotation><xs:documentation>An email address for the researcher or contributor. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="orcid:email"><xs:attributeGroup ref="orcid:visibility"/><xs:attribute name="primary" type="xs:boolean" default="true"><xs:annotation><xs:documentation>Indicates (by a TRUE value) the address that the ORCID Registry will used to contact the researcher or contributor (based on user contact preferences). The primary attribute is assigned as TRUE to exactly one email address.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="current" type="xs:boolean" default="true"><xs:annotation><xs:documentation>Indicates if the address is a current one for the user. The current attribute is assigned as TRUE to any email address currently used. Former addresses also may be associated with ORCID records, and should include a current attribute of FALSE.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="verified" type="xs:boolean" default="false"><xs:annotation><xs:documentation>Indicates (with a TRUE value) if the researcher or contributor verified the email address by clicking on a link sent to the address. This field can not be set when adding an email address to an ORCID record.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="source" type="orcid:orcid-path"><xs:annotation><xs:documentation>The ORCID identifier for the individual user (or legacy client application) that created the item. Either a source or source-client-id will be present. NOTE: value will be replaced by source element in future XSD versions.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="source-client-id" type="orcid:client-path"><xs:annotation><xs:documentation>The client ID for the client application (Member organization system) that created the item. Either a source or source-client-id will be present. NOTE: value will be replaced by source element in future XSD versions.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:simpleContent></xs:complexType></xs:element>
Element orcid:address
Namespace
http://www.orcid.org/ns/orcid
Annotations
Container for address information. Only country information is included at this time.
<xs:element name="address"><xs:annotation><xs:documentation>Container for address information. Only country information is included at this time.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element minOccurs="0" ref="orcid:country"/></xs:sequence></xs:complexType></xs:element>
Element orcid:country
Namespace
http://www.orcid.org/ns/orcid
Annotations
Country represented by its ISO 3611 code. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.
<xs:element name="country"><xs:annotation><xs:documentation>Country represented by its ISO 3611 code. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="orcid:iso-3166-country-or-empty"><xs:attributeGroup ref="orcid:visibility"/></xs:extension></xs:simpleContent></xs:complexType></xs:element>
Element orcid:keywords
Namespace
http://www.orcid.org/ns/orcid
Annotations
Container for words or phrases describing areas of research for the researcher. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.
<xs:element name="keywords"><xs:annotation><xs:documentation>Container for words or phrases describing areas of research for the researcher. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:keyword" minOccurs="0" maxOccurs="unbounded"/></xs:sequence><xs:attributeGroup ref="orcid:visibility"/></xs:complexType></xs:element>
Element orcid:keyword
Namespace
http://www.orcid.org/ns/orcid
Annotations
One instance of a keyword, a word or phrase describing areas of research for the researcher.
<xs:element name="keyword"><xs:annotation><xs:documentation>One instance of a keyword, a word or phrase describing areas of research for the researcher.</xs:documentation></xs:annotation><xs:complexType mixed="true"/></xs:element>
Element orcid:external-identifiers
Namespace
http://www.orcid.org/ns/orcid
Annotations
Container for references to the reasearcher or contributor in other systems. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.
<xs:element name="external-identifiers"><xs:annotation><xs:documentation>Container for references to the reasearcher or contributor in other systems. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" ref="orcid:external-identifier"/></xs:sequence><xs:attributeGroup ref="orcid:visibility"/></xs:complexType></xs:element>
Element orcid:external-identifier
Namespace
http://www.orcid.org/ns/orcid
Annotations
A reference to the reasearcher or contributor in other systems. Contains display text (<exernal-id-common-name>), the reference number (<external-id-reference>), and a URL to the source (<external-id-url>).
<xs:element name="external-identifier"><xs:annotation><xs:documentation>A reference to the reasearcher or contributor in other systems. Contains display text (<exernal-id-common-name>), the reference number (<external-id-reference>), and a URL to the source (<external-id-url>).</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:external-id-common-name" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:external-id-reference" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:external-id-url" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:source" minOccurs="0"/></xs:sequence></xs:complexType></xs:element>
Element orcid:external-id-common-name
Namespace
http://www.orcid.org/ns/orcid
Annotations
The display name/type for the external ID - an identifier for the researcher in another system.
<xs:element name="external-id-common-name"><xs:annotation><xs:documentation>The display name/type for the external ID - an identifier for the researcher in another system.</xs:documentation></xs:annotation><xs:complexType mixed="true"/></xs:element>
Element orcid:external-id-reference
Namespace
http://www.orcid.org/ns/orcid
Annotations
The value for the external ID - an identifier for the researcher in another system.
<xs:element name="external-id-reference"><xs:annotation><xs:documentation>The value for the external ID - an identifier for the researcher in another system.</xs:documentation></xs:annotation><xs:complexType mixed="true"/></xs:element>
Element orcid:external-id-url
Namespace
http://www.orcid.org/ns/orcid
Annotations
The URL for the external ID - an identifier for the researcher in another system.
<xs:element name="external-id-url"><xs:annotation><xs:documentation>The URL for the external ID - an identifier for the researcher in another system.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:anyURI"/></xs:simpleContent></xs:complexType></xs:element>
Element orcid:delegation
Namespace
http://www.orcid.org/ns/orcid
Annotations
(FUTURE) Container for functionality that has not yet been built. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.
<xs:element name="delegation"><xs:annotation><xs:documentation>(FUTURE) Container for functionality that has not yet been built. The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element minOccurs="0" ref="orcid:given-permission-to"/><xs:element minOccurs="0" ref="orcid:given-permission-by"/></xs:sequence><xs:attributeGroup ref="orcid:visibility"/></xs:complexType></xs:element>
<xs:element name="applications"><xs:annotation><xs:documentation>(FOR INTERNAL USE ONLY) Container for Authorizations. Not used by the API.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" ref="orcid:application-summary"/></xs:sequence><xs:attributeGroup ref="orcid:visibility"/></xs:complexType></xs:element>
Container for research activities of the researcher or contributor, such as Works.Please note that the orcid-patents element is deprecated and will be removed soon
<xs:element name="orcid-activities"><xs:annotation><xs:documentation>Container for research activities of the researcher or contributor, such as Works. Please note that the orcid-patents element is deprecated and will be removed soon</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element minOccurs="0" maxOccurs="1" ref="orcid:affiliations"/><xs:element minOccurs="0" maxOccurs="1" ref="orcid:orcid-works"/><xs:element minOccurs="0" maxOccurs="1" ref="orcid:funding-list"/></xs:sequence></xs:complexType></xs:element>
Element orcid:affiliations
Namespace
http://www.orcid.org/ns/orcid
Annotations
Container for the list of affiliations (eg. employment or education) associated with the researcher or contributor
<xs:element name="affiliations"><xs:annotation><xs:documentation>Container for the list of affiliations (eg. employment or education) associated with the researcher or contributor</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" ref="orcid:affiliation"/></xs:sequence></xs:complexType></xs:element>
Element orcid:affiliation
Namespace
http://www.orcid.org/ns/orcid
Annotations
An affiliation associated with the researcher or contributor. * The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.* The put-code attribute is used only when reading this element. When updating the item, the put-code attribute must be included to indicate the specific record to be updated.
<xs:element name="affiliation"><xs:annotation><xs:documentation>An affiliation associated with the researcher or contributor. * The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information. * The put-code attribute is used only when reading this element. When updating the item, the put-code attribute must be included to indicate the specific record to be updated.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element name="type" type="orcid:affiliation-type"/><xs:element name="department-name" type="orcid:non-empty-string" minOccurs="0" maxOccurs="1"/><xs:element name="role-title" type="orcid:non-empty-string" minOccurs="0" maxOccurs="1"/><xs:element name="start-date" type="orcid:fuzzy-date" minOccurs="0" maxOccurs="1"/><xs:element name="end-date" type="orcid:fuzzy-date" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:organization" minOccurs="1" maxOccurs="1"/><xs:element ref="orcid:source" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:created-date" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:last-modified-date" minOccurs="0" maxOccurs="1"/></xs:sequence><xs:attributeGroup ref="orcid:put-code"/><xs:attributeGroup ref="orcid:visibility"/></xs:complexType></xs:element>
<xs:element name="year"><xs:annotation><xs:documentation>Used with the fuzzy-date type. Represents the year of the date.</xs:documentation></xs:annotation><xs:complexType mixed="true"><xs:simpleContent><xs:extension base="orcid:year"/></xs:simpleContent></xs:complexType></xs:element>
Element orcid:month
Namespace
http://www.orcid.org/ns/orcid
Annotations
Used with the fuzzy-date type. Represents the month of the date.
<xs:element name="month"><xs:annotation><xs:documentation>Used with the fuzzy-date type. Represents the month of the date.</xs:documentation></xs:annotation><xs:complexType mixed="true"><xs:simpleContent><xs:extension base="orcid:month"/></xs:simpleContent></xs:complexType></xs:element>
Element orcid:day
Namespace
http://www.orcid.org/ns/orcid
Annotations
Used with the fuzzy-date type. Represents the day of the date.
<xs:element name="day"><xs:annotation><xs:documentation>Used with the fuzzy-date type. Represents the day of the date.</xs:documentation></xs:annotation><xs:complexType mixed="true"><xs:simpleContent><xs:extension base="orcid:day"/></xs:simpleContent></xs:complexType></xs:element>
A reference to an organization. When available, an organization will be tied to a disambiguated organization which uniquely identifies the organization.
<xs:element name="organization"><xs:annotation><xs:documentation>A reference to an organization. When available, an organization will be tied to a disambiguated organization which uniquely identifies the organization.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element name="name" type="orcid:non-empty-string"/><xs:element name="address" type="orcid:organization-address"/><xs:element name="disambiguated-organization" type="orcid:disambiguated-organization" minOccurs="0" maxOccurs="1"/></xs:sequence></xs:complexType></xs:element>
<xs:element minOccurs="0" name="region" type="orcid:non-empty-string"><xs:annotation><xs:documentation>Region within a country</xs:documentation></xs:annotation></xs:element>
<xs:element name="disambiguation-source" type="orcid:short-text"><xs:annotation><xs:documentation>The source for providing the disambiguated organization ID.</xs:documentation></xs:annotation></xs:element>
<xs:element name="created-date"><xs:annotation><xs:documentation>The date time when element was created.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:dateTime"/></xs:simpleContent></xs:complexType></xs:element>
Element orcid:orcid-works
Namespace
http://www.orcid.org/ns/orcid
Annotations
Container for the Works published by the researcher or contributor.
<xs:element name="orcid-works"><xs:annotation><xs:documentation>Container for the Works published by the researcher or contributor.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" ref="orcid:orcid-work"/></xs:sequence><xs:attributeGroup ref="orcid:scope"/></xs:complexType></xs:element>
Element orcid:orcid-work
Namespace
http://www.orcid.org/ns/orcid
Annotations
A work published by the researcher or contributor. * The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.* The put-code attribute is used only when reading this element. When updating the item, the put-code attribute must be included to indicate the specific record to be updated.
<xs:element name="orcid-work"><xs:annotation><xs:documentation>A work published by the researcher or contributor. * The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information. * The put-code attribute is used only when reading this element. When updating the item, the put-code attribute must be included to indicate the specific record to be updated.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:work-title" minOccurs="0"/><xs:element ref="orcid:journal-title" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:short-description" minOccurs="0"/><xs:element ref="orcid:work-citation" minOccurs="0"/><xs:element ref="orcid:work-type"/><xs:element ref="orcid:publication-date" minOccurs="0"/><xs:element ref="orcid:work-external-identifiers" minOccurs="0"/><xs:element ref="orcid:url" minOccurs="0"/><xs:element ref="orcid:work-contributors" minOccurs="0"/><xs:element ref="orcid:source" minOccurs="0"/><xs:element ref="orcid:created-date" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:last-modified-date" minOccurs="0" maxOccurs="1"/><xs:element name="language-code" type="orcid:language-code" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:country" minOccurs="0"/></xs:sequence><xs:attributeGroup ref="orcid:visibility"/><xs:attributeGroup ref="orcid:put-code"/></xs:complexType></xs:element>
<xs:element name="work-title"><xs:annotation><xs:documentation>Container for titles of the work.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element name="title" type="orcid:non-empty-string"><xs:annotation><xs:documentation>The main name or title of the work. For a spin-off company, include use the company name</xs:documentation></xs:annotation></xs:element><xs:element ref="orcid:subtitle" minOccurs="0"/><xs:element ref="orcid:translated-title" minOccurs="0"/></xs:sequence></xs:complexType></xs:element>
<xs:element name="title" type="orcid:non-empty-string"><xs:annotation><xs:documentation>The main name or title of the work. For a spin-off company, include use the company name</xs:documentation></xs:annotation></xs:element>
<xs:element name="subtitle"><xs:annotation><xs:documentation>If the work has a subtitle, include it here.</xs:documentation></xs:annotation><xs:complexType mixed="true"/></xs:element>
Element orcid:translated-title
Namespace
http://www.orcid.org/ns/orcid
Annotations
The main title of the work or funding translated into another language. The translated language will be included in the <language-code> attribute.
<xs:element name="translated-title"><xs:annotation><xs:documentation>The main title of the work or funding translated into another language. The translated language will be included in the <language-code> attribute.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:restriction base="orcid:stringWithLangCode"><xs:maxLength value="1000"/></xs:restriction></xs:simpleContent></xs:complexType></xs:element>
Element orcid:journal-title
Namespace
http://www.orcid.org/ns/orcid
Annotations
The title of the publication or group under which the work was published. * If a jounal, include the journal title of the work. * If a book chapter, use the book title.* If a translation or a manual, use the series title.* If a dictionary entry, use the dictionary title.* If a conference poster, abstract or paper, use the conference name.
<xs:element name="journal-title"><xs:annotation><xs:documentation>The title of the publication or group under which the work was published. * If a jounal, include the journal title of the work. * If a book chapter, use the book title. * If a translation or a manual, use the series title. * If a dictionary entry, use the dictionary title. * If a conference poster, abstract or paper, use the conference name.</xs:documentation></xs:annotation><xs:complexType mixed="true"/></xs:element>
Element orcid:short-description
Namespace
http://www.orcid.org/ns/orcid
Annotations
A short narrative (few sentences) describing the item.
<xs:element name="work-citation" type="orcid:citation"><xs:annotation><xs:documentation>Element containing the type and content of the citation for this work</xs:documentation></xs:annotation></xs:element>
The types of works accepted accepted by the ORCID Registry. Please refer to the CASRAI dictionary for definitions of each work type. http://dictionary.casrai.org/research-personnel-profile/contributions/outputs
<xs:element name="publication-date"><xs:annotation><xs:documentation>The date that the work was first published.</xs:documentation></xs:annotation><xs:complexType><xs:complexContent><xs:extension base="orcid:fuzzy-date"><xs:attribute name="media-type" type="orcid:media-type"/></xs:extension></xs:complexContent></xs:complexType></xs:element>
Element orcid:work-external-identifiers
Namespace
http://www.orcid.org/ns/orcid
Annotations
Container for storing the external references to the work.
<xs:element name="work-external-identifiers"><xs:annotation><xs:documentation>Container for storing the external references to the work.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" ref="orcid:work-external-identifier"/></xs:sequence><xs:attributeGroup ref="orcid:scope"/></xs:complexType></xs:element>
<xs:element name="work-external-identifier"><xs:annotation><xs:documentation>External references to the work.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:work-external-identifier-type" maxOccurs="1"/><xs:element ref="orcid:work-external-identifier-id" maxOccurs="1"/></xs:sequence></xs:complexType></xs:element>
Element orcid:work-external-identifier-type
Namespace
http://www.orcid.org/ns/orcid
Annotations
The type of work external identifier, e.g DOI, PMID etc.
Diagram
Type
restriction of xs:string
Properties
content
simple
Facets
enumeration
agr
Agricola
enumeration
arxiv
enumeration
asin
enumeration
asin-tld
enumeration
bibcode
enumeration
cba
Chinese Biological Abstracts
enumeration
cit
CiteSeer
enumeration
ctx
CiteXplore submission
enumeration
doi
enumeration
eid
enumeration
ethos
EThOS Peristent ID
enumeration
handle
enumeration
hir
NHS Evidence
enumeration
isbn
enumeration
issn
enumeration
jfm
enumeration
jstor
enumeration
lccn
enumeration
mr
enumeration
oclc
enumeration
ol
enumeration
osti
enumeration
other-id
enumeration
pat
Patent number prefixed with ISO 3611 two letter country code
enumeration
pmc
enumeration
pmid
enumeration
rfc
enumeration
source-work-id
Non-standard ID with meaning only in the system from which the work data were sourced
<xs:element name="work-external-identifier-type"><xs:annotation><xs:documentation>The type of work external identifier, e.g DOI, PMID etc.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="agr"><xs:annotation><xs:documentation>Agricola</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="arxiv"/><xs:enumeration value="asin"/><xs:enumeration value="asin-tld"/><xs:enumeration value="bibcode"/><xs:enumeration value="cba"><xs:annotation><xs:documentation>Chinese Biological Abstracts</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="cit"><xs:annotation><xs:documentation>CiteSeer</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="ctx"><xs:annotation><xs:documentation>CiteXplore submission</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="doi"/><xs:enumeration value="eid"/><xs:enumeration value="ethos"><xs:annotation><xs:documentation>EThOS Peristent ID</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="handle"/><xs:enumeration value="hir"><xs:annotation><xs:documentation>NHS Evidence</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="isbn"/><xs:enumeration value="issn"/><xs:enumeration value="jfm"/><xs:enumeration value="jstor"/><xs:enumeration value="lccn"/><xs:enumeration value="mr"/><xs:enumeration value="oclc"/><xs:enumeration value="ol"/><xs:enumeration value="osti"/><xs:enumeration value="other-id"/><xs:enumeration value="pat"><xs:annotation><xs:documentation>Patent number prefixed with ISO 3611 two letter country code</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="pmc"/><xs:enumeration value="pmid"/><xs:enumeration value="rfc"/><xs:enumeration value="source-work-id"><xs:annotation><xs:documentation>Non-standard ID with meaning only in the system from which the work data were sourced</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="ssrn"/><xs:enumeration value="uri"/><xs:enumeration value="urn"/><xs:enumeration value="wos"><xs:annotation><xs:documentation>Web of Science identifier</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="zbl"/></xs:restriction></xs:simpleType></xs:element>
<xs:element name="work-external-identifier-id" type="orcid:non-empty-string"><xs:annotation><xs:documentation>Value for the identifier</xs:documentation></xs:annotation></xs:element>
<xs:element name="work-contributors"><xs:annotation><xs:documentation>Container for the contributors of a Work.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" ref="orcid:contributor"/></xs:sequence></xs:complexType></xs:element>
Element orcid:contributor
Namespace
http://www.orcid.org/ns/orcid
Annotations
A collaborator or other contributor to a work or other orcid-activity
<xs:element name="contributor"><xs:annotation><xs:documentation>A collaborator or other contributor to a work or other orcid-activity</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:contributor-orcid" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:credit-name" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:contributor-email" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:contributor-attributes" minOccurs="0" maxOccurs="1"/></xs:sequence></xs:complexType></xs:element>
<xs:element name="contributor-orcid" type="orcid:orcid-id"><xs:annotation><xs:documentation>ORCID iD for the contributor</xs:documentation></xs:annotation></xs:element>
Element orcid:contributor-email
Namespace
http://www.orcid.org/ns/orcid
Annotations
Email of the collaborator or other contributor. When provided during creation or update, the email address is used to look up and add the contributor's ORCID iD.
<xs:element name="contributor-email"><xs:annotation><xs:documentation>Email of the collaborator or other contributor. When provided during creation or update, the email address is used to look up and add the contributor's ORCID iD.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="orcid:email"/></xs:simpleContent></xs:complexType></xs:element>
Element orcid:contributor-attributes
Namespace
http://www.orcid.org/ns/orcid
Annotations
Provides detail of the nature of the contribution by the collaborator or other contirbutor.
<xs:element name="contributor-attributes"><xs:annotation><xs:documentation>Provides detail of the nature of the contribution by the collaborator or other contirbutor.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:contributor-sequence" minOccurs="0"/><xs:element ref="orcid:contributor-role" minOccurs="0"/></xs:sequence></xs:complexType></xs:element>
Element orcid:contributor-sequence
Namespace
http://www.orcid.org/ns/orcid
Annotations
Indication of where in the contributor list the collaborator or other contributor's name would appear
<xs:element name="contributor-sequence"><xs:annotation><xs:documentation>Indication of where in the contributor list the collaborator or other contributor's name would appear</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="first"/><xs:enumeration value="additional"/></xs:restriction></xs:simpleType></xs:element>
Element orcid:contributor-role
Namespace
http://www.orcid.org/ns/orcid
Annotations
The role performed by the collaborator or other contributor.
<xs:element name="contributor-role"><xs:annotation><xs:documentation>The role performed by the collaborator or other contributor.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="author"/><xs:enumeration value="assignee"/><xs:enumeration value="editor"/><xs:enumeration value="chair-or-translator"/><xs:enumeration value="co-investigator"/><xs:enumeration value="co-inventor"/><xs:enumeration value="graduate-student"/><xs:enumeration value="other-inventor"/><xs:enumeration value="principal-investigator"/><xs:enumeration value="postdoctoral-researcher"/><xs:enumeration value="support-staff"/></xs:restriction></xs:simpleType></xs:element>
<xs:element name="funding-list"><xs:annotation><xs:documentation>Container for the funding received by the researcher or contributor</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" ref="orcid:funding"/></xs:sequence></xs:complexType></xs:element>
Element orcid:funding
Namespace
http://www.orcid.org/ns/orcid
Annotations
Funding received by the researcher or contributor. * REQUIRED FIELDS: Funding-type, Funding-title, Funding Agency (organization)* The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information.* The put-code attribute is used only when reading this element. When updating the item, the put-code attribute must be included to indicate the specific record to be updated.
<xs:element name="funding"><xs:annotation><xs:documentation>Funding received by the researcher or contributor. * REQUIRED FIELDS: Funding-type, Funding-title, Funding Agency (organization) * The visibility attribute (private, limited or public) can be set at record creation, and indicates who can see this section of information. * The put-code attribute is used only when reading this element. When updating the item, the put-code attribute must be included to indicate the specific record to be updated.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:funding-type" minOccurs="1" maxOccurs="1"/><xs:element ref="orcid:organization-defined-type" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:funding-title" minOccurs="1"/><xs:element ref="orcid:short-description" minOccurs="0"/><xs:element ref="orcid:amount" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:url" minOccurs="0" maxOccurs="1"/><xs:element name="start-date" type="orcid:fuzzy-date" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>Start date for the funding.</xs:documentation></xs:annotation></xs:element><xs:element name="end-date" type="orcid:fuzzy-date" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>End date for the funding.</xs:documentation></xs:annotation></xs:element><xs:element ref="orcid:funding-external-identifiers" minOccurs="0"/><xs:element ref="orcid:funding-contributors" minOccurs="0"/><xs:element ref="orcid:organization" minOccurs="1" maxOccurs="1"/><xs:element ref="orcid:source" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:created-date" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:last-modified-date" minOccurs="0" maxOccurs="1"/></xs:sequence><xs:attributeGroup ref="orcid:put-code"/><xs:attributeGroup ref="orcid:visibility"/></xs:complexType></xs:element>
Element orcid:funding-type
Namespace
http://www.orcid.org/ns/orcid
Annotations
The type of funding, it could be grant, contract, award or salary-award.
<xs:element name="funding-type"><xs:annotation><xs:documentation>The type of funding, it could be grant, contract, award or salary-award.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="grant"/><xs:enumeration value="contract"/><xs:enumeration value="award"/><xs:enumeration value="salary-award"/></xs:restriction></xs:simpleType></xs:element>
Element orcid:organization-defined-type
Namespace
http://www.orcid.org/ns/orcid
Annotations
Container for a organization defined type for an external identifier.
<xs:element name="organization-defined-type" type="orcid:string255"><xs:annotation><xs:documentation>Container for a organization defined type for an external identifier.</xs:documentation></xs:annotation></xs:element>
<xs:element name="funding-title"><xs:annotation><xs:documentation>Container for titles of the funding.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element name="title" type="orcid:string1000"><xs:annotation><xs:documentation>The main name or title of the funding.</xs:documentation></xs:annotation></xs:element><xs:element ref="orcid:translated-title" minOccurs="0"/></xs:sequence></xs:complexType></xs:element>
<xs:element name="title" type="orcid:string1000"><xs:annotation><xs:documentation>The main name or title of the funding.</xs:documentation></xs:annotation></xs:element>
<xs:element name="start-date" type="orcid:fuzzy-date" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>Start date for the funding.</xs:documentation></xs:annotation></xs:element>
<xs:element name="end-date" type="orcid:fuzzy-date" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>End date for the funding.</xs:documentation></xs:annotation></xs:element>
Element orcid:funding-external-identifiers
Namespace
http://www.orcid.org/ns/orcid
Annotations
Container for storing the external references to the funding.
<xs:element name="funding-external-identifiers"><xs:annotation><xs:documentation>Container for storing the external references to the funding.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" ref="orcid:funding-external-identifier"/></xs:sequence></xs:complexType></xs:element>
Element orcid:funding-external-identifier
Namespace
http://www.orcid.org/ns/orcid
Annotations
An external identifier that uniquely represents the funding. Includes an identifier type and value as well as a URL for a link to more information about the funding.
<xs:element name="funding-external-identifier"><xs:annotation><xs:documentation>An external identifier that uniquely represents the funding. Includes an identifier type and value as well as a URL for a link to more information about the funding.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:funding-external-identifier-type" minOccurs="1" maxOccurs="1"/><xs:element name="funding-external-identifier-value" type="orcid:string2084" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>Value of the external identifier.</xs:documentation></xs:annotation></xs:element><xs:element name="funding-external-identifier-url" type="xs:anyURI" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>URL link to additional information about the funding.</xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType></xs:element>
Element orcid:funding-external-identifier-type
Namespace
http://www.orcid.org/ns/orcid
Annotations
The type of the funding external identifier. Currently only grant number is supported.
<xs:element name="funding-external-identifier-type"><xs:annotation><xs:documentation>The type of the funding external identifier. Currently only grant number is supported.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="grant_number"/></xs:restriction></xs:simpleType></xs:element>
<xs:element name="funding-external-identifier-value" type="orcid:string2084" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>Value of the external identifier.</xs:documentation></xs:annotation></xs:element>
URL link to additional information about the funding.
Diagram
Type
xs:anyURI
Properties
content
simple
minOccurs
0
maxOccurs
1
Source
<xs:element name="funding-external-identifier-url" type="xs:anyURI" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>URL link to additional information about the funding.</xs:documentation></xs:annotation></xs:element>
<xs:element name="funding-contributors"><xs:annotation><xs:documentation>Container for the contributors of a funding.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" ref="orcid:funding-contributor"/></xs:sequence></xs:complexType></xs:element>
Element orcid:funding-contributor
Namespace
http://www.orcid.org/ns/orcid
Annotations
A collaborator or other contributor to a work or other orcid-activity
<xs:element name="funding-contributor"><xs:annotation><xs:documentation>A collaborator or other contributor to a work or other orcid-activity</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:contributor-orcid" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:credit-name" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:contributor-email" minOccurs="0" maxOccurs="1"/><xs:element ref="orcid:funding-contributor-attributes" minOccurs="0" maxOccurs="1"/></xs:sequence></xs:complexType></xs:element>
Element orcid:funding-contributor-attributes
Namespace
http://www.orcid.org/ns/orcid
Annotations
Provides detail of the nature of the contribution by the collaborator or other contirbutor.
<xs:element name="funding-contributor-attributes"><xs:annotation><xs:documentation>Provides detail of the nature of the contribution by the collaborator or other contirbutor.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:funding-contributor-role" minOccurs="0"/></xs:sequence></xs:complexType></xs:element>
Element orcid:funding-contributor-role
Namespace
http://www.orcid.org/ns/orcid
Annotations
The role performed by the collaborator or other contributor.
<xs:element name="funding-contributor-role"><xs:annotation><xs:documentation>The role performed by the collaborator or other contributor.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="lead"/><xs:enumeration value="co-lead"/><xs:enumeration value="supported-by"/><xs:enumeration value="other-contribution"/></xs:restriction></xs:simpleType></xs:element>
Element orcid:orcid-internal
Namespace
http://www.orcid.org/ns/orcid
Annotations
(FOR INTERNAL USE ONLY) Container for data that are strictly for internaluse only.
<xs:element name="orcid-internal"><xs:annotation><xs:documentation>(FOR INTERNAL USE ONLY) Container for data that are strictly for internal use only.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element minOccurs="0" ref="orcid:security-details"/><xs:element minOccurs="0" ref="orcid:preferences"/><xs:element minOccurs="0" name="group-orcid-identifier" type="orcid:orcid-id"><xs:annotation><xs:documentation>(FOR INTERNAL USE ONLY) Group ID for API clients.</xs:documentation></xs:annotation></xs:element><xs:element name="referred-by" type="xs:string" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>(FOR INTERNAL USE ONLY) User registration is know to be driven by Member</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" ref="orcid:salesforce-id"/></xs:sequence><xs:attributeGroup ref="orcid:scope"/><xs:attributeGroup ref="orcid:visibility"/></xs:complexType></xs:element>
<xs:element name="preferences"><xs:annotation><xs:documentation>(FOR INTERNAL USE ONLY) Preferences set by the researcher or contributor.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:send-email-frequency-days"/><xs:element ref="orcid:send-change-notifications"/><xs:element ref="orcid:send-orcid-news"/><xs:element ref="orcid:send-member-update-requests"/><xs:element ref="orcid:activities-visibility-default"/><xs:element ref="orcid:developer-tools-enabled" minOccurs="0"/></xs:sequence></xs:complexType></xs:element>
<xs:element minOccurs="0" name="group-orcid-identifier" type="orcid:orcid-id"><xs:annotation><xs:documentation>(FOR INTERNAL USE ONLY) Group ID for API clients.</xs:documentation></xs:annotation></xs:element>
(FOR INTERNAL USE ONLY) User registration is know to be driven by Member
Diagram
Type
xs:string
Properties
content
simple
minOccurs
0
maxOccurs
1
Source
<xs:element name="referred-by" type="xs:string" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>(FOR INTERNAL USE ONLY) User registration is know to be driven by Member</xs:documentation></xs:annotation></xs:element>
Element orcid:salesforce-id
Namespace
http://www.orcid.org/ns/orcid
Annotations
(FOR INTERNAL USE ONLY) An ID that identifies a profile in Salesforce.
<xs:element name="salesforce-id" type="orcid:salesforce-id"><xs:annotation><xs:documentation>(FOR INTERNAL USE ONLY) An ID that identifies a profile in Salesforce.</xs:documentation></xs:annotation></xs:element>
Element orcid:orcid-search-results
Namespace
http://www.orcid.org/ns/orcid
Annotations
The container element for the results when performing a search on the ORCID Registry. the num-found attribute indicates the number of successful matches.
<xs:element name="orcid-search-results"><xs:annotation><xs:documentation>The container element for the results when performing a search on the ORCID Registry. the num-found attribute indicates the number of successful matches.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:orcid-search-result" minOccurs="0" maxOccurs="unbounded"/></xs:sequence><xs:attribute name="num-found" type="xs:integer" default="0"/></xs:complexType></xs:element>
Element orcid:orcid-search-result
Namespace
http://www.orcid.org/ns/orcid
Annotations
A single result when performing a search on the ORCID Registry.
<xs:element name="orcid-search-result"><xs:annotation><xs:documentation>A single result when performing a search on the ORCID Registry.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="orcid:relevancy-score" maxOccurs="1"/><xs:element ref="orcid:orcid-profile" maxOccurs="1"/></xs:sequence></xs:complexType></xs:element>
Element orcid:relevancy-score
Namespace
http://www.orcid.org/ns/orcid
Annotations
Search relevancy score based on ORCID's search scoring model.
<xs:element name="error-desc"><xs:annotation><xs:documentation>A human readable error message included when the request was unsuccessful.</xs:documentation></xs:annotation><xs:complexType mixed="true"/></xs:element>
Element orcid:source-reference
Namespace
http://www.orcid.org/ns/orcid
Annotations
(UNUSED) The identifier or other reference information for the researcher or contributor in the source client application (Member Organization's) system.
Diagram
Properties
content
complex
mixed
true
Model
Source
<xs:element name="source-reference"><xs:annotation><xs:documentation>(UNUSED) The identifier or other reference information for the researcher or contributor in the source client application (Member Organization's) system.</xs:documentation></xs:annotation><xs:complexType mixed="true"/></xs:element>
<xs:element name="work-source" type="orcid:orcid-id"><xs:annotation><xs:documentation>Container for the source of a work.</xs:documentation></xs:annotation></xs:element>
<xs:element name="path" type="orcid:orcid-path"><xs:annotation><xs:documentation>(UNUSED) Replaced by either client-path or orcid-path</xs:documentation></xs:annotation></xs:element>
Complex Type orcid:orcid-id
Namespace
http://www.orcid.org/ns/orcid
Annotations
The identifier of the researcher or contributor inORCID (the ORCID iD). At least one of uri or path must be given. NOTE: this type is also used for legacy client IDs.
<xs:complexType name="orcid-id"><xs:annotation><xs:documentation>The identifier of the researcher or contributor in ORCID (the ORCID iD). At least one of uri or path must be given. NOTE: this type is also used for legacy client IDs.</xs:documentation></xs:annotation><xs:sequence><xs:choice><xs:sequence><xs:element name="uri" type="orcid:orcid-uri"><xs:annotation><xs:documentation>ORCID iD in URI form (preferred).</xs:documentation></xs:annotation></xs:element><xs:element name="path" type="orcid:orcid-path" minOccurs="0"><xs:annotation><xs:documentation>ORCID path (16-character identifier) of the ORCID iD.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:element name="path" type="orcid:orcid-path"><xs:annotation><xs:documentation>ORCID path (16-character identifier) of the ORCID iD.</xs:documentation></xs:annotation></xs:element></xs:choice><xs:element ref="orcid:host" minOccurs="0"/></xs:sequence></xs:complexType>
<xs:simpleType name="orcid-uri"><xs:annotation><xs:documentation>ORCID URI for the ORCID iD.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="http://([^/]*orcid\.org|localhost.*/orcid-web)/(\d{4}-){3,}\d{3}[\dX]"/></xs:restriction></xs:simpleType>
<xs:simpleType name="orcid-path"><xs:annotation><xs:documentation>Path for the ORCID iD.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="(\d{4}-){3,}\d{3}[\dX]"/></xs:restriction></xs:simpleType>
Simple Type orcid:creation-method
Namespace
http://www.orcid.org/ns/orcid
Annotations
Indicates how the ORCID record and iD were created.
<xs:simpleType name="creation-method"><xs:annotation><xs:documentation>Indicates how the ORCID record and iD were created.</xs:documentation></xs:annotation><xs:restriction base="orcid:non-empty-string"><xs:enumeration value="API"><xs:annotation><xs:documentation>The ORCID Record was created using the ORCID Member API.</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="Direct"><xs:annotation><xs:documentation>The user registered on the /register page.</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="Member-referred"><xs:annotation><xs:documentation>The registered on the /oauth/signin.</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="website"><xs:annotation><xs:documentation>DEPRECATED use Direct or Member-referred instead. The method used to create the ORCID Record (Website or API).</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
Simple Type orcid:non-empty-string
Namespace
http://www.orcid.org/ns/orcid
Annotations
Must contain one or more charaters that are not aspace, carriage return or linefeed
<xs:simpleType name="non-empty-string"><xs:annotation><xs:documentation>Must contain one or more charaters that are not a space, carriage return or linefeed</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="[\s\S]*[^\s\n\r]+[\s\S]*"/></xs:restriction></xs:simpleType>
Complex Type orcid:client-id
Namespace
http://www.orcid.org/ns/orcid
Annotations
The identifier of an ORCID API client app. At least one of uri or path must be given. NOTE: legacy API clients still may be identified by the orcid-id type.
<xs:complexType name="client-id"><xs:annotation><xs:documentation>The identifier of an ORCID API client app. At least one of uri or path must be given. NOTE: legacy API clients still may be identified by the orcid-id type.</xs:documentation></xs:annotation><xs:sequence><xs:choice><xs:sequence><xs:element name="uri" type="orcid:client-uri"/><xs:element name="path" type="orcid:client-path" minOccurs="0"/></xs:sequence><xs:element name="path" type="orcid:client-path"/></xs:choice><xs:element ref="orcid:host" minOccurs="0"/></xs:sequence></xs:complexType>
<xs:simpleType name="client-uri"><xs:annotation><xs:documentation>ORCID URI for the API client ID.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="http://([^/]*orcid\.org|localhost.*/orcid-web)/client/APP-[\da-zA-Z]{16}"/></xs:restriction></xs:simpleType>
<xs:simpleType name="client-path"><xs:annotation><xs:documentation>Path for the API client ID.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="APP-[\da-zA-Z]{16}"/></xs:restriction></xs:simpleType>
Simple Type orcid:visibility
Namespace
http://www.orcid.org/ns/orcid
Annotations
Indicates who can see the value of the element when reading the ORCID record. See the enumerations for definitions of each value, private, limited, public, registered-only.
Diagram
Type
restriction of xs:string
Facets
enumeration
private
The data can only be seen by the researcher or contributor. This data may be used internally by ORCID for Record disambiguation purposes.
enumeration
limited
The data can only be seen by trusted parties (organizations or people) as indicated by the researcher or contributor. This information is only shared with systems that the researcher or contributor has specifically granted authorization (using OAuth).
enumeration
public
The data can be seen by anyone. It is publically available via the ORCID Registry website and the public API without further authroization by the researcher or contributor.
<xs:simpleType name="visibility"><xs:annotation><xs:documentation>Indicates who can see the value of the element when reading the ORCID record. See the enumerations for definitions of each value, private, limited, public, registered-only.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:enumeration value="private"><xs:annotation><xs:documentation>The data can only be seen by the researcher or contributor. This data may be used internally by ORCID for Record disambiguation purposes.</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="limited"><xs:annotation><xs:documentation>The data can only be seen by trusted parties (organizations or people) as indicated by the researcher or contributor. This information is only shared with systems that the researcher or contributor has specifically granted authorization (using OAuth).</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="public"><xs:annotation><xs:documentation>The data can be seen by anyone. It is publically available via the ORCID Registry website and the public API without further authroization by the researcher or contributor.</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="registered-only"><xs:annotation><xs:documentation>The data is shared only with the registered user.</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
Simple Type orcid:bio-text
Namespace
http://www.orcid.org/ns/orcid
Annotations
Bio text is a string of max length: 5000 characters.
<xs:simpleType name="bio-text"><xs:annotation><xs:documentation>Bio text is a string of max length: 5000 characters.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:maxLength value="5000"/></xs:restriction></xs:simpleType>
<xs:simpleType name="email"><xs:annotation><xs:documentation>Type to represent an email address.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="[^@]+@[^\.]+\..+"/></xs:restriction></xs:simpleType>
<xs:simpleType name="iso-3166-country-or-empty"><xs:annotation><xs:documentation>Contains either a country code or an empty value</xs:documentation></xs:annotation><xs:union memberTypes="orcid:iso-3166-country orcid:empty"/></xs:simpleType>
Simple Type orcid:scope-path-type
Namespace
http://www.orcid.org/ns/orcid
Annotations
See the ORCID Knowledgebase for a complete description of ORCID Scopes and related documentation: http://support.orcid.org/knowledgebase/articles/120162-orcid-scopes.
<xs:simpleType name="scope"><xs:annotation><xs:documentation>Indicates the special privledges that the API client has for this item. i.e., can it read limited data or update the value.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:enumeration value="read-limited"/><xs:enumeration value="update"/></xs:restriction></xs:simpleType>
Simple Type orcid:affiliation-type
Namespace
http://www.orcid.org/ns/orcid
Annotations
The type of the affiliation. Presently only "education" and "employment" are used. "distinction", "funding", and "contribution" are all for FUTURE use and will not be show to the researcher in the web interface.
<xs:simpleType name="affiliation-type"><xs:annotation><xs:documentation>The type of the affiliation. Presently only "education" and "employment" are used. "distinction", "funding", and "contribution" are all for FUTURE use and will not be show to the researcher in the web interface.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:enumeration value="education"/><xs:enumeration value="employment"/></xs:restriction></xs:simpleType>
<xs:complexType name="fuzzy-date"><xs:annotation><xs:documentation>In some places the full date is not required.</xs:documentation></xs:annotation><xs:sequence><xs:element ref="orcid:year"/><xs:sequence minOccurs="0"><xs:element ref="orcid:month"/><xs:element ref="orcid:day" minOccurs="0"/></xs:sequence></xs:sequence></xs:complexType>
<xs:simpleType name="year"><xs:annotation><xs:documentation>4-character string representing a year of a date.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="\d{4}"/></xs:restriction></xs:simpleType>
Simple Type orcid:month
Namespace
http://www.orcid.org/ns/orcid
Annotations
2-character string representing a month of a date.
<xs:simpleType name="month"><xs:annotation><xs:documentation>2-character string representing a month of a date.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="\d{2}"/></xs:restriction></xs:simpleType>
<xs:simpleType name="day"><xs:annotation><xs:documentation>2-character string representing a day of a date.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="\d{2}"/></xs:restriction></xs:simpleType>
<xs:complexType name="organization-address"><xs:annotation><xs:documentation>Container for organization location information</xs:documentation></xs:annotation><xs:sequence><xs:element minOccurs="1" name="city" type="orcid:non-empty-string"><xs:annotation><xs:documentation>City</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" name="region" type="orcid:non-empty-string"><xs:annotation><xs:documentation>Region within a country</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="1" name="country" type="orcid:iso-3166-country"/></xs:sequence></xs:complexType>
Simple Type orcid:iso-3166-country
Namespace
http://www.orcid.org/ns/orcid
Annotations
ISO 3166 country codes. NOTE: the values displayed to the website user are localized (translated) in the ORCID Registry web interface. For reference: https://github.com/ORCID/ORCID-Source/tree/master/orcid-core/src/main/resources/i18n
A reference to a disambiguated version the organization to which the researcher or contributor is affiliated. The list of disambiguated organizations come from ORCID partners such as Ringgold, ISNI and FundRef.
<xs:complexType name="disambiguated-organization"><xs:annotation><xs:documentation>A reference to a disambiguated version the organization to which the researcher or contributor is affiliated. The list of disambiguated organizations come from ORCID partners such as Ringgold, ISNI and FundRef.</xs:documentation></xs:annotation><xs:sequence><xs:element ref="orcid:disambiguated-organization-identifier"/><xs:element ref="orcid:disambiguation-source"/></xs:sequence></xs:complexType>
Simple Type orcid:short-text
Namespace
http://www.orcid.org/ns/orcid
Annotations
A non-empty string that has a maximum size of 2084 characters
<xs:simpleType name="short-text"><xs:annotation><xs:documentation>A non-empty string that has a maximum size of 2084 characters</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:maxLength value="500"/></xs:restriction></xs:simpleType>
Complex Type orcid:stringWithLangCode
Namespace
http://www.orcid.org/ns/orcid
Annotations
A non-empty string that includes a language code to indicate the language used for the string's value.
<xs:complexType name="stringWithLangCode"><xs:annotation><xs:documentation>A non-empty string that includes a language code to indicate the language used for the string's value.</xs:documentation></xs:annotation><xs:simpleContent><xs:extension base="orcid:non-empty-string"><xs:attribute name="language-code" type="orcid:language-code" use="required"/></xs:extension></xs:simpleContent></xs:complexType>
Simple Type orcid:language-code
Namespace
http://www.orcid.org/ns/orcid
Annotations
Two letter language code to identify the language used in work fields. Chinese is expressed in more than two letters, with a modifier to indicate simplified (zh_CN) or traditional (zh_TW) Chinese.
Container for a work citation. Citations may be fielded (e.g., RIS, BibTeX - preferred citation type), or may be textual (APA, MLA, Chicago, etc.) The required work-citation-type element indicates the format of the citation.
<xs:complexType name="citation"><xs:annotation><xs:documentation>Container for a work citation. Citations may be fielded (e.g., RIS, BibTeX - preferred citation type), or may be textual (APA, MLA, Chicago, etc.) The required work-citation-type element indicates the format of the citation.</xs:documentation></xs:annotation><xs:sequence><xs:element name="work-citation-type" default="formatted-unspecified" type="orcid:citation-type" maxOccurs="1" minOccurs="1"/><xs:element name="citation" type="xs:string" maxOccurs="1" minOccurs="1"/></xs:sequence></xs:complexType>
Simple Type orcid:citation-type
Namespace
http://www.orcid.org/ns/orcid
Annotations
(REQUIRED) The type (format) of the citation. BibTeX format is recommended. NOTE: the values displayed to the website user are localized (translated) in the ORCID Registry web interface. For reference: https://github.com/ORCID/ORCID-Source/tree/master/orcid-core/src/main/resources/i18n
<xs:simpleType name="citation-type"><xs:annotation><xs:documentation>(REQUIRED) The type (format) of the citation. BibTeX format is recommended. NOTE: the values displayed to the website user are localized (translated) in the ORCID Registry web interface. For reference: https://github.com/ORCID/ORCID-Source/tree/master/orcid-core/src/main/resources/i18n</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:enumeration value="formatted-unspecified"/><xs:enumeration value="bibtex"/><xs:enumeration value="ris"/><xs:enumeration value="formatted-apa"/><xs:enumeration value="formatted-harvard"/><xs:enumeration value="formatted-ieee"/><xs:enumeration value="formatted-mla"/><xs:enumeration value="formatted-vancouver"/><xs:enumeration value="formatted-chicago"/></xs:restriction></xs:simpleType>
Simple Type orcid:media-type
Namespace
http://www.orcid.org/ns/orcid
Annotations
Used with the publication date to indicate which version of the publication the date refers to.
<xs:simpleType name="media-type"><xs:annotation><xs:documentation>Used with the publication date to indicate which version of the publication the date refers to.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:enumeration value="print"/><xs:enumeration value="online"/><xs:enumeration value="other"/></xs:restriction></xs:simpleType>
Simple Type orcid:string255
Namespace
http://www.orcid.org/ns/orcid
Annotations
A non-empty string that has a maximum size of 255 characters
<xs:simpleType name="string255"><xs:annotation><xs:documentation>A non-empty string that has a maximum size of 255 characters</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:maxLength value="255"/></xs:restriction></xs:simpleType>
Simple Type orcid:string1000
Namespace
http://www.orcid.org/ns/orcid
Annotations
A non-empty string that has a maximum size of 1000 characters
<xs:simpleType name="string1000"><xs:annotation><xs:documentation>A non-empty string that has a maximum size of 1000 characters</xs:documentation></xs:annotation><xs:restriction base="orcid:non-empty-string"><xs:maxLength value="1000"/></xs:restriction></xs:simpleType>
Simple Type orcid:currency-code
Namespace
http://www.orcid.org/ns/orcid
Annotations
The currency code used for funding amounts. From the ISO 4217 list (www.iso.org/iso/home/standards/currency_codes.htm).
<xs:simpleType name="string2084"><xs:annotation><xs:documentation>A non-empty string that has a maximum size of 2084 characters</xs:documentation></xs:annotation><xs:restriction base="orcid:non-empty-string"><xs:maxLength value="2084"/></xs:restriction></xs:simpleType>
<xs:simpleType name="orcid-type"><xs:annotation><xs:documentation>Indicates the ORCID record type for the ORCID iD referenced. NOTE: orcid-types of API client are only used for legacy API clients.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:enumeration value="admin"/><xs:enumeration value="user"/><xs:enumeration value="group"/><xs:enumeration value="client"/></xs:restriction></xs:simpleType>
Simple Type orcid:client-type
Namespace
http://www.orcid.org/ns/orcid
Annotations
Indicates the client type for the API client based on the ORCID membership type.
<xs:simpleType name="client-type"><xs:annotation><xs:documentation>Indicates the client type for the API client based on the ORCID membership type.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:enumeration value="creator"/><xs:enumeration value="premium-creator"/><xs:enumeration value="updater"/><xs:enumeration value="premium-updater"/></xs:restriction></xs:simpleType>
Simple Type orcid:group-type
Namespace
http://www.orcid.org/ns/orcid
Annotations
Indicates the group type for the API client based on the ORCID membership type.
<xs:simpleType name="group-type"><xs:annotation><xs:documentation>Indicates the group type for the API client based on the ORCID membership type.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:enumeration value="basic"/><xs:enumeration value="premium"/><xs:enumeration value="basic-institution"/><xs:enumeration value="premium-institution"/></xs:restriction></xs:simpleType>
The data can only be seen by the researcher or contributor. This data may be used internally by ORCID for Record disambiguation purposes.
enumeration
limited
The data can only be seen by trusted parties (organizations or people) as indicated by the researcher or contributor. This information is only shared with systems that the researcher or contributor has specifically granted authorization (using OAuth).
enumeration
public
The data can be seen by anyone. It is publically available via the ORCID Registry website and the public API without further authroization by the researcher or contributor.
Indicates (by a TRUE value) the address that the ORCID Registry will used to contact the researcher or contributor (based on user contact preferences). The primary attribute is assigned as TRUE to exactly one email address.
<xs:attribute name="primary" type="xs:boolean" default="true"><xs:annotation><xs:documentation>Indicates (by a TRUE value) the address that the ORCID Registry will used to contact the researcher or contributor (based on user contact preferences). The primary attribute is assigned as TRUE to exactly one email address.</xs:documentation></xs:annotation></xs:attribute>
Indicates if the address is a current one for the user. The current attribute is assigned as TRUE to any email address currently used. Former addresses also may be associated with ORCID records, and should include a current attribute of FALSE.
<xs:attribute name="current" type="xs:boolean" default="true"><xs:annotation><xs:documentation>Indicates if the address is a current one for the user. The current attribute is assigned as TRUE to any email address currently used. Former addresses also may be associated with ORCID records, and should include a current attribute of FALSE.</xs:documentation></xs:annotation></xs:attribute>
Indicates (with a TRUE value) if the researcher or contributor verified the email address by clicking on a link sent to the address. This field can not be set when adding an email address to an ORCID record.
<xs:attribute name="verified" type="xs:boolean" default="false"><xs:annotation><xs:documentation>Indicates (with a TRUE value) if the researcher or contributor verified the email address by clicking on a link sent to the address. This field can not be set when adding an email address to an ORCID record.</xs:documentation></xs:annotation></xs:attribute>
The ORCID identifier for the individual user (or legacy client application) that created the item. Either a source or source-client-id will be present. NOTE: value will be replaced by source element in future XSD versions.
<xs:attribute name="source" type="orcid:orcid-path"><xs:annotation><xs:documentation>The ORCID identifier for the individual user (or legacy client application) that created the item. Either a source or source-client-id will be present. NOTE: value will be replaced by source element in future XSD versions.</xs:documentation></xs:annotation></xs:attribute>
The client ID for the client application (Member organization system) that created the item. Either a source or source-client-id will be present. NOTE: value will be replaced by source element in future XSD versions.
<xs:attribute name="source-client-id" type="orcid:client-path"><xs:annotation><xs:documentation>The client ID for the client application (Member organization system) that created the item. Either a source or source-client-id will be present. NOTE: value will be replaced by source element in future XSD versions.</xs:documentation></xs:annotation></xs:attribute>
The visiblity that the researcher or contributor has assigned to this section of data. Visiblity can also be set during record creation by the institution. The visibility attribute (private, limited or public) indicates who can see a section of information. See ORCID's privacy policy for more details: http://orcid.org/privacy-policy.
<xs:attributeGroup name="visibility"><xs:annotation><xs:documentation>The visiblity that the researcher or contributor has assigned to this section of data. Visiblity can also be set during record creation by the institution. The visibility attribute (private, limited or public) indicates who can see a section of information. See ORCID's privacy policy for more details: http://orcid.org/privacy-policy.</xs:documentation></xs:annotation><xs:attribute name="visibility" use="optional" type="orcid:visibility"/></xs:attributeGroup>
Attribute Group orcid:scope
Namespace
http://www.orcid.org/ns/orcid
Annotations
The authorization scope that the API client has on this section of data.
<xs:attributeGroup name="scope"><xs:annotation><xs:documentation>The authorization scope that the API client has on this section of data.</xs:documentation></xs:annotation><xs:attribute name="scope" use="optional" type="orcid:scope"></xs:attribute></xs:attributeGroup>
Attribute Group orcid:put-code
Namespace
http://www.orcid.org/ns/orcid
Annotations
The put-code attribute is present only when reading elements. The code must be used when PUTing (updating) items that contain the attribute (works, affiliations, etc) to ensure that the existing item's history is retained.
<xs:attributeGroup name="put-code"><xs:annotation><xs:documentation>The put-code attribute is present only when reading elements. The code must be used when PUTing (updating) items that contain the attribute (works, affiliations, etc) to ensure that the existing item's history is retained.</xs:documentation></xs:annotation><xs:attribute name="put-code" use="optional" type="xs:integer"></xs:attribute></xs:attributeGroup>