getSubmissionInfoFull

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>

abstractText

String

The summary text of a published submission relevant to potential reviewers. It is authored by a person who may also be a reviewer on a ScholarOne Manuscripts submission.

<abstractText>Creating a fitness base, cross training, VO2 max, nutrition, intervals, fartleks -- using the techniques of an elite runner to train for fitness without injury. How much is too much? How much dedication 
and time can you expect of noncompetitive amateurs? Keeping it fun while getting results.</abstractText>

archiveDate

dateTime

The date a manuscript is scheduled to be archived or has been archived. When manuscripts are archived, the files for those submissions are no longer available on the system, although metadata is still accessible.

<archiveDate>2013-10-21T19:24:29Z</archiveDate>

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>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>

• authorORCIDID
  Validation*

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>

contraDocumentId

Integer

This element acts as a unique identifier for a manuscript document that was transferred from a different submission site.

<contraDocumentId>56411706</contraDocumentId>

contraSiteName

String

This element represents the name or identifier of the original submission site from which the manuscript was transferred.

<contraSiteName>wbrex</contraSiteName>

coverLetter

Complex

This element is used to store the textual content of the cover letter associated with a manuscript submission.

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

text

text

String

This child element holds the actual content of the cover letter in plain text format.

<text>This is a cover letter</text>

customManuscriptFlags

Complex

Container element for flags or labels that are custom to the manuscript. These flags provide additional categorization or special identifiers for the manuscript.

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

customManuscriptFlag

customManuscriptFlag

String

This element represents a single flag that has been applied to the manuscript. Multiple customManuscriptFlag elements can be present to signify various attributes or categorizations.

<customManuscriptFlag>Starfleet Member</customManuscriptFlag>

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>

crossCheckOverall
SimilarityIndex

Integer

The overall percentage match from iThenticate. This is the most recent successful cross check similarity index value.

<crossCheckOverallSimilarityIndex>11</crossCheckOverallSimilarityIndex>

decisionDate

dateTime

The date and time the decision was made on the submission.

<decisionDate>2013-1021T19:24:29Z</decisionDate>

decisionType

String

The system label for the type of decision made on the submission.
Available decision types are: Accept, Accept for First Look, Reject (Hard), Reject With Appeal, Reject With Resubmission, Reject with Transfer, Revise, and Additional Reviews Required.

<decisionType>ACCEPT</decisionType>

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>

documentIdLatest

Integer

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

<documentIdLatest>49952200</documentIdLatest>

documentIdOriginal

Integer

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

<documentIdOriginal>49952200</documentIdOriginal>

doi

String

A DOI is a unique character string (a 'digital identifier') used to identify an object, such as an electronic document.

<doi>10.Prefix/:</doi>

dueDateOfNextRevision
Resubmission

dateTime

The date a manuscript revision or resubmission is due.

<dueDateOfNextRevisionResubmission>
2013-12-21T04:59:00Z
</dueDateOfNextRevisionResubmission>

externalManuscriptId

String

The unique manuscript ID provided by the external system when manuscripts are ingested via submission integration.

<externalManuscriptId>
EXAMPLE-2020-0101
</externalManuscriptId>

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

journalName

String

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

<journalName>Web Services Sample: vol2, iss 3</journalName>

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>

revisionNumber

Integer

The number of times that a manuscript has been revised and a revision has been started. If a manuscript was originally submitted and then revised once, the number of revisions will be 1.

<revisionNumber>0</revisionNumber>

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>

submissionDateOriginal

dateTime

The date and time that the first iteration of a manuscript was submitted.

For example, if a manuscript is initially submitted and then receives a revision decision, the 'Submission Date – Original' field will display the date and time of the first submission. Note that this date may sometimes be adjusted by the Editorial Office.

<submissionDateOriginal>
2013-10-18T20:56:15Z
</submissionDateOriginal>

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>

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>WRK4-23-Apr-0005</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>WRK4-23-Apr-0005
</submissionIdOriginal>

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>

systemTransmittalDate

dateTime

For each version of a manuscript, the systemTransmittalDate field records the date and time the manuscript version was submitted. Once recorded, this date cannot be edited by any user. It serves as a static record of when each version was first submitted to ScholarOne.

<systemTransmittalDate>
2023-04-20 00:13:22.471
</systemTransmittalDate>

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>

transmissionDate

dateTime

The actual date and time that the author submitted the manuscript.

<transmissionDate>
2023-04-20T04:13:22Z
</transmissionDate>

withdrawnDate

dateTime

The most recent date a manuscript has been withdrawn.
(If a submission is in draft, has been un-submitted, or has been submitted but then WITHDRAWN, we DO display the submission question and response information from prior to the withdrawal.)

<withdrawnDate>
2013-10-14T17:09:52Z
</withdrawnDate>

submissionFiles

Complex

Information about file(s) uploaded as part of the submission. There can be 0…n files associated with a submission.

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

customerFileName, docLink, fileDesignation, fileId, systemFileName

customerFileName

String

The name of the file the author uploaded as part of the submission.

<customerFileName>Computers in Classrooms Title Page Collins.docx</customerFileName>

docLink

String

Link to access the submission files uploaded by the author.

<docLink>
https://clarivate-scholarone-prod-us-
west-2-s1m-files.s3.us-west-2.amazonaws.com/docfiles/prod1/
salesdemoplus/2023/04/
49952200/docfiles/original-files/49952200.pdf</docLink>

fileDesignation

String

Indicates the content of the file being uploaded. File designation options appear in the dropdown menu and differ according to the journal. Each file designation is associated with criteria for inclusion such as
“Title”, “Abstract”, “Main text”; Figure and Table file designations also include an option to add captions.

<fileDesignation>Main Document</fileDesignation>

fileId

String

Database ID value for the file. Includes only files uploaded by the Author on the File Upload step of submission or by the Admin into the "Manuscript Files" section of the Manuscript Files tab. Only the most recent version of the file will be listed.

<fileId>1224899037</fileId>

systemFileName

String

System-generated, internal unique identifier for the submission file.

<systemFileName>
49952200_File000000_1224899037.pdf
</systemFileName>

submissionFunders

Complex

Information about funder(s) entered as part of the submission. There can be 0…n funders associated with a submission.

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

fundRefInfo,grants,name

fundRefInfo

Complex

Information about FundRef specific identifiers entered as part of funder information.

• Complex Child_ of submissionFunders
  Includes the following response elements:

altName, identifier, name

altName

String

FundRef Preferred alternate name of the funding body.

<altName>AONA</altName>

identifier

String

FundRef unique identifier of the funding body.

<identifier>10.13039/100001473</identifier>

name

String

FundRef Preferred label of the funding body.

<name>AO North America</name>

grants

Complex

Identifier for funding award at the named institution. There can be 0…n grants associated with a funder.

• Complex Child_ of submissionFunders
  Includes the following response elements:

number

number

String

Identifier for funding award at the named institution.

<number>GrantNo1</number>

name

String

FundRef Preferred label of the funding body or the funder name manually entered by the submitter.

<name>AO North America</name>

referenceSubmission

Complex

Details on the referenced submitted - published article

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

referenceSubmissionDocumentId, referenceSubmissionSubmissionId, referenceSubmissionSubmissionType,
referenceSubmissionTitle

referenceSubmission
DocumentId

Integer

Document ID of a referenced manuscript. Reference to a submitted published article.
(Reference manuscripts are typically used with Letter to the Editor functionality.)

<referenceSubmissionDocumentId>170904
</referenceSubmissionDocumentId>

referenceSubmission
SubmissionId

String

The Manuscript ID of the given reference manuscript associated with that submission.
(Reference manuscripts are typically used with Letter to the Editor functionality.)

<referenceSubmissionSubmissionId>WRK11191
</referenceSubmissionSubmissionId>

referenceSubmission
SubmissionType

String

The manuscript type of the given reference manuscript associated with that submission.
(Reference manuscripts are typically used with Letter to the Editor functionality.)

<referenceSubmissionSubmissionType>LTE
</referenceSubmissionSubmissionType>

referenceSubmissionTitle

String

The title of the given reference manuscript associated with that submission.
(Reference manuscripts are typically used with Letter to the Editor functionality.)

<referenceSubmissionTitle>LTE Manuscript 5Title
</referenceSubmissionTitle>

submissionFlags

String

Flags are used to indicate specific information about a manuscript. Multiple flags can be assigned to a single manuscript. Flags are customizable by profile.

<submissionFlags>Special Attention Please;Second Opinion Required </submissionFlags>

submissionCustom
Questions

Complex

Submission custom questions refer to additional questiones that authors answer during their manuscript submission process, which are not included in the standard submission questionnaire. Custom questions without provided answers are excluded from the response. Additionally, custom questions that require answers in the form of Labels, URLs, or Images are also not included in the response.

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

answerType, customQuestionId,
questionName questionStatus, questionText, submissionCustomAnswers

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>879297
</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 >

submissionCustom
Answers

Complex

Submission custom answers refer to answers provided by authors to each Custom Question on the submission form.

• Complex Child_ of parent submissionCustomQuestions
  Includes following response elements:

abbreviatedResponse, answerExternalId, answerName,
answerStatus, answerText, numericValue

abbreviatedResponse

String

Shortened custom question response as configured in Submission Custom Questions.

<abbreviatedResponse> msid</abbreviatedResponse>

answerExternalId

String

Custom ID use to denote unique question/answer pairs in submission integration packages.

<answerExternalID>SI_YCQ1</answerExternalID>

answerId

Integer

Numeric value representing the unique 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>

numericValue

String

The numeric value (or score) assigned to a response selected or entered by an Author during the submission process.

<numericValue>4.0</numericValue>

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, datetimeStarted, datetimeDue, datetimeCompleted, taskCustomQuestions

assignmentPersonId

Integer

Uniquely identifies the person assigned to a specific task within the submission process.

<assignmentPersonId>96015884</assignmentPersonId>

assignmentRoleId

Integer

Represents the specific role assigned to the person. This ID is linked to predefined roles within the system, and it dictates the responsibilities and permissions granted to the person in relation to the submission.

<assignmentRoleId>36482</assignmentRoleId>

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>

datetimeStarted

dateTime

The date and time in UTC the task started.

<datetimeStarted>
2024-04-11T12:15:02Z
</datetimeStarted>

datetimeDue

dateTime

The date and time in UTC when the task is due, as determined by the site configuration.

<datetimeDue>
2023-02-28T03:29:56Z
</datetimeDue>

datetimeCompleted

dateTime

The date and time in UTC the task was completed.

<datetimeCompleted>
2023-02-21T06:43:36Z
</datetimeCompleted>

recommendation
Comments

Complex

Represents a container for a collection of comments related to a recommendation made during the review process.

• Complex Child_ of task
  Includes the following response elements:\

recommendationComment

recommendation
Comment

Complex

Contains a single comment or piece of feedback associated with a recommendation.

• Complex Child_ of recommendationComments
  Includes the following response elements:

comment, commentType

comment

String

Captures a general piece of feedback or note related to the submission. It may include observations, suggestions, or clarifications provided by any participant in the submission process, such as Reviewers, Editors, or Administrators.

<comment>
The paper should be revised
according to the review comments.
</comment>

commentType

String

Specifies the type or category of the comment.

<commentType>Author</commentType>

taskCustomQuestions

Complex

Task custom questions refer to questions that Admins and Editors answer as part of their manuscript check up on tasks. Custom questions without an answer are not included in the response. Custom questions with the answer types Label, URL, or Image are not included in the response.

• Complex Child_ of task
  Includes the following response elements:

answerType, customQuestionId, questionName, questionStatus, questionText, taskCustomAnswers

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>31139
</customQuestionId>

questionName

String

The configured name of a question asked at the checklist.

<questionName>Are the outcomes clearly defined?
</questionName>

questionStatus

String

Current status of a custom question. Validvalues 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 the outcomes clearly defined.</questionText>

taskCustomAnswer

Complex

Task custom answers refer to answers provided by Admins/Editors to each Custom Question on the Admin/Editor checklists.

• Complex Child_ of parent taskCustomQuestions
  Includes the following response elements:

abbreviatedResponse, answerExternalId,
answerName, answerStatus, answerText, numericValue

abbreviatedResponse

String

Shortened custom question response as configured in Checklist Custom Questions.

<abbreviatedResponse>Yes
</abbreviatedResponse>

answerExternalId

String

Custom ID use to denote unique question/answer pairs in submission integration packages.

<answerExternalID>SI_YCQ1
</answerExternalID>

answerId

Integer

Numeric value representing the unique answer.

<answerId>67996</answerId>

answerName

String

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

<answerName>Yes</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 checklist question to be entered or selected by the Admin/Editor.

<answerText>Yes, the outcomes are defined</answerText>

recommendationDecision
CustomQuestions

Complex

Recommendation/Decision custom questions refer to questions that Admins and Editors answer as part of their recommendation or decision tasks. Custom questions without an answer are not included in the response. Custom questions with the answer types Label, URL, or Image are not included in the response.

• Complex Child_ of task
  Includes following response elements:

answerType, customQuestionId,
questionName, questionStatus, questionText, recommendationDecision, CustomAnswer

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>31139
</customQuestionId>

questionName

String

The configured name of a question asked at the checklist.

<questionName>Justified</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> Are the discussion
 and conclusions justified by the results</questionText>

recommendationDecision
CustomAnswer

Complex

Recommendation/Decision custom answers refer to answers provided by Admins/Editors to each Custom Question on the recommendation/decision tasks.

• Complex Child_ of parent recommendationDecisionCustomQuestions
  Includes following response elements:

abbreviatedResponse, answerExternalId,
answerName, answerStatus, answerText, numericValue

abbreviatedResponse

String

Shortened custom question response as configured in Checklist Custom Questions.

<abbreviatedResponse>Y</abbreviatedResponse>

answerExternalId

String

Custom ID use to denote unique question/answer pairs in submission integration packages

<answerExternalID>SI_YCQ4</answerExternalID>

answerId

Integer

Numeric value representing the unique answer.

<answerId>67996</answerId>

answerName

String

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

<answerName>Justify_answer_Yes</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 checklist question to be entered or selected by the Admin/Editor.

<answerText>Yes</answerText>

attributes

Complex

Information about attributes entered as part of the submission. There can be 0…n attributes associated with a submission.

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

attributeId, attributeName, attributeTypeId, attributeTypeName

attributeId

Integer

Numeric value representing the unique attribute.

<attributeId>144426292</attributeId>

attributeName

String

Name of the selected attribute as defined in the system or by the user.

<attributeName>Natural Language Processing</attributeName>

attributeTypeId

Integer

Numeric value representing the unique attribute group.

<attributeTypeId>3507</attributeTypeId>

attributeTypeName

String

Name of the attribute group.

<attributeTypeName>Keywords</attributeTypeName>