SearchPublicationsApi.md

SearchPublicationsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
searchPublications	POST /api/v1/search/publications	Search@publications
searchPublicationsByDoi	POST /api/v1/search/doi	Search@publications

searchPublications

SearchPublications200Response searchPublications(searchPublicationsRequest, sort, direction, source)

Search@publications

Returns gateway publications related to the provided query term(s)

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.SearchPublicationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    SearchPublicationsApi apiInstance = new SearchPublicationsApi(defaultClient);
    SearchPublicationsRequest searchPublicationsRequest = new SearchPublicationsRequest(); // SearchPublicationsRequest | Submit search query
    String sort = "created"; // String | Field to sort by (default: 'score')
    String direction = "asc"; // String | Sort direction ('asc' or 'desc', default: 'desc')
    String source = "GAT"; // String | Which source to search ('GAT' or 'FED', default: 'GAT')
    try {
      SearchPublications200Response result = apiInstance.searchPublications(searchPublicationsRequest, sort, direction, source);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SearchPublicationsApi#searchPublications");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
searchPublicationsRequest	SearchPublicationsRequest	Submit search query
sort	String	Field to sort by (default: 'score')	[optional]
direction	String	Sort direction ('asc' or 'desc', default: 'desc')	[optional] [enum: asc, desc]
source	String	Which source to search ('GAT' or 'FED', default: 'GAT')	[optional] [enum: GAT, FED]

Return type

SearchPublications200Response

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-

searchPublicationsByDoi

SearchPublicationsByDoi200Response searchPublicationsByDoi(searchPublicationsByDoiRequest)

Search@publications

Returns publications from EuropePMC matching a give DOI

Example

// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.auth.*;
import uk.ac.hdruk.gatewayapi.models.*;
import uk.ac.hdruk.gatewayapi.api.SearchPublicationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    SearchPublicationsApi apiInstance = new SearchPublicationsApi(defaultClient);
    SearchPublicationsByDoiRequest searchPublicationsByDoiRequest = new SearchPublicationsByDoiRequest(); // SearchPublicationsByDoiRequest | Submit search query
    try {
      SearchPublicationsByDoi200Response result = apiInstance.searchPublicationsByDoi(searchPublicationsByDoiRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SearchPublicationsApi#searchPublicationsByDoi");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
searchPublicationsByDoiRequest	SearchPublicationsByDoiRequest	Submit search query

Return type

SearchPublicationsByDoi200Response

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
204	No match found	-