API Docs

NAVIGATE CONTENT
Ex Libris Developer Network Alma Documentation REST APIs API Docs

Rest Researcher

Overview

This XSD describes the researcher object that as part of the user object that is used in SIS load. For Esploro use only.

Data Dictionary

Click here to download rest_researcher.xsd

researcher

Description: Researcher information.

FieldTypeDescription
researcher_first_namestring255LengthThe researcher's first name.
researcher_middle_namestring255LengthThe researcher's middle name.
researcher_last_namestring255LengthThe researcher's last name.
researcher_suffixstring255LengthThe researcher's suffix.
researcher_title with attr. The researcher's title.

The valid values for this parameter are controlled by the code-table: UserTitles. These are the currently defined values for your institution:
CodeDescription
profile_image_urlstringURL of Researcher's profile image.
photo_urlstringPhoto URL. Optional in User API and in SIS load.
profile_identifier_urlstringResearcher Profile URL
display_titlestring255LengthThe researcher's display title.
position with attr. Researcher's position (code). Possible codes are listed in 'OrganizationPositions' code table. Optional in User API and in SIS load.
The valid values for this parameter are controlled by the code-table: OrganizationPositions. These are the currently defined values for your institution:
CodeDescription
portal_profile with attr. This flag controls whether the researcher’s profile is included in the Research Portal. Possible codes are listed in 'Esploro Portal Field' code table. Default: Yes.
The valid values for this parameter are controlled by the code-table: EsploroPortalField. These are the currently defined values for your institution:
CodeDescription
auto_capturestring20LengthThis flag controls whether the researcher name is included in automatic capture. Default: Yes.
update_ORCID_profilebooleanThis flag controls if the researcher's ORCID profile is updated
Default: Yes.
research_centerstring20LengthThis flag controls access to the Researcher Center. Default: Yes.
previous_affiliatedbooleanThis flag controls if the non-affiliated researcher was affiliated. Possible values: true/false. Default: false.
default_publication_language with attr. The researcher's default publication language. Possible codes are listed in 'User Preferred Language' code table. Default: en. On SIS synch this field will not be replaced if it was updated manually.
The valid values for this parameter are controlled by the code-table: UserPreferredLanguage. These are the currently defined values for your institution:
CodeDescription
researcher_alternate_emailsresearcher_alternate_emailsThe researcher's alternate emails.
researcher_organization_affiliationsresearcher_organization_affiliationsThe researcher's current organization affiliations.
researcher_previous_organization_affiliationsresearcher_previous_organization_affiliationsThe researcher's previous organization affiliations.
researcher_external_organization_affiliationsresearcher_external_organization_affiliationsThe researcher's current external organization affiliations.
researcher_previous_external_organization_affiliationsresearcher_previous_external_organization_affiliationsThe researcher's previous external organization affiliations.
researcher_name_variantsresearcher_name_variantsThe researcher's name variants.
researcher_engagement_typesresearcher_engagement_typesThe researcher's engagement types. Maximum 5 researcher engagement types allowed.
researcher_research_topicsresearcher_research_topicsThe researcher's research topics.
researcher_keywordsresearcher_keywordsThe researcher's keywords.
researcher_associationsresearcher_associationsThe researcher's associations.
researcher_languagesresearcher_languagesThe researcher's languages.
researcher_honorsresearcher_honorsThe researcher's honors.
researcher_educationsresearcher_educationsThe researcher's educations.
researcher_descriptionsresearcher_descriptionsThe researcher's descriptions.
researcher_webpagesresearcher_webpagesThe researcher's webpages.
user_identifiersuser_identifiersList of the researcher's additional identifiers.
researcher_redirection_mappingstring4000LengthThe identifier for mapping the redirecation from legacy systems.

 

researcher_keywords

Description: List of researcher's keywords.

FieldTypeDescription
researcher_keywordresearcher_keywordSpecific researcher's keyword.

 

researcher_keyword

Description: Specific researcher's keyword.

FieldTypeDescription
valuestringThe keyword value. Mandatory.

 

researcher_research_topics

Description: List of researcher's research topics.

FieldTypeDescription
researcher_research_topic with attr. Specific researcher's research topic. Possible codes are listed in 'ResearchTopicsLabels' code table. Optional in User API and in SIS load.
The valid values for this parameter are controlled by the code-table: ResearchTopicsLabels. These are the currently defined values for your institution:
CodeDescription

 

researcher_associations

Description: List of researcher's associations.

FieldTypeDescription
researcher_associationresearcher_associationSpecific researcher's association.

 

researcher_association

Description: Specific researcher's association.

FieldTypeDescription
valuestringThe association value. Mandatory.

 

researcher_languages

Description: List of researcher's languages.

FieldTypeDescription
researcher_language with attr. The language value. Mandatory in User API and in SIS load. Possible codes are listed in 'ResearchLanguagesNames' code table.
The valid values for this parameter are controlled by the code-table: ResearchLanguagesNames. These are the currently defined values for your institution:
CodeDescription

 

researcher_name_variants

Description: List of researcher's name variants.

FieldTypeDescription
researcher_name_variantresearcher_name_variantSpecific researcher's name variant.

 

researcher_name_variant

Description: Specific researcher's name variant.

FieldTypeDescription
first_namestring255LengthThe researcher's first name.
middle_namestring255LengthThe researcher's middle name.
last_namestring255LengthThe researcher's last name.
name_suffixstring255LengthThe researcher's name suffix.

 

researcher_engagement_types

Description: List of researcher's engagement types. Maximum 5 researcher engagement types allowed.

FieldTypeDescription
researcher_engagement_typeresearcher_engagement_typeSpecific researcher's engagement type.

 

researcher_engagement_type

Description: Specific researcher's engagement type.

FieldTypeDescription
researcher_engagement with attr. The researcher's engagement type. Possible codes are listed in 'Researcher Engagement Types' code table. Default: en.
The valid values for this parameter are controlled by the code-table: ResearcherEngagementTypes. These are the currently defined values for your institution:
CodeDescription
engagement_end_datedateThe researcher's engagement end date.

 

researcher_alternate_emails

Description: List of researcher's alternate emails.

FieldTypeDescription
researcher_alternate_emailresearcher_alternate_emailSpecific researcher's alternate email.

 

researcher_alternate_email

Description: Specific researcher's alternate email.

FieldTypeDescription
email_addressstring255LengthThe researcher's email address. Mandatory

 

researcher_organization_affiliations

Description: List of researcher's current organization affiliations.

FieldTypeDescription
researcher_organization_affiliationresearcher_organization_affiliationSpecific researcher's current organization affiliation info.

 

researcher_previous_organization_affiliations

Description: List of researcher's previous organization affiliations.

FieldTypeDescription
researcher_previous_organization_affiliationresearcher_organization_affiliationSpecific researcher's previous organization affiliation info.

 

researcher_external_organization_affiliations

Description: List of researcher's current external organization affiliations.

FieldTypeDescription
researcher_external_organization_affiliationresearcher_organization_affiliationSpecific researcher's current external organization affiliation info.

 

researcher_previous_external_organization_affiliations

Description: List of researcher's previous external organization affiliations.

FieldTypeDescription
researcher_previous_external_organization_affiliationresearcher_organization_affiliationSpecific researcher's previous external organization affiliation info.

 

researcher_organization_affiliation

Description: Specific researcher's organization affiliation info.

FieldTypeDescription
organization_codestring255LengthThe researcher's organization affiliation code.
organization_namestring255LengthThe researcher's organization affiliation name.
start_datedateThe researcher's organization affiliation start date.
end_datedateThe researcher's organization affiliation end date.
position with attr. Researcher's position (code). Possible codes are listed in 'OrganizationPositions' code table. Optional in User API and in SIS load.
The valid values for this parameter are controlled by the code-table: OrganizationPositions. These are the currently defined values for your institution:
CodeDescription
titlestring255LengthThe researcher's full title/position.
positionOrderstring255LengthOrder of this organization affiliation.

 

researcher_honors

Description: List of researcher's honors.

FieldTypeDescription
researcher_honorresearcher_honorSpecific researcher's honor info.

 

researcher_honor

Description: Specific researcher's honor info.

FieldTypeDescription
organization_codestring255LengthThe researcher's honor organization code.
organization_namestring255LengthThe researcher's honor organization name.
titlestring255LengthThe researcher's honor title.
time_periodstring255LengthThe researcher's honor time period.

 

researcher_educations

Description: List of researcher's educations.

FieldTypeDescription
researcher_educationresearcher_educationSpecific researcher's education info.

 

researcher_education

Description: Specific researcher's education info.

FieldTypeDescription
organization_codestring255LengthThe researcher's education organization code.
organization_namestring255LengthThe researcher's education organization name.
degreestring255LengthThe researcher's education degree.
from_yearstring255LengthThe researcher's education from date - partial date in format YYYYMMDD / YYYYMM / YYYY.
to_yearstring255LengthThe researcher's education to year - partial date in format YYYYMMDD / YYYYMM / YYYY.
field_of_studystring255LengthThe researcher's education field_of_study. The default is 'Unknown'
additional_detailsstring255LengthThe researcher's education additional details.
suppress_from_public_portalbooleanThe researcher's education suppress_from_public_portal. The default is false.

 

researcher_descriptions

Description: List of researcher's descriptions.

FieldTypeDescription
researcher_descriptionresearcher_descriptionSpecific researcher's description.

 

researcher_description

Description: Specific researcher's description.

FieldTypeDescription
descriptionstringThe description value. Mandatory.

 

researcher_webpages

Description: List of researcher's webpages.

FieldTypeDescription
researcher_webpageresearcher_webpageSpecific researcher's webpage.

 

researcher_webpage

Description: Specific researcher's webpage.

FieldTypeDescription
urlstringThe webpage value. Mandatory.
titlestringThe webpage title. Optional.
descriptionstringThe webpage description. Optional.
typestringThe webpage title. Possible values: Homepage, CV, Pubpage, Unknown, Profile, Lab.

 

Samples

XML
JSON
__