ORBi REST API

Index

• GET / - Return this page.

Items

• GET/POST /items - Return a list of items.
  optional parameters:

  • HTTP HEADER (Accept) : if needed you can format the output in json or xml 'Accept:application/json' or 'Accept:application/xml' (default:'application/xml')
  • limit: number of references returned (default:10/maximum:2000)
  • offset: offset applied to the result, if the offset is greater than the max result then the API will return an empty list of references (default:0)
  • mode: format used in the citation output - can be apa,chicago or html(default:'apa')
  • lang: language used for output - can be 'en' or 'fr' (default:'en')
  • query examples:
    • if you need the list of references of an author given his master id : query=author_authority:$master_id
    • if you need the list of references of authors given their master ids : query=author_authority:$master_id_1 OR author_authority:$master_id_2
    • if you need a reference given its handle : query=handle:$handle
    • if you need the list of references linked to a given funder authority : query=sponsor_authority:$funder_authority
    • if you need the list of references with subject 'chemistry' : query=subject:chemistry
    • if you need the list of references with a specific issued year : query=issued:2020
    • if you need the list of references with a range of issued years : query=issued:[2020 TO 2021]
    • if you need the list of references with a bigger issued year : query=issued:[2019 TO *]
    • if you need the list of references with a smaller issued year : query=issued:[* TO 2019]
  • sort_1, sort_2 and sort_3: Sorting order (e.g.: "title_sort:asc", "issued_dt:desc", "lastModified:desc")
  • field: Additionnal fields available in the output only for apa/chicago/html mode, if not specify all fields will be present. You have to use ',' separator for multiple values. Values allowed : type,classification,access,contributors,format,handle,lastModified,publicationDate,review,doi
  fields used in the result (only for apa/chicago/html mode):

  • type: Document type Typology and definitions The attribute 'code' is the authority identifier of the document type
  • classification: Disciplines, one or more disciplines to ensure that the publication is correctly assigned to the research area. The attribute 'code' is the authority identifier of the document classification
  • access: The access of the reference, it can be (0-Open Access, 1-Open Access after embargo, 2-Restricted access, 3-Private access)
  • review: Peer reviewed, the publication is peer reviewed (revised by experts outside the editorial board) or editorial reviewed (internal review by the editorial board) The attribute 'code' is the authority identifier of the peer reviewed status
  • citation: The citation of the reference (depend of the mode used) can be apa/chicago/html
  • doi: the document has a DOI (permanent identifier given to online publications)
  • format: The file format of the fulltext
  • handle: The handle identifier of the reference
  • lastModified: The last date when the reference has been modified
  • publicationDate: The date which the reference has been published
• GET/POST /metrics - Return a list of itemMetrics.
  optional parameters:

  • limit: number of metrics returned (default:10/maximum:2000)
  • offset: offset applied to the result, if the offset is greater than the max result then the API will return an empty list of metrics (default:0)
  • query examples:
    • if you need the list of metrics of an author given his master id : query=author_authority:$master_id
    • if you need the list of metrics of authors given their master ids : query=author_authority:$master_id_1 OR author_authority:$master_id_2
    • if you need metrics of a specific handle : query=handle:$handle
    • if you need the list of metrics linked to a given funder authority : query=sponsor_authority:$funder_authority
    • if you need the list of metrics with subject 'chemistry' : query=subject:chemistry
    • if you need the list of metrics with a specific issued year : query=issued:2020
    • if you need the list of metrics with a range of issued years : query=issued:[2020 TO 2021]
    • if you need the list of metrics with a bigger issued year : query=issued:[2019 TO *]
    • if you need the list of metrics with a smaller issued year : query=issued:[* TO 2019]