Centre for Media Research




About

Dr Niamh Thornton has lectured on Spanish Language, Latin American Culture and Film studies at the University of Ulster since 2004. She is currently head of Film Studies and coordinator of Spanish at Coleraine. Before joining the University of Ulster, she previously worked as a lecturer in Spanish at Waterford Institute of Technology (1999-2002, 2003-2004), Dublin City University (2002-2003) and University of Dublin, Trinity College (2003-2004). While at Waterford, she co-founded, and continues to be an editor of the journal Film and Film Culture.

Research Fields

Her primary area of research is contemporary Latin American and Mexican narrative and film, and is currently preparing a monograph on the representation of violence and conflict in Mexican film.

Professional Affiliations

She is the president of Women in Spanish, Portuguese and Latin American Studies (http://www.wisps.org.uk/) and member of the Association of Hispanists of Great Britain and Ireland.

Contact Details

Office
+44 (0)28

Books Authored





Web Services: EPrints (UIR)



How to use this web service

general

The UIR web service is called via a URL whose structure is explained below:

always required varies according to requirements
service address controller name controller action parameter key parameter value
https://webservices.ulster.ac.uk/uir /publications /get /email /an.academic@ulster.ac.uk
  /types      
  /itemids      
service address This is always the same, and must be used, for all calls to the UIR web service.
controller name
publications provides a list of publications depending on the combination of parameters (key/value pairs) specified
types

provides a list of item types used by an author
itemids

provides a list of item ids used by an author (can be filtered by type)

Features added in the future will be listed here and
in the UIR Developer Guide (login required).

controller action The types, publications and itemids controllers currently implement a get action.
parameter key Several parameters can be passed to a controller in order to specify the data required.
Email is one of the mandatory parameters.

See below for more information about parameter keys and valid values.
parameter value Each parameter key must have a corresponding value. For the key email,
the corresponding value must be an Ulster email in the format specified.

See below for more information about parameter keys and valid values.

Multiple parameter key/value pairs can be passed to the controller by
appending them as required to the URL, in any order.

There are five types of parameter which can be used to specify the publications
required, how they should be rendered (and in the future, what format citations should have).
Click the headings below for an explanation and examples of each.

publications – mandatory parameters

The UIR publications controller requires at least one of the mandatory parameters below.
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/publications/get/email/an.academic@ulster.ac.uk all publications which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/publications/get/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation
/publications/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

UIR codes

The names of Research Institutes and groups can change.
Less frequently, School and Faculty names may also change.
The webservice now publishes the UIR code for each of these entities.
The codes remain constant within the UIR so there will be no need to
update code when a name changes (although there may occasionally be a
new code added, for example, when a new group is created).

Codes are listed alongside institute, group, faculty and school names in the tabs below.
Both codes and names are drawn directly from the UIR and therefore are always up-to-date.

It is strongly recommended that you use the codes
rather than the names to retrieve items from the UIR.

Please note

The word mandatory is not a parameter key.
Use one of the following key words to specify a mandatory parameter.
Click on each key word to display its list of valid values.

Values

a valid Ulster staff member’s email

Tips

If you don’t get any results back for an email, and you are certain that
you are using a valid email, check for that person in the
Browse | Ulster Authors and Editors
section of the repository. If they are not listed there, they do not have any items live in the
repository.

Values

ri_ad Art_and_Design_Research_Institute
ri_hu Arts_and_Humanities_Research_Institute
ri_biomed Biomedical_Sciences_Research_Institute
ri_bue Built_Environment_Research_Institute
ri_bsm Business_and_Management_Research_Institute
ri_ms Centre_for_Media_Research
ri_cs Computer_Science_Research_Institute
ri_namr Engineering_Research_Institute
ri_es Environmental_Sciences_Research_Institute
ri_hrsri Health_and_Rehabilitation_Sciences_Research_Institute
ri_spri Institute_for_Research_in_Social_Sciences
ri_nur Institute_of_Nursing_and_Health_Research
ri_c Irish_and_Celtic_Studies_Research_Institute
ri_p Psychology_Research_Institute
ri_sprt Sport_and_Exercise_Sciences_Research_Institute
ri_tji Transitional_Justice_Institute

Examples

/publications/get/institute/Institute_of_Nursing_Research

/publications/get/institute/Sport_and_Exercise_Science_Research_Institute

/publications/get/institute/ri_sprt

Values

rig_hrsri_spic Activity_and_Enablement_(AE)
rig_namr_amfr Advanced_Metal_Forming
rig_ad_ac Art_and_Context
rig_ad_fa Art,_Conflict_and_Society
rig_cs_ai Artificial_Intelligence_and_Applications
rig_p_bn Behavioural_Neuroscience_and_Behaviour_Analysis
rig_nur_hrsrc Centre_for_Health_and_Rehabilitation_Technologies
rig_nur_ddch Centre_for_Intellectual_and_Developmental_Disabilities
rig_nur_mfiw Centre_for_Maternal,_Fetal_and_Infant_Research
rig_sprt_ph Centre_for_Physical_Activity_and_Health
rig_bue_crpp Centre_for_Research_on_Property_and_Planning_(RPP)
rig_sprt_sp Centre_for_Sport_in_Society
rig_sprt_sps Centre_for_Sports_Science_and_Sports_Medicine
rig_bue_cst Centre_for_Sustainable_Technologies_(CST)
rig_es_cm Coastal_Systems
rig_spri_c Communication
rig_hu_ca Creative_Arts_and_Technologies
rig_ad_aa Creative_Ecologies
rig_biomed_d Diabetes
rig_hrsri_diii Diabetic_Foot_-_Infection_-_Imaging_-_Intervention_(D3i)
rig_spri_ed Education
rig_nur_nepr Education_and_Professional_Issues_Research_Group
rig_namr_ecrc Engineering_Composites
rig_hu_en English
rig_bue_fsertc Fire_Safety_and_Engineering_Research_and_Technology_Centre_(FireSERT)
rig_es_f Freshwater_Sciences
rig_ad_d Future_and_Virtual_Worlds
rig_biomed_mo Genomic_Medicine
rig_es_g Geophysics
rig_nur_hpah Health_Promotion_and_Adolescent_Health
rig_p_hp Health,_Education_and_Well-being
rig_hu_h History
rig_bue_hsef Hydrogen_Safety_Engineering_and_Research_Centre_(HySAFER)
rig_biomed_ii Infection_and_Immunity/Microbiology
rig_cs_ise Information_and_Communication_Engineering
rig_cs_isrc Intelligent_Systems_Research_Centre
rig_spri_l Linguistics
rig_nur_mci Managing_Chronic_Illness_Research_Centre
rig_hrsri_mci Managing_Chronic_Illness_through_’Assisted_Living’
rig_es_ma Maritime_Archaeology
rig_hrsri_dm Medical_Imaging
rig_nur_mh Mental_Health
rig_hu_eu Modern_Languages
rig_hrsri_md Musculoskeletal_Disorder_(MSKD)_Rehabilitation
rigsg_mo_na Nano_Systems_Biology
rig_namr_nibec Nanotechnology_&_Integrated_BioEngineering_Centre_(NIBEC)
rig_hrsri_nr Neurorehabilitation_for_Health_(NRH)
rigsg_mo_nd Neuroscience_&_Neurodegenerative_Diseases
rig_biomed_niche Northern_Ireland_Centre_for_Food_and_Health_(NICHE)
rig_p_pc Peace,_Conflict_and_Equality
rig_nur_pcp Person-centred_Practice_Research_Centre
rig_biomed_psp Pharmaceutical_Science_and_Practice
rig_spri_p Politics_&_International_Studies
rig_p_msm Population_Health_Sciences_and_Mental_Health_Services
rig_p_pmh Psychotraumatology,_Mental_Health_&_Suicidal_Behaviour
rig_es_qec Quaternary_Environmental_Change
rig_hrsri_rcp Rehabilitation_in_Cancer_Patients
rig_hrsri_rrs Rehabilitation_in_Rheumatic_Sciences
rig_hrsri_rh Respiratory_Health
rig_cs_se Smart_Environments
rig_spri_sw Social_Work_&_Social_Policy
rig_es_s Society_and_Environment
rig_ad_sp Space_and_Place
rig_biomed_sm Stratified_Medicine
rig_bue_saber Studies_Allied_to_Built_Environment_Research_(SABER)
rig_es_t Terrestrial_Ecology
rig_p_bc The_Bamford_Centre_for_Mental_Health_and_Wellbeing
rigsg_mo_t Transcriptional_Regulation_&_Epigenetics
rigsg_mo_v Vascular_Medicine
rig_biomed_vs Vision

Examples

/publications/get/group/Coastal_Systems

/publications/get/group/Molecular_Medicine

Tips

Specifying a group applies the filter at a lower level
than institute.
If you specify both, the controller will return items at the institute level
(which should include the group level if the affiliations were applied correctly
when the item was deposited).

Values

fac_adbe Faculty_of_Art,_Design_and_the_Built_Environment
fac_arts Faculty_of_Arts
fac_ce Faculty_of_Computing_&_Engineering
fac_lhs Faculty_of_Life_and_Health_Sciences
fac_ss Faculty_of_Social_Sciences
fac_ubs Ulster_Business_School

Examples

/publications/get/faculty/Faculty_of_Arts

/publications/get/faculty/Ulster_Business_School

Values

sch_adbe_ad Belfast_School_of_Art
sch_ubs_bi Business_Institute
sch_ubs_da Department_of_Accounting,_Finance_and_Economics
sch_ubs_dbrfs Department_of_Business_and_Enterprise
sch_ubs_dhtm Department_of_Hospitality_and_Tourism_Management
sch_ubs_dib Department_of_International_Business
sch_ubs_dm Department_of_Management_and_Leadership
sch_ubs_dmes Department_of_Marketing,_Entrepreneurship_and_Strategy
sch_ss_gsp Graduate_School_of_Professional_Legal_Education
sch_ss_inc INCORE
sch_arts_iuss Institute_of_Ulster_Scots_Studies
sch_adbe_x_rgs Research_Graduate_School
sch_arts_x_rgs Research_Graduate_School
sch_ce_x_rgs Research_Graduate_School
sch_lhs_x_rgs Research_Graduate_School
sch_ubs_x_rgs Research_Graduate_School
sch_ss_x_rgs Research_Graduate_School_(Social_Sciences)
sch_lhs_bs School_of_Biomedical_Sciences
sch_ss_c School_of_Communication
sch_ce_cie School_of_Computing_and_Information_Engineering
sch_ce_cis School_of_Computing_and_Intelligent_Systems
sch_ce_cm School_of_Computing_and_Mathematics
sch_arts_ca School_of_Creative_Arts_and_Technologies
sch_ss_ps School_of_Criminology,_Politics_and_Social_Policy
sch_ss_ed School_of_Education
sch_ce_eme School_of_Engineering
sch_arts_hia School_of_English_and_History
sch_lhs_es School_of_Geography_and_Environmental_Sciences
sch_lhs_hs School_of_Health_Sciences
sch_arts_i School_of_Irish_Language_and_Literature
sch_ss_l School_of_Law
sch_arts_mfj School_of_Media,_Film_&_Journalism
sch_arts_ll School_of_Modern_Languages
sch_lhs_n School_of_Nursing
sch_lhs_pps School_of_Pharmacy_and_Pharmaceutical_Science
sch_lhs_p School_of_Psychology
sch_ss_sass School_of_Sociology_and_Applied_Social_Studies
sch_lhs_ss School_of_Sport
sch_adbe_be School_of_the_Built_Environment
sch_adbe_arc The_Belfast_School_of_Architecture

Examples

/publications/get/school/School_of_Communication

/publications/get/school/School_of_Sports_Studies

Tips

As for institute/group combinations, specifying a school applies the filter
at a lower level than faculty, therefore you should not specify the parent faculty
if you only want the group publications.
If you specify both, the service will return items at the faculty level.

publications – type

You can specify which type(s) of items you want the web service to return, or to exclude.

Type names

artefact
article
body_of_work
book_authored
book_edited
book_section
composition
conference_item
confidential_report_external
design
device
digital_media
exhibition
installation
internet_publication
other
patent
performance
research_report_external
scholarly_edition
software
thesis

Default

If you do not use the type parameter, all item types will be returned.

Examples

/publications/get/school/School_of_Law/type/article

/publications/get/school/sch_ss_l/type/book_edited,book_section

/publications/get/school/sch_ss_l/type/-article

Tips

If you specify one item type, the service will return only items of that type.

You can specify more than one item type by separating the values with commas. The service will return items of those types.

You can exclude a particular item type by prefixing the value of the parameter with a minus-sign.

publications – render

You can specify how the data will be rendered, according to your preference
for any processing you want to do with the publications data before displaying
it on the target web page.

The json and xml rendering options return additional data that may be useful for
any custom processing you want to do. For example, the creators’ names are
returned in a separate structure in addition to as a list.

The web service has the following options for how the data will be rendered.
Please note, the examples below are for illustration only.
Additional fields may be added if required in the future.

Values

Examples

html

/publications/get/email/an.academic@ulster.ac.uk/render/html

HTML is the default option if you do not specify a render parameter.


The HTML returned will have the same format as the UIR author_by_email view.

xml

/publications/get/email/an.academic@ulster.ac.uk/type/article/render/xml

<eprints>

<eprint>

<eprintid>318</eprintid>

<type>article</type>

<creators>Smith A, Academic AN and Another S</creators>

<creators_names>

<creators_name>

<family>Smith</family>

<given>A</given>

<position>0</position>

</creators_name>

<creators_name>

<family>Academic</family>

<given>AN</given>

<position>1</position>

</creators_name>

<creators_name>

<family>Another</family>

<given>S</given>

<position>2</position>

</creators_name>

</creators_names>

<publication_date>(2009)</publication_date>

<publication_date_year>2009</publication_date_year>

<publication_date_month>3</publication_date_month>

<publication_date_day/>

<title><a target=”_blank” href=”http://eprints-dev.ulster.ac.uk/318″><em>The Development and Pilot Testing of an Instrument to Measure Nurses’ Working Environment: The Nursing Context Index</em></a></title>

<publication>WORLDVIEWS ON EVIDENCE-BASED NURSING</publication>

<volume>6</volume>

<number>3</number>

<pagerange>173-182</pagerange>

</eprint>

</eprints>

json

/publications/get/institute/Institute_of_Nursing_Research/type/article/render/json

[

{

“eprintid”:4,

“type”:”article”,

“creators”:”Switzer C and McDowell S”,

“publication_date”:”(2009)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>”,

“title”:”Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast”

“publication”:”Memory Studies”,

“volume”:”2″,

“number”:”3″,

“pagerange”:”337-353″

“citation”:”Switzer C and McDowell S (2009) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>. Memory Studies 2 (3). pp. 337-353.”

},

{

“eprintid”:48,

“type”:”article”,

“creators”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F”,

“publication_date”:”(2010)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>”,

“title”:”A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks”

“publication”:”Computers in Biology and Medicine”,

“volume”:”40″,

“number”:”3″,

“pagerange”:”306-317″

“citation”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F (2010) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>. Computers in Biology and Medicine 40 (3). pp. 306-317.”

}

]

Use the php function json_decode
if you need to turn the default json string into an array for additional processing.

publications – format

Citation format options are currently under review.
Please let us know if there is a particular format you require.
In the meantime, all publication citations will be returned
in the default format (the same format as displayed in the UIR).

Values

Default

If you do not specify the format parameter, the publication citations will be returned in
the default EPrints format.

Examples

Tips

publications – order

Fields to order on can be chained using the semicolon ; character.

Defaults

If you do not specify any order parameter, the publications will be returned
ordered by year of publication (descending), first author’s name (ascending) and
title (ascending).

If you specify an order without a flag, the default order is ascending.
Specify descending order by adding ,d after the field you want to sort on.

Values

Examples

year

/publications/get/email/an.academic@ulster.ac.uk/type/conference_item/order/year

returns all the conference contributions for an.academic@ulster.ac.uk sorted in ascending order by the
year of publication

NOTE: a list of the types for any given email can be retrieved using the types parameter
(see the types – mandatory section below for more information)

date,d

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/date,d

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by the
complete date of publication

NOTE: only the year part of the publication date is required when depositing an item in the
UIR, the month and day may not exist in the item metadata

year,d;name

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/year,d;name

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by year of
publication, and within the year, in ascending order of first author’s name

title

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/title

returns all the articles for an.academic@ulster.ac.uk sorted in ascending order of title
(useful for checking for possible duplicates)

types – mandatory parameters

The types controller will return a list of the item types for the
parameter(s) supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires at least one of the same mandatory parameters as publications (see
the publications – mandatory parameters section above).
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/types/get/email/an.academic@ulster.ac.uk all types which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/types/get/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation
/types/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

Please note

The word mandatory is not a parameter key.
See the publications – mandatory parameters section above for a
complete list of the current names for faculties, research institutes, etc.

item IDs – mandatory parameters

The itemids controller will return a list of the item IDs for the
Ulster email supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires a single mandatory parameter: a valid Ulster email.

Optionally, you can use the type parameter to get item IDs for a particular
type of item.

The same rendering options are available as for publications:
html (default), json and xml.

Examples

/itemids/get/email/an.academic@ulster.ac.uk all item IDs (and item types) which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/itemids/get/email/an.academic@ulster.ac.uk/type/article all item IDs for items of the specified type which have the email an.academic@ulster.ac.uk in the authors/creators metadata field


Books Edited





Web Services: EPrints (UIR)



How to use this web service

general

The UIR web service is called via a URL whose structure is explained below:

always required varies according to requirements
service address controller name controller action parameter key parameter value
https://webservices.ulster.ac.uk/uir /publications /get /email /an.academic@ulster.ac.uk
  /types      
  /itemids      
service address This is always the same, and must be used, for all calls to the UIR web service.
controller name
publications provides a list of publications depending on the combination of parameters (key/value pairs) specified
types

provides a list of item types used by an author
itemids

provides a list of item ids used by an author (can be filtered by type)

Features added in the future will be listed here and
in the UIR Developer Guide (login required).

controller action The types, publications and itemids controllers currently implement a get action.
parameter key Several parameters can be passed to a controller in order to specify the data required.
Email is one of the mandatory parameters.

See below for more information about parameter keys and valid values.
parameter value Each parameter key must have a corresponding value. For the key email,
the corresponding value must be an Ulster email in the format specified.

See below for more information about parameter keys and valid values.

Multiple parameter key/value pairs can be passed to the controller by
appending them as required to the URL, in any order.

There are five types of parameter which can be used to specify the publications
required, how they should be rendered (and in the future, what format citations should have).
Click the headings below for an explanation and examples of each.

publications – mandatory parameters

The UIR publications controller requires at least one of the mandatory parameters below.
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/publications/get/email/an.academic@ulster.ac.uk all publications which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/publications/get/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation
/publications/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

UIR codes

The names of Research Institutes and groups can change.
Less frequently, School and Faculty names may also change.
The webservice now publishes the UIR code for each of these entities.
The codes remain constant within the UIR so there will be no need to
update code when a name changes (although there may occasionally be a
new code added, for example, when a new group is created).

Codes are listed alongside institute, group, faculty and school names in the tabs below.
Both codes and names are drawn directly from the UIR and therefore are always up-to-date.

It is strongly recommended that you use the codes
rather than the names to retrieve items from the UIR.

Please note

The word mandatory is not a parameter key.
Use one of the following key words to specify a mandatory parameter.
Click on each key word to display its list of valid values.

Values

a valid Ulster staff member’s email

Tips

If you don’t get any results back for an email, and you are certain that
you are using a valid email, check for that person in the
Browse | Ulster Authors and Editors
section of the repository. If they are not listed there, they do not have any items live in the
repository.

Values

ri_ad Art_and_Design_Research_Institute
ri_hu Arts_and_Humanities_Research_Institute
ri_biomed Biomedical_Sciences_Research_Institute
ri_bue Built_Environment_Research_Institute
ri_bsm Business_and_Management_Research_Institute
ri_ms Centre_for_Media_Research
ri_cs Computer_Science_Research_Institute
ri_namr Engineering_Research_Institute
ri_es Environmental_Sciences_Research_Institute
ri_hrsri Health_and_Rehabilitation_Sciences_Research_Institute
ri_spri Institute_for_Research_in_Social_Sciences
ri_nur Institute_of_Nursing_and_Health_Research
ri_c Irish_and_Celtic_Studies_Research_Institute
ri_p Psychology_Research_Institute
ri_sprt Sport_and_Exercise_Sciences_Research_Institute
ri_tji Transitional_Justice_Institute

Examples

/publications/get/institute/Institute_of_Nursing_Research

/publications/get/institute/Sport_and_Exercise_Science_Research_Institute

/publications/get/institute/ri_sprt

Values

rig_hrsri_spic Activity_and_Enablement_(AE)
rig_namr_amfr Advanced_Metal_Forming
rig_ad_ac Art_and_Context
rig_ad_fa Art,_Conflict_and_Society
rig_cs_ai Artificial_Intelligence_and_Applications
rig_p_bn Behavioural_Neuroscience_and_Behaviour_Analysis
rig_nur_hrsrc Centre_for_Health_and_Rehabilitation_Technologies
rig_nur_ddch Centre_for_Intellectual_and_Developmental_Disabilities
rig_nur_mfiw Centre_for_Maternal,_Fetal_and_Infant_Research
rig_sprt_ph Centre_for_Physical_Activity_and_Health
rig_bue_crpp Centre_for_Research_on_Property_and_Planning_(RPP)
rig_sprt_sp Centre_for_Sport_in_Society
rig_sprt_sps Centre_for_Sports_Science_and_Sports_Medicine
rig_bue_cst Centre_for_Sustainable_Technologies_(CST)
rig_es_cm Coastal_Systems
rig_spri_c Communication
rig_hu_ca Creative_Arts_and_Technologies
rig_ad_aa Creative_Ecologies
rig_biomed_d Diabetes
rig_hrsri_diii Diabetic_Foot_-_Infection_-_Imaging_-_Intervention_(D3i)
rig_spri_ed Education
rig_nur_nepr Education_and_Professional_Issues_Research_Group
rig_namr_ecrc Engineering_Composites
rig_hu_en English
rig_bue_fsertc Fire_Safety_and_Engineering_Research_and_Technology_Centre_(FireSERT)
rig_es_f Freshwater_Sciences
rig_ad_d Future_and_Virtual_Worlds
rig_biomed_mo Genomic_Medicine
rig_es_g Geophysics
rig_nur_hpah Health_Promotion_and_Adolescent_Health
rig_p_hp Health,_Education_and_Well-being
rig_hu_h History
rig_bue_hsef Hydrogen_Safety_Engineering_and_Research_Centre_(HySAFER)
rig_biomed_ii Infection_and_Immunity/Microbiology
rig_cs_ise Information_and_Communication_Engineering
rig_cs_isrc Intelligent_Systems_Research_Centre
rig_spri_l Linguistics
rig_nur_mci Managing_Chronic_Illness_Research_Centre
rig_hrsri_mci Managing_Chronic_Illness_through_’Assisted_Living’
rig_es_ma Maritime_Archaeology
rig_hrsri_dm Medical_Imaging
rig_nur_mh Mental_Health
rig_hu_eu Modern_Languages
rig_hrsri_md Musculoskeletal_Disorder_(MSKD)_Rehabilitation
rigsg_mo_na Nano_Systems_Biology
rig_namr_nibec Nanotechnology_&_Integrated_BioEngineering_Centre_(NIBEC)
rig_hrsri_nr Neurorehabilitation_for_Health_(NRH)
rigsg_mo_nd Neuroscience_&_Neurodegenerative_Diseases
rig_biomed_niche Northern_Ireland_Centre_for_Food_and_Health_(NICHE)
rig_p_pc Peace,_Conflict_and_Equality
rig_nur_pcp Person-centred_Practice_Research_Centre
rig_biomed_psp Pharmaceutical_Science_and_Practice
rig_spri_p Politics_&_International_Studies
rig_p_msm Population_Health_Sciences_and_Mental_Health_Services
rig_p_pmh Psychotraumatology,_Mental_Health_&_Suicidal_Behaviour
rig_es_qec Quaternary_Environmental_Change
rig_hrsri_rcp Rehabilitation_in_Cancer_Patients
rig_hrsri_rrs Rehabilitation_in_Rheumatic_Sciences
rig_hrsri_rh Respiratory_Health
rig_cs_se Smart_Environments
rig_spri_sw Social_Work_&_Social_Policy
rig_es_s Society_and_Environment
rig_ad_sp Space_and_Place
rig_biomed_sm Stratified_Medicine
rig_bue_saber Studies_Allied_to_Built_Environment_Research_(SABER)
rig_es_t Terrestrial_Ecology
rig_p_bc The_Bamford_Centre_for_Mental_Health_and_Wellbeing
rigsg_mo_t Transcriptional_Regulation_&_Epigenetics
rigsg_mo_v Vascular_Medicine
rig_biomed_vs Vision

Examples

/publications/get/group/Coastal_Systems

/publications/get/group/Molecular_Medicine

Tips

Specifying a group applies the filter at a lower level
than institute.
If you specify both, the controller will return items at the institute level
(which should include the group level if the affiliations were applied correctly
when the item was deposited).

Values

fac_adbe Faculty_of_Art,_Design_and_the_Built_Environment
fac_arts Faculty_of_Arts
fac_ce Faculty_of_Computing_&_Engineering
fac_lhs Faculty_of_Life_and_Health_Sciences
fac_ss Faculty_of_Social_Sciences
fac_ubs Ulster_Business_School

Examples

/publications/get/faculty/Faculty_of_Arts

/publications/get/faculty/Ulster_Business_School

Values

sch_adbe_ad Belfast_School_of_Art
sch_ubs_bi Business_Institute
sch_ubs_da Department_of_Accounting,_Finance_and_Economics
sch_ubs_dbrfs Department_of_Business_and_Enterprise
sch_ubs_dhtm Department_of_Hospitality_and_Tourism_Management
sch_ubs_dib Department_of_International_Business
sch_ubs_dm Department_of_Management_and_Leadership
sch_ubs_dmes Department_of_Marketing,_Entrepreneurship_and_Strategy
sch_ss_gsp Graduate_School_of_Professional_Legal_Education
sch_ss_inc INCORE
sch_arts_iuss Institute_of_Ulster_Scots_Studies
sch_adbe_x_rgs Research_Graduate_School
sch_arts_x_rgs Research_Graduate_School
sch_ce_x_rgs Research_Graduate_School
sch_lhs_x_rgs Research_Graduate_School
sch_ubs_x_rgs Research_Graduate_School
sch_ss_x_rgs Research_Graduate_School_(Social_Sciences)
sch_lhs_bs School_of_Biomedical_Sciences
sch_ss_c School_of_Communication
sch_ce_cie School_of_Computing_and_Information_Engineering
sch_ce_cis School_of_Computing_and_Intelligent_Systems
sch_ce_cm School_of_Computing_and_Mathematics
sch_arts_ca School_of_Creative_Arts_and_Technologies
sch_ss_ps School_of_Criminology,_Politics_and_Social_Policy
sch_ss_ed School_of_Education
sch_ce_eme School_of_Engineering
sch_arts_hia School_of_English_and_History
sch_lhs_es School_of_Geography_and_Environmental_Sciences
sch_lhs_hs School_of_Health_Sciences
sch_arts_i School_of_Irish_Language_and_Literature
sch_ss_l School_of_Law
sch_arts_mfj School_of_Media,_Film_&_Journalism
sch_arts_ll School_of_Modern_Languages
sch_lhs_n School_of_Nursing
sch_lhs_pps School_of_Pharmacy_and_Pharmaceutical_Science
sch_lhs_p School_of_Psychology
sch_ss_sass School_of_Sociology_and_Applied_Social_Studies
sch_lhs_ss School_of_Sport
sch_adbe_be School_of_the_Built_Environment
sch_adbe_arc The_Belfast_School_of_Architecture

Examples

/publications/get/school/School_of_Communication

/publications/get/school/School_of_Sports_Studies

Tips

As for institute/group combinations, specifying a school applies the filter
at a lower level than faculty, therefore you should not specify the parent faculty
if you only want the group publications.
If you specify both, the service will return items at the faculty level.

publications – type

You can specify which type(s) of items you want the web service to return, or to exclude.

Type names

artefact
article
body_of_work
book_authored
book_edited
book_section
composition
conference_item
confidential_report_external
design
device
digital_media
exhibition
installation
internet_publication
other
patent
performance
research_report_external
scholarly_edition
software
thesis

Default

If you do not use the type parameter, all item types will be returned.

Examples

/publications/get/school/School_of_Law/type/article

/publications/get/school/sch_ss_l/type/book_edited,book_section

/publications/get/school/sch_ss_l/type/-article

Tips

If you specify one item type, the service will return only items of that type.

You can specify more than one item type by separating the values with commas. The service will return items of those types.

You can exclude a particular item type by prefixing the value of the parameter with a minus-sign.

publications – render

You can specify how the data will be rendered, according to your preference
for any processing you want to do with the publications data before displaying
it on the target web page.

The json and xml rendering options return additional data that may be useful for
any custom processing you want to do. For example, the creators’ names are
returned in a separate structure in addition to as a list.

The web service has the following options for how the data will be rendered.
Please note, the examples below are for illustration only.
Additional fields may be added if required in the future.

Values

Examples

html

/publications/get/email/an.academic@ulster.ac.uk/render/html

HTML is the default option if you do not specify a render parameter.


The HTML returned will have the same format as the UIR author_by_email view.

xml

/publications/get/email/an.academic@ulster.ac.uk/type/article/render/xml

<eprints>

<eprint>

<eprintid>318</eprintid>

<type>article</type>

<creators>Smith A, Academic AN and Another S</creators>

<creators_names>

<creators_name>

<family>Smith</family>

<given>A</given>

<position>0</position>

</creators_name>

<creators_name>

<family>Academic</family>

<given>AN</given>

<position>1</position>

</creators_name>

<creators_name>

<family>Another</family>

<given>S</given>

<position>2</position>

</creators_name>

</creators_names>

<publication_date>(2009)</publication_date>

<publication_date_year>2009</publication_date_year>

<publication_date_month>3</publication_date_month>

<publication_date_day/>

<title><a target=”_blank” href=”http://eprints-dev.ulster.ac.uk/318″><em>The Development and Pilot Testing of an Instrument to Measure Nurses’ Working Environment: The Nursing Context Index</em></a></title>

<publication>WORLDVIEWS ON EVIDENCE-BASED NURSING</publication>

<volume>6</volume>

<number>3</number>

<pagerange>173-182</pagerange>

</eprint>

</eprints>

json

/publications/get/institute/Institute_of_Nursing_Research/type/article/render/json

[

{

“eprintid”:4,

“type”:”article”,

“creators”:”Switzer C and McDowell S”,

“publication_date”:”(2009)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>”,

“title”:”Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast”

“publication”:”Memory Studies”,

“volume”:”2″,

“number”:”3″,

“pagerange”:”337-353″

“citation”:”Switzer C and McDowell S (2009) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>. Memory Studies 2 (3). pp. 337-353.”

},

{

“eprintid”:48,

“type”:”article”,

“creators”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F”,

“publication_date”:”(2010)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>”,

“title”:”A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks”

“publication”:”Computers in Biology and Medicine”,

“volume”:”40″,

“number”:”3″,

“pagerange”:”306-317″

“citation”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F (2010) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>. Computers in Biology and Medicine 40 (3). pp. 306-317.”

}

]

Use the php function json_decode
if you need to turn the default json string into an array for additional processing.

publications – format

Citation format options are currently under review.
Please let us know if there is a particular format you require.
In the meantime, all publication citations will be returned
in the default format (the same format as displayed in the UIR).

Values

Default

If you do not specify the format parameter, the publication citations will be returned in
the default EPrints format.

Examples

Tips

publications – order

Fields to order on can be chained using the semicolon ; character.

Defaults

If you do not specify any order parameter, the publications will be returned
ordered by year of publication (descending), first author’s name (ascending) and
title (ascending).

If you specify an order without a flag, the default order is ascending.
Specify descending order by adding ,d after the field you want to sort on.

Values

Examples

year

/publications/get/email/an.academic@ulster.ac.uk/type/conference_item/order/year

returns all the conference contributions for an.academic@ulster.ac.uk sorted in ascending order by the
year of publication

NOTE: a list of the types for any given email can be retrieved using the types parameter
(see the types – mandatory section below for more information)

date,d

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/date,d

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by the
complete date of publication

NOTE: only the year part of the publication date is required when depositing an item in the
UIR, the month and day may not exist in the item metadata

year,d;name

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/year,d;name

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by year of
publication, and within the year, in ascending order of first author’s name

title

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/title

returns all the articles for an.academic@ulster.ac.uk sorted in ascending order of title
(useful for checking for possible duplicates)

types – mandatory parameters

The types controller will return a list of the item types for the
parameter(s) supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires at least one of the same mandatory parameters as publications (see
the publications – mandatory parameters section above).
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/types/get/email/an.academic@ulster.ac.uk all types which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/types/get/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation
/types/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

Please note

The word mandatory is not a parameter key.
See the publications – mandatory parameters section above for a
complete list of the current names for faculties, research institutes, etc.

item IDs – mandatory parameters

The itemids controller will return a list of the item IDs for the
Ulster email supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires a single mandatory parameter: a valid Ulster email.

Optionally, you can use the type parameter to get item IDs for a particular
type of item.

The same rendering options are available as for publications:
html (default), json and xml.

Examples

/itemids/get/email/an.academic@ulster.ac.uk all item IDs (and item types) which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/itemids/get/email/an.academic@ulster.ac.uk/type/article all item IDs for items of the specified type which have the email an.academic@ulster.ac.uk in the authors/creators metadata field


Articles





Web Services: EPrints (UIR)



How to use this web service

general

The UIR web service is called via a URL whose structure is explained below:

always required varies according to requirements
service address controller name controller action parameter key parameter value
https://webservices.ulster.ac.uk/uir /publications /get /email /an.academic@ulster.ac.uk
  /types      
  /itemids      
service address This is always the same, and must be used, for all calls to the UIR web service.
controller name
publications provides a list of publications depending on the combination of parameters (key/value pairs) specified
types

provides a list of item types used by an author
itemids

provides a list of item ids used by an author (can be filtered by type)

Features added in the future will be listed here and
in the UIR Developer Guide (login required).

controller action The types, publications and itemids controllers currently implement a get action.
parameter key Several parameters can be passed to a controller in order to specify the data required.
Email is one of the mandatory parameters.

See below for more information about parameter keys and valid values.
parameter value Each parameter key must have a corresponding value. For the key email,
the corresponding value must be an Ulster email in the format specified.

See below for more information about parameter keys and valid values.

Multiple parameter key/value pairs can be passed to the controller by
appending them as required to the URL, in any order.

There are five types of parameter which can be used to specify the publications
required, how they should be rendered (and in the future, what format citations should have).
Click the headings below for an explanation and examples of each.

publications – mandatory parameters

The UIR publications controller requires at least one of the mandatory parameters below.
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/publications/get/email/an.academic@ulster.ac.uk all publications which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/publications/get/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation
/publications/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

UIR codes

The names of Research Institutes and groups can change.
Less frequently, School and Faculty names may also change.
The webservice now publishes the UIR code for each of these entities.
The codes remain constant within the UIR so there will be no need to
update code when a name changes (although there may occasionally be a
new code added, for example, when a new group is created).

Codes are listed alongside institute, group, faculty and school names in the tabs below.
Both codes and names are drawn directly from the UIR and therefore are always up-to-date.

It is strongly recommended that you use the codes
rather than the names to retrieve items from the UIR.

Please note

The word mandatory is not a parameter key.
Use one of the following key words to specify a mandatory parameter.
Click on each key word to display its list of valid values.

Values

a valid Ulster staff member’s email

Tips

If you don’t get any results back for an email, and you are certain that
you are using a valid email, check for that person in the
Browse | Ulster Authors and Editors
section of the repository. If they are not listed there, they do not have any items live in the
repository.

Values

ri_ad Art_and_Design_Research_Institute
ri_hu Arts_and_Humanities_Research_Institute
ri_biomed Biomedical_Sciences_Research_Institute
ri_bue Built_Environment_Research_Institute
ri_bsm Business_and_Management_Research_Institute
ri_ms Centre_for_Media_Research
ri_cs Computer_Science_Research_Institute
ri_namr Engineering_Research_Institute
ri_es Environmental_Sciences_Research_Institute
ri_hrsri Health_and_Rehabilitation_Sciences_Research_Institute
ri_spri Institute_for_Research_in_Social_Sciences
ri_nur Institute_of_Nursing_and_Health_Research
ri_c Irish_and_Celtic_Studies_Research_Institute
ri_p Psychology_Research_Institute
ri_sprt Sport_and_Exercise_Sciences_Research_Institute
ri_tji Transitional_Justice_Institute

Examples

/publications/get/institute/Institute_of_Nursing_Research

/publications/get/institute/Sport_and_Exercise_Science_Research_Institute

/publications/get/institute/ri_sprt

Values

rig_hrsri_spic Activity_and_Enablement_(AE)
rig_namr_amfr Advanced_Metal_Forming
rig_ad_ac Art_and_Context
rig_ad_fa Art,_Conflict_and_Society
rig_cs_ai Artificial_Intelligence_and_Applications
rig_p_bn Behavioural_Neuroscience_and_Behaviour_Analysis
rig_nur_hrsrc Centre_for_Health_and_Rehabilitation_Technologies
rig_nur_ddch Centre_for_Intellectual_and_Developmental_Disabilities
rig_nur_mfiw Centre_for_Maternal,_Fetal_and_Infant_Research
rig_sprt_ph Centre_for_Physical_Activity_and_Health
rig_bue_crpp Centre_for_Research_on_Property_and_Planning_(RPP)
rig_sprt_sp Centre_for_Sport_in_Society
rig_sprt_sps Centre_for_Sports_Science_and_Sports_Medicine
rig_bue_cst Centre_for_Sustainable_Technologies_(CST)
rig_es_cm Coastal_Systems
rig_spri_c Communication
rig_hu_ca Creative_Arts_and_Technologies
rig_ad_aa Creative_Ecologies
rig_biomed_d Diabetes
rig_hrsri_diii Diabetic_Foot_-_Infection_-_Imaging_-_Intervention_(D3i)
rig_spri_ed Education
rig_nur_nepr Education_and_Professional_Issues_Research_Group
rig_namr_ecrc Engineering_Composites
rig_hu_en English
rig_bue_fsertc Fire_Safety_and_Engineering_Research_and_Technology_Centre_(FireSERT)
rig_es_f Freshwater_Sciences
rig_ad_d Future_and_Virtual_Worlds
rig_biomed_mo Genomic_Medicine
rig_es_g Geophysics
rig_nur_hpah Health_Promotion_and_Adolescent_Health
rig_p_hp Health,_Education_and_Well-being
rig_hu_h History
rig_bue_hsef Hydrogen_Safety_Engineering_and_Research_Centre_(HySAFER)
rig_biomed_ii Infection_and_Immunity/Microbiology
rig_cs_ise Information_and_Communication_Engineering
rig_cs_isrc Intelligent_Systems_Research_Centre
rig_spri_l Linguistics
rig_nur_mci Managing_Chronic_Illness_Research_Centre
rig_hrsri_mci Managing_Chronic_Illness_through_’Assisted_Living’
rig_es_ma Maritime_Archaeology
rig_hrsri_dm Medical_Imaging
rig_nur_mh Mental_Health
rig_hu_eu Modern_Languages
rig_hrsri_md Musculoskeletal_Disorder_(MSKD)_Rehabilitation
rigsg_mo_na Nano_Systems_Biology
rig_namr_nibec Nanotechnology_&_Integrated_BioEngineering_Centre_(NIBEC)
rig_hrsri_nr Neurorehabilitation_for_Health_(NRH)
rigsg_mo_nd Neuroscience_&_Neurodegenerative_Diseases
rig_biomed_niche Northern_Ireland_Centre_for_Food_and_Health_(NICHE)
rig_p_pc Peace,_Conflict_and_Equality
rig_nur_pcp Person-centred_Practice_Research_Centre
rig_biomed_psp Pharmaceutical_Science_and_Practice
rig_spri_p Politics_&_International_Studies
rig_p_msm Population_Health_Sciences_and_Mental_Health_Services
rig_p_pmh Psychotraumatology,_Mental_Health_&_Suicidal_Behaviour
rig_es_qec Quaternary_Environmental_Change
rig_hrsri_rcp Rehabilitation_in_Cancer_Patients
rig_hrsri_rrs Rehabilitation_in_Rheumatic_Sciences
rig_hrsri_rh Respiratory_Health
rig_cs_se Smart_Environments
rig_spri_sw Social_Work_&_Social_Policy
rig_es_s Society_and_Environment
rig_ad_sp Space_and_Place
rig_biomed_sm Stratified_Medicine
rig_bue_saber Studies_Allied_to_Built_Environment_Research_(SABER)
rig_es_t Terrestrial_Ecology
rig_p_bc The_Bamford_Centre_for_Mental_Health_and_Wellbeing
rigsg_mo_t Transcriptional_Regulation_&_Epigenetics
rigsg_mo_v Vascular_Medicine
rig_biomed_vs Vision

Examples

/publications/get/group/Coastal_Systems

/publications/get/group/Molecular_Medicine

Tips

Specifying a group applies the filter at a lower level
than institute.
If you specify both, the controller will return items at the institute level
(which should include the group level if the affiliations were applied correctly
when the item was deposited).

Values

fac_adbe Faculty_of_Art,_Design_and_the_Built_Environment
fac_arts Faculty_of_Arts
fac_ce Faculty_of_Computing_&_Engineering
fac_lhs Faculty_of_Life_and_Health_Sciences
fac_ss Faculty_of_Social_Sciences
fac_ubs Ulster_Business_School

Examples

/publications/get/faculty/Faculty_of_Arts

/publications/get/faculty/Ulster_Business_School

Values

sch_adbe_ad Belfast_School_of_Art
sch_ubs_bi Business_Institute
sch_ubs_da Department_of_Accounting,_Finance_and_Economics
sch_ubs_dbrfs Department_of_Business_and_Enterprise
sch_ubs_dhtm Department_of_Hospitality_and_Tourism_Management
sch_ubs_dib Department_of_International_Business
sch_ubs_dm Department_of_Management_and_Leadership
sch_ubs_dmes Department_of_Marketing,_Entrepreneurship_and_Strategy
sch_ss_gsp Graduate_School_of_Professional_Legal_Education
sch_ss_inc INCORE
sch_arts_iuss Institute_of_Ulster_Scots_Studies
sch_adbe_x_rgs Research_Graduate_School
sch_arts_x_rgs Research_Graduate_School
sch_ce_x_rgs Research_Graduate_School
sch_lhs_x_rgs Research_Graduate_School
sch_ubs_x_rgs Research_Graduate_School
sch_ss_x_rgs Research_Graduate_School_(Social_Sciences)
sch_lhs_bs School_of_Biomedical_Sciences
sch_ss_c School_of_Communication
sch_ce_cie School_of_Computing_and_Information_Engineering
sch_ce_cis School_of_Computing_and_Intelligent_Systems
sch_ce_cm School_of_Computing_and_Mathematics
sch_arts_ca School_of_Creative_Arts_and_Technologies
sch_ss_ps School_of_Criminology,_Politics_and_Social_Policy
sch_ss_ed School_of_Education
sch_ce_eme School_of_Engineering
sch_arts_hia School_of_English_and_History
sch_lhs_es School_of_Geography_and_Environmental_Sciences
sch_lhs_hs School_of_Health_Sciences
sch_arts_i School_of_Irish_Language_and_Literature
sch_ss_l School_of_Law
sch_arts_mfj School_of_Media,_Film_&_Journalism
sch_arts_ll School_of_Modern_Languages
sch_lhs_n School_of_Nursing
sch_lhs_pps School_of_Pharmacy_and_Pharmaceutical_Science
sch_lhs_p School_of_Psychology
sch_ss_sass School_of_Sociology_and_Applied_Social_Studies
sch_lhs_ss School_of_Sport
sch_adbe_be School_of_the_Built_Environment
sch_adbe_arc The_Belfast_School_of_Architecture

Examples

/publications/get/school/School_of_Communication

/publications/get/school/School_of_Sports_Studies

Tips

As for institute/group combinations, specifying a school applies the filter
at a lower level than faculty, therefore you should not specify the parent faculty
if you only want the group publications.
If you specify both, the service will return items at the faculty level.

publications – type

You can specify which type(s) of items you want the web service to return, or to exclude.

Type names

artefact
article
body_of_work
book_authored
book_edited
book_section
composition
conference_item
confidential_report_external
design
device
digital_media
exhibition
installation
internet_publication
other
patent
performance
research_report_external
scholarly_edition
software
thesis

Default

If you do not use the type parameter, all item types will be returned.

Examples

/publications/get/school/School_of_Law/type/article

/publications/get/school/sch_ss_l/type/book_edited,book_section

/publications/get/school/sch_ss_l/type/-article

Tips

If you specify one item type, the service will return only items of that type.

You can specify more than one item type by separating the values with commas. The service will return items of those types.

You can exclude a particular item type by prefixing the value of the parameter with a minus-sign.

publications – render

You can specify how the data will be rendered, according to your preference
for any processing you want to do with the publications data before displaying
it on the target web page.

The json and xml rendering options return additional data that may be useful for
any custom processing you want to do. For example, the creators’ names are
returned in a separate structure in addition to as a list.

The web service has the following options for how the data will be rendered.
Please note, the examples below are for illustration only.
Additional fields may be added if required in the future.

Values

Examples

html

/publications/get/email/an.academic@ulster.ac.uk/render/html

HTML is the default option if you do not specify a render parameter.


The HTML returned will have the same format as the UIR author_by_email view.

xml

/publications/get/email/an.academic@ulster.ac.uk/type/article/render/xml

<eprints>

<eprint>

<eprintid>318</eprintid>

<type>article</type>

<creators>Smith A, Academic AN and Another S</creators>

<creators_names>

<creators_name>

<family>Smith</family>

<given>A</given>

<position>0</position>

</creators_name>

<creators_name>

<family>Academic</family>

<given>AN</given>

<position>1</position>

</creators_name>

<creators_name>

<family>Another</family>

<given>S</given>

<position>2</position>

</creators_name>

</creators_names>

<publication_date>(2009)</publication_date>

<publication_date_year>2009</publication_date_year>

<publication_date_month>3</publication_date_month>

<publication_date_day/>

<title><a target=”_blank” href=”http://eprints-dev.ulster.ac.uk/318″><em>The Development and Pilot Testing of an Instrument to Measure Nurses’ Working Environment: The Nursing Context Index</em></a></title>

<publication>WORLDVIEWS ON EVIDENCE-BASED NURSING</publication>

<volume>6</volume>

<number>3</number>

<pagerange>173-182</pagerange>

</eprint>

</eprints>

json

/publications/get/institute/Institute_of_Nursing_Research/type/article/render/json

[

{

“eprintid”:4,

“type”:”article”,

“creators”:”Switzer C and McDowell S”,

“publication_date”:”(2009)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>”,

“title”:”Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast”

“publication”:”Memory Studies”,

“volume”:”2″,

“number”:”3″,

“pagerange”:”337-353″

“citation”:”Switzer C and McDowell S (2009) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>. Memory Studies 2 (3). pp. 337-353.”

},

{

“eprintid”:48,

“type”:”article”,

“creators”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F”,

“publication_date”:”(2010)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>”,

“title”:”A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks”

“publication”:”Computers in Biology and Medicine”,

“volume”:”40″,

“number”:”3″,

“pagerange”:”306-317″

“citation”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F (2010) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>. Computers in Biology and Medicine 40 (3). pp. 306-317.”

}

]

Use the php function json_decode
if you need to turn the default json string into an array for additional processing.

publications – format

Citation format options are currently under review.
Please let us know if there is a particular format you require.
In the meantime, all publication citations will be returned
in the default format (the same format as displayed in the UIR).

Values

Default

If you do not specify the format parameter, the publication citations will be returned in
the default EPrints format.

Examples

Tips

publications – order

Fields to order on can be chained using the semicolon ; character.

Defaults

If you do not specify any order parameter, the publications will be returned
ordered by year of publication (descending), first author’s name (ascending) and
title (ascending).

If you specify an order without a flag, the default order is ascending.
Specify descending order by adding ,d after the field you want to sort on.

Values

Examples

year

/publications/get/email/an.academic@ulster.ac.uk/type/conference_item/order/year

returns all the conference contributions for an.academic@ulster.ac.uk sorted in ascending order by the
year of publication

NOTE: a list of the types for any given email can be retrieved using the types parameter
(see the types – mandatory section below for more information)

date,d

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/date,d

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by the
complete date of publication

NOTE: only the year part of the publication date is required when depositing an item in the
UIR, the month and day may not exist in the item metadata

year,d;name

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/year,d;name

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by year of
publication, and within the year, in ascending order of first author’s name

title

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/title

returns all the articles for an.academic@ulster.ac.uk sorted in ascending order of title
(useful for checking for possible duplicates)

types – mandatory parameters

The types controller will return a list of the item types for the
parameter(s) supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires at least one of the same mandatory parameters as publications (see
the publications – mandatory parameters section above).
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/types/get/email/an.academic@ulster.ac.uk all types which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/types/get/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation
/types/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

Please note

The word mandatory is not a parameter key.
See the publications – mandatory parameters section above for a
complete list of the current names for faculties, research institutes, etc.

item IDs – mandatory parameters

The itemids controller will return a list of the item IDs for the
Ulster email supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires a single mandatory parameter: a valid Ulster email.

Optionally, you can use the type parameter to get item IDs for a particular
type of item.

The same rendering options are available as for publications:
html (default), json and xml.

Examples

/itemids/get/email/an.academic@ulster.ac.uk all item IDs (and item types) which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/itemids/get/email/an.academic@ulster.ac.uk/type/article all item IDs for items of the specified type which have the email an.academic@ulster.ac.uk in the authors/creators metadata field


Book Sections





Web Services: EPrints (UIR)



How to use this web service

general

The UIR web service is called via a URL whose structure is explained below:

always required varies according to requirements
service address controller name controller action parameter key parameter value
https://webservices.ulster.ac.uk/uir /publications /get /email /an.academic@ulster.ac.uk
  /types      
  /itemids      
service address This is always the same, and must be used, for all calls to the UIR web service.
controller name
publications provides a list of publications depending on the combination of parameters (key/value pairs) specified
types

provides a list of item types used by an author
itemids

provides a list of item ids used by an author (can be filtered by type)

Features added in the future will be listed here and
in the UIR Developer Guide (login required).

controller action The types, publications and itemids controllers currently implement a get action.
parameter key Several parameters can be passed to a controller in order to specify the data required.
Email is one of the mandatory parameters.

See below for more information about parameter keys and valid values.
parameter value Each parameter key must have a corresponding value. For the key email,
the corresponding value must be an Ulster email in the format specified.

See below for more information about parameter keys and valid values.

Multiple parameter key/value pairs can be passed to the controller by
appending them as required to the URL, in any order.

There are five types of parameter which can be used to specify the publications
required, how they should be rendered (and in the future, what format citations should have).
Click the headings below for an explanation and examples of each.

publications – mandatory parameters

The UIR publications controller requires at least one of the mandatory parameters below.
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/publications/get/email/an.academic@ulster.ac.uk all publications which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/publications/get/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation
/publications/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

UIR codes

The names of Research Institutes and groups can change.
Less frequently, School and Faculty names may also change.
The webservice now publishes the UIR code for each of these entities.
The codes remain constant within the UIR so there will be no need to
update code when a name changes (although there may occasionally be a
new code added, for example, when a new group is created).

Codes are listed alongside institute, group, faculty and school names in the tabs below.
Both codes and names are drawn directly from the UIR and therefore are always up-to-date.

It is strongly recommended that you use the codes
rather than the names to retrieve items from the UIR.

Please note

The word mandatory is not a parameter key.
Use one of the following key words to specify a mandatory parameter.
Click on each key word to display its list of valid values.

Values

a valid Ulster staff member’s email

Tips

If you don’t get any results back for an email, and you are certain that
you are using a valid email, check for that person in the
Browse | Ulster Authors and Editors
section of the repository. If they are not listed there, they do not have any items live in the
repository.

Values

ri_ad Art_and_Design_Research_Institute
ri_hu Arts_and_Humanities_Research_Institute
ri_biomed Biomedical_Sciences_Research_Institute
ri_bue Built_Environment_Research_Institute
ri_bsm Business_and_Management_Research_Institute
ri_ms Centre_for_Media_Research
ri_cs Computer_Science_Research_Institute
ri_namr Engineering_Research_Institute
ri_es Environmental_Sciences_Research_Institute
ri_hrsri Health_and_Rehabilitation_Sciences_Research_Institute
ri_spri Institute_for_Research_in_Social_Sciences
ri_nur Institute_of_Nursing_and_Health_Research
ri_c Irish_and_Celtic_Studies_Research_Institute
ri_p Psychology_Research_Institute
ri_sprt Sport_and_Exercise_Sciences_Research_Institute
ri_tji Transitional_Justice_Institute

Examples

/publications/get/institute/Institute_of_Nursing_Research

/publications/get/institute/Sport_and_Exercise_Science_Research_Institute

/publications/get/institute/ri_sprt

Values

rig_hrsri_spic Activity_and_Enablement_(AE)
rig_namr_amfr Advanced_Metal_Forming
rig_ad_ac Art_and_Context
rig_ad_fa Art,_Conflict_and_Society
rig_cs_ai Artificial_Intelligence_and_Applications
rig_p_bn Behavioural_Neuroscience_and_Behaviour_Analysis
rig_nur_hrsrc Centre_for_Health_and_Rehabilitation_Technologies
rig_nur_ddch Centre_for_Intellectual_and_Developmental_Disabilities
rig_nur_mfiw Centre_for_Maternal,_Fetal_and_Infant_Research
rig_sprt_ph Centre_for_Physical_Activity_and_Health
rig_bue_crpp Centre_for_Research_on_Property_and_Planning_(RPP)
rig_sprt_sp Centre_for_Sport_in_Society
rig_sprt_sps Centre_for_Sports_Science_and_Sports_Medicine
rig_bue_cst Centre_for_Sustainable_Technologies_(CST)
rig_es_cm Coastal_Systems
rig_spri_c Communication
rig_hu_ca Creative_Arts_and_Technologies
rig_ad_aa Creative_Ecologies
rig_biomed_d Diabetes
rig_hrsri_diii Diabetic_Foot_-_Infection_-_Imaging_-_Intervention_(D3i)
rig_spri_ed Education
rig_nur_nepr Education_and_Professional_Issues_Research_Group
rig_namr_ecrc Engineering_Composites
rig_hu_en English
rig_bue_fsertc Fire_Safety_and_Engineering_Research_and_Technology_Centre_(FireSERT)
rig_es_f Freshwater_Sciences
rig_ad_d Future_and_Virtual_Worlds
rig_biomed_mo Genomic_Medicine
rig_es_g Geophysics
rig_nur_hpah Health_Promotion_and_Adolescent_Health
rig_p_hp Health,_Education_and_Well-being
rig_hu_h History
rig_bue_hsef Hydrogen_Safety_Engineering_and_Research_Centre_(HySAFER)
rig_biomed_ii Infection_and_Immunity/Microbiology
rig_cs_ise Information_and_Communication_Engineering
rig_cs_isrc Intelligent_Systems_Research_Centre
rig_spri_l Linguistics
rig_nur_mci Managing_Chronic_Illness_Research_Centre
rig_hrsri_mci Managing_Chronic_Illness_through_’Assisted_Living’
rig_es_ma Maritime_Archaeology
rig_hrsri_dm Medical_Imaging
rig_nur_mh Mental_Health
rig_hu_eu Modern_Languages
rig_hrsri_md Musculoskeletal_Disorder_(MSKD)_Rehabilitation
rigsg_mo_na Nano_Systems_Biology
rig_namr_nibec Nanotechnology_&_Integrated_BioEngineering_Centre_(NIBEC)
rig_hrsri_nr Neurorehabilitation_for_Health_(NRH)
rigsg_mo_nd Neuroscience_&_Neurodegenerative_Diseases
rig_biomed_niche Northern_Ireland_Centre_for_Food_and_Health_(NICHE)
rig_p_pc Peace,_Conflict_and_Equality
rig_nur_pcp Person-centred_Practice_Research_Centre
rig_biomed_psp Pharmaceutical_Science_and_Practice
rig_spri_p Politics_&_International_Studies
rig_p_msm Population_Health_Sciences_and_Mental_Health_Services
rig_p_pmh Psychotraumatology,_Mental_Health_&_Suicidal_Behaviour
rig_es_qec Quaternary_Environmental_Change
rig_hrsri_rcp Rehabilitation_in_Cancer_Patients
rig_hrsri_rrs Rehabilitation_in_Rheumatic_Sciences
rig_hrsri_rh Respiratory_Health
rig_cs_se Smart_Environments
rig_spri_sw Social_Work_&_Social_Policy
rig_es_s Society_and_Environment
rig_ad_sp Space_and_Place
rig_biomed_sm Stratified_Medicine
rig_bue_saber Studies_Allied_to_Built_Environment_Research_(SABER)
rig_es_t Terrestrial_Ecology
rig_p_bc The_Bamford_Centre_for_Mental_Health_and_Wellbeing
rigsg_mo_t Transcriptional_Regulation_&_Epigenetics
rigsg_mo_v Vascular_Medicine
rig_biomed_vs Vision

Examples

/publications/get/group/Coastal_Systems

/publications/get/group/Molecular_Medicine

Tips

Specifying a group applies the filter at a lower level
than institute.
If you specify both, the controller will return items at the institute level
(which should include the group level if the affiliations were applied correctly
when the item was deposited).

Values

fac_adbe Faculty_of_Art,_Design_and_the_Built_Environment
fac_arts Faculty_of_Arts
fac_ce Faculty_of_Computing_&_Engineering
fac_lhs Faculty_of_Life_and_Health_Sciences
fac_ss Faculty_of_Social_Sciences
fac_ubs Ulster_Business_School

Examples

/publications/get/faculty/Faculty_of_Arts

/publications/get/faculty/Ulster_Business_School

Values

sch_adbe_ad Belfast_School_of_Art
sch_ubs_bi Business_Institute
sch_ubs_da Department_of_Accounting,_Finance_and_Economics
sch_ubs_dbrfs Department_of_Business_and_Enterprise
sch_ubs_dhtm Department_of_Hospitality_and_Tourism_Management
sch_ubs_dib Department_of_International_Business
sch_ubs_dm Department_of_Management_and_Leadership
sch_ubs_dmes Department_of_Marketing,_Entrepreneurship_and_Strategy
sch_ss_gsp Graduate_School_of_Professional_Legal_Education
sch_ss_inc INCORE
sch_arts_iuss Institute_of_Ulster_Scots_Studies
sch_adbe_x_rgs Research_Graduate_School
sch_arts_x_rgs Research_Graduate_School
sch_ce_x_rgs Research_Graduate_School
sch_lhs_x_rgs Research_Graduate_School
sch_ubs_x_rgs Research_Graduate_School
sch_ss_x_rgs Research_Graduate_School_(Social_Sciences)
sch_lhs_bs School_of_Biomedical_Sciences
sch_ss_c School_of_Communication
sch_ce_cie School_of_Computing_and_Information_Engineering
sch_ce_cis School_of_Computing_and_Intelligent_Systems
sch_ce_cm School_of_Computing_and_Mathematics
sch_arts_ca School_of_Creative_Arts_and_Technologies
sch_ss_ps School_of_Criminology,_Politics_and_Social_Policy
sch_ss_ed School_of_Education
sch_ce_eme School_of_Engineering
sch_arts_hia School_of_English_and_History
sch_lhs_es School_of_Geography_and_Environmental_Sciences
sch_lhs_hs School_of_Health_Sciences
sch_arts_i School_of_Irish_Language_and_Literature
sch_ss_l School_of_Law
sch_arts_mfj School_of_Media,_Film_&_Journalism
sch_arts_ll School_of_Modern_Languages
sch_lhs_n School_of_Nursing
sch_lhs_pps School_of_Pharmacy_and_Pharmaceutical_Science
sch_lhs_p School_of_Psychology
sch_ss_sass School_of_Sociology_and_Applied_Social_Studies
sch_lhs_ss School_of_Sport
sch_adbe_be School_of_the_Built_Environment
sch_adbe_arc The_Belfast_School_of_Architecture

Examples

/publications/get/school/School_of_Communication

/publications/get/school/School_of_Sports_Studies

Tips

As for institute/group combinations, specifying a school applies the filter
at a lower level than faculty, therefore you should not specify the parent faculty
if you only want the group publications.
If you specify both, the service will return items at the faculty level.

publications – type

You can specify which type(s) of items you want the web service to return, or to exclude.

Type names

artefact
article
body_of_work
book_authored
book_edited
book_section
composition
conference_item
confidential_report_external
design
device
digital_media
exhibition
installation
internet_publication
other
patent
performance
research_report_external
scholarly_edition
software
thesis

Default

If you do not use the type parameter, all item types will be returned.

Examples

/publications/get/school/School_of_Law/type/article

/publications/get/school/sch_ss_l/type/book_edited,book_section

/publications/get/school/sch_ss_l/type/-article

Tips

If you specify one item type, the service will return only items of that type.

You can specify more than one item type by separating the values with commas. The service will return items of those types.

You can exclude a particular item type by prefixing the value of the parameter with a minus-sign.

publications – render

You can specify how the data will be rendered, according to your preference
for any processing you want to do with the publications data before displaying
it on the target web page.

The json and xml rendering options return additional data that may be useful for
any custom processing you want to do. For example, the creators’ names are
returned in a separate structure in addition to as a list.

The web service has the following options for how the data will be rendered.
Please note, the examples below are for illustration only.
Additional fields may be added if required in the future.

Values

Examples

html

/publications/get/email/an.academic@ulster.ac.uk/render/html

HTML is the default option if you do not specify a render parameter.


The HTML returned will have the same format as the UIR author_by_email view.

xml

/publications/get/email/an.academic@ulster.ac.uk/type/article/render/xml

<eprints>

<eprint>

<eprintid>318</eprintid>

<type>article</type>

<creators>Smith A, Academic AN and Another S</creators>

<creators_names>

<creators_name>

<family>Smith</family>

<given>A</given>

<position>0</position>

</creators_name>

<creators_name>

<family>Academic</family>

<given>AN</given>

<position>1</position>

</creators_name>

<creators_name>

<family>Another</family>

<given>S</given>

<position>2</position>

</creators_name>

</creators_names>

<publication_date>(2009)</publication_date>

<publication_date_year>2009</publication_date_year>

<publication_date_month>3</publication_date_month>

<publication_date_day/>

<title><a target=”_blank” href=”http://eprints-dev.ulster.ac.uk/318″><em>The Development and Pilot Testing of an Instrument to Measure Nurses’ Working Environment: The Nursing Context Index</em></a></title>

<publication>WORLDVIEWS ON EVIDENCE-BASED NURSING</publication>

<volume>6</volume>

<number>3</number>

<pagerange>173-182</pagerange>

</eprint>

</eprints>

json

/publications/get/institute/Institute_of_Nursing_Research/type/article/render/json

[

{

“eprintid”:4,

“type”:”article”,

“creators”:”Switzer C and McDowell S”,

“publication_date”:”(2009)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>”,

“title”:”Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast”

“publication”:”Memory Studies”,

“volume”:”2″,

“number”:”3″,

“pagerange”:”337-353″

“citation”:”Switzer C and McDowell S (2009) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>. Memory Studies 2 (3). pp. 337-353.”

},

{

“eprintid”:48,

“type”:”article”,

“creators”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F”,

“publication_date”:”(2010)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>”,

“title”:”A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks”

“publication”:”Computers in Biology and Medicine”,

“volume”:”40″,

“number”:”3″,

“pagerange”:”306-317″

“citation”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F (2010) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>. Computers in Biology and Medicine 40 (3). pp. 306-317.”

}

]

Use the php function json_decode
if you need to turn the default json string into an array for additional processing.

publications – format

Citation format options are currently under review.
Please let us know if there is a particular format you require.
In the meantime, all publication citations will be returned
in the default format (the same format as displayed in the UIR).

Values

Default

If you do not specify the format parameter, the publication citations will be returned in
the default EPrints format.

Examples

Tips

publications – order

Fields to order on can be chained using the semicolon ; character.

Defaults

If you do not specify any order parameter, the publications will be returned
ordered by year of publication (descending), first author’s name (ascending) and
title (ascending).

If you specify an order without a flag, the default order is ascending.
Specify descending order by adding ,d after the field you want to sort on.

Values

Examples

year

/publications/get/email/an.academic@ulster.ac.uk/type/conference_item/order/year

returns all the conference contributions for an.academic@ulster.ac.uk sorted in ascending order by the
year of publication

NOTE: a list of the types for any given email can be retrieved using the types parameter
(see the types – mandatory section below for more information)

date,d

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/date,d

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by the
complete date of publication

NOTE: only the year part of the publication date is required when depositing an item in the
UIR, the month and day may not exist in the item metadata

year,d;name

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/year,d;name

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by year of
publication, and within the year, in ascending order of first author’s name

title

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/title

returns all the articles for an.academic@ulster.ac.uk sorted in ascending order of title
(useful for checking for possible duplicates)

types – mandatory parameters

The types controller will return a list of the item types for the
parameter(s) supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires at least one of the same mandatory parameters as publications (see
the publications – mandatory parameters section above).
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/types/get/email/an.academic@ulster.ac.uk all types which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/types/get/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation
/types/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

Please note

The word mandatory is not a parameter key.
See the publications – mandatory parameters section above for a
complete list of the current names for faculties, research institutes, etc.

item IDs – mandatory parameters

The itemids controller will return a list of the item IDs for the
Ulster email supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires a single mandatory parameter: a valid Ulster email.

Optionally, you can use the type parameter to get item IDs for a particular
type of item.

The same rendering options are available as for publications:
html (default), json and xml.

Examples

/itemids/get/email/an.academic@ulster.ac.uk all item IDs (and item types) which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/itemids/get/email/an.academic@ulster.ac.uk/type/article all item IDs for items of the specified type which have the email an.academic@ulster.ac.uk in the authors/creators metadata field


Composition





Web Services: EPrints (UIR)



How to use this web service

general

The UIR web service is called via a URL whose structure is explained below:

always required varies according to requirements
service address controller name controller action parameter key parameter value
https://webservices.ulster.ac.uk/uir /publications /get /email /an.academic@ulster.ac.uk
  /types      
  /itemids      
service address This is always the same, and must be used, for all calls to the UIR web service.
controller name
publications provides a list of publications depending on the combination of parameters (key/value pairs) specified
types

provides a list of item types used by an author
itemids

provides a list of item ids used by an author (can be filtered by type)

Features added in the future will be listed here and
in the UIR Developer Guide (login required).

controller action The types, publications and itemids controllers currently implement a get action.
parameter key Several parameters can be passed to a controller in order to specify the data required.
Email is one of the mandatory parameters.

See below for more information about parameter keys and valid values.
parameter value Each parameter key must have a corresponding value. For the key email,
the corresponding value must be an Ulster email in the format specified.

See below for more information about parameter keys and valid values.

Multiple parameter key/value pairs can be passed to the controller by
appending them as required to the URL, in any order.

There are five types of parameter which can be used to specify the publications
required, how they should be rendered (and in the future, what format citations should have).
Click the headings below for an explanation and examples of each.

publications – mandatory parameters

The UIR publications controller requires at least one of the mandatory parameters below.
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/publications/get/email/an.academic@ulster.ac.uk all publications which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/publications/get/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation
/publications/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

UIR codes

The names of Research Institutes and groups can change.
Less frequently, School and Faculty names may also change.
The webservice now publishes the UIR code for each of these entities.
The codes remain constant within the UIR so there will be no need to
update code when a name changes (although there may occasionally be a
new code added, for example, when a new group is created).

Codes are listed alongside institute, group, faculty and school names in the tabs below.
Both codes and names are drawn directly from the UIR and therefore are always up-to-date.

It is strongly recommended that you use the codes
rather than the names to retrieve items from the UIR.

Please note

The word mandatory is not a parameter key.
Use one of the following key words to specify a mandatory parameter.
Click on each key word to display its list of valid values.

Values

a valid Ulster staff member’s email

Tips

If you don’t get any results back for an email, and you are certain that
you are using a valid email, check for that person in the
Browse | Ulster Authors and Editors
section of the repository. If they are not listed there, they do not have any items live in the
repository.

Values

ri_ad Art_and_Design_Research_Institute
ri_hu Arts_and_Humanities_Research_Institute
ri_biomed Biomedical_Sciences_Research_Institute
ri_bue Built_Environment_Research_Institute
ri_bsm Business_and_Management_Research_Institute
ri_ms Centre_for_Media_Research
ri_cs Computer_Science_Research_Institute
ri_namr Engineering_Research_Institute
ri_es Environmental_Sciences_Research_Institute
ri_hrsri Health_and_Rehabilitation_Sciences_Research_Institute
ri_spri Institute_for_Research_in_Social_Sciences
ri_nur Institute_of_Nursing_and_Health_Research
ri_c Irish_and_Celtic_Studies_Research_Institute
ri_p Psychology_Research_Institute
ri_sprt Sport_and_Exercise_Sciences_Research_Institute
ri_tji Transitional_Justice_Institute

Examples

/publications/get/institute/Institute_of_Nursing_Research

/publications/get/institute/Sport_and_Exercise_Science_Research_Institute

/publications/get/institute/ri_sprt

Values

rig_hrsri_spic Activity_and_Enablement_(AE)
rig_namr_amfr Advanced_Metal_Forming
rig_ad_ac Art_and_Context
rig_ad_fa Art,_Conflict_and_Society
rig_cs_ai Artificial_Intelligence_and_Applications
rig_p_bn Behavioural_Neuroscience_and_Behaviour_Analysis
rig_nur_hrsrc Centre_for_Health_and_Rehabilitation_Technologies
rig_nur_ddch Centre_for_Intellectual_and_Developmental_Disabilities
rig_nur_mfiw Centre_for_Maternal,_Fetal_and_Infant_Research
rig_sprt_ph Centre_for_Physical_Activity_and_Health
rig_bue_crpp Centre_for_Research_on_Property_and_Planning_(RPP)
rig_sprt_sp Centre_for_Sport_in_Society
rig_sprt_sps Centre_for_Sports_Science_and_Sports_Medicine
rig_bue_cst Centre_for_Sustainable_Technologies_(CST)
rig_es_cm Coastal_Systems
rig_spri_c Communication
rig_hu_ca Creative_Arts_and_Technologies
rig_ad_aa Creative_Ecologies
rig_biomed_d Diabetes
rig_hrsri_diii Diabetic_Foot_-_Infection_-_Imaging_-_Intervention_(D3i)
rig_spri_ed Education
rig_nur_nepr Education_and_Professional_Issues_Research_Group
rig_namr_ecrc Engineering_Composites
rig_hu_en English
rig_bue_fsertc Fire_Safety_and_Engineering_Research_and_Technology_Centre_(FireSERT)
rig_es_f Freshwater_Sciences
rig_ad_d Future_and_Virtual_Worlds
rig_biomed_mo Genomic_Medicine
rig_es_g Geophysics
rig_nur_hpah Health_Promotion_and_Adolescent_Health
rig_p_hp Health,_Education_and_Well-being
rig_hu_h History
rig_bue_hsef Hydrogen_Safety_Engineering_and_Research_Centre_(HySAFER)
rig_biomed_ii Infection_and_Immunity/Microbiology
rig_cs_ise Information_and_Communication_Engineering
rig_cs_isrc Intelligent_Systems_Research_Centre
rig_spri_l Linguistics
rig_nur_mci Managing_Chronic_Illness_Research_Centre
rig_hrsri_mci Managing_Chronic_Illness_through_’Assisted_Living’
rig_es_ma Maritime_Archaeology
rig_hrsri_dm Medical_Imaging
rig_nur_mh Mental_Health
rig_hu_eu Modern_Languages
rig_hrsri_md Musculoskeletal_Disorder_(MSKD)_Rehabilitation
rigsg_mo_na Nano_Systems_Biology
rig_namr_nibec Nanotechnology_&_Integrated_BioEngineering_Centre_(NIBEC)
rig_hrsri_nr Neurorehabilitation_for_Health_(NRH)
rigsg_mo_nd Neuroscience_&_Neurodegenerative_Diseases
rig_biomed_niche Northern_Ireland_Centre_for_Food_and_Health_(NICHE)
rig_p_pc Peace,_Conflict_and_Equality
rig_nur_pcp Person-centred_Practice_Research_Centre
rig_biomed_psp Pharmaceutical_Science_and_Practice
rig_spri_p Politics_&_International_Studies
rig_p_msm Population_Health_Sciences_and_Mental_Health_Services
rig_p_pmh Psychotraumatology,_Mental_Health_&_Suicidal_Behaviour
rig_es_qec Quaternary_Environmental_Change
rig_hrsri_rcp Rehabilitation_in_Cancer_Patients
rig_hrsri_rrs Rehabilitation_in_Rheumatic_Sciences
rig_hrsri_rh Respiratory_Health
rig_cs_se Smart_Environments
rig_spri_sw Social_Work_&_Social_Policy
rig_es_s Society_and_Environment
rig_ad_sp Space_and_Place
rig_biomed_sm Stratified_Medicine
rig_bue_saber Studies_Allied_to_Built_Environment_Research_(SABER)
rig_es_t Terrestrial_Ecology
rig_p_bc The_Bamford_Centre_for_Mental_Health_and_Wellbeing
rigsg_mo_t Transcriptional_Regulation_&_Epigenetics
rigsg_mo_v Vascular_Medicine
rig_biomed_vs Vision

Examples

/publications/get/group/Coastal_Systems

/publications/get/group/Molecular_Medicine

Tips

Specifying a group applies the filter at a lower level
than institute.
If you specify both, the controller will return items at the institute level
(which should include the group level if the affiliations were applied correctly
when the item was deposited).

Values

fac_adbe Faculty_of_Art,_Design_and_the_Built_Environment
fac_arts Faculty_of_Arts
fac_ce Faculty_of_Computing_&_Engineering
fac_lhs Faculty_of_Life_and_Health_Sciences
fac_ss Faculty_of_Social_Sciences
fac_ubs Ulster_Business_School

Examples

/publications/get/faculty/Faculty_of_Arts

/publications/get/faculty/Ulster_Business_School

Values

sch_adbe_ad Belfast_School_of_Art
sch_ubs_bi Business_Institute
sch_ubs_da Department_of_Accounting,_Finance_and_Economics
sch_ubs_dbrfs Department_of_Business_and_Enterprise
sch_ubs_dhtm Department_of_Hospitality_and_Tourism_Management
sch_ubs_dib Department_of_International_Business
sch_ubs_dm Department_of_Management_and_Leadership
sch_ubs_dmes Department_of_Marketing,_Entrepreneurship_and_Strategy
sch_ss_gsp Graduate_School_of_Professional_Legal_Education
sch_ss_inc INCORE
sch_arts_iuss Institute_of_Ulster_Scots_Studies
sch_adbe_x_rgs Research_Graduate_School
sch_arts_x_rgs Research_Graduate_School
sch_ce_x_rgs Research_Graduate_School
sch_lhs_x_rgs Research_Graduate_School
sch_ubs_x_rgs Research_Graduate_School
sch_ss_x_rgs Research_Graduate_School_(Social_Sciences)
sch_lhs_bs School_of_Biomedical_Sciences
sch_ss_c School_of_Communication
sch_ce_cie School_of_Computing_and_Information_Engineering
sch_ce_cis School_of_Computing_and_Intelligent_Systems
sch_ce_cm School_of_Computing_and_Mathematics
sch_arts_ca School_of_Creative_Arts_and_Technologies
sch_ss_ps School_of_Criminology,_Politics_and_Social_Policy
sch_ss_ed School_of_Education
sch_ce_eme School_of_Engineering
sch_arts_hia School_of_English_and_History
sch_lhs_es School_of_Geography_and_Environmental_Sciences
sch_lhs_hs School_of_Health_Sciences
sch_arts_i School_of_Irish_Language_and_Literature
sch_ss_l School_of_Law
sch_arts_mfj School_of_Media,_Film_&_Journalism
sch_arts_ll School_of_Modern_Languages
sch_lhs_n School_of_Nursing
sch_lhs_pps School_of_Pharmacy_and_Pharmaceutical_Science
sch_lhs_p School_of_Psychology
sch_ss_sass School_of_Sociology_and_Applied_Social_Studies
sch_lhs_ss School_of_Sport
sch_adbe_be School_of_the_Built_Environment
sch_adbe_arc The_Belfast_School_of_Architecture

Examples

/publications/get/school/School_of_Communication

/publications/get/school/School_of_Sports_Studies

Tips

As for institute/group combinations, specifying a school applies the filter
at a lower level than faculty, therefore you should not specify the parent faculty
if you only want the group publications.
If you specify both, the service will return items at the faculty level.

publications – type

You can specify which type(s) of items you want the web service to return, or to exclude.

Type names

artefact
article
body_of_work
book_authored
book_edited
book_section
composition
conference_item
confidential_report_external
design
device
digital_media
exhibition
installation
internet_publication
other
patent
performance
research_report_external
scholarly_edition
software
thesis

Default

If you do not use the type parameter, all item types will be returned.

Examples

/publications/get/school/School_of_Law/type/article

/publications/get/school/sch_ss_l/type/book_edited,book_section

/publications/get/school/sch_ss_l/type/-article

Tips

If you specify one item type, the service will return only items of that type.

You can specify more than one item type by separating the values with commas. The service will return items of those types.

You can exclude a particular item type by prefixing the value of the parameter with a minus-sign.

publications – render

You can specify how the data will be rendered, according to your preference
for any processing you want to do with the publications data before displaying
it on the target web page.

The json and xml rendering options return additional data that may be useful for
any custom processing you want to do. For example, the creators’ names are
returned in a separate structure in addition to as a list.

The web service has the following options for how the data will be rendered.
Please note, the examples below are for illustration only.
Additional fields may be added if required in the future.

Values

Examples

html

/publications/get/email/an.academic@ulster.ac.uk/render/html

HTML is the default option if you do not specify a render parameter.


The HTML returned will have the same format as the UIR author_by_email view.

xml

/publications/get/email/an.academic@ulster.ac.uk/type/article/render/xml

<eprints>

<eprint>

<eprintid>318</eprintid>

<type>article</type>

<creators>Smith A, Academic AN and Another S</creators>

<creators_names>

<creators_name>

<family>Smith</family>

<given>A</given>

<position>0</position>

</creators_name>

<creators_name>

<family>Academic</family>

<given>AN</given>

<position>1</position>

</creators_name>

<creators_name>

<family>Another</family>

<given>S</given>

<position>2</position>

</creators_name>

</creators_names>

<publication_date>(2009)</publication_date>

<publication_date_year>2009</publication_date_year>

<publication_date_month>3</publication_date_month>

<publication_date_day/>

<title><a target=”_blank” href=”http://eprints-dev.ulster.ac.uk/318″><em>The Development and Pilot Testing of an Instrument to Measure Nurses’ Working Environment: The Nursing Context Index</em></a></title>

<publication>WORLDVIEWS ON EVIDENCE-BASED NURSING</publication>

<volume>6</volume>

<number>3</number>

<pagerange>173-182</pagerange>

</eprint>

</eprints>

json

/publications/get/institute/Institute_of_Nursing_Research/type/article/render/json

[

{

“eprintid”:4,

“type”:”article”,

“creators”:”Switzer C and McDowell S”,

“publication_date”:”(2009)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>”,

“title”:”Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast”

“publication”:”Memory Studies”,

“volume”:”2″,

“number”:”3″,

“pagerange”:”337-353″

“citation”:”Switzer C and McDowell S (2009) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>. Memory Studies 2 (3). pp. 337-353.”

},

{

“eprintid”:48,

“type”:”article”,

“creators”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F”,

“publication_date”:”(2010)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>”,

“title”:”A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks”

“publication”:”Computers in Biology and Medicine”,

“volume”:”40″,

“number”:”3″,

“pagerange”:”306-317″

“citation”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F (2010) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>. Computers in Biology and Medicine 40 (3). pp. 306-317.”

}

]

Use the php function json_decode
if you need to turn the default json string into an array for additional processing.

publications – format

Citation format options are currently under review.
Please let us know if there is a particular format you require.
In the meantime, all publication citations will be returned
in the default format (the same format as displayed in the UIR).

Values

Default

If you do not specify the format parameter, the publication citations will be returned in
the default EPrints format.

Examples

Tips

publications – order

Fields to order on can be chained using the semicolon ; character.

Defaults

If you do not specify any order parameter, the publications will be returned
ordered by year of publication (descending), first author’s name (ascending) and
title (ascending).

If you specify an order without a flag, the default order is ascending.
Specify descending order by adding ,d after the field you want to sort on.

Values

Examples

year

/publications/get/email/an.academic@ulster.ac.uk/type/conference_item/order/year

returns all the conference contributions for an.academic@ulster.ac.uk sorted in ascending order by the
year of publication

NOTE: a list of the types for any given email can be retrieved using the types parameter
(see the types – mandatory section below for more information)

date,d

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/date,d

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by the
complete date of publication

NOTE: only the year part of the publication date is required when depositing an item in the
UIR, the month and day may not exist in the item metadata

year,d;name

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/year,d;name

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by year of
publication, and within the year, in ascending order of first author’s name

title

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/title

returns all the articles for an.academic@ulster.ac.uk sorted in ascending order of title
(useful for checking for possible duplicates)

types – mandatory parameters

The types controller will return a list of the item types for the
parameter(s) supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires at least one of the same mandatory parameters as publications (see
the publications – mandatory parameters section above).
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/types/get/email/an.academic@ulster.ac.uk all types which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/types/get/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation
/types/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

Please note

The word mandatory is not a parameter key.
See the publications – mandatory parameters section above for a
complete list of the current names for faculties, research institutes, etc.

item IDs – mandatory parameters

The itemids controller will return a list of the item IDs for the
Ulster email supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires a single mandatory parameter: a valid Ulster email.

Optionally, you can use the type parameter to get item IDs for a particular
type of item.

The same rendering options are available as for publications:
html (default), json and xml.

Examples

/itemids/get/email/an.academic@ulster.ac.uk all item IDs (and item types) which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/itemids/get/email/an.academic@ulster.ac.uk/type/article all item IDs for items of the specified type which have the email an.academic@ulster.ac.uk in the authors/creators metadata field


Digital Media





Web Services: EPrints (UIR)



How to use this web service

general

The UIR web service is called via a URL whose structure is explained below:

always required varies according to requirements
service address controller name controller action parameter key parameter value
https://webservices.ulster.ac.uk/uir /publications /get /email /an.academic@ulster.ac.uk
  /types      
  /itemids      
service address This is always the same, and must be used, for all calls to the UIR web service.
controller name
publications provides a list of publications depending on the combination of parameters (key/value pairs) specified
types

provides a list of item types used by an author
itemids

provides a list of item ids used by an author (can be filtered by type)

Features added in the future will be listed here and
in the UIR Developer Guide (login required).

controller action The types, publications and itemids controllers currently implement a get action.
parameter key Several parameters can be passed to a controller in order to specify the data required.
Email is one of the mandatory parameters.

See below for more information about parameter keys and valid values.
parameter value Each parameter key must have a corresponding value. For the key email,
the corresponding value must be an Ulster email in the format specified.

See below for more information about parameter keys and valid values.

Multiple parameter key/value pairs can be passed to the controller by
appending them as required to the URL, in any order.

There are five types of parameter which can be used to specify the publications
required, how they should be rendered (and in the future, what format citations should have).
Click the headings below for an explanation and examples of each.

publications – mandatory parameters

The UIR publications controller requires at least one of the mandatory parameters below.
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/publications/get/email/an.academic@ulster.ac.uk all publications which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/publications/get/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation
/publications/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

UIR codes

The names of Research Institutes and groups can change.
Less frequently, School and Faculty names may also change.
The webservice now publishes the UIR code for each of these entities.
The codes remain constant within the UIR so there will be no need to
update code when a name changes (although there may occasionally be a
new code added, for example, when a new group is created).

Codes are listed alongside institute, group, faculty and school names in the tabs below.
Both codes and names are drawn directly from the UIR and therefore are always up-to-date.

It is strongly recommended that you use the codes
rather than the names to retrieve items from the UIR.

Please note

The word mandatory is not a parameter key.
Use one of the following key words to specify a mandatory parameter.
Click on each key word to display its list of valid values.

Values

a valid Ulster staff member’s email

Tips

If you don’t get any results back for an email, and you are certain that
you are using a valid email, check for that person in the
Browse | Ulster Authors and Editors
section of the repository. If they are not listed there, they do not have any items live in the
repository.

Values

ri_ad Art_and_Design_Research_Institute
ri_hu Arts_and_Humanities_Research_Institute
ri_biomed Biomedical_Sciences_Research_Institute
ri_bue Built_Environment_Research_Institute
ri_bsm Business_and_Management_Research_Institute
ri_ms Centre_for_Media_Research
ri_cs Computer_Science_Research_Institute
ri_namr Engineering_Research_Institute
ri_es Environmental_Sciences_Research_Institute
ri_hrsri Health_and_Rehabilitation_Sciences_Research_Institute
ri_spri Institute_for_Research_in_Social_Sciences
ri_nur Institute_of_Nursing_and_Health_Research
ri_c Irish_and_Celtic_Studies_Research_Institute
ri_p Psychology_Research_Institute
ri_sprt Sport_and_Exercise_Sciences_Research_Institute
ri_tji Transitional_Justice_Institute

Examples

/publications/get/institute/Institute_of_Nursing_Research

/publications/get/institute/Sport_and_Exercise_Science_Research_Institute

/publications/get/institute/ri_sprt

Values

rig_hrsri_spic Activity_and_Enablement_(AE)
rig_namr_amfr Advanced_Metal_Forming
rig_ad_ac Art_and_Context
rig_ad_fa Art,_Conflict_and_Society
rig_cs_ai Artificial_Intelligence_and_Applications
rig_p_bn Behavioural_Neuroscience_and_Behaviour_Analysis
rig_nur_hrsrc Centre_for_Health_and_Rehabilitation_Technologies
rig_nur_ddch Centre_for_Intellectual_and_Developmental_Disabilities
rig_nur_mfiw Centre_for_Maternal,_Fetal_and_Infant_Research
rig_sprt_ph Centre_for_Physical_Activity_and_Health
rig_bue_crpp Centre_for_Research_on_Property_and_Planning_(RPP)
rig_sprt_sp Centre_for_Sport_in_Society
rig_sprt_sps Centre_for_Sports_Science_and_Sports_Medicine
rig_bue_cst Centre_for_Sustainable_Technologies_(CST)
rig_es_cm Coastal_Systems
rig_spri_c Communication
rig_hu_ca Creative_Arts_and_Technologies
rig_ad_aa Creative_Ecologies
rig_biomed_d Diabetes
rig_hrsri_diii Diabetic_Foot_-_Infection_-_Imaging_-_Intervention_(D3i)
rig_spri_ed Education
rig_nur_nepr Education_and_Professional_Issues_Research_Group
rig_namr_ecrc Engineering_Composites
rig_hu_en English
rig_bue_fsertc Fire_Safety_and_Engineering_Research_and_Technology_Centre_(FireSERT)
rig_es_f Freshwater_Sciences
rig_ad_d Future_and_Virtual_Worlds
rig_biomed_mo Genomic_Medicine
rig_es_g Geophysics
rig_nur_hpah Health_Promotion_and_Adolescent_Health
rig_p_hp Health,_Education_and_Well-being
rig_hu_h History
rig_bue_hsef Hydrogen_Safety_Engineering_and_Research_Centre_(HySAFER)
rig_biomed_ii Infection_and_Immunity/Microbiology
rig_cs_ise Information_and_Communication_Engineering
rig_cs_isrc Intelligent_Systems_Research_Centre
rig_spri_l Linguistics
rig_nur_mci Managing_Chronic_Illness_Research_Centre
rig_hrsri_mci Managing_Chronic_Illness_through_’Assisted_Living’
rig_es_ma Maritime_Archaeology
rig_hrsri_dm Medical_Imaging
rig_nur_mh Mental_Health
rig_hu_eu Modern_Languages
rig_hrsri_md Musculoskeletal_Disorder_(MSKD)_Rehabilitation
rigsg_mo_na Nano_Systems_Biology
rig_namr_nibec Nanotechnology_&_Integrated_BioEngineering_Centre_(NIBEC)
rig_hrsri_nr Neurorehabilitation_for_Health_(NRH)
rigsg_mo_nd Neuroscience_&_Neurodegenerative_Diseases
rig_biomed_niche Northern_Ireland_Centre_for_Food_and_Health_(NICHE)
rig_p_pc Peace,_Conflict_and_Equality
rig_nur_pcp Person-centred_Practice_Research_Centre
rig_biomed_psp Pharmaceutical_Science_and_Practice
rig_spri_p Politics_&_International_Studies
rig_p_msm Population_Health_Sciences_and_Mental_Health_Services
rig_p_pmh Psychotraumatology,_Mental_Health_&_Suicidal_Behaviour
rig_es_qec Quaternary_Environmental_Change
rig_hrsri_rcp Rehabilitation_in_Cancer_Patients
rig_hrsri_rrs Rehabilitation_in_Rheumatic_Sciences
rig_hrsri_rh Respiratory_Health
rig_cs_se Smart_Environments
rig_spri_sw Social_Work_&_Social_Policy
rig_es_s Society_and_Environment
rig_ad_sp Space_and_Place
rig_biomed_sm Stratified_Medicine
rig_bue_saber Studies_Allied_to_Built_Environment_Research_(SABER)
rig_es_t Terrestrial_Ecology
rig_p_bc The_Bamford_Centre_for_Mental_Health_and_Wellbeing
rigsg_mo_t Transcriptional_Regulation_&_Epigenetics
rigsg_mo_v Vascular_Medicine
rig_biomed_vs Vision

Examples

/publications/get/group/Coastal_Systems

/publications/get/group/Molecular_Medicine

Tips

Specifying a group applies the filter at a lower level
than institute.
If you specify both, the controller will return items at the institute level
(which should include the group level if the affiliations were applied correctly
when the item was deposited).

Values

fac_adbe Faculty_of_Art,_Design_and_the_Built_Environment
fac_arts Faculty_of_Arts
fac_ce Faculty_of_Computing_&_Engineering
fac_lhs Faculty_of_Life_and_Health_Sciences
fac_ss Faculty_of_Social_Sciences
fac_ubs Ulster_Business_School

Examples

/publications/get/faculty/Faculty_of_Arts

/publications/get/faculty/Ulster_Business_School

Values

sch_adbe_ad Belfast_School_of_Art
sch_ubs_bi Business_Institute
sch_ubs_da Department_of_Accounting,_Finance_and_Economics
sch_ubs_dbrfs Department_of_Business_and_Enterprise
sch_ubs_dhtm Department_of_Hospitality_and_Tourism_Management
sch_ubs_dib Department_of_International_Business
sch_ubs_dm Department_of_Management_and_Leadership
sch_ubs_dmes Department_of_Marketing,_Entrepreneurship_and_Strategy
sch_ss_gsp Graduate_School_of_Professional_Legal_Education
sch_ss_inc INCORE
sch_arts_iuss Institute_of_Ulster_Scots_Studies
sch_adbe_x_rgs Research_Graduate_School
sch_arts_x_rgs Research_Graduate_School
sch_ce_x_rgs Research_Graduate_School
sch_lhs_x_rgs Research_Graduate_School
sch_ubs_x_rgs Research_Graduate_School
sch_ss_x_rgs Research_Graduate_School_(Social_Sciences)
sch_lhs_bs School_of_Biomedical_Sciences
sch_ss_c School_of_Communication
sch_ce_cie School_of_Computing_and_Information_Engineering
sch_ce_cis School_of_Computing_and_Intelligent_Systems
sch_ce_cm School_of_Computing_and_Mathematics
sch_arts_ca School_of_Creative_Arts_and_Technologies
sch_ss_ps School_of_Criminology,_Politics_and_Social_Policy
sch_ss_ed School_of_Education
sch_ce_eme School_of_Engineering
sch_arts_hia School_of_English_and_History
sch_lhs_es School_of_Geography_and_Environmental_Sciences
sch_lhs_hs School_of_Health_Sciences
sch_arts_i School_of_Irish_Language_and_Literature
sch_ss_l School_of_Law
sch_arts_mfj School_of_Media,_Film_&_Journalism
sch_arts_ll School_of_Modern_Languages
sch_lhs_n School_of_Nursing
sch_lhs_pps School_of_Pharmacy_and_Pharmaceutical_Science
sch_lhs_p School_of_Psychology
sch_ss_sass School_of_Sociology_and_Applied_Social_Studies
sch_lhs_ss School_of_Sport
sch_adbe_be School_of_the_Built_Environment
sch_adbe_arc The_Belfast_School_of_Architecture

Examples

/publications/get/school/School_of_Communication

/publications/get/school/School_of_Sports_Studies

Tips

As for institute/group combinations, specifying a school applies the filter
at a lower level than faculty, therefore you should not specify the parent faculty
if you only want the group publications.
If you specify both, the service will return items at the faculty level.

publications – type

You can specify which type(s) of items you want the web service to return, or to exclude.

Type names

artefact
article
body_of_work
book_authored
book_edited
book_section
composition
conference_item
confidential_report_external
design
device
digital_media
exhibition
installation
internet_publication
other
patent
performance
research_report_external
scholarly_edition
software
thesis

Default

If you do not use the type parameter, all item types will be returned.

Examples

/publications/get/school/School_of_Law/type/article

/publications/get/school/sch_ss_l/type/book_edited,book_section

/publications/get/school/sch_ss_l/type/-article

Tips

If you specify one item type, the service will return only items of that type.

You can specify more than one item type by separating the values with commas. The service will return items of those types.

You can exclude a particular item type by prefixing the value of the parameter with a minus-sign.

publications – render

You can specify how the data will be rendered, according to your preference
for any processing you want to do with the publications data before displaying
it on the target web page.

The json and xml rendering options return additional data that may be useful for
any custom processing you want to do. For example, the creators’ names are
returned in a separate structure in addition to as a list.

The web service has the following options for how the data will be rendered.
Please note, the examples below are for illustration only.
Additional fields may be added if required in the future.

Values

Examples

html

/publications/get/email/an.academic@ulster.ac.uk/render/html

HTML is the default option if you do not specify a render parameter.


The HTML returned will have the same format as the UIR author_by_email view.

xml

/publications/get/email/an.academic@ulster.ac.uk/type/article/render/xml

<eprints>

<eprint>

<eprintid>318</eprintid>

<type>article</type>

<creators>Smith A, Academic AN and Another S</creators>

<creators_names>

<creators_name>

<family>Smith</family>

<given>A</given>

<position>0</position>

</creators_name>

<creators_name>

<family>Academic</family>

<given>AN</given>

<position>1</position>

</creators_name>

<creators_name>

<family>Another</family>

<given>S</given>

<position>2</position>

</creators_name>

</creators_names>

<publication_date>(2009)</publication_date>

<publication_date_year>2009</publication_date_year>

<publication_date_month>3</publication_date_month>

<publication_date_day/>

<title><a target=”_blank” href=”http://eprints-dev.ulster.ac.uk/318″><em>The Development and Pilot Testing of an Instrument to Measure Nurses’ Working Environment: The Nursing Context Index</em></a></title>

<publication>WORLDVIEWS ON EVIDENCE-BASED NURSING</publication>

<volume>6</volume>

<number>3</number>

<pagerange>173-182</pagerange>

</eprint>

</eprints>

json

/publications/get/institute/Institute_of_Nursing_Research/type/article/render/json

[

{

“eprintid”:4,

“type”:”article”,

“creators”:”Switzer C and McDowell S”,

“publication_date”:”(2009)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>”,

“title”:”Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast”

“publication”:”Memory Studies”,

“volume”:”2″,

“number”:”3″,

“pagerange”:”337-353″

“citation”:”Switzer C and McDowell S (2009) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>. Memory Studies 2 (3). pp. 337-353.”

},

{

“eprintid”:48,

“type”:”article”,

“creators”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F”,

“publication_date”:”(2010)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>”,

“title”:”A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks”

“publication”:”Computers in Biology and Medicine”,

“volume”:”40″,

“number”:”3″,

“pagerange”:”306-317″

“citation”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F (2010) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>. Computers in Biology and Medicine 40 (3). pp. 306-317.”

}

]

Use the php function json_decode
if you need to turn the default json string into an array for additional processing.

publications – format

Citation format options are currently under review.
Please let us know if there is a particular format you require.
In the meantime, all publication citations will be returned
in the default format (the same format as displayed in the UIR).

Values

Default

If you do not specify the format parameter, the publication citations will be returned in
the default EPrints format.

Examples

Tips

publications – order

Fields to order on can be chained using the semicolon ; character.

Defaults

If you do not specify any order parameter, the publications will be returned
ordered by year of publication (descending), first author’s name (ascending) and
title (ascending).

If you specify an order without a flag, the default order is ascending.
Specify descending order by adding ,d after the field you want to sort on.

Values

Examples

year

/publications/get/email/an.academic@ulster.ac.uk/type/conference_item/order/year

returns all the conference contributions for an.academic@ulster.ac.uk sorted in ascending order by the
year of publication

NOTE: a list of the types for any given email can be retrieved using the types parameter
(see the types – mandatory section below for more information)

date,d

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/date,d

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by the
complete date of publication

NOTE: only the year part of the publication date is required when depositing an item in the
UIR, the month and day may not exist in the item metadata

year,d;name

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/year,d;name

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by year of
publication, and within the year, in ascending order of first author’s name

title

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/title

returns all the articles for an.academic@ulster.ac.uk sorted in ascending order of title
(useful for checking for possible duplicates)

types – mandatory parameters

The types controller will return a list of the item types for the
parameter(s) supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires at least one of the same mandatory parameters as publications (see
the publications – mandatory parameters section above).
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/types/get/email/an.academic@ulster.ac.uk all types which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/types/get/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation
/types/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

Please note

The word mandatory is not a parameter key.
See the publications – mandatory parameters section above for a
complete list of the current names for faculties, research institutes, etc.

item IDs – mandatory parameters

The itemids controller will return a list of the item IDs for the
Ulster email supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires a single mandatory parameter: a valid Ulster email.

Optionally, you can use the type parameter to get item IDs for a particular
type of item.

The same rendering options are available as for publications:
html (default), json and xml.

Examples

/itemids/get/email/an.academic@ulster.ac.uk all item IDs (and item types) which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/itemids/get/email/an.academic@ulster.ac.uk/type/article all item IDs for items of the specified type which have the email an.academic@ulster.ac.uk in the authors/creators metadata field


Exhibition





Web Services: EPrints (UIR)



How to use this web service

general

The UIR web service is called via a URL whose structure is explained below:

always required varies according to requirements
service address controller name controller action parameter key parameter value
https://webservices.ulster.ac.uk/uir /publications /get /email /an.academic@ulster.ac.uk
  /types      
  /itemids      
service address This is always the same, and must be used, for all calls to the UIR web service.
controller name
publications provides a list of publications depending on the combination of parameters (key/value pairs) specified
types

provides a list of item types used by an author
itemids

provides a list of item ids used by an author (can be filtered by type)

Features added in the future will be listed here and
in the UIR Developer Guide (login required).

controller action The types, publications and itemids controllers currently implement a get action.
parameter key Several parameters can be passed to a controller in order to specify the data required.
Email is one of the mandatory parameters.

See below for more information about parameter keys and valid values.
parameter value Each parameter key must have a corresponding value. For the key email,
the corresponding value must be an Ulster email in the format specified.

See below for more information about parameter keys and valid values.

Multiple parameter key/value pairs can be passed to the controller by
appending them as required to the URL, in any order.

There are five types of parameter which can be used to specify the publications
required, how they should be rendered (and in the future, what format citations should have).
Click the headings below for an explanation and examples of each.

publications – mandatory parameters

The UIR publications controller requires at least one of the mandatory parameters below.
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/publications/get/email/an.academic@ulster.ac.uk all publications which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/publications/get/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation
/publications/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

UIR codes

The names of Research Institutes and groups can change.
Less frequently, School and Faculty names may also change.
The webservice now publishes the UIR code for each of these entities.
The codes remain constant within the UIR so there will be no need to
update code when a name changes (although there may occasionally be a
new code added, for example, when a new group is created).

Codes are listed alongside institute, group, faculty and school names in the tabs below.
Both codes and names are drawn directly from the UIR and therefore are always up-to-date.

It is strongly recommended that you use the codes
rather than the names to retrieve items from the UIR.

Please note

The word mandatory is not a parameter key.
Use one of the following key words to specify a mandatory parameter.
Click on each key word to display its list of valid values.

Values

a valid Ulster staff member’s email

Tips

If you don’t get any results back for an email, and you are certain that
you are using a valid email, check for that person in the
Browse | Ulster Authors and Editors
section of the repository. If they are not listed there, they do not have any items live in the
repository.

Values

ri_ad Art_and_Design_Research_Institute
ri_hu Arts_and_Humanities_Research_Institute
ri_biomed Biomedical_Sciences_Research_Institute
ri_bue Built_Environment_Research_Institute
ri_bsm Business_and_Management_Research_Institute
ri_ms Centre_for_Media_Research
ri_cs Computer_Science_Research_Institute
ri_namr Engineering_Research_Institute
ri_es Environmental_Sciences_Research_Institute
ri_hrsri Health_and_Rehabilitation_Sciences_Research_Institute
ri_spri Institute_for_Research_in_Social_Sciences
ri_nur Institute_of_Nursing_and_Health_Research
ri_c Irish_and_Celtic_Studies_Research_Institute
ri_p Psychology_Research_Institute
ri_sprt Sport_and_Exercise_Sciences_Research_Institute
ri_tji Transitional_Justice_Institute

Examples

/publications/get/institute/Institute_of_Nursing_Research

/publications/get/institute/Sport_and_Exercise_Science_Research_Institute

/publications/get/institute/ri_sprt

Values

rig_hrsri_spic Activity_and_Enablement_(AE)
rig_namr_amfr Advanced_Metal_Forming
rig_ad_ac Art_and_Context
rig_ad_fa Art,_Conflict_and_Society
rig_cs_ai Artificial_Intelligence_and_Applications
rig_p_bn Behavioural_Neuroscience_and_Behaviour_Analysis
rig_nur_hrsrc Centre_for_Health_and_Rehabilitation_Technologies
rig_nur_ddch Centre_for_Intellectual_and_Developmental_Disabilities
rig_nur_mfiw Centre_for_Maternal,_Fetal_and_Infant_Research
rig_sprt_ph Centre_for_Physical_Activity_and_Health
rig_bue_crpp Centre_for_Research_on_Property_and_Planning_(RPP)
rig_sprt_sp Centre_for_Sport_in_Society
rig_sprt_sps Centre_for_Sports_Science_and_Sports_Medicine
rig_bue_cst Centre_for_Sustainable_Technologies_(CST)
rig_es_cm Coastal_Systems
rig_spri_c Communication
rig_hu_ca Creative_Arts_and_Technologies
rig_ad_aa Creative_Ecologies
rig_biomed_d Diabetes
rig_hrsri_diii Diabetic_Foot_-_Infection_-_Imaging_-_Intervention_(D3i)
rig_spri_ed Education
rig_nur_nepr Education_and_Professional_Issues_Research_Group
rig_namr_ecrc Engineering_Composites
rig_hu_en English
rig_bue_fsertc Fire_Safety_and_Engineering_Research_and_Technology_Centre_(FireSERT)
rig_es_f Freshwater_Sciences
rig_ad_d Future_and_Virtual_Worlds
rig_biomed_mo Genomic_Medicine
rig_es_g Geophysics
rig_nur_hpah Health_Promotion_and_Adolescent_Health
rig_p_hp Health,_Education_and_Well-being
rig_hu_h History
rig_bue_hsef Hydrogen_Safety_Engineering_and_Research_Centre_(HySAFER)
rig_biomed_ii Infection_and_Immunity/Microbiology
rig_cs_ise Information_and_Communication_Engineering
rig_cs_isrc Intelligent_Systems_Research_Centre
rig_spri_l Linguistics
rig_nur_mci Managing_Chronic_Illness_Research_Centre
rig_hrsri_mci Managing_Chronic_Illness_through_’Assisted_Living’
rig_es_ma Maritime_Archaeology
rig_hrsri_dm Medical_Imaging
rig_nur_mh Mental_Health
rig_hu_eu Modern_Languages
rig_hrsri_md Musculoskeletal_Disorder_(MSKD)_Rehabilitation
rigsg_mo_na Nano_Systems_Biology
rig_namr_nibec Nanotechnology_&_Integrated_BioEngineering_Centre_(NIBEC)
rig_hrsri_nr Neurorehabilitation_for_Health_(NRH)
rigsg_mo_nd Neuroscience_&_Neurodegenerative_Diseases
rig_biomed_niche Northern_Ireland_Centre_for_Food_and_Health_(NICHE)
rig_p_pc Peace,_Conflict_and_Equality
rig_nur_pcp Person-centred_Practice_Research_Centre
rig_biomed_psp Pharmaceutical_Science_and_Practice
rig_spri_p Politics_&_International_Studies
rig_p_msm Population_Health_Sciences_and_Mental_Health_Services
rig_p_pmh Psychotraumatology,_Mental_Health_&_Suicidal_Behaviour
rig_es_qec Quaternary_Environmental_Change
rig_hrsri_rcp Rehabilitation_in_Cancer_Patients
rig_hrsri_rrs Rehabilitation_in_Rheumatic_Sciences
rig_hrsri_rh Respiratory_Health
rig_cs_se Smart_Environments
rig_spri_sw Social_Work_&_Social_Policy
rig_es_s Society_and_Environment
rig_ad_sp Space_and_Place
rig_biomed_sm Stratified_Medicine
rig_bue_saber Studies_Allied_to_Built_Environment_Research_(SABER)
rig_es_t Terrestrial_Ecology
rig_p_bc The_Bamford_Centre_for_Mental_Health_and_Wellbeing
rigsg_mo_t Transcriptional_Regulation_&_Epigenetics
rigsg_mo_v Vascular_Medicine
rig_biomed_vs Vision

Examples

/publications/get/group/Coastal_Systems

/publications/get/group/Molecular_Medicine

Tips

Specifying a group applies the filter at a lower level
than institute.
If you specify both, the controller will return items at the institute level
(which should include the group level if the affiliations were applied correctly
when the item was deposited).

Values

fac_adbe Faculty_of_Art,_Design_and_the_Built_Environment
fac_arts Faculty_of_Arts
fac_ce Faculty_of_Computing_&_Engineering
fac_lhs Faculty_of_Life_and_Health_Sciences
fac_ss Faculty_of_Social_Sciences
fac_ubs Ulster_Business_School

Examples

/publications/get/faculty/Faculty_of_Arts

/publications/get/faculty/Ulster_Business_School

Values

sch_adbe_ad Belfast_School_of_Art
sch_ubs_bi Business_Institute
sch_ubs_da Department_of_Accounting,_Finance_and_Economics
sch_ubs_dbrfs Department_of_Business_and_Enterprise
sch_ubs_dhtm Department_of_Hospitality_and_Tourism_Management
sch_ubs_dib Department_of_International_Business
sch_ubs_dm Department_of_Management_and_Leadership
sch_ubs_dmes Department_of_Marketing,_Entrepreneurship_and_Strategy
sch_ss_gsp Graduate_School_of_Professional_Legal_Education
sch_ss_inc INCORE
sch_arts_iuss Institute_of_Ulster_Scots_Studies
sch_adbe_x_rgs Research_Graduate_School
sch_arts_x_rgs Research_Graduate_School
sch_ce_x_rgs Research_Graduate_School
sch_lhs_x_rgs Research_Graduate_School
sch_ubs_x_rgs Research_Graduate_School
sch_ss_x_rgs Research_Graduate_School_(Social_Sciences)
sch_lhs_bs School_of_Biomedical_Sciences
sch_ss_c School_of_Communication
sch_ce_cie School_of_Computing_and_Information_Engineering
sch_ce_cis School_of_Computing_and_Intelligent_Systems
sch_ce_cm School_of_Computing_and_Mathematics
sch_arts_ca School_of_Creative_Arts_and_Technologies
sch_ss_ps School_of_Criminology,_Politics_and_Social_Policy
sch_ss_ed School_of_Education
sch_ce_eme School_of_Engineering
sch_arts_hia School_of_English_and_History
sch_lhs_es School_of_Geography_and_Environmental_Sciences
sch_lhs_hs School_of_Health_Sciences
sch_arts_i School_of_Irish_Language_and_Literature
sch_ss_l School_of_Law
sch_arts_mfj School_of_Media,_Film_&_Journalism
sch_arts_ll School_of_Modern_Languages
sch_lhs_n School_of_Nursing
sch_lhs_pps School_of_Pharmacy_and_Pharmaceutical_Science
sch_lhs_p School_of_Psychology
sch_ss_sass School_of_Sociology_and_Applied_Social_Studies
sch_lhs_ss School_of_Sport
sch_adbe_be School_of_the_Built_Environment
sch_adbe_arc The_Belfast_School_of_Architecture

Examples

/publications/get/school/School_of_Communication

/publications/get/school/School_of_Sports_Studies

Tips

As for institute/group combinations, specifying a school applies the filter
at a lower level than faculty, therefore you should not specify the parent faculty
if you only want the group publications.
If you specify both, the service will return items at the faculty level.

publications – type

You can specify which type(s) of items you want the web service to return, or to exclude.

Type names

artefact
article
body_of_work
book_authored
book_edited
book_section
composition
conference_item
confidential_report_external
design
device
digital_media
exhibition
installation
internet_publication
other
patent
performance
research_report_external
scholarly_edition
software
thesis

Default

If you do not use the type parameter, all item types will be returned.

Examples

/publications/get/school/School_of_Law/type/article

/publications/get/school/sch_ss_l/type/book_edited,book_section

/publications/get/school/sch_ss_l/type/-article

Tips

If you specify one item type, the service will return only items of that type.

You can specify more than one item type by separating the values with commas. The service will return items of those types.

You can exclude a particular item type by prefixing the value of the parameter with a minus-sign.

publications – render

You can specify how the data will be rendered, according to your preference
for any processing you want to do with the publications data before displaying
it on the target web page.

The json and xml rendering options return additional data that may be useful for
any custom processing you want to do. For example, the creators’ names are
returned in a separate structure in addition to as a list.

The web service has the following options for how the data will be rendered.
Please note, the examples below are for illustration only.
Additional fields may be added if required in the future.

Values

Examples

html

/publications/get/email/an.academic@ulster.ac.uk/render/html

HTML is the default option if you do not specify a render parameter.


The HTML returned will have the same format as the UIR author_by_email view.

xml

/publications/get/email/an.academic@ulster.ac.uk/type/article/render/xml

<eprints>

<eprint>

<eprintid>318</eprintid>

<type>article</type>

<creators>Smith A, Academic AN and Another S</creators>

<creators_names>

<creators_name>

<family>Smith</family>

<given>A</given>

<position>0</position>

</creators_name>

<creators_name>

<family>Academic</family>

<given>AN</given>

<position>1</position>

</creators_name>

<creators_name>

<family>Another</family>

<given>S</given>

<position>2</position>

</creators_name>

</creators_names>

<publication_date>(2009)</publication_date>

<publication_date_year>2009</publication_date_year>

<publication_date_month>3</publication_date_month>

<publication_date_day/>

<title><a target=”_blank” href=”http://eprints-dev.ulster.ac.uk/318″><em>The Development and Pilot Testing of an Instrument to Measure Nurses’ Working Environment: The Nursing Context Index</em></a></title>

<publication>WORLDVIEWS ON EVIDENCE-BASED NURSING</publication>

<volume>6</volume>

<number>3</number>

<pagerange>173-182</pagerange>

</eprint>

</eprints>

json

/publications/get/institute/Institute_of_Nursing_Research/type/article/render/json

[

{

“eprintid”:4,

“type”:”article”,

“creators”:”Switzer C and McDowell S”,

“publication_date”:”(2009)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>”,

“title”:”Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast”

“publication”:”Memory Studies”,

“volume”:”2″,

“number”:”3″,

“pagerange”:”337-353″

“citation”:”Switzer C and McDowell S (2009) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>. Memory Studies 2 (3). pp. 337-353.”

},

{

“eprintid”:48,

“type”:”article”,

“creators”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F”,

“publication_date”:”(2010)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>”,

“title”:”A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks”

“publication”:”Computers in Biology and Medicine”,

“volume”:”40″,

“number”:”3″,

“pagerange”:”306-317″

“citation”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F (2010) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>. Computers in Biology and Medicine 40 (3). pp. 306-317.”

}

]

Use the php function json_decode
if you need to turn the default json string into an array for additional processing.

publications – format

Citation format options are currently under review.
Please let us know if there is a particular format you require.
In the meantime, all publication citations will be returned
in the default format (the same format as displayed in the UIR).

Values

Default

If you do not specify the format parameter, the publication citations will be returned in
the default EPrints format.

Examples

Tips

publications – order

Fields to order on can be chained using the semicolon ; character.

Defaults

If you do not specify any order parameter, the publications will be returned
ordered by year of publication (descending), first author’s name (ascending) and
title (ascending).

If you specify an order without a flag, the default order is ascending.
Specify descending order by adding ,d after the field you want to sort on.

Values

Examples

year

/publications/get/email/an.academic@ulster.ac.uk/type/conference_item/order/year

returns all the conference contributions for an.academic@ulster.ac.uk sorted in ascending order by the
year of publication

NOTE: a list of the types for any given email can be retrieved using the types parameter
(see the types – mandatory section below for more information)

date,d

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/date,d

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by the
complete date of publication

NOTE: only the year part of the publication date is required when depositing an item in the
UIR, the month and day may not exist in the item metadata

year,d;name

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/year,d;name

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by year of
publication, and within the year, in ascending order of first author’s name

title

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/title

returns all the articles for an.academic@ulster.ac.uk sorted in ascending order of title
(useful for checking for possible duplicates)

types – mandatory parameters

The types controller will return a list of the item types for the
parameter(s) supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires at least one of the same mandatory parameters as publications (see
the publications – mandatory parameters section above).
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/types/get/email/an.academic@ulster.ac.uk all types which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/types/get/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation
/types/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

Please note

The word mandatory is not a parameter key.
See the publications – mandatory parameters section above for a
complete list of the current names for faculties, research institutes, etc.

item IDs – mandatory parameters

The itemids controller will return a list of the item IDs for the
Ulster email supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires a single mandatory parameter: a valid Ulster email.

Optionally, you can use the type parameter to get item IDs for a particular
type of item.

The same rendering options are available as for publications:
html (default), json and xml.

Examples

/itemids/get/email/an.academic@ulster.ac.uk all item IDs (and item types) which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/itemids/get/email/an.academic@ulster.ac.uk/type/article all item IDs for items of the specified type which have the email an.academic@ulster.ac.uk in the authors/creators metadata field


Installations





Web Services: EPrints (UIR)



How to use this web service

general

The UIR web service is called via a URL whose structure is explained below:

always required varies according to requirements
service address controller name controller action parameter key parameter value
https://webservices.ulster.ac.uk/uir /publications /get /email /an.academic@ulster.ac.uk
  /types      
  /itemids      
service address This is always the same, and must be used, for all calls to the UIR web service.
controller name
publications provides a list of publications depending on the combination of parameters (key/value pairs) specified
types

provides a list of item types used by an author
itemids

provides a list of item ids used by an author (can be filtered by type)

Features added in the future will be listed here and
in the UIR Developer Guide (login required).

controller action The types, publications and itemids controllers currently implement a get action.
parameter key Several parameters can be passed to a controller in order to specify the data required.
Email is one of the mandatory parameters.

See below for more information about parameter keys and valid values.
parameter value Each parameter key must have a corresponding value. For the key email,
the corresponding value must be an Ulster email in the format specified.

See below for more information about parameter keys and valid values.

Multiple parameter key/value pairs can be passed to the controller by
appending them as required to the URL, in any order.

There are five types of parameter which can be used to specify the publications
required, how they should be rendered (and in the future, what format citations should have).
Click the headings below for an explanation and examples of each.

publications – mandatory parameters

The UIR publications controller requires at least one of the mandatory parameters below.
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/publications/get/email/an.academic@ulster.ac.uk all publications which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/publications/get/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation
/publications/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

UIR codes

The names of Research Institutes and groups can change.
Less frequently, School and Faculty names may also change.
The webservice now publishes the UIR code for each of these entities.
The codes remain constant within the UIR so there will be no need to
update code when a name changes (although there may occasionally be a
new code added, for example, when a new group is created).

Codes are listed alongside institute, group, faculty and school names in the tabs below.
Both codes and names are drawn directly from the UIR and therefore are always up-to-date.

It is strongly recommended that you use the codes
rather than the names to retrieve items from the UIR.

Please note

The word mandatory is not a parameter key.
Use one of the following key words to specify a mandatory parameter.
Click on each key word to display its list of valid values.

Values

a valid Ulster staff member’s email

Tips

If you don’t get any results back for an email, and you are certain that
you are using a valid email, check for that person in the
Browse | Ulster Authors and Editors
section of the repository. If they are not listed there, they do not have any items live in the
repository.

Values

ri_ad Art_and_Design_Research_Institute
ri_hu Arts_and_Humanities_Research_Institute
ri_biomed Biomedical_Sciences_Research_Institute
ri_bue Built_Environment_Research_Institute
ri_bsm Business_and_Management_Research_Institute
ri_ms Centre_for_Media_Research
ri_cs Computer_Science_Research_Institute
ri_namr Engineering_Research_Institute
ri_es Environmental_Sciences_Research_Institute
ri_hrsri Health_and_Rehabilitation_Sciences_Research_Institute
ri_spri Institute_for_Research_in_Social_Sciences
ri_nur Institute_of_Nursing_and_Health_Research
ri_c Irish_and_Celtic_Studies_Research_Institute
ri_p Psychology_Research_Institute
ri_sprt Sport_and_Exercise_Sciences_Research_Institute
ri_tji Transitional_Justice_Institute

Examples

/publications/get/institute/Institute_of_Nursing_Research

/publications/get/institute/Sport_and_Exercise_Science_Research_Institute

/publications/get/institute/ri_sprt

Values

rig_hrsri_spic Activity_and_Enablement_(AE)
rig_namr_amfr Advanced_Metal_Forming
rig_ad_ac Art_and_Context
rig_ad_fa Art,_Conflict_and_Society
rig_cs_ai Artificial_Intelligence_and_Applications
rig_p_bn Behavioural_Neuroscience_and_Behaviour_Analysis
rig_nur_hrsrc Centre_for_Health_and_Rehabilitation_Technologies
rig_nur_ddch Centre_for_Intellectual_and_Developmental_Disabilities
rig_nur_mfiw Centre_for_Maternal,_Fetal_and_Infant_Research
rig_sprt_ph Centre_for_Physical_Activity_and_Health
rig_bue_crpp Centre_for_Research_on_Property_and_Planning_(RPP)
rig_sprt_sp Centre_for_Sport_in_Society
rig_sprt_sps Centre_for_Sports_Science_and_Sports_Medicine
rig_bue_cst Centre_for_Sustainable_Technologies_(CST)
rig_es_cm Coastal_Systems
rig_spri_c Communication
rig_hu_ca Creative_Arts_and_Technologies
rig_ad_aa Creative_Ecologies
rig_biomed_d Diabetes
rig_hrsri_diii Diabetic_Foot_-_Infection_-_Imaging_-_Intervention_(D3i)
rig_spri_ed Education
rig_nur_nepr Education_and_Professional_Issues_Research_Group
rig_namr_ecrc Engineering_Composites
rig_hu_en English
rig_bue_fsertc Fire_Safety_and_Engineering_Research_and_Technology_Centre_(FireSERT)
rig_es_f Freshwater_Sciences
rig_ad_d Future_and_Virtual_Worlds
rig_biomed_mo Genomic_Medicine
rig_es_g Geophysics
rig_nur_hpah Health_Promotion_and_Adolescent_Health
rig_p_hp Health,_Education_and_Well-being
rig_hu_h History
rig_bue_hsef Hydrogen_Safety_Engineering_and_Research_Centre_(HySAFER)
rig_biomed_ii Infection_and_Immunity/Microbiology
rig_cs_ise Information_and_Communication_Engineering
rig_cs_isrc Intelligent_Systems_Research_Centre
rig_spri_l Linguistics
rig_nur_mci Managing_Chronic_Illness_Research_Centre
rig_hrsri_mci Managing_Chronic_Illness_through_’Assisted_Living’
rig_es_ma Maritime_Archaeology
rig_hrsri_dm Medical_Imaging
rig_nur_mh Mental_Health
rig_hu_eu Modern_Languages
rig_hrsri_md Musculoskeletal_Disorder_(MSKD)_Rehabilitation
rigsg_mo_na Nano_Systems_Biology
rig_namr_nibec Nanotechnology_&_Integrated_BioEngineering_Centre_(NIBEC)
rig_hrsri_nr Neurorehabilitation_for_Health_(NRH)
rigsg_mo_nd Neuroscience_&_Neurodegenerative_Diseases
rig_biomed_niche Northern_Ireland_Centre_for_Food_and_Health_(NICHE)
rig_p_pc Peace,_Conflict_and_Equality
rig_nur_pcp Person-centred_Practice_Research_Centre
rig_biomed_psp Pharmaceutical_Science_and_Practice
rig_spri_p Politics_&_International_Studies
rig_p_msm Population_Health_Sciences_and_Mental_Health_Services
rig_p_pmh Psychotraumatology,_Mental_Health_&_Suicidal_Behaviour
rig_es_qec Quaternary_Environmental_Change
rig_hrsri_rcp Rehabilitation_in_Cancer_Patients
rig_hrsri_rrs Rehabilitation_in_Rheumatic_Sciences
rig_hrsri_rh Respiratory_Health
rig_cs_se Smart_Environments
rig_spri_sw Social_Work_&_Social_Policy
rig_es_s Society_and_Environment
rig_ad_sp Space_and_Place
rig_biomed_sm Stratified_Medicine
rig_bue_saber Studies_Allied_to_Built_Environment_Research_(SABER)
rig_es_t Terrestrial_Ecology
rig_p_bc The_Bamford_Centre_for_Mental_Health_and_Wellbeing
rigsg_mo_t Transcriptional_Regulation_&_Epigenetics
rigsg_mo_v Vascular_Medicine
rig_biomed_vs Vision

Examples

/publications/get/group/Coastal_Systems

/publications/get/group/Molecular_Medicine

Tips

Specifying a group applies the filter at a lower level
than institute.
If you specify both, the controller will return items at the institute level
(which should include the group level if the affiliations were applied correctly
when the item was deposited).

Values

fac_adbe Faculty_of_Art,_Design_and_the_Built_Environment
fac_arts Faculty_of_Arts
fac_ce Faculty_of_Computing_&_Engineering
fac_lhs Faculty_of_Life_and_Health_Sciences
fac_ss Faculty_of_Social_Sciences
fac_ubs Ulster_Business_School

Examples

/publications/get/faculty/Faculty_of_Arts

/publications/get/faculty/Ulster_Business_School

Values

sch_adbe_ad Belfast_School_of_Art
sch_ubs_bi Business_Institute
sch_ubs_da Department_of_Accounting,_Finance_and_Economics
sch_ubs_dbrfs Department_of_Business_and_Enterprise
sch_ubs_dhtm Department_of_Hospitality_and_Tourism_Management
sch_ubs_dib Department_of_International_Business
sch_ubs_dm Department_of_Management_and_Leadership
sch_ubs_dmes Department_of_Marketing,_Entrepreneurship_and_Strategy
sch_ss_gsp Graduate_School_of_Professional_Legal_Education
sch_ss_inc INCORE
sch_arts_iuss Institute_of_Ulster_Scots_Studies
sch_adbe_x_rgs Research_Graduate_School
sch_arts_x_rgs Research_Graduate_School
sch_ce_x_rgs Research_Graduate_School
sch_lhs_x_rgs Research_Graduate_School
sch_ubs_x_rgs Research_Graduate_School
sch_ss_x_rgs Research_Graduate_School_(Social_Sciences)
sch_lhs_bs School_of_Biomedical_Sciences
sch_ss_c School_of_Communication
sch_ce_cie School_of_Computing_and_Information_Engineering
sch_ce_cis School_of_Computing_and_Intelligent_Systems
sch_ce_cm School_of_Computing_and_Mathematics
sch_arts_ca School_of_Creative_Arts_and_Technologies
sch_ss_ps School_of_Criminology,_Politics_and_Social_Policy
sch_ss_ed School_of_Education
sch_ce_eme School_of_Engineering
sch_arts_hia School_of_English_and_History
sch_lhs_es School_of_Geography_and_Environmental_Sciences
sch_lhs_hs School_of_Health_Sciences
sch_arts_i School_of_Irish_Language_and_Literature
sch_ss_l School_of_Law
sch_arts_mfj School_of_Media,_Film_&_Journalism
sch_arts_ll School_of_Modern_Languages
sch_lhs_n School_of_Nursing
sch_lhs_pps School_of_Pharmacy_and_Pharmaceutical_Science
sch_lhs_p School_of_Psychology
sch_ss_sass School_of_Sociology_and_Applied_Social_Studies
sch_lhs_ss School_of_Sport
sch_adbe_be School_of_the_Built_Environment
sch_adbe_arc The_Belfast_School_of_Architecture

Examples

/publications/get/school/School_of_Communication

/publications/get/school/School_of_Sports_Studies

Tips

As for institute/group combinations, specifying a school applies the filter
at a lower level than faculty, therefore you should not specify the parent faculty
if you only want the group publications.
If you specify both, the service will return items at the faculty level.

publications – type

You can specify which type(s) of items you want the web service to return, or to exclude.

Type names

artefact
article
body_of_work
book_authored
book_edited
book_section
composition
conference_item
confidential_report_external
design
device
digital_media
exhibition
installation
internet_publication
other
patent
performance
research_report_external
scholarly_edition
software
thesis

Default

If you do not use the type parameter, all item types will be returned.

Examples

/publications/get/school/School_of_Law/type/article

/publications/get/school/sch_ss_l/type/book_edited,book_section

/publications/get/school/sch_ss_l/type/-article

Tips

If you specify one item type, the service will return only items of that type.

You can specify more than one item type by separating the values with commas. The service will return items of those types.

You can exclude a particular item type by prefixing the value of the parameter with a minus-sign.

publications – render

You can specify how the data will be rendered, according to your preference
for any processing you want to do with the publications data before displaying
it on the target web page.

The json and xml rendering options return additional data that may be useful for
any custom processing you want to do. For example, the creators’ names are
returned in a separate structure in addition to as a list.

The web service has the following options for how the data will be rendered.
Please note, the examples below are for illustration only.
Additional fields may be added if required in the future.

Values

Examples

html

/publications/get/email/an.academic@ulster.ac.uk/render/html

HTML is the default option if you do not specify a render parameter.


The HTML returned will have the same format as the UIR author_by_email view.

xml

/publications/get/email/an.academic@ulster.ac.uk/type/article/render/xml

<eprints>

<eprint>

<eprintid>318</eprintid>

<type>article</type>

<creators>Smith A, Academic AN and Another S</creators>

<creators_names>

<creators_name>

<family>Smith</family>

<given>A</given>

<position>0</position>

</creators_name>

<creators_name>

<family>Academic</family>

<given>AN</given>

<position>1</position>

</creators_name>

<creators_name>

<family>Another</family>

<given>S</given>

<position>2</position>

</creators_name>

</creators_names>

<publication_date>(2009)</publication_date>

<publication_date_year>2009</publication_date_year>

<publication_date_month>3</publication_date_month>

<publication_date_day/>

<title><a target=”_blank” href=”http://eprints-dev.ulster.ac.uk/318″><em>The Development and Pilot Testing of an Instrument to Measure Nurses’ Working Environment: The Nursing Context Index</em></a></title>

<publication>WORLDVIEWS ON EVIDENCE-BASED NURSING</publication>

<volume>6</volume>

<number>3</number>

<pagerange>173-182</pagerange>

</eprint>

</eprints>

json

/publications/get/institute/Institute_of_Nursing_Research/type/article/render/json

[

{

“eprintid”:4,

“type”:”article”,

“creators”:”Switzer C and McDowell S”,

“publication_date”:”(2009)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>”,

“title”:”Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast”

“publication”:”Memory Studies”,

“volume”:”2″,

“number”:”3″,

“pagerange”:”337-353″

“citation”:”Switzer C and McDowell S (2009) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>. Memory Studies 2 (3). pp. 337-353.”

},

{

“eprintid”:48,

“type”:”article”,

“creators”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F”,

“publication_date”:”(2010)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>”,

“title”:”A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks”

“publication”:”Computers in Biology and Medicine”,

“volume”:”40″,

“number”:”3″,

“pagerange”:”306-317″

“citation”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F (2010) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>. Computers in Biology and Medicine 40 (3). pp. 306-317.”

}

]

Use the php function json_decode
if you need to turn the default json string into an array for additional processing.

publications – format

Citation format options are currently under review.
Please let us know if there is a particular format you require.
In the meantime, all publication citations will be returned
in the default format (the same format as displayed in the UIR).

Values

Default

If you do not specify the format parameter, the publication citations will be returned in
the default EPrints format.

Examples

Tips

publications – order

Fields to order on can be chained using the semicolon ; character.

Defaults

If you do not specify any order parameter, the publications will be returned
ordered by year of publication (descending), first author’s name (ascending) and
title (ascending).

If you specify an order without a flag, the default order is ascending.
Specify descending order by adding ,d after the field you want to sort on.

Values

Examples

year

/publications/get/email/an.academic@ulster.ac.uk/type/conference_item/order/year

returns all the conference contributions for an.academic@ulster.ac.uk sorted in ascending order by the
year of publication

NOTE: a list of the types for any given email can be retrieved using the types parameter
(see the types – mandatory section below for more information)

date,d

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/date,d

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by the
complete date of publication

NOTE: only the year part of the publication date is required when depositing an item in the
UIR, the month and day may not exist in the item metadata

year,d;name

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/year,d;name

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by year of
publication, and within the year, in ascending order of first author’s name

title

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/title

returns all the articles for an.academic@ulster.ac.uk sorted in ascending order of title
(useful for checking for possible duplicates)

types – mandatory parameters

The types controller will return a list of the item types for the
parameter(s) supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires at least one of the same mandatory parameters as publications (see
the publications – mandatory parameters section above).
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/types/get/email/an.academic@ulster.ac.uk all types which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/types/get/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation
/types/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

Please note

The word mandatory is not a parameter key.
See the publications – mandatory parameters section above for a
complete list of the current names for faculties, research institutes, etc.

item IDs – mandatory parameters

The itemids controller will return a list of the item IDs for the
Ulster email supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires a single mandatory parameter: a valid Ulster email.

Optionally, you can use the type parameter to get item IDs for a particular
type of item.

The same rendering options are available as for publications:
html (default), json and xml.

Examples

/itemids/get/email/an.academic@ulster.ac.uk all item IDs (and item types) which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/itemids/get/email/an.academic@ulster.ac.uk/type/article all item IDs for items of the specified type which have the email an.academic@ulster.ac.uk in the authors/creators metadata field


Internet Publication





Web Services: EPrints (UIR)



How to use this web service

general

The UIR web service is called via a URL whose structure is explained below:

always required varies according to requirements
service address controller name controller action parameter key parameter value
https://webservices.ulster.ac.uk/uir /publications /get /email /an.academic@ulster.ac.uk
  /types      
  /itemids      
service address This is always the same, and must be used, for all calls to the UIR web service.
controller name
publications provides a list of publications depending on the combination of parameters (key/value pairs) specified
types

provides a list of item types used by an author
itemids

provides a list of item ids used by an author (can be filtered by type)

Features added in the future will be listed here and
in the UIR Developer Guide (login required).

controller action The types, publications and itemids controllers currently implement a get action.
parameter key Several parameters can be passed to a controller in order to specify the data required.
Email is one of the mandatory parameters.

See below for more information about parameter keys and valid values.
parameter value Each parameter key must have a corresponding value. For the key email,
the corresponding value must be an Ulster email in the format specified.

See below for more information about parameter keys and valid values.

Multiple parameter key/value pairs can be passed to the controller by
appending them as required to the URL, in any order.

There are five types of parameter which can be used to specify the publications
required, how they should be rendered (and in the future, what format citations should have).
Click the headings below for an explanation and examples of each.

publications – mandatory parameters

The UIR publications controller requires at least one of the mandatory parameters below.
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/publications/get/email/an.academic@ulster.ac.uk all publications which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/publications/get/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation
/publications/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

UIR codes

The names of Research Institutes and groups can change.
Less frequently, School and Faculty names may also change.
The webservice now publishes the UIR code for each of these entities.
The codes remain constant within the UIR so there will be no need to
update code when a name changes (although there may occasionally be a
new code added, for example, when a new group is created).

Codes are listed alongside institute, group, faculty and school names in the tabs below.
Both codes and names are drawn directly from the UIR and therefore are always up-to-date.

It is strongly recommended that you use the codes
rather than the names to retrieve items from the UIR.

Please note

The word mandatory is not a parameter key.
Use one of the following key words to specify a mandatory parameter.
Click on each key word to display its list of valid values.

Values

a valid Ulster staff member’s email

Tips

If you don’t get any results back for an email, and you are certain that
you are using a valid email, check for that person in the
Browse | Ulster Authors and Editors
section of the repository. If they are not listed there, they do not have any items live in the
repository.

Values

ri_ad Art_and_Design_Research_Institute
ri_hu Arts_and_Humanities_Research_Institute
ri_biomed Biomedical_Sciences_Research_Institute
ri_bue Built_Environment_Research_Institute
ri_bsm Business_and_Management_Research_Institute
ri_ms Centre_for_Media_Research
ri_cs Computer_Science_Research_Institute
ri_namr Engineering_Research_Institute
ri_es Environmental_Sciences_Research_Institute
ri_hrsri Health_and_Rehabilitation_Sciences_Research_Institute
ri_spri Institute_for_Research_in_Social_Sciences
ri_nur Institute_of_Nursing_and_Health_Research
ri_c Irish_and_Celtic_Studies_Research_Institute
ri_p Psychology_Research_Institute
ri_sprt Sport_and_Exercise_Sciences_Research_Institute
ri_tji Transitional_Justice_Institute

Examples

/publications/get/institute/Institute_of_Nursing_Research

/publications/get/institute/Sport_and_Exercise_Science_Research_Institute

/publications/get/institute/ri_sprt

Values

rig_hrsri_spic Activity_and_Enablement_(AE)
rig_namr_amfr Advanced_Metal_Forming
rig_ad_ac Art_and_Context
rig_ad_fa Art,_Conflict_and_Society
rig_cs_ai Artificial_Intelligence_and_Applications
rig_p_bn Behavioural_Neuroscience_and_Behaviour_Analysis
rig_nur_hrsrc Centre_for_Health_and_Rehabilitation_Technologies
rig_nur_ddch Centre_for_Intellectual_and_Developmental_Disabilities
rig_nur_mfiw Centre_for_Maternal,_Fetal_and_Infant_Research
rig_sprt_ph Centre_for_Physical_Activity_and_Health
rig_bue_crpp Centre_for_Research_on_Property_and_Planning_(RPP)
rig_sprt_sp Centre_for_Sport_in_Society
rig_sprt_sps Centre_for_Sports_Science_and_Sports_Medicine
rig_bue_cst Centre_for_Sustainable_Technologies_(CST)
rig_es_cm Coastal_Systems
rig_spri_c Communication
rig_hu_ca Creative_Arts_and_Technologies
rig_ad_aa Creative_Ecologies
rig_biomed_d Diabetes
rig_hrsri_diii Diabetic_Foot_-_Infection_-_Imaging_-_Intervention_(D3i)
rig_spri_ed Education
rig_nur_nepr Education_and_Professional_Issues_Research_Group
rig_namr_ecrc Engineering_Composites
rig_hu_en English
rig_bue_fsertc Fire_Safety_and_Engineering_Research_and_Technology_Centre_(FireSERT)
rig_es_f Freshwater_Sciences
rig_ad_d Future_and_Virtual_Worlds
rig_biomed_mo Genomic_Medicine
rig_es_g Geophysics
rig_nur_hpah Health_Promotion_and_Adolescent_Health
rig_p_hp Health,_Education_and_Well-being
rig_hu_h History
rig_bue_hsef Hydrogen_Safety_Engineering_and_Research_Centre_(HySAFER)
rig_biomed_ii Infection_and_Immunity/Microbiology
rig_cs_ise Information_and_Communication_Engineering
rig_cs_isrc Intelligent_Systems_Research_Centre
rig_spri_l Linguistics
rig_nur_mci Managing_Chronic_Illness_Research_Centre
rig_hrsri_mci Managing_Chronic_Illness_through_’Assisted_Living’
rig_es_ma Maritime_Archaeology
rig_hrsri_dm Medical_Imaging
rig_nur_mh Mental_Health
rig_hu_eu Modern_Languages
rig_hrsri_md Musculoskeletal_Disorder_(MSKD)_Rehabilitation
rigsg_mo_na Nano_Systems_Biology
rig_namr_nibec Nanotechnology_&_Integrated_BioEngineering_Centre_(NIBEC)
rig_hrsri_nr Neurorehabilitation_for_Health_(NRH)
rigsg_mo_nd Neuroscience_&_Neurodegenerative_Diseases
rig_biomed_niche Northern_Ireland_Centre_for_Food_and_Health_(NICHE)
rig_p_pc Peace,_Conflict_and_Equality
rig_nur_pcp Person-centred_Practice_Research_Centre
rig_biomed_psp Pharmaceutical_Science_and_Practice
rig_spri_p Politics_&_International_Studies
rig_p_msm Population_Health_Sciences_and_Mental_Health_Services
rig_p_pmh Psychotraumatology,_Mental_Health_&_Suicidal_Behaviour
rig_es_qec Quaternary_Environmental_Change
rig_hrsri_rcp Rehabilitation_in_Cancer_Patients
rig_hrsri_rrs Rehabilitation_in_Rheumatic_Sciences
rig_hrsri_rh Respiratory_Health
rig_cs_se Smart_Environments
rig_spri_sw Social_Work_&_Social_Policy
rig_es_s Society_and_Environment
rig_ad_sp Space_and_Place
rig_biomed_sm Stratified_Medicine
rig_bue_saber Studies_Allied_to_Built_Environment_Research_(SABER)
rig_es_t Terrestrial_Ecology
rig_p_bc The_Bamford_Centre_for_Mental_Health_and_Wellbeing
rigsg_mo_t Transcriptional_Regulation_&_Epigenetics
rigsg_mo_v Vascular_Medicine
rig_biomed_vs Vision

Examples

/publications/get/group/Coastal_Systems

/publications/get/group/Molecular_Medicine

Tips

Specifying a group applies the filter at a lower level
than institute.
If you specify both, the controller will return items at the institute level
(which should include the group level if the affiliations were applied correctly
when the item was deposited).

Values

fac_adbe Faculty_of_Art,_Design_and_the_Built_Environment
fac_arts Faculty_of_Arts
fac_ce Faculty_of_Computing_&_Engineering
fac_lhs Faculty_of_Life_and_Health_Sciences
fac_ss Faculty_of_Social_Sciences
fac_ubs Ulster_Business_School

Examples

/publications/get/faculty/Faculty_of_Arts

/publications/get/faculty/Ulster_Business_School

Values

sch_adbe_ad Belfast_School_of_Art
sch_ubs_bi Business_Institute
sch_ubs_da Department_of_Accounting,_Finance_and_Economics
sch_ubs_dbrfs Department_of_Business_and_Enterprise
sch_ubs_dhtm Department_of_Hospitality_and_Tourism_Management
sch_ubs_dib Department_of_International_Business
sch_ubs_dm Department_of_Management_and_Leadership
sch_ubs_dmes Department_of_Marketing,_Entrepreneurship_and_Strategy
sch_ss_gsp Graduate_School_of_Professional_Legal_Education
sch_ss_inc INCORE
sch_arts_iuss Institute_of_Ulster_Scots_Studies
sch_adbe_x_rgs Research_Graduate_School
sch_arts_x_rgs Research_Graduate_School
sch_ce_x_rgs Research_Graduate_School
sch_lhs_x_rgs Research_Graduate_School
sch_ubs_x_rgs Research_Graduate_School
sch_ss_x_rgs Research_Graduate_School_(Social_Sciences)
sch_lhs_bs School_of_Biomedical_Sciences
sch_ss_c School_of_Communication
sch_ce_cie School_of_Computing_and_Information_Engineering
sch_ce_cis School_of_Computing_and_Intelligent_Systems
sch_ce_cm School_of_Computing_and_Mathematics
sch_arts_ca School_of_Creative_Arts_and_Technologies
sch_ss_ps School_of_Criminology,_Politics_and_Social_Policy
sch_ss_ed School_of_Education
sch_ce_eme School_of_Engineering
sch_arts_hia School_of_English_and_History
sch_lhs_es School_of_Geography_and_Environmental_Sciences
sch_lhs_hs School_of_Health_Sciences
sch_arts_i School_of_Irish_Language_and_Literature
sch_ss_l School_of_Law
sch_arts_mfj School_of_Media,_Film_&_Journalism
sch_arts_ll School_of_Modern_Languages
sch_lhs_n School_of_Nursing
sch_lhs_pps School_of_Pharmacy_and_Pharmaceutical_Science
sch_lhs_p School_of_Psychology
sch_ss_sass School_of_Sociology_and_Applied_Social_Studies
sch_lhs_ss School_of_Sport
sch_adbe_be School_of_the_Built_Environment
sch_adbe_arc The_Belfast_School_of_Architecture

Examples

/publications/get/school/School_of_Communication

/publications/get/school/School_of_Sports_Studies

Tips

As for institute/group combinations, specifying a school applies the filter
at a lower level than faculty, therefore you should not specify the parent faculty
if you only want the group publications.
If you specify both, the service will return items at the faculty level.

publications – type

You can specify which type(s) of items you want the web service to return, or to exclude.

Type names

artefact
article
body_of_work
book_authored
book_edited
book_section
composition
conference_item
confidential_report_external
design
device
digital_media
exhibition
installation
internet_publication
other
patent
performance
research_report_external
scholarly_edition
software
thesis

Default

If you do not use the type parameter, all item types will be returned.

Examples

/publications/get/school/School_of_Law/type/article

/publications/get/school/sch_ss_l/type/book_edited,book_section

/publications/get/school/sch_ss_l/type/-article

Tips

If you specify one item type, the service will return only items of that type.

You can specify more than one item type by separating the values with commas. The service will return items of those types.

You can exclude a particular item type by prefixing the value of the parameter with a minus-sign.

publications – render

You can specify how the data will be rendered, according to your preference
for any processing you want to do with the publications data before displaying
it on the target web page.

The json and xml rendering options return additional data that may be useful for
any custom processing you want to do. For example, the creators’ names are
returned in a separate structure in addition to as a list.

The web service has the following options for how the data will be rendered.
Please note, the examples below are for illustration only.
Additional fields may be added if required in the future.

Values

Examples

html

/publications/get/email/an.academic@ulster.ac.uk/render/html

HTML is the default option if you do not specify a render parameter.


The HTML returned will have the same format as the UIR author_by_email view.

xml

/publications/get/email/an.academic@ulster.ac.uk/type/article/render/xml

<eprints>

<eprint>

<eprintid>318</eprintid>

<type>article</type>

<creators>Smith A, Academic AN and Another S</creators>

<creators_names>

<creators_name>

<family>Smith</family>

<given>A</given>

<position>0</position>

</creators_name>

<creators_name>

<family>Academic</family>

<given>AN</given>

<position>1</position>

</creators_name>

<creators_name>

<family>Another</family>

<given>S</given>

<position>2</position>

</creators_name>

</creators_names>

<publication_date>(2009)</publication_date>

<publication_date_year>2009</publication_date_year>

<publication_date_month>3</publication_date_month>

<publication_date_day/>

<title><a target=”_blank” href=”http://eprints-dev.ulster.ac.uk/318″><em>The Development and Pilot Testing of an Instrument to Measure Nurses’ Working Environment: The Nursing Context Index</em></a></title>

<publication>WORLDVIEWS ON EVIDENCE-BASED NURSING</publication>

<volume>6</volume>

<number>3</number>

<pagerange>173-182</pagerange>

</eprint>

</eprints>

json

/publications/get/institute/Institute_of_Nursing_Research/type/article/render/json

[

{

“eprintid”:4,

“type”:”article”,

“creators”:”Switzer C and McDowell S”,

“publication_date”:”(2009)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>”,

“title”:”Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast”

“publication”:”Memory Studies”,

“volume”:”2″,

“number”:”3″,

“pagerange”:”337-353″

“citation”:”Switzer C and McDowell S (2009) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>. Memory Studies 2 (3). pp. 337-353.”

},

{

“eprintid”:48,

“type”:”article”,

“creators”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F”,

“publication_date”:”(2010)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>”,

“title”:”A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks”

“publication”:”Computers in Biology and Medicine”,

“volume”:”40″,

“number”:”3″,

“pagerange”:”306-317″

“citation”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F (2010) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>. Computers in Biology and Medicine 40 (3). pp. 306-317.”

}

]

Use the php function json_decode
if you need to turn the default json string into an array for additional processing.

publications – format

Citation format options are currently under review.
Please let us know if there is a particular format you require.
In the meantime, all publication citations will be returned
in the default format (the same format as displayed in the UIR).

Values

Default

If you do not specify the format parameter, the publication citations will be returned in
the default EPrints format.

Examples

Tips

publications – order

Fields to order on can be chained using the semicolon ; character.

Defaults

If you do not specify any order parameter, the publications will be returned
ordered by year of publication (descending), first author’s name (ascending) and
title (ascending).

If you specify an order without a flag, the default order is ascending.
Specify descending order by adding ,d after the field you want to sort on.

Values

Examples

year

/publications/get/email/an.academic@ulster.ac.uk/type/conference_item/order/year

returns all the conference contributions for an.academic@ulster.ac.uk sorted in ascending order by the
year of publication

NOTE: a list of the types for any given email can be retrieved using the types parameter
(see the types – mandatory section below for more information)

date,d

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/date,d

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by the
complete date of publication

NOTE: only the year part of the publication date is required when depositing an item in the
UIR, the month and day may not exist in the item metadata

year,d;name

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/year,d;name

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by year of
publication, and within the year, in ascending order of first author’s name

title

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/title

returns all the articles for an.academic@ulster.ac.uk sorted in ascending order of title
(useful for checking for possible duplicates)

types – mandatory parameters

The types controller will return a list of the item types for the
parameter(s) supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires at least one of the same mandatory parameters as publications (see
the publications – mandatory parameters section above).
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/types/get/email/an.academic@ulster.ac.uk all types which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/types/get/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation
/types/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

Please note

The word mandatory is not a parameter key.
See the publications – mandatory parameters section above for a
complete list of the current names for faculties, research institutes, etc.

item IDs – mandatory parameters

The itemids controller will return a list of the item IDs for the
Ulster email supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires a single mandatory parameter: a valid Ulster email.

Optionally, you can use the type parameter to get item IDs for a particular
type of item.

The same rendering options are available as for publications:
html (default), json and xml.

Examples

/itemids/get/email/an.academic@ulster.ac.uk all item IDs (and item types) which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/itemids/get/email/an.academic@ulster.ac.uk/type/article all item IDs for items of the specified type which have the email an.academic@ulster.ac.uk in the authors/creators metadata field


Performance





Web Services: EPrints (UIR)



How to use this web service

general

The UIR web service is called via a URL whose structure is explained below:

always required varies according to requirements
service address controller name controller action parameter key parameter value
https://webservices.ulster.ac.uk/uir /publications /get /email /an.academic@ulster.ac.uk
  /types      
  /itemids      
service address This is always the same, and must be used, for all calls to the UIR web service.
controller name
publications provides a list of publications depending on the combination of parameters (key/value pairs) specified
types

provides a list of item types used by an author
itemids

provides a list of item ids used by an author (can be filtered by type)

Features added in the future will be listed here and
in the UIR Developer Guide (login required).

controller action The types, publications and itemids controllers currently implement a get action.
parameter key Several parameters can be passed to a controller in order to specify the data required.
Email is one of the mandatory parameters.

See below for more information about parameter keys and valid values.
parameter value Each parameter key must have a corresponding value. For the key email,
the corresponding value must be an Ulster email in the format specified.

See below for more information about parameter keys and valid values.

Multiple parameter key/value pairs can be passed to the controller by
appending them as required to the URL, in any order.

There are five types of parameter which can be used to specify the publications
required, how they should be rendered (and in the future, what format citations should have).
Click the headings below for an explanation and examples of each.

publications – mandatory parameters

The UIR publications controller requires at least one of the mandatory parameters below.
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/publications/get/email/an.academic@ulster.ac.uk all publications which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/publications/get/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation
/publications/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

UIR codes

The names of Research Institutes and groups can change.
Less frequently, School and Faculty names may also change.
The webservice now publishes the UIR code for each of these entities.
The codes remain constant within the UIR so there will be no need to
update code when a name changes (although there may occasionally be a
new code added, for example, when a new group is created).

Codes are listed alongside institute, group, faculty and school names in the tabs below.
Both codes and names are drawn directly from the UIR and therefore are always up-to-date.

It is strongly recommended that you use the codes
rather than the names to retrieve items from the UIR.

Please note

The word mandatory is not a parameter key.
Use one of the following key words to specify a mandatory parameter.
Click on each key word to display its list of valid values.

Values

a valid Ulster staff member’s email

Tips

If you don’t get any results back for an email, and you are certain that
you are using a valid email, check for that person in the
Browse | Ulster Authors and Editors
section of the repository. If they are not listed there, they do not have any items live in the
repository.

Values

ri_ad Art_and_Design_Research_Institute
ri_hu Arts_and_Humanities_Research_Institute
ri_biomed Biomedical_Sciences_Research_Institute
ri_bue Built_Environment_Research_Institute
ri_bsm Business_and_Management_Research_Institute
ri_ms Centre_for_Media_Research
ri_cs Computer_Science_Research_Institute
ri_namr Engineering_Research_Institute
ri_es Environmental_Sciences_Research_Institute
ri_hrsri Health_and_Rehabilitation_Sciences_Research_Institute
ri_spri Institute_for_Research_in_Social_Sciences
ri_nur Institute_of_Nursing_and_Health_Research
ri_c Irish_and_Celtic_Studies_Research_Institute
ri_p Psychology_Research_Institute
ri_sprt Sport_and_Exercise_Sciences_Research_Institute
ri_tji Transitional_Justice_Institute

Examples

/publications/get/institute/Institute_of_Nursing_Research

/publications/get/institute/Sport_and_Exercise_Science_Research_Institute

/publications/get/institute/ri_sprt

Values

rig_hrsri_spic Activity_and_Enablement_(AE)
rig_namr_amfr Advanced_Metal_Forming
rig_ad_ac Art_and_Context
rig_ad_fa Art,_Conflict_and_Society
rig_cs_ai Artificial_Intelligence_and_Applications
rig_p_bn Behavioural_Neuroscience_and_Behaviour_Analysis
rig_nur_hrsrc Centre_for_Health_and_Rehabilitation_Technologies
rig_nur_ddch Centre_for_Intellectual_and_Developmental_Disabilities
rig_nur_mfiw Centre_for_Maternal,_Fetal_and_Infant_Research
rig_sprt_ph Centre_for_Physical_Activity_and_Health
rig_bue_crpp Centre_for_Research_on_Property_and_Planning_(RPP)
rig_sprt_sp Centre_for_Sport_in_Society
rig_sprt_sps Centre_for_Sports_Science_and_Sports_Medicine
rig_bue_cst Centre_for_Sustainable_Technologies_(CST)
rig_es_cm Coastal_Systems
rig_spri_c Communication
rig_hu_ca Creative_Arts_and_Technologies
rig_ad_aa Creative_Ecologies
rig_biomed_d Diabetes
rig_hrsri_diii Diabetic_Foot_-_Infection_-_Imaging_-_Intervention_(D3i)
rig_spri_ed Education
rig_nur_nepr Education_and_Professional_Issues_Research_Group
rig_namr_ecrc Engineering_Composites
rig_hu_en English
rig_bue_fsertc Fire_Safety_and_Engineering_Research_and_Technology_Centre_(FireSERT)
rig_es_f Freshwater_Sciences
rig_ad_d Future_and_Virtual_Worlds
rig_biomed_mo Genomic_Medicine
rig_es_g Geophysics
rig_nur_hpah Health_Promotion_and_Adolescent_Health
rig_p_hp Health,_Education_and_Well-being
rig_hu_h History
rig_bue_hsef Hydrogen_Safety_Engineering_and_Research_Centre_(HySAFER)
rig_biomed_ii Infection_and_Immunity/Microbiology
rig_cs_ise Information_and_Communication_Engineering
rig_cs_isrc Intelligent_Systems_Research_Centre
rig_spri_l Linguistics
rig_nur_mci Managing_Chronic_Illness_Research_Centre
rig_hrsri_mci Managing_Chronic_Illness_through_’Assisted_Living’
rig_es_ma Maritime_Archaeology
rig_hrsri_dm Medical_Imaging
rig_nur_mh Mental_Health
rig_hu_eu Modern_Languages
rig_hrsri_md Musculoskeletal_Disorder_(MSKD)_Rehabilitation
rigsg_mo_na Nano_Systems_Biology
rig_namr_nibec Nanotechnology_&_Integrated_BioEngineering_Centre_(NIBEC)
rig_hrsri_nr Neurorehabilitation_for_Health_(NRH)
rigsg_mo_nd Neuroscience_&_Neurodegenerative_Diseases
rig_biomed_niche Northern_Ireland_Centre_for_Food_and_Health_(NICHE)
rig_p_pc Peace,_Conflict_and_Equality
rig_nur_pcp Person-centred_Practice_Research_Centre
rig_biomed_psp Pharmaceutical_Science_and_Practice
rig_spri_p Politics_&_International_Studies
rig_p_msm Population_Health_Sciences_and_Mental_Health_Services
rig_p_pmh Psychotraumatology,_Mental_Health_&_Suicidal_Behaviour
rig_es_qec Quaternary_Environmental_Change
rig_hrsri_rcp Rehabilitation_in_Cancer_Patients
rig_hrsri_rrs Rehabilitation_in_Rheumatic_Sciences
rig_hrsri_rh Respiratory_Health
rig_cs_se Smart_Environments
rig_spri_sw Social_Work_&_Social_Policy
rig_es_s Society_and_Environment
rig_ad_sp Space_and_Place
rig_biomed_sm Stratified_Medicine
rig_bue_saber Studies_Allied_to_Built_Environment_Research_(SABER)
rig_es_t Terrestrial_Ecology
rig_p_bc The_Bamford_Centre_for_Mental_Health_and_Wellbeing
rigsg_mo_t Transcriptional_Regulation_&_Epigenetics
rigsg_mo_v Vascular_Medicine
rig_biomed_vs Vision

Examples

/publications/get/group/Coastal_Systems

/publications/get/group/Molecular_Medicine

Tips

Specifying a group applies the filter at a lower level
than institute.
If you specify both, the controller will return items at the institute level
(which should include the group level if the affiliations were applied correctly
when the item was deposited).

Values

fac_adbe Faculty_of_Art,_Design_and_the_Built_Environment
fac_arts Faculty_of_Arts
fac_ce Faculty_of_Computing_&_Engineering
fac_lhs Faculty_of_Life_and_Health_Sciences
fac_ss Faculty_of_Social_Sciences
fac_ubs Ulster_Business_School

Examples

/publications/get/faculty/Faculty_of_Arts

/publications/get/faculty/Ulster_Business_School

Values

sch_adbe_ad Belfast_School_of_Art
sch_ubs_bi Business_Institute
sch_ubs_da Department_of_Accounting,_Finance_and_Economics
sch_ubs_dbrfs Department_of_Business_and_Enterprise
sch_ubs_dhtm Department_of_Hospitality_and_Tourism_Management
sch_ubs_dib Department_of_International_Business
sch_ubs_dm Department_of_Management_and_Leadership
sch_ubs_dmes Department_of_Marketing,_Entrepreneurship_and_Strategy
sch_ss_gsp Graduate_School_of_Professional_Legal_Education
sch_ss_inc INCORE
sch_arts_iuss Institute_of_Ulster_Scots_Studies
sch_adbe_x_rgs Research_Graduate_School
sch_arts_x_rgs Research_Graduate_School
sch_ce_x_rgs Research_Graduate_School
sch_lhs_x_rgs Research_Graduate_School
sch_ubs_x_rgs Research_Graduate_School
sch_ss_x_rgs Research_Graduate_School_(Social_Sciences)
sch_lhs_bs School_of_Biomedical_Sciences
sch_ss_c School_of_Communication
sch_ce_cie School_of_Computing_and_Information_Engineering
sch_ce_cis School_of_Computing_and_Intelligent_Systems
sch_ce_cm School_of_Computing_and_Mathematics
sch_arts_ca School_of_Creative_Arts_and_Technologies
sch_ss_ps School_of_Criminology,_Politics_and_Social_Policy
sch_ss_ed School_of_Education
sch_ce_eme School_of_Engineering
sch_arts_hia School_of_English_and_History
sch_lhs_es School_of_Geography_and_Environmental_Sciences
sch_lhs_hs School_of_Health_Sciences
sch_arts_i School_of_Irish_Language_and_Literature
sch_ss_l School_of_Law
sch_arts_mfj School_of_Media,_Film_&_Journalism
sch_arts_ll School_of_Modern_Languages
sch_lhs_n School_of_Nursing
sch_lhs_pps School_of_Pharmacy_and_Pharmaceutical_Science
sch_lhs_p School_of_Psychology
sch_ss_sass School_of_Sociology_and_Applied_Social_Studies
sch_lhs_ss School_of_Sport
sch_adbe_be School_of_the_Built_Environment
sch_adbe_arc The_Belfast_School_of_Architecture

Examples

/publications/get/school/School_of_Communication

/publications/get/school/School_of_Sports_Studies

Tips

As for institute/group combinations, specifying a school applies the filter
at a lower level than faculty, therefore you should not specify the parent faculty
if you only want the group publications.
If you specify both, the service will return items at the faculty level.

publications – type

You can specify which type(s) of items you want the web service to return, or to exclude.

Type names

artefact
article
body_of_work
book_authored
book_edited
book_section
composition
conference_item
confidential_report_external
design
device
digital_media
exhibition
installation
internet_publication
other
patent
performance
research_report_external
scholarly_edition
software
thesis

Default

If you do not use the type parameter, all item types will be returned.

Examples

/publications/get/school/School_of_Law/type/article

/publications/get/school/sch_ss_l/type/book_edited,book_section

/publications/get/school/sch_ss_l/type/-article

Tips

If you specify one item type, the service will return only items of that type.

You can specify more than one item type by separating the values with commas. The service will return items of those types.

You can exclude a particular item type by prefixing the value of the parameter with a minus-sign.

publications – render

You can specify how the data will be rendered, according to your preference
for any processing you want to do with the publications data before displaying
it on the target web page.

The json and xml rendering options return additional data that may be useful for
any custom processing you want to do. For example, the creators’ names are
returned in a separate structure in addition to as a list.

The web service has the following options for how the data will be rendered.
Please note, the examples below are for illustration only.
Additional fields may be added if required in the future.

Values

Examples

html

/publications/get/email/an.academic@ulster.ac.uk/render/html

HTML is the default option if you do not specify a render parameter.


The HTML returned will have the same format as the UIR author_by_email view.

xml

/publications/get/email/an.academic@ulster.ac.uk/type/article/render/xml

<eprints>

<eprint>

<eprintid>318</eprintid>

<type>article</type>

<creators>Smith A, Academic AN and Another S</creators>

<creators_names>

<creators_name>

<family>Smith</family>

<given>A</given>

<position>0</position>

</creators_name>

<creators_name>

<family>Academic</family>

<given>AN</given>

<position>1</position>

</creators_name>

<creators_name>

<family>Another</family>

<given>S</given>

<position>2</position>

</creators_name>

</creators_names>

<publication_date>(2009)</publication_date>

<publication_date_year>2009</publication_date_year>

<publication_date_month>3</publication_date_month>

<publication_date_day/>

<title><a target=”_blank” href=”http://eprints-dev.ulster.ac.uk/318″><em>The Development and Pilot Testing of an Instrument to Measure Nurses’ Working Environment: The Nursing Context Index</em></a></title>

<publication>WORLDVIEWS ON EVIDENCE-BASED NURSING</publication>

<volume>6</volume>

<number>3</number>

<pagerange>173-182</pagerange>

</eprint>

</eprints>

json

/publications/get/institute/Institute_of_Nursing_Research/type/article/render/json

[

{

“eprintid”:4,

“type”:”article”,

“creators”:”Switzer C and McDowell S”,

“publication_date”:”(2009)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>”,

“title”:”Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast”

“publication”:”Memory Studies”,

“volume”:”2″,

“number”:”3″,

“pagerange”:”337-353″

“citation”:”Switzer C and McDowell S (2009) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>. Memory Studies 2 (3). pp. 337-353.”

},

{

“eprintid”:48,

“type”:”article”,

“creators”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F”,

“publication_date”:”(2010)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>”,

“title”:”A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks”

“publication”:”Computers in Biology and Medicine”,

“volume”:”40″,

“number”:”3″,

“pagerange”:”306-317″

“citation”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F (2010) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>. Computers in Biology and Medicine 40 (3). pp. 306-317.”

}

]

Use the php function json_decode
if you need to turn the default json string into an array for additional processing.

publications – format

Citation format options are currently under review.
Please let us know if there is a particular format you require.
In the meantime, all publication citations will be returned
in the default format (the same format as displayed in the UIR).

Values

Default

If you do not specify the format parameter, the publication citations will be returned in
the default EPrints format.

Examples

Tips

publications – order

Fields to order on can be chained using the semicolon ; character.

Defaults

If you do not specify any order parameter, the publications will be returned
ordered by year of publication (descending), first author’s name (ascending) and
title (ascending).

If you specify an order without a flag, the default order is ascending.
Specify descending order by adding ,d after the field you want to sort on.

Values

Examples

year

/publications/get/email/an.academic@ulster.ac.uk/type/conference_item/order/year

returns all the conference contributions for an.academic@ulster.ac.uk sorted in ascending order by the
year of publication

NOTE: a list of the types for any given email can be retrieved using the types parameter
(see the types – mandatory section below for more information)

date,d

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/date,d

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by the
complete date of publication

NOTE: only the year part of the publication date is required when depositing an item in the
UIR, the month and day may not exist in the item metadata

year,d;name

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/year,d;name

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by year of
publication, and within the year, in ascending order of first author’s name

title

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/title

returns all the articles for an.academic@ulster.ac.uk sorted in ascending order of title
(useful for checking for possible duplicates)

types – mandatory parameters

The types controller will return a list of the item types for the
parameter(s) supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires at least one of the same mandatory parameters as publications (see
the publications – mandatory parameters section above).
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/types/get/email/an.academic@ulster.ac.uk all types which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/types/get/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation
/types/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

Please note

The word mandatory is not a parameter key.
See the publications – mandatory parameters section above for a
complete list of the current names for faculties, research institutes, etc.

item IDs – mandatory parameters

The itemids controller will return a list of the item IDs for the
Ulster email supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires a single mandatory parameter: a valid Ulster email.

Optionally, you can use the type parameter to get item IDs for a particular
type of item.

The same rendering options are available as for publications:
html (default), json and xml.

Examples

/itemids/get/email/an.academic@ulster.ac.uk all item IDs (and item types) which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/itemids/get/email/an.academic@ulster.ac.uk/type/article all item IDs for items of the specified type which have the email an.academic@ulster.ac.uk in the authors/creators metadata field


Body of Work





Web Services: EPrints (UIR)



How to use this web service

general

The UIR web service is called via a URL whose structure is explained below:

always required varies according to requirements
service address controller name controller action parameter key parameter value
https://webservices.ulster.ac.uk/uir /publications /get /email /an.academic@ulster.ac.uk
  /types      
  /itemids      
service address This is always the same, and must be used, for all calls to the UIR web service.
controller name
publications provides a list of publications depending on the combination of parameters (key/value pairs) specified
types

provides a list of item types used by an author
itemids

provides a list of item ids used by an author (can be filtered by type)

Features added in the future will be listed here and
in the UIR Developer Guide (login required).

controller action The types, publications and itemids controllers currently implement a get action.
parameter key Several parameters can be passed to a controller in order to specify the data required.
Email is one of the mandatory parameters.

See below for more information about parameter keys and valid values.
parameter value Each parameter key must have a corresponding value. For the key email,
the corresponding value must be an Ulster email in the format specified.

See below for more information about parameter keys and valid values.

Multiple parameter key/value pairs can be passed to the controller by
appending them as required to the URL, in any order.

There are five types of parameter which can be used to specify the publications
required, how they should be rendered (and in the future, what format citations should have).
Click the headings below for an explanation and examples of each.

publications – mandatory parameters

The UIR publications controller requires at least one of the mandatory parameters below.
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/publications/get/email/an.academic@ulster.ac.uk all publications which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/publications/get/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation
/publications/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

UIR codes

The names of Research Institutes and groups can change.
Less frequently, School and Faculty names may also change.
The webservice now publishes the UIR code for each of these entities.
The codes remain constant within the UIR so there will be no need to
update code when a name changes (although there may occasionally be a
new code added, for example, when a new group is created).

Codes are listed alongside institute, group, faculty and school names in the tabs below.
Both codes and names are drawn directly from the UIR and therefore are always up-to-date.

It is strongly recommended that you use the codes
rather than the names to retrieve items from the UIR.

Please note

The word mandatory is not a parameter key.
Use one of the following key words to specify a mandatory parameter.
Click on each key word to display its list of valid values.

Values

a valid Ulster staff member’s email

Tips

If you don’t get any results back for an email, and you are certain that
you are using a valid email, check for that person in the
Browse | Ulster Authors and Editors
section of the repository. If they are not listed there, they do not have any items live in the
repository.

Values

ri_ad Art_and_Design_Research_Institute
ri_hu Arts_and_Humanities_Research_Institute
ri_biomed Biomedical_Sciences_Research_Institute
ri_bue Built_Environment_Research_Institute
ri_bsm Business_and_Management_Research_Institute
ri_ms Centre_for_Media_Research
ri_cs Computer_Science_Research_Institute
ri_namr Engineering_Research_Institute
ri_es Environmental_Sciences_Research_Institute
ri_hrsri Health_and_Rehabilitation_Sciences_Research_Institute
ri_spri Institute_for_Research_in_Social_Sciences
ri_nur Institute_of_Nursing_and_Health_Research
ri_c Irish_and_Celtic_Studies_Research_Institute
ri_p Psychology_Research_Institute
ri_sprt Sport_and_Exercise_Sciences_Research_Institute
ri_tji Transitional_Justice_Institute

Examples

/publications/get/institute/Institute_of_Nursing_Research

/publications/get/institute/Sport_and_Exercise_Science_Research_Institute

/publications/get/institute/ri_sprt

Values

rig_hrsri_spic Activity_and_Enablement_(AE)
rig_namr_amfr Advanced_Metal_Forming
rig_ad_ac Art_and_Context
rig_ad_fa Art,_Conflict_and_Society
rig_cs_ai Artificial_Intelligence_and_Applications
rig_p_bn Behavioural_Neuroscience_and_Behaviour_Analysis
rig_nur_hrsrc Centre_for_Health_and_Rehabilitation_Technologies
rig_nur_ddch Centre_for_Intellectual_and_Developmental_Disabilities
rig_nur_mfiw Centre_for_Maternal,_Fetal_and_Infant_Research
rig_sprt_ph Centre_for_Physical_Activity_and_Health
rig_bue_crpp Centre_for_Research_on_Property_and_Planning_(RPP)
rig_sprt_sp Centre_for_Sport_in_Society
rig_sprt_sps Centre_for_Sports_Science_and_Sports_Medicine
rig_bue_cst Centre_for_Sustainable_Technologies_(CST)
rig_es_cm Coastal_Systems
rig_spri_c Communication
rig_hu_ca Creative_Arts_and_Technologies
rig_ad_aa Creative_Ecologies
rig_biomed_d Diabetes
rig_hrsri_diii Diabetic_Foot_-_Infection_-_Imaging_-_Intervention_(D3i)
rig_spri_ed Education
rig_nur_nepr Education_and_Professional_Issues_Research_Group
rig_namr_ecrc Engineering_Composites
rig_hu_en English
rig_bue_fsertc Fire_Safety_and_Engineering_Research_and_Technology_Centre_(FireSERT)
rig_es_f Freshwater_Sciences
rig_ad_d Future_and_Virtual_Worlds
rig_biomed_mo Genomic_Medicine
rig_es_g Geophysics
rig_nur_hpah Health_Promotion_and_Adolescent_Health
rig_p_hp Health,_Education_and_Well-being
rig_hu_h History
rig_bue_hsef Hydrogen_Safety_Engineering_and_Research_Centre_(HySAFER)
rig_biomed_ii Infection_and_Immunity/Microbiology
rig_cs_ise Information_and_Communication_Engineering
rig_cs_isrc Intelligent_Systems_Research_Centre
rig_spri_l Linguistics
rig_nur_mci Managing_Chronic_Illness_Research_Centre
rig_hrsri_mci Managing_Chronic_Illness_through_’Assisted_Living’
rig_es_ma Maritime_Archaeology
rig_hrsri_dm Medical_Imaging
rig_nur_mh Mental_Health
rig_hu_eu Modern_Languages
rig_hrsri_md Musculoskeletal_Disorder_(MSKD)_Rehabilitation
rigsg_mo_na Nano_Systems_Biology
rig_namr_nibec Nanotechnology_&_Integrated_BioEngineering_Centre_(NIBEC)
rig_hrsri_nr Neurorehabilitation_for_Health_(NRH)
rigsg_mo_nd Neuroscience_&_Neurodegenerative_Diseases
rig_biomed_niche Northern_Ireland_Centre_for_Food_and_Health_(NICHE)
rig_p_pc Peace,_Conflict_and_Equality
rig_nur_pcp Person-centred_Practice_Research_Centre
rig_biomed_psp Pharmaceutical_Science_and_Practice
rig_spri_p Politics_&_International_Studies
rig_p_msm Population_Health_Sciences_and_Mental_Health_Services
rig_p_pmh Psychotraumatology,_Mental_Health_&_Suicidal_Behaviour
rig_es_qec Quaternary_Environmental_Change
rig_hrsri_rcp Rehabilitation_in_Cancer_Patients
rig_hrsri_rrs Rehabilitation_in_Rheumatic_Sciences
rig_hrsri_rh Respiratory_Health
rig_cs_se Smart_Environments
rig_spri_sw Social_Work_&_Social_Policy
rig_es_s Society_and_Environment
rig_ad_sp Space_and_Place
rig_biomed_sm Stratified_Medicine
rig_bue_saber Studies_Allied_to_Built_Environment_Research_(SABER)
rig_es_t Terrestrial_Ecology
rig_p_bc The_Bamford_Centre_for_Mental_Health_and_Wellbeing
rigsg_mo_t Transcriptional_Regulation_&_Epigenetics
rigsg_mo_v Vascular_Medicine
rig_biomed_vs Vision

Examples

/publications/get/group/Coastal_Systems

/publications/get/group/Molecular_Medicine

Tips

Specifying a group applies the filter at a lower level
than institute.
If you specify both, the controller will return items at the institute level
(which should include the group level if the affiliations were applied correctly
when the item was deposited).

Values

fac_adbe Faculty_of_Art,_Design_and_the_Built_Environment
fac_arts Faculty_of_Arts
fac_ce Faculty_of_Computing_&_Engineering
fac_lhs Faculty_of_Life_and_Health_Sciences
fac_ss Faculty_of_Social_Sciences
fac_ubs Ulster_Business_School

Examples

/publications/get/faculty/Faculty_of_Arts

/publications/get/faculty/Ulster_Business_School

Values

sch_adbe_ad Belfast_School_of_Art
sch_ubs_bi Business_Institute
sch_ubs_da Department_of_Accounting,_Finance_and_Economics
sch_ubs_dbrfs Department_of_Business_and_Enterprise
sch_ubs_dhtm Department_of_Hospitality_and_Tourism_Management
sch_ubs_dib Department_of_International_Business
sch_ubs_dm Department_of_Management_and_Leadership
sch_ubs_dmes Department_of_Marketing,_Entrepreneurship_and_Strategy
sch_ss_gsp Graduate_School_of_Professional_Legal_Education
sch_ss_inc INCORE
sch_arts_iuss Institute_of_Ulster_Scots_Studies
sch_adbe_x_rgs Research_Graduate_School
sch_arts_x_rgs Research_Graduate_School
sch_ce_x_rgs Research_Graduate_School
sch_lhs_x_rgs Research_Graduate_School
sch_ubs_x_rgs Research_Graduate_School
sch_ss_x_rgs Research_Graduate_School_(Social_Sciences)
sch_lhs_bs School_of_Biomedical_Sciences
sch_ss_c School_of_Communication
sch_ce_cie School_of_Computing_and_Information_Engineering
sch_ce_cis School_of_Computing_and_Intelligent_Systems
sch_ce_cm School_of_Computing_and_Mathematics
sch_arts_ca School_of_Creative_Arts_and_Technologies
sch_ss_ps School_of_Criminology,_Politics_and_Social_Policy
sch_ss_ed School_of_Education
sch_ce_eme School_of_Engineering
sch_arts_hia School_of_English_and_History
sch_lhs_es School_of_Geography_and_Environmental_Sciences
sch_lhs_hs School_of_Health_Sciences
sch_arts_i School_of_Irish_Language_and_Literature
sch_ss_l School_of_Law
sch_arts_mfj School_of_Media,_Film_&_Journalism
sch_arts_ll School_of_Modern_Languages
sch_lhs_n School_of_Nursing
sch_lhs_pps School_of_Pharmacy_and_Pharmaceutical_Science
sch_lhs_p School_of_Psychology
sch_ss_sass School_of_Sociology_and_Applied_Social_Studies
sch_lhs_ss School_of_Sport
sch_adbe_be School_of_the_Built_Environment
sch_adbe_arc The_Belfast_School_of_Architecture

Examples

/publications/get/school/School_of_Communication

/publications/get/school/School_of_Sports_Studies

Tips

As for institute/group combinations, specifying a school applies the filter
at a lower level than faculty, therefore you should not specify the parent faculty
if you only want the group publications.
If you specify both, the service will return items at the faculty level.

publications – type

You can specify which type(s) of items you want the web service to return, or to exclude.

Type names

artefact
article
body_of_work
book_authored
book_edited
book_section
composition
conference_item
confidential_report_external
design
device
digital_media
exhibition
installation
internet_publication
other
patent
performance
research_report_external
scholarly_edition
software
thesis

Default

If you do not use the type parameter, all item types will be returned.

Examples

/publications/get/school/School_of_Law/type/article

/publications/get/school/sch_ss_l/type/book_edited,book_section

/publications/get/school/sch_ss_l/type/-article

Tips

If you specify one item type, the service will return only items of that type.

You can specify more than one item type by separating the values with commas. The service will return items of those types.

You can exclude a particular item type by prefixing the value of the parameter with a minus-sign.

publications – render

You can specify how the data will be rendered, according to your preference
for any processing you want to do with the publications data before displaying
it on the target web page.

The json and xml rendering options return additional data that may be useful for
any custom processing you want to do. For example, the creators’ names are
returned in a separate structure in addition to as a list.

The web service has the following options for how the data will be rendered.
Please note, the examples below are for illustration only.
Additional fields may be added if required in the future.

Values

Examples

html

/publications/get/email/an.academic@ulster.ac.uk/render/html

HTML is the default option if you do not specify a render parameter.


The HTML returned will have the same format as the UIR author_by_email view.

xml

/publications/get/email/an.academic@ulster.ac.uk/type/article/render/xml

<eprints>

<eprint>

<eprintid>318</eprintid>

<type>article</type>

<creators>Smith A, Academic AN and Another S</creators>

<creators_names>

<creators_name>

<family>Smith</family>

<given>A</given>

<position>0</position>

</creators_name>

<creators_name>

<family>Academic</family>

<given>AN</given>

<position>1</position>

</creators_name>

<creators_name>

<family>Another</family>

<given>S</given>

<position>2</position>

</creators_name>

</creators_names>

<publication_date>(2009)</publication_date>

<publication_date_year>2009</publication_date_year>

<publication_date_month>3</publication_date_month>

<publication_date_day/>

<title><a target=”_blank” href=”http://eprints-dev.ulster.ac.uk/318″><em>The Development and Pilot Testing of an Instrument to Measure Nurses’ Working Environment: The Nursing Context Index</em></a></title>

<publication>WORLDVIEWS ON EVIDENCE-BASED NURSING</publication>

<volume>6</volume>

<number>3</number>

<pagerange>173-182</pagerange>

</eprint>

</eprints>

json

/publications/get/institute/Institute_of_Nursing_Research/type/article/render/json

[

{

“eprintid”:4,

“type”:”article”,

“creators”:”Switzer C and McDowell S”,

“publication_date”:”(2009)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>”,

“title”:”Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast”

“publication”:”Memory Studies”,

“volume”:”2″,

“number”:”3″,

“pagerange”:”337-353″

“citation”:”Switzer C and McDowell S (2009) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>. Memory Studies 2 (3). pp. 337-353.”

},

{

“eprintid”:48,

“type”:”article”,

“creators”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F”,

“publication_date”:”(2010)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>”,

“title”:”A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks”

“publication”:”Computers in Biology and Medicine”,

“volume”:”40″,

“number”:”3″,

“pagerange”:”306-317″

“citation”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F (2010) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>. Computers in Biology and Medicine 40 (3). pp. 306-317.”

}

]

Use the php function json_decode
if you need to turn the default json string into an array for additional processing.

publications – format

Citation format options are currently under review.
Please let us know if there is a particular format you require.
In the meantime, all publication citations will be returned
in the default format (the same format as displayed in the UIR).

Values

Default

If you do not specify the format parameter, the publication citations will be returned in
the default EPrints format.

Examples

Tips

publications – order

Fields to order on can be chained using the semicolon ; character.

Defaults

If you do not specify any order parameter, the publications will be returned
ordered by year of publication (descending), first author’s name (ascending) and
title (ascending).

If you specify an order without a flag, the default order is ascending.
Specify descending order by adding ,d after the field you want to sort on.

Values

Examples

year

/publications/get/email/an.academic@ulster.ac.uk/type/conference_item/order/year

returns all the conference contributions for an.academic@ulster.ac.uk sorted in ascending order by the
year of publication

NOTE: a list of the types for any given email can be retrieved using the types parameter
(see the types – mandatory section below for more information)

date,d

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/date,d

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by the
complete date of publication

NOTE: only the year part of the publication date is required when depositing an item in the
UIR, the month and day may not exist in the item metadata

year,d;name

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/year,d;name

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by year of
publication, and within the year, in ascending order of first author’s name

title

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/title

returns all the articles for an.academic@ulster.ac.uk sorted in ascending order of title
(useful for checking for possible duplicates)

types – mandatory parameters

The types controller will return a list of the item types for the
parameter(s) supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires at least one of the same mandatory parameters as publications (see
the publications – mandatory parameters section above).
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/types/get/email/an.academic@ulster.ac.uk all types which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/types/get/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation
/types/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

Please note

The word mandatory is not a parameter key.
See the publications – mandatory parameters section above for a
complete list of the current names for faculties, research institutes, etc.

item IDs – mandatory parameters

The itemids controller will return a list of the item IDs for the
Ulster email supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires a single mandatory parameter: a valid Ulster email.

Optionally, you can use the type parameter to get item IDs for a particular
type of item.

The same rendering options are available as for publications:
html (default), json and xml.

Examples

/itemids/get/email/an.academic@ulster.ac.uk all item IDs (and item types) which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/itemids/get/email/an.academic@ulster.ac.uk/type/article all item IDs for items of the specified type which have the email an.academic@ulster.ac.uk in the authors/creators metadata field


Conference Items





Web Services: EPrints (UIR)



How to use this web service

general

The UIR web service is called via a URL whose structure is explained below:

always required varies according to requirements
service address controller name controller action parameter key parameter value
https://webservices.ulster.ac.uk/uir /publications /get /email /an.academic@ulster.ac.uk
  /types      
  /itemids      
service address This is always the same, and must be used, for all calls to the UIR web service.
controller name
publications provides a list of publications depending on the combination of parameters (key/value pairs) specified
types

provides a list of item types used by an author
itemids

provides a list of item ids used by an author (can be filtered by type)

Features added in the future will be listed here and
in the UIR Developer Guide (login required).

controller action The types, publications and itemids controllers currently implement a get action.
parameter key Several parameters can be passed to a controller in order to specify the data required.
Email is one of the mandatory parameters.

See below for more information about parameter keys and valid values.
parameter value Each parameter key must have a corresponding value. For the key email,
the corresponding value must be an Ulster email in the format specified.

See below for more information about parameter keys and valid values.

Multiple parameter key/value pairs can be passed to the controller by
appending them as required to the URL, in any order.

There are five types of parameter which can be used to specify the publications
required, how they should be rendered (and in the future, what format citations should have).
Click the headings below for an explanation and examples of each.

publications – mandatory parameters

The UIR publications controller requires at least one of the mandatory parameters below.
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/publications/get/email/an.academic@ulster.ac.uk all publications which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/publications/get/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation
/publications/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all publications with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

UIR codes

The names of Research Institutes and groups can change.
Less frequently, School and Faculty names may also change.
The webservice now publishes the UIR code for each of these entities.
The codes remain constant within the UIR so there will be no need to
update code when a name changes (although there may occasionally be a
new code added, for example, when a new group is created).

Codes are listed alongside institute, group, faculty and school names in the tabs below.
Both codes and names are drawn directly from the UIR and therefore are always up-to-date.

It is strongly recommended that you use the codes
rather than the names to retrieve items from the UIR.

Please note

The word mandatory is not a parameter key.
Use one of the following key words to specify a mandatory parameter.
Click on each key word to display its list of valid values.

Values

a valid Ulster staff member’s email

Tips

If you don’t get any results back for an email, and you are certain that
you are using a valid email, check for that person in the
Browse | Ulster Authors and Editors
section of the repository. If they are not listed there, they do not have any items live in the
repository.

Values

ri_ad Art_and_Design_Research_Institute
ri_hu Arts_and_Humanities_Research_Institute
ri_biomed Biomedical_Sciences_Research_Institute
ri_bue Built_Environment_Research_Institute
ri_bsm Business_and_Management_Research_Institute
ri_ms Centre_for_Media_Research
ri_cs Computer_Science_Research_Institute
ri_namr Engineering_Research_Institute
ri_es Environmental_Sciences_Research_Institute
ri_hrsri Health_and_Rehabilitation_Sciences_Research_Institute
ri_spri Institute_for_Research_in_Social_Sciences
ri_nur Institute_of_Nursing_and_Health_Research
ri_c Irish_and_Celtic_Studies_Research_Institute
ri_p Psychology_Research_Institute
ri_sprt Sport_and_Exercise_Sciences_Research_Institute
ri_tji Transitional_Justice_Institute

Examples

/publications/get/institute/Institute_of_Nursing_Research

/publications/get/institute/Sport_and_Exercise_Science_Research_Institute

/publications/get/institute/ri_sprt

Values

rig_hrsri_spic Activity_and_Enablement_(AE)
rig_namr_amfr Advanced_Metal_Forming
rig_ad_ac Art_and_Context
rig_ad_fa Art,_Conflict_and_Society
rig_cs_ai Artificial_Intelligence_and_Applications
rig_p_bn Behavioural_Neuroscience_and_Behaviour_Analysis
rig_nur_hrsrc Centre_for_Health_and_Rehabilitation_Technologies
rig_nur_ddch Centre_for_Intellectual_and_Developmental_Disabilities
rig_nur_mfiw Centre_for_Maternal,_Fetal_and_Infant_Research
rig_sprt_ph Centre_for_Physical_Activity_and_Health
rig_bue_crpp Centre_for_Research_on_Property_and_Planning_(RPP)
rig_sprt_sp Centre_for_Sport_in_Society
rig_sprt_sps Centre_for_Sports_Science_and_Sports_Medicine
rig_bue_cst Centre_for_Sustainable_Technologies_(CST)
rig_es_cm Coastal_Systems
rig_spri_c Communication
rig_hu_ca Creative_Arts_and_Technologies
rig_ad_aa Creative_Ecologies
rig_biomed_d Diabetes
rig_hrsri_diii Diabetic_Foot_-_Infection_-_Imaging_-_Intervention_(D3i)
rig_spri_ed Education
rig_nur_nepr Education_and_Professional_Issues_Research_Group
rig_namr_ecrc Engineering_Composites
rig_hu_en English
rig_bue_fsertc Fire_Safety_and_Engineering_Research_and_Technology_Centre_(FireSERT)
rig_es_f Freshwater_Sciences
rig_ad_d Future_and_Virtual_Worlds
rig_biomed_mo Genomic_Medicine
rig_es_g Geophysics
rig_nur_hpah Health_Promotion_and_Adolescent_Health
rig_p_hp Health,_Education_and_Well-being
rig_hu_h History
rig_bue_hsef Hydrogen_Safety_Engineering_and_Research_Centre_(HySAFER)
rig_biomed_ii Infection_and_Immunity/Microbiology
rig_cs_ise Information_and_Communication_Engineering
rig_cs_isrc Intelligent_Systems_Research_Centre
rig_spri_l Linguistics
rig_nur_mci Managing_Chronic_Illness_Research_Centre
rig_hrsri_mci Managing_Chronic_Illness_through_’Assisted_Living’
rig_es_ma Maritime_Archaeology
rig_hrsri_dm Medical_Imaging
rig_nur_mh Mental_Health
rig_hu_eu Modern_Languages
rig_hrsri_md Musculoskeletal_Disorder_(MSKD)_Rehabilitation
rigsg_mo_na Nano_Systems_Biology
rig_namr_nibec Nanotechnology_&_Integrated_BioEngineering_Centre_(NIBEC)
rig_hrsri_nr Neurorehabilitation_for_Health_(NRH)
rigsg_mo_nd Neuroscience_&_Neurodegenerative_Diseases
rig_biomed_niche Northern_Ireland_Centre_for_Food_and_Health_(NICHE)
rig_p_pc Peace,_Conflict_and_Equality
rig_nur_pcp Person-centred_Practice_Research_Centre
rig_biomed_psp Pharmaceutical_Science_and_Practice
rig_spri_p Politics_&_International_Studies
rig_p_msm Population_Health_Sciences_and_Mental_Health_Services
rig_p_pmh Psychotraumatology,_Mental_Health_&_Suicidal_Behaviour
rig_es_qec Quaternary_Environmental_Change
rig_hrsri_rcp Rehabilitation_in_Cancer_Patients
rig_hrsri_rrs Rehabilitation_in_Rheumatic_Sciences
rig_hrsri_rh Respiratory_Health
rig_cs_se Smart_Environments
rig_spri_sw Social_Work_&_Social_Policy
rig_es_s Society_and_Environment
rig_ad_sp Space_and_Place
rig_biomed_sm Stratified_Medicine
rig_bue_saber Studies_Allied_to_Built_Environment_Research_(SABER)
rig_es_t Terrestrial_Ecology
rig_p_bc The_Bamford_Centre_for_Mental_Health_and_Wellbeing
rigsg_mo_t Transcriptional_Regulation_&_Epigenetics
rigsg_mo_v Vascular_Medicine
rig_biomed_vs Vision

Examples

/publications/get/group/Coastal_Systems

/publications/get/group/Molecular_Medicine

Tips

Specifying a group applies the filter at a lower level
than institute.
If you specify both, the controller will return items at the institute level
(which should include the group level if the affiliations were applied correctly
when the item was deposited).

Values

fac_adbe Faculty_of_Art,_Design_and_the_Built_Environment
fac_arts Faculty_of_Arts
fac_ce Faculty_of_Computing_&_Engineering
fac_lhs Faculty_of_Life_and_Health_Sciences
fac_ss Faculty_of_Social_Sciences
fac_ubs Ulster_Business_School

Examples

/publications/get/faculty/Faculty_of_Arts

/publications/get/faculty/Ulster_Business_School

Values

sch_adbe_ad Belfast_School_of_Art
sch_ubs_bi Business_Institute
sch_ubs_da Department_of_Accounting,_Finance_and_Economics
sch_ubs_dbrfs Department_of_Business_and_Enterprise
sch_ubs_dhtm Department_of_Hospitality_and_Tourism_Management
sch_ubs_dib Department_of_International_Business
sch_ubs_dm Department_of_Management_and_Leadership
sch_ubs_dmes Department_of_Marketing,_Entrepreneurship_and_Strategy
sch_ss_gsp Graduate_School_of_Professional_Legal_Education
sch_ss_inc INCORE
sch_arts_iuss Institute_of_Ulster_Scots_Studies
sch_adbe_x_rgs Research_Graduate_School
sch_arts_x_rgs Research_Graduate_School
sch_ce_x_rgs Research_Graduate_School
sch_lhs_x_rgs Research_Graduate_School
sch_ubs_x_rgs Research_Graduate_School
sch_ss_x_rgs Research_Graduate_School_(Social_Sciences)
sch_lhs_bs School_of_Biomedical_Sciences
sch_ss_c School_of_Communication
sch_ce_cie School_of_Computing_and_Information_Engineering
sch_ce_cis School_of_Computing_and_Intelligent_Systems
sch_ce_cm School_of_Computing_and_Mathematics
sch_arts_ca School_of_Creative_Arts_and_Technologies
sch_ss_ps School_of_Criminology,_Politics_and_Social_Policy
sch_ss_ed School_of_Education
sch_ce_eme School_of_Engineering
sch_arts_hia School_of_English_and_History
sch_lhs_es School_of_Geography_and_Environmental_Sciences
sch_lhs_hs School_of_Health_Sciences
sch_arts_i School_of_Irish_Language_and_Literature
sch_ss_l School_of_Law
sch_arts_mfj School_of_Media,_Film_&_Journalism
sch_arts_ll School_of_Modern_Languages
sch_lhs_n School_of_Nursing
sch_lhs_pps School_of_Pharmacy_and_Pharmaceutical_Science
sch_lhs_p School_of_Psychology
sch_ss_sass School_of_Sociology_and_Applied_Social_Studies
sch_lhs_ss School_of_Sport
sch_adbe_be School_of_the_Built_Environment
sch_adbe_arc The_Belfast_School_of_Architecture

Examples

/publications/get/school/School_of_Communication

/publications/get/school/School_of_Sports_Studies

Tips

As for institute/group combinations, specifying a school applies the filter
at a lower level than faculty, therefore you should not specify the parent faculty
if you only want the group publications.
If you specify both, the service will return items at the faculty level.

publications – type

You can specify which type(s) of items you want the web service to return, or to exclude.

Type names

artefact
article
body_of_work
book_authored
book_edited
book_section
composition
conference_item
confidential_report_external
design
device
digital_media
exhibition
installation
internet_publication
other
patent
performance
research_report_external
scholarly_edition
software
thesis

Default

If you do not use the type parameter, all item types will be returned.

Examples

/publications/get/school/School_of_Law/type/article

/publications/get/school/sch_ss_l/type/book_edited,book_section

/publications/get/school/sch_ss_l/type/-article

Tips

If you specify one item type, the service will return only items of that type.

You can specify more than one item type by separating the values with commas. The service will return items of those types.

You can exclude a particular item type by prefixing the value of the parameter with a minus-sign.

publications – render

You can specify how the data will be rendered, according to your preference
for any processing you want to do with the publications data before displaying
it on the target web page.

The json and xml rendering options return additional data that may be useful for
any custom processing you want to do. For example, the creators’ names are
returned in a separate structure in addition to as a list.

The web service has the following options for how the data will be rendered.
Please note, the examples below are for illustration only.
Additional fields may be added if required in the future.

Values

Examples

html

/publications/get/email/an.academic@ulster.ac.uk/render/html

HTML is the default option if you do not specify a render parameter.


The HTML returned will have the same format as the UIR author_by_email view.

xml

/publications/get/email/an.academic@ulster.ac.uk/type/article/render/xml

<eprints>

<eprint>

<eprintid>318</eprintid>

<type>article</type>

<creators>Smith A, Academic AN and Another S</creators>

<creators_names>

<creators_name>

<family>Smith</family>

<given>A</given>

<position>0</position>

</creators_name>

<creators_name>

<family>Academic</family>

<given>AN</given>

<position>1</position>

</creators_name>

<creators_name>

<family>Another</family>

<given>S</given>

<position>2</position>

</creators_name>

</creators_names>

<publication_date>(2009)</publication_date>

<publication_date_year>2009</publication_date_year>

<publication_date_month>3</publication_date_month>

<publication_date_day/>

<title><a target=”_blank” href=”http://eprints-dev.ulster.ac.uk/318″><em>The Development and Pilot Testing of an Instrument to Measure Nurses’ Working Environment: The Nursing Context Index</em></a></title>

<publication>WORLDVIEWS ON EVIDENCE-BASED NURSING</publication>

<volume>6</volume>

<number>3</number>

<pagerange>173-182</pagerange>

</eprint>

</eprints>

json

/publications/get/institute/Institute_of_Nursing_Research/type/article/render/json

[

{

“eprintid”:4,

“type”:”article”,

“creators”:”Switzer C and McDowell S”,

“publication_date”:”(2009)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>”,

“title”:”Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast”

“publication”:”Memory Studies”,

“volume”:”2″,

“number”:”3″,

“pagerange”:”337-353″

“citation”:”Switzer C and McDowell S (2009) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/4\”><em>Redrawing cognitive maps of conflict: lost spaces and forgetting in the centre of Belfast<\/em><\/a>. Memory Studies 2 (3). pp. 337-353.”

},

{

“eprintid”:48,

“type”:”article”,

“creators”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F”,

“publication_date”:”(2010)”,

“title_with_link”:”<a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>”,

“title”:”A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks”

“publication”:”Computers in Biology and Medicine”,

“volume”:”40″,

“number”:”3″,

“pagerange”:”306-317″

“citation”:”Azuaje F, Zheng H, Wang H, Browne F, Azuaje F, Zheng H, Wang H and Browne F (2010) <a target=\”_blank\” href=\”http:\/\/eprints.ulster.ac.uk\/48\”><em>A knowledge-driven probabilistic framework for the prediction of protein\u2013protein interaction networks<\/em><\/a>. Computers in Biology and Medicine 40 (3). pp. 306-317.”

}

]

Use the php function json_decode
if you need to turn the default json string into an array for additional processing.

publications – format

Citation format options are currently under review.
Please let us know if there is a particular format you require.
In the meantime, all publication citations will be returned
in the default format (the same format as displayed in the UIR).

Values

Default

If you do not specify the format parameter, the publication citations will be returned in
the default EPrints format.

Examples

Tips

publications – order

Fields to order on can be chained using the semicolon ; character.

Defaults

If you do not specify any order parameter, the publications will be returned
ordered by year of publication (descending), first author’s name (ascending) and
title (ascending).

If you specify an order without a flag, the default order is ascending.
Specify descending order by adding ,d after the field you want to sort on.

Values

Examples

year

/publications/get/email/an.academic@ulster.ac.uk/type/conference_item/order/year

returns all the conference contributions for an.academic@ulster.ac.uk sorted in ascending order by the
year of publication

NOTE: a list of the types for any given email can be retrieved using the types parameter
(see the types – mandatory section below for more information)

date,d

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/date,d

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by the
complete date of publication

NOTE: only the year part of the publication date is required when depositing an item in the
UIR, the month and day may not exist in the item metadata

year,d;name

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/year,d;name

returns all the articles for an.academic@ulster.ac.uk sorted in descending order by year of
publication, and within the year, in ascending order of first author’s name

title

/publications/get/email/an.academic@ulster.ac.uk/type/article/order/title

returns all the articles for an.academic@ulster.ac.uk sorted in ascending order of title
(useful for checking for possible duplicates)

types – mandatory parameters

The types controller will return a list of the item types for the
parameter(s) supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires at least one of the same mandatory parameters as publications (see
the publications – mandatory parameters section above).
No data will be returned unless you supply a value for at least one of these parameters.
You can combine mandatory parameters in order to specify more precise filtering of
the data to be returned.

Examples

/types/get/email/an.academic@ulster.ac.uk all types which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/types/get/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation
/types/get/email/f.spinola@ulster.ac.uk/group/Maritime_Archaeology all types with the Maritime Archaelogy research group affiliation AND
which have the email f.spinola@ulster.ac.uk in the authors/creators metadata field

Please note

The word mandatory is not a parameter key.
See the publications – mandatory parameters section above for a
complete list of the current names for faculties, research institutes, etc.

item IDs – mandatory parameters

The itemids controller will return a list of the item IDs for the
Ulster email supplied, to help you organise the UIR content on
faculty and research institute web pages.

It requires a single mandatory parameter: a valid Ulster email.

Optionally, you can use the type parameter to get item IDs for a particular
type of item.

The same rendering options are available as for publications:
html (default), json and xml.

Examples

/itemids/get/email/an.academic@ulster.ac.uk all item IDs (and item types) which have the email an.academic@ulster.ac.uk in the authors/creators metadata field
/itemids/get/email/an.academic@ulster.ac.uk/type/article all item IDs for items of the specified type which have the email an.academic@ulster.ac.uk in the authors/creators metadata field