Overview

The Relay API provides a unified way to submit and manage different types of objects for validation and storage. Some of the supported use cases include document integrity checks, reviewer matching and author verification, with the flexibility to support additional workflows as needed.

Clients interact with the API through a POST request containing a JSON payload with the relevant details. Each request is validated against predefined constraints before the data is stored and made available for future retrieval.

Method: POST

Resource

/api/s1m/v2/system/addJSONData

Request Parameters

Element	Type	Description	Required	Example or Default Value
addJSONData	Root		Yes
username	String	Profile User Name. This is the user name used by the API, not a ScholarOne Manuscripts user. This is from the Caller’s profile.	Yes	sample_user
password	String	The API Key. Encrypted value uniquely identifying and authenticating Caller	Yes	SRU4DQ5WOJ2PX8CA
site_name	String	Site short name. The short name is the abbreviated or truncated name of the journal, society, publisher, or family.	Yes	salesdemoplus
url	String	The Web Service URL, which identifies the specific service to handle the request.	Yes	v2/system/addJSONData
external_id	String	An id value that can be set by the client for call tracking. Caller supplied Text string to be stored with Audit History information.	No	123456

Request Body Elements

The request body must be in JSON format.

Request Body Elements for Integrity Check example

{
    "data": {
        "type": 2,
        "payload": {
            "documentId": 12345,
            "content": "<p>Sample content</p>",
            "checkType": 1111,
            "url": "https://example.com",
            "effectiveDate": "2025-03-17",
            "score": 45,
            "alert": "false"
        }
    }
}

Request Body Elements Description

Request Body Elements/Example Relay API	Type	Description	Req
data	Object	Root object that defines the request structure	Yes
type `2`	Integer	This field defines the type of the request being made. Always set to 2	Yes
payload	Object	Contains the specific details relevant to the request.	Yes
documentId `12334567`	Integer	Unique identifier of the document.	Yes
checkType `1111`	Integer	Represents the type of integrity check being performed. Assigned by S1	Yes `(for Research Integrity use)`
content `<p>Sample Content</p>`	String	The document content. It supports basic HTML tags and has a maximum length of 2000 characters. The content field allows the following HTML tags: Text formatting: `<a>, <b>, <blockquote>, <br>, <cite>, <code>, <dd>, <dl>, <dt>, <em>, <i>, <li>, <ol>, <p>, <pre>, <q>, <small><strike>, <strong>, <sub>, <sup>, <u>, <ul>` Images: `<img>` (must have a src attribute pointing to http or https URLs)	Yes
url `https://www.example.com`	String	The URL providing additional information related to the Integrity Check request. Max length: 500 characters.	Yes
effectiveDate `2025-03-11`	date	The expiration date of the check. The value must be provided in standard date format.	Yes `(for Research Integrity use)`
score `45`	Integer	A numeric representation ot the integrity check score. Must be between 0 and 100.	Yes `(for Research Integrity use)`
alert `"true" or "false"`	String	Indicates whether an alert was triggered during the integrity check.	Yes `(for Research Integrity use)`