This is the Pure web service

It contains a SOAP service endpoint at /ws/pure4webservice/. Point your tool to the WSDL for current or stable

You may also want to use the REST service at /ws/rest/

Use cases and examples

Person Organisation Research Output OAI Documentation Available Endpoints

Person

Description Url
List of first persons /ws/rest/person
Show a window of ten persons from 10-20 /ws/rest/person?rendering=xml_long&window.size=10&window.offset=10
List of persons order by last name /ws/rest/person?orderBy.property=lastName
To Show information for a specific person, including organisation associated in xml_long format /ws/rest/person?uuids.uuid=975731c9-a130-4444-9600-a73dadd16f53&rendering=xml_long
Show all research output for a specific person of contribution to journal - article /ws/rest/publication?associatedPersonUuids.uuid=8983bb5d-99b4-4612-bef8-e4a29985fbbd&typeClassificationUris.uri=/dk/atira/pure/researchoutput/researchoutputtypes/contributiontojournal/article&window.size=20
For getting all research output for a specific person with specified period, from 2000 to 2010-10-12 /ws/rest/publication?associatedPersonUuids.uuid=8983bb5d-99b4-4612-bef8-e4a29985fbbd&publicationDate.fromDate=2000&publicationDate.toDate=2010-10-12&window.size=20
To show all research output for a specific person associated with either of two organisations /ws/rest/publication?associatedPersonUuids.uuid=8983bb5d-99b4-4612-bef8-e4a29985fbbd&associatedOrganisationUuids.uuid=c7c73b69-aaba-442a-bba3-c286b0f0591b,81a0f123-95ec-4621-ab8f-2cfd4d6fdfa2&window.size=20
To show all activities associated with a specific person /ws/rest/activity?associatedPersonUuids.uuid=8c025099-81ed-4dfc-a467-6b6d3738cc94&window.size=20
To show all projects associated with a specific person /ws/rest/project?associatedPersonUuids.uuid=8c025099-81ed-4dfc-a467-6b6d3738cc94&window.size=20

Organisation

Description Url
List organisations /ws/rest/organisation
list organisations of type college /ws/rest/organisation?typeClassificationUris.uri=/dk/atira/pure/organisation/organisationtypes/organisation/college
Show persons associated with a specific organisation /ws/rest/person?associatedOrganisationUuids.uuid=dfff7b7d-6011-4c2a-b65b-bdf67bca17e1&window.size=20
Show research output associated with a specific organisation /ws/rest/publication?associatedOrganisationUuids.uuid=dfff7b7d-6011-4c2a-b65b-bdf67bca17e1&window.size=20
Show activities associated with a specific organisation /ws/rest/activity?associatedOrganisationUuids.uuid=dfff7b7d-6011-4c2a-b65b-bdf67bca17e1&window.size=20
Show projects associated with a specific organisation /ws/rest/project?associatedOrganisationUuids.uuid=dfff7b7d-6011-4c2a-b65b-bdf67bca17e1&window.size=20

Research Output

Description Url
Show all supported rendering formats for research output /ws/rest/getAllowedFormatsRequest?type=dk.atira.pure.api.shared.model.publication.AbstractPublication
Get research output of type contributions to journal - article /ws/rest/publication?typeClassificationUris.uri=/dk/atira/pure/researchoutput/researchoutputtypes/contributiontojournal/article&window.size=20
To show all research output assiged to a given organisation, including all suborganisations /ws/rest/publication?associatedOrganisationUuids.uuid="organisation uuid"&window.size=20&associatedOrganisationAggregationStrategy=RecursiveContentValueAggregator
When using wildcards for searching parenteses () must be used to surround the search term. Note that the () are url encoded /ws/rest/publication?searchString=%28blood*%29
For getting all validated and approved research output for a given organisation and all underlying organisations /ws/rest/publication?window.size=20&associatedOrganisationAggregationStrategy=RecursiveContentValueAggregatorworkflowStates.workflowState[0]=approved&workflowStates.workflowState[0].workflowName=publication&associatedOrganisationUuids.uuid=27379a37-7b2b-49e4-beda-ad1d0522102c&workflowStates.workflowState[1]=validated&workflowStates.workflowState[1].workflowName=publication
Get all research ouput that have Scopus as source /ws/rest/publication.current?source.name=Scopus
Get research ouput with either of two specific PubMed IDs /ws/rest/publication.current?source.name=PubMed&source.value=19838868,11017075
Person - Person collaboration on ResearchOutput (co-authors) /ws/rest/collaborators.current?sourceFamily=Person&targetFamily=Person&collaborationFamilies.value=ResearchOutput&window.size=3
Person - Person collaboration on ResearchOutput (co-authors)
Limited to two specific persons. Including details
/ws/rest/collaborators.current?sourceCriteria.uuids.uuid=570e4106-c776-4e33-a04a-bb043c9a227c,0951dd40-f822-4f2e-9c1e-5fe2648b8a30&sourceFamily=Person&targetFamily=Person&collaborationFamilies.value=ResearchOutput&includeCollaborationDetails=true
Person - External Person collaboration on ResearchOutput using GetExternalCoauthorRequest /ws/rest/externalcoauthor.current?personUuids.uuid=6635b72f-4ac2-4e6a-bf05-0bfd77d0c13f

OAI

For harvesting based on the OAI-PMH protocol, the OAI service is available at at /ws/oai?verb=Identify
Also see

Description Url
Currently support OAI-PMH formats /ws/oai?verb=ListMetadataFormats
Show a list with a certain format /ws/oai?verb=ListRecords&metadataPrefix=oai_dc
The sets that the OAI-PMH currently supported /ws/oai?verb=ListSets"
Example of using a set. This is for listing research output along with associated files /ws/oai?verb=ListRecords&metadataPrefix=oai_dc&set=publications:withFiles

Documentation

Generated REST reference documentation can be downloaded at /ws/doc/rest/reference.pdf. Finally the Atira WIKI contains some getting started webservice information as well. And of course you can always get in touch on pure-support@atira.dk and issues.atira.dk.

Another way of getting started with REST web service, is to use SoapUI to explore the available REST endpoints. Use the WSDL url, either stable or current in SoapUI allows for an overview of the endpoints along with example soap request. These requests can be translated to REST request with little practice.

Available EndPoints

Below is listed the available end point for the REST web service. Notice that endpoint may have two versions, e.g activity and activity.current. activity is the stable version of the endpoint, which changes rarely and most often for only for bugfixes. activity.current is the current version og the endpoint, which be redefined in minor releases.


Allowed Endpoints

The following section contains allowed endpoints. These endpoints are used to help show which content can be access for different endpoints, e.g. alloworderby lists which order by queries are allow for a specific content type


Description Url
List allowed formats for UpmProjects /ws/rest/allowedformats?type=dk.atira.pure.modules.unifiedprojectmodel.external.model.project.UPMProject

Content Type Endpoints

The content type endpoints are standalone endpoints, which can be queired without adding parameters as they correspond to the underlying model.


Description Url
Lists activities with activity date older than 1. January 2012 /ws/rest/activity?activityDate.fromDate=2012-01-01
Shows all events for a specific person /ws/rest/event?associatedPersonUuids.uuid=ceba005a-de5d-482a-bf25-f253a688e117
Shows all publishers of type publisher /ws/rest/publisher?type=dk.atira.pure.api.shared.model.publisher.Publisher

Classification Endpoints

The subset of endpoints in the following are used to browsing classification schemes for entry types in Pure


Description Url
Explore award classification /ws/rest/classifications?uris.uri=/dk/atira/pure/award/awardtypes/award/researchcouncils/award
Show classification hierarchy for children of upmprojests /ws/rest/classificationschemehierarchy.current?baseUri=/dk/atira/pure/upmproject/upmprojecttypes

Keywords From Endpoints

This section of endpoints are used for retrieving a hierarchy of keywords from another entity, e.g. keywordsfromperson will list keywords related to person in a hierarchy


Description Url
List keywords for person with the email: test@email.com /ws/rest/keywordsfromperson?email=test@email.com
List keywords for a specific organiation /ws/rest/keywordsfromorganisation?uuids.uuid=de540719-b874-4c2e-bad9-6142c620642a

Strategies Endpoints

Used to create links from content to the corresponding linking strategy. Linking strategies is used when outputting XHTML renderings, for example short, standard or harvard.


Description Url
Organisation links /ws/rest/organisation?rendering=short&linkingStrategy=portalLinkingStrategy

Changes Endpoint

The changes endpoint is used to get an overview of changes to content, typically within some period. Initial request should be done with a date as parameter, and consequent requests should use resumption tokens (returned by each response).

Description Url
Initial request to get changes since a specific data /ws/rest/changes.current?fromDate=2015-01-22
Listing changes base on the resumption token /ws/rest/changes.current?resumptionToken=%3C?xml%20version=%221.0%22%20encoding=%22UTF-8%22%20standalone=%22yes%22?%3E%3CchangesResultResumptionToken%20greaterThanId=%222851215%22/%3E

Other Endpoints

There are a number of additional endpoints, most can be queried with the similar patterns to the examples presented above.