getSubmissionInfoBasic

getSubmissionInfoBasic requires input of a Document ID or IDs, or a Submission ID or IDs, and returns basic information about the manuscript's status and their respective author(s).

Required Parameters

  • Submission ID(s) or Document ID(s) - up to 25
  • Site Short Name

Optional Parameters

  • Locale ID
  • _type
  • External ID

Resource

  • By documentID: /api/s1m/v3/submissions/basic/metadata/documentids
  • By submissionID: /api/s1m/v3/submissions/basic/metadata/submissionids

Request Parameters

Element Type Description Required Example or Default Value
getSubmissionInfoBasic 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
ids† Integer or Integer Array Document Id or Ids. Unique identifier for each Manuscript Revision in the ScholarOne Manuscripts system. Internally to ScholarOne, this is a numeric value. Each entry must be surrounded by single or double quotes and comma separated when more than one entry is specified. Yes, if submission IDs are not used. ’88026’ Or if a list is being requested: '88026','88087','89328'
ids†† String or String Array Submission Id or Ids. Also known as the Manuscript ID or Document Number. Identifier that is seen in the ScholarOne UI for each Manuscript. Submission Ids are case-sensitive. Each entry must be surrounded by single or double quotes and comma separated when more than one entry is specified. Yes, if document IDs are not used. 'WEB-2013-0002' Or if a list is being requested: 'WEB-2013-0002','WEB-2013-0003'
site_name String Site short name. The short name is the abbreviated or truncated name of the journal, society, publisher, or family. Yes web_svcs
url String The Web Service URL, which identifies the specific service to handle the request. Yes v3/submissions/basic/metadata/documentids
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
locale_id Integer The unique identifier for a specific language. The value of the locale_id must match to the specific language as defined in the Caller’s profile. No Options are:
  • 1 (United States English)
  • 2 (Simplified Chinese, Pinyin ordering)
  • 3 (French)
_type String The data type requested from the Service <xml> or <json>. This defaults to <xml>. No xml (default if omitted), or json

Response Elements

Response Element

Type

Description

Example or default Value

Status

String

State of a given request call

Can be one of SUCCESS, FAILURE, or MAINTENANCE. 

<status>SUCCESS</status>

callID

String

The CALL_ID is the unique identifier for a given Web Services call. Generated by the ScholarOne Web Services application.

<callId>63631fe1-7378-4cc1-ab18-87c06c2eff58</callId>

profileCallId

String

An id value that is set by the client for call tracking.  Set by the request’s external_id element.

<profileCallId>111111</profileCallId>

authorFullName

String

The full name of the author in the format “Lastname Suffix, Salutation Firstname Middlename”. Submitting Author or Submitting Agent.

<authorFullName>Hucho, Dr. Tim</authorFullName>

authorMembershipId

String

Society Membership number of the user.

<authorMembershipId>society_123</authorMembershipId>

authorORCIDId

String

The ORCID is a nonproprietary alphanumeric code to uniquely identify scientific and other academic authors.

<authorORCIDId>0000-0002-6167-6691</authorORCIDId>

authorORCIDIdValidation

Boolean

Indication of whether that author ORCID has been validated by the author.

<authorORCIDIdValidation>TRUE</authorORCIDIdValidation>

authorPersonId

Integer

A unique numeric identifier associated with a person record (not the user's User ID used for accessing ScholarOne).

<authorPersonId>686975</authorPersonId>

authorResearcherId

String

Provides solution to Author ambiguity by assigning a unique identifier for scientific authors.

<authorReseacherId>A1061-2007</authorResearcherId>

authorSuffix

String

The suffix chosen in the author’s account record.

<authorSuffix>III</authorSuffix>

documentId

Integer

Unique identifier of the document. Unique identifier for each Manuscript Revision in the ScholarOneManuscripts system. Internally to ScholarOne, this is a numeric value.

<documentId>88026</documentId>

inputIndex

Integer

Provides caller the ability to correlate requested document or submission IDs to the appropriate response element. The inputIndex will be randomly chosen when a document or submission id is entered more than once.

<inputIndex>4</inputIndex>
This is a zero-based value. That is, if a single document ID is requested, theinputIndex is 0

journalDigitalIssn

String

The configured digital International Standard Serial Number for the publication on ScholarOne site.

<journalDigitalIssn>5678-1234</journalDigitalIssn>

journalPrintIssn

String

The configured print International Standard Serial Number for the publication on S1 site

<journalPrintIssn>2043- 0008</journalPrintIssn>

submissionDate

dateTime

The 'Submission Date' reflects the date and time in UTC when a manuscript was submitted to the site. It's important to note that this date might be altered by the Editorial Office. For the precise date and time when the author submitted the document, refer to the 'Transmission Date'.

<submissionDate>
2024-05-10T11:47:48Z
</submissionDate>

submissionId

String

Also known as the Manuscript ID or Document Number, an identifier given to each submitted manuscript. Submission IDs are case-sensitive and are not necessarily unique.

<submissionId>Sensors00996-2005</submissionId>

submissionTitle

String

The title of a manuscript submitted to a publication.

<submissionTitle>
The Use of Computers in Elementary Classrooms</submissionTitle>

submissionType

String

The Submission Type refers to the name of the group or collection of attributes chosen by the author to classify a submission.

<submissionType>Original Article</submissionType>

transferSubId

String

A unique identifier assigned to each submission, enabling tracking even when the submission is transferred across ScholarOne sites.

<transferSubId>ac6828d7-b1c3-4561-9933-9d37680226f21</transferSubId>

submissionStatus

Complex

The status of a submission. Lists open tasks (action items) and any decision made on that submission.

  • Complex Child_ of Parent Root
    Includes the following response elements:\

decisionName, documentStatusId, documentStatusName, inDraftFlag, task

decisionName

String

The name of the decision rendered on the submission.

<decisionName>Immediate Reject</decisionName>

documentStatusId

Integer

Key identifier for document status.

<documentStatusId>3</documentStatusId>

documentStatusName

String

User-friendly name of a document’s status in the journal’s submission workflow.

<documentStatusName>Submitted</documentStatusName>

inDraftFlag

Boolean

Indicates whether the manuscript is currently in DRAFT status.

<inDraftFlag>false</inDraftFlag>

task

Complex

Activity currently being performed for the current manuscript.

  • Complex Child_ of submissionStatus
    Includes the following response elements:

taskId, taskName, taskStatus, taskStatusName

taskId

Integer

Global unique identifier of the task.

<taskId>434153960</taskId>

taskName

String

Name of task as configured in the site workflow.

<taskName>Forms Tracking - CTA</taskName>

taskStatus

String

The Task Status indicates the current stage of progress for a specific task associated with the submission. It can be one of the following: pending, processing, overdue, closing, initiated, on hold, or rescinded.

<taskStatus>OVERDUE</taskStatus>

taskStatusName

String

If the manuscript contains tasks with various statuses like pending, processing, overdue, closing, initiated, on hold, or rescinded, this is the corresponding status text shown to users in the 'Status' column of manuscript lists. If no specific text is set for the column, it defaults to 'Open Task X', where X represents the task number within the manuscript submission status response.

<taskStatusName>Complete Checklist</taskStatusName>