getStubInfoFull

getStubInfoFull submits a request using a Document ID or IDs and retrieves the content of the corresponding invited stub manuscript.

Required Parameters

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

Optional Parameters

  • Locale ID
  • _type
  • External ID

Resource

  • By documentID: /api/s1m/v4/submissions/full/stub/documentids

Request Parameters

Element Type Description Required Example or Default Value
getStubInfoFull 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 ’88026’ Or if a list is being requested: '88026','88087','89328'
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 v2/submissions/basic/contributors/authors/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>

topic

Complex

Represents the metadata and status information related to a specific manuscript topic configured within the system. This element contains detailed information related to the manuscript's assignment, submission, and update scheduling.

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

document2topics, id, name, status, submissionDueDateType, submissionDueDateTypeId, topicParentName, updateSchedNo, updateSchedOption, updateSchedPeriod

document2topics

Complex

Provides a detailed linkage between the document and the topic, including author information and document status.

  • Complex Child_ of topic

Includes the following response elements:

assignedFl, document, documentId, hasBeenUpdatedFl, keepAuthorFl, lastUpdated, person2RoleId, personId, stubStatus, submissionDueDateType, topicId, trackingNo, updateSchedNo, updateSchedOption, pdateSchedPeriod, updateSchedulePeriod

assignedFl

Boolean

Flag indicating whether the document is assigned to the topic.

<assignedFl>true</assignedFl>

document

Complex

Contains elements that provide detailed information about the document.

  • Complex Child_ of document2topics

Includes the following response elements:

archiveStatus, archiveStatusId, authorFullName, authorORCIDId, authorPersonId, documentId, documentIdLatest, documentIdOriginal, inputIndex, journalDigitalIssn, journalName, preferredPerson, revisionNumber, submissionId, submissionIdLatest, submissionIdOriginal, submissionStatus

archiveStatus

String

The archive status of the manuscript – e.g. “Archived,” “Draft revision/resubmission files deleted,” etc

<archiveStatus>NORMAL</archiveStatus>

archiveStatusId

Integer

Primary Key of the Archive Status Table in the ScholarOne Manuscripts database.

<archiveStatusId>0</archiveStatusId>

authorFullName

String

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

<authorFullName>author, test</authorFullName>

authorORCIDId

String

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

<ORCIDId>1111-0003-4738-1544</ORCIDId>

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>11206255</authorPersonId>

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>20406360</documentId>

documentIdLatest

Integer

A unique identifier for the most recent submitted (not draft) version of the manuscript.

<documentIdLatest>20406360</documentIdLatest>

documentIdOriginal

Integer

A unique identifier given to the first iteration of a manuscript.

<documentIdOriginal>20406360</documentIdOriginal>

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>0</inputIndex>

journalDigitalIssn

String

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

<journalDigitalIssn>5678-1234</journalDigitalIssn>

journalName

String

The long name associated with the journal as defined during issue creation.

<journalName>Sales Demo Plus</journalName>

preferredPerson

Complex

Details about the preferred contact person.

  • Complex Child_ of document

Includes the following response elements:

department, email, firstName, institution, lastName, personId, personTypeName,
phone, preferredTypeName

department

String

Person's affiliated department.

<department>c1 department 2</department>

email

String

The primary e-mail address of the person.

<email>
[email protected]
</email>

firstName

String

The first or given name of the person.

<firstName>test</firstName>

institution

String

Institution associated with the person.

<institution>new</institution>

lastName

String

The last name (surname or family name) of the person.

<lastName>author</lastName>

personId

Integer

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

<personId>11206255</personId>

personTypeName

String

Specifies the role of the person associated with the document.

<personTypeName>AUTHOR</personTypeName>

phone

String

Phone number of the person.

<phone>c1 phone 333-333-333</phone>

preferredTypeName

String

Indicates the type designation of a person who is marked as the preferred contact within the context of the manuscript.

<preferredTypeName>PREFERRED</preferredTypeName>

ringgoldId

String

Person's institution Ringgold ID identifier.

<ringgoldId>3463</ringgoldId>

revisionNumber

Integer

Revision number of the document.

<revisionNumber>0</revisionNumber>

subCustomQuestionsDetails
Page

Complex

This element encapsulates all the custom question details associated with the manuscript submission.

  • Complex Child_ of document

Includes the following response elements:

readOnly, submissionCustomQuestion

readOnly

Boolean

Indicates whether the custom questions can be modified or not.

<readOnly>false</readOnly>

submissionCustomQuestion

Complex

Contains details for a single custom question related to the manuscript submission.

  • Complex Child_ of subCustomQuestionsDetailsPage

Includes the following response elements:

answerType, customQuestionId,
questionName, questionStatus, questionText, submissionCustomAnswer

answerType

String

Standard HTML input options. Available answer types are Checkbox, Radio, Select, Multiselect, Textarea, Text or Calendar.

<answerType>TYPE_RADIO</answerType>

customQuestionId

Integer

Unique identifier of the custom question.

<customQuestionId>1158559</customQuestionId>

questionName

String

The configured name of a question asked during the submission process.

<questionName>
Submitted solely to this journal
</questionName>

questionStatus

String

Current status of a custom question. Valid values are ‘ACTIVE’ or ‘INACTIVE’.

<questionStatus>ACTIVE</questionStatus>

questionText

String

The full text of the custom question, often including detailed instructions or information.

<questionText>Confirm that the manuscript has been submitted 
solely to this journal and is not published, in press, or submitted elsewhere</questionText >

submissionCustomAnswer

Complex

Contains the details of the answer provided by the submitter to the custom question.

  • Complex Child_ of submissionCustomQuestion

Includes the following response elements:

abbreviatedResponse, answerId,
answerName, answerStatus, answerText

abbreviatedResponse

String

Shortened custom question response as configured in Submission Custom Questions.

<abbreviatedResponse>msid</abbreviatedResponse>

answerId

Integer

Unique identifier for the answer.

<answerId>1407860</answerId>

answerName

String

Human-recognizable name given to the answer to aid in configuration-user lookup

<answerName>confirm - ethical</answerName>

answerStatus

String

Indicates whether the answer is enabled or disabled. The status can be 'ACTIVE' or 'INACTIVE'.

<answerStatus>ACTIVE</answerStatus>

answerText

String

The response to a submission question to be entered or selected by the author.

<answerText>Yes</answerText>

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>draft</submissionId>

submissionIdLatest

String

A unique identifier given to the most recent iteration of a manuscript. For example, if the manuscript was submitted initially and received a revision decision, the Subsmission ID – Latest will be the Manuscript ID of that second, revised manuscript

<submissionIdLatest>draft</submissionIdLatest>

submissionIdOriginal

String

A unique identifier given to the first iteration of a manuscript. For example, if the manuscript was submitted initially and received a revision decision, the Manuscript ID – Original will be the Manuscript ID of the first, original submission.

<submissionIdOriginal>draft</submissionIdOriginal>

submissionStatus

Complex

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

  • Complex Child_ of document

Includes the following response elements:

documentStatusId, documentStatusName, inDraftFlag

documentStatusId

Integer

Key identifier for document status.

<documentStatusId>9</documentStatusId>

documentStatusName

String

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

<documentStatusName>Invited</documentStatusName>

inDraftFlag

Boolean

Indicates whether the manuscript is currently in DRAFT status.

<inDraftFlag>false</inDraftFlag>

transferSubId

String

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

<transferSubId>cb77e4fe-547e-4f62-b657-91cc05e892401</transferSubId>

documentId

Integer

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

<documentId>20406360</documentId>

hasBeenUpdatedFl

Boolean

Indicates whether the document associated with the topic has been updated since its initial submission or configuration.

<hasBeenUpdatedFl>false</hasBeenUpdatedFl>

keepAuthorFl

Boolean

Indicates whether the author should be retained in the context of the document-topic relationship.

<keepAuthorFl>false</keepAuthorFl>

lastUpdated

dateTime

Specifies the date and time when the document-topic relationship was last modified.

 <lastUpdated>
2015-05-28 00:00:00.0
</lastUpdated>

person2RoleId

Integer

A unique identifier of a person (typically an author) and their specific role associated with a manuscript topic within the system.

<person2RoleId>120701618</person2RoleId>

personId

Integer

Unique identifier of the Person.

<personId>25724296</personId>

stubStatus

String

Status of the stub.

<stubStatus>Active</stubStatus>

submissionDueDateType

String

Specifies the type of submission due date being used.

<submissionDueDateType>Use rolling submission due date</submissionDueDateType>

topicId

Integer

Unique identifier of the topic associated with a specific manuscript stub configuration.

<topicId>24107</topicId>

trackingNo

Integer

The unique number for identifying and tracking the manuscript document associated with a specific topic.

<trackingNo>1452145</trackingNo>

updateSchedNo

Integer

Number indicating the update schedule.

<updateSchedNo>1</updateSchedNo>

updateSchedOption

String

Specifies whether an update is required.

<updateSchedOption>Update not required</updateSchedOption>

updateSchedPeriod

Integer

Period specified for updates.

<updateSchedPeriod>1</updateSchedPeriod>

updateSchedulePeriod

String

Defines the unit of time used to determine the frequency of updates required for the topic.

 <updateSchedulePeriod>
UPDATE_SCHED_PERIOD_DAYS
</updateSchedulePeriod>

id

Integer

The unique identifier for the topic.

<id>24107</id>

name

String

The name of the topic.

<name>Animal husbandry</name>

submissionDueDateType

String

Specifies the type of submission due date being used.

<submissionDueDateType>
Use rolling submission due date
</submissionDueDateType>

submissionDueDateTypeId

Integer

Numerical identifier for the submission due date type.

<submissionDueDateTypeId>30</submissionDueDateTypeId>

topicParentName

String

The name of the parent topic category.

<topicParentName>Agriculture,
 Forestry & Soils</topicParentName>

updateSchedNo

Integer

Number indicating the update schedule.

<updateSchedNo>0</updateSchedNo>

updateSchedOption

String

Specifies whether an update is required.

<updateSchedOption>Update not required</updateSchedOption>

updateSchedPeriod

Integer

Period specified for updates.

<updateSchedPeriod>0</updateSchedPeriod>