Overview

ScholarOne Web Services provides access to submission and peer review metadata from the ScholarOne Manuscripts production database. This API allows users to interact with the system programmatically, making it a powerful tool for integrating submission data into other systems or for creating custom workflows.

REST API

The ScholarOne Web Services REST (Representational State Transfer) APIs allow access to various resources via URI paths. To use the API, an application sends HTTP requests and processes the responses. By default, responses are formatted in XML, although users can request JSON format if preferred. As the API is based on open standards, it can be accessed using any web development language.

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.

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 the ScholarOne Delivery team 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 site you will interact with.
Web Services Client: A tool or utility that can send and receive messages via HTTP, using the GET method.

Response Content Types

The following data formats are supported for response data sent back by the API server. The required data format is specified as the <_type> Standard Query Parameter.

Response Format	Specified in URI as	Response Content-Type
JSON	json	application/json
XML	xml	application/xml

Null Values

Some of the fields in a resource may be optional or currently absent. The values of these fields are represented as a special NULL value. This value maps to corresponding equivalents in the data formats as listed below.

Response Format	Null Value Representation
JSON	null
XML	No element (assume null values for missing elements)

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 and choose the Developer role for tailored assistance.