Guides
Start typing to search…

Overview

The ScholarOne Conferences API enables seamless data extraction from ScholarOne Conferences production data base to external systems.

REST API

The ScholarOne Web Services REST (Representational State Transfer) APIs provide access to resources via URI (Uniform Resource Identifier) paths. Your application will make an HTTP request and parse the response. By default, the response format is XML. If you wish, you can request JSON instead of XML.


Web Service Client Requirements

To interact with ScholarOne’s REST-based services, a client must be capable of sending and receiving messages, including handling both success and failure responses. Users have the option to create their own client in any language, or use an existing client such as Postman to make calls.


General Information

  • Data Access: Most data fields in ScholarOne Conferences can be accessed through our API.
  • Real-Time Updates: The API refreshes data with each call, providing real-time information from ScholarOne Conferences.
  • Access Control: Access may be restricted to specific IP addresses or open to all authorized users, depending on the configuration set by your organization.
  • Consistent Credentials: API credentials remain the same year-over-year and support access to multiple sites.
  • Field Mapping: Vendors can use API data to populate your application fields. To ensure accuracy, identify field names and IDs are needed for data mapping.
  • Data Inclusion: All ScholarOne Conferences data is available, but users must filter data by specific parameters, such as abstract status or session IDs. For example, you might pull only the "title" and "abstract body" of accepted abstracts.

Compliance with Standards

ScholarOne Web Services adheres to several key standards, including:

  • JSR 224: Java API for XML-based Web Services 2.0 (JAX-WS)
  • JSR 311: Java API for RESTful Web Services (JAX-RS)
  • WADL 1.1: Web Application Description Language
  • XML Version 1.0
  • Formats: XML, JSON
  • Protocol: HTTPS

Prerequisites for Using the ScholarOne API

To use the ScholarOne APIs, you will need the following:

  • API Key: Provided by your Implementation Consultant and configured in your Account Profile.
  • ScholarOne Web Services Username: A profile name specific to your ScholarOne Web Services application.
  • Site Short Name: The short name identifying the specific ScholarOne Conferences site you will interact with. (xxxxx.abstractcentral.com)
  • Web Services Client: A tool or utility that can send and receive messages via HTTP, using the GET method.

API Structure and Example

The ScholarOne Conferences API has three main data calls:

  1. Abstracts Data
  2. Session Data
  3. Person Data

Example usage:

  1. Session Retrieval: Use getSessionByDate to get IDs of sessions modified within a set period.
  2. Abstract Details: With getSessionsByID, access session contents and then use the resulting Abstract Control IDs with getAbstractsByID to retrieve abstract details.
  3. Author Information: For co-author details, call getPersonByID using co-author person IDs extracted from getAbstrctsByID call.

Response Content Types

The API supports both JSON and XML response formats. The type can be set within the request URI. Null values appear as follows:

  • JSON: Represented as null.
  • XML: Null values are indicated by the absence of the element.

Common API Pitfalls

Avoid these common issues:

  • Repeated Calls to the Same IDs: Avoid frequent, redundant requests.
  • Excessive Calls: To prevent throttling and potential API overload, restrict API requests to a maximum of 30 calls per minute.
  • Static Data Calls: Ensure data has been updated since the last call.
  • High Volume in Off-Peak Times: Frequent calls should be limited to periods close to major events (e.g., just before/after conferences).

Best Practice API Strategies

Follow these guidelines for optimal API usage:

  • Evaluate Call Patterns: Regularly review and adjust call frequency.
  • Request Only Updated Data: Pull only modified abstracts, sessions, or person data.
  • Bulk Calls: Group requests into batches (up to 25 IDs per call).
  • Optimize Timeframes: Use ByDate calls with correct time intervals. Initial pulls may cover longer periods but shorten the range for subsequent calls.
  • Utilize Testing Tools: Use Postman or similar tools to test and refine API performance.

Support

If you have any questions regarding the usage of our Web Services product or issues with your access, please visit the ScholarOne Support page

Updated 5 months ago

What’s Next