getChecklistByName

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>

document

Complex

Root element for each document utilized during an API call

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

checkLists, documentId, documentIdLatest, documentIdOriginal, submissionId, submissionIdLatest, submissionIdOriginal, submissionStatus, transferSubId

checkLists

Complex

Represents a collection of all checklist items.

• Complex Child_ of document
  Includes the following response elements:

checkList

checkList

Complex

A predefined list of questions that the Editorial Staff must review and complete throughout the manuscript workflow process.

• Complex Child_ of checkLists
  Includes the following response elements:

detailId, detailName, displayDetailName, displayTaskName, documentTaskId, questions, taskId, taskName

detailId

Integer

A unique numeric identifier for each checklist. This ID is generated by the ScholarOne system.

<detailId>173445</detailId>

detailName

String

The configured name for a checklist.

<detailName>Production Checklist</detailName>

displayDetailName

String

The checklist name visible to the user.

<displayDetailName>Production Checklist</displayDetailName>

displayTaskName

String

The name of the checklist task visible to the user.

<displayTaskName>Production Checklist</displayTaskName>

documentTaskId

Integer

A unique numeric identifier for each checklist task.

<documentTaskId>312175429</documentTaskId>

questions

Complex

Represents a collection of all question items.

• Complex Child_ of checkList
  Includes the following response elements:

question

question

Complex

Refer to the checklist question that the Editorial Staff answers as part of their manuscript workflow process.

• Complex Child_ of questions
  Includes the following response elements:

answerType, answers, questionId, displayQuestionName, questionName, questionStatus, questionText

answerType

String

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

<answerType>TYPE_RADIO</answerType>

answers

Complex

Represents a collection of all answer items.

• Complex Child_ of question
  Includes the following response elements:

answer

answer

Complex

Refer to answers provided by the Editorial Staff to each checklist item.

• Complex Child _of answers
  Includes the following response elements:

abbreviatedResponse, answerId, answerName, answerStatus, answerText,

abbreviatedResponse

String

Abbreviated response to a checklist question.

<abbreviatedResponse>MNR</abbreviatedResponse>

answerId

Integer

Numeric value representing the unique answer.

<answerId>445900</answerId>

answerName

String

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

<answerName>Main Journal</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.

<answerText>MNRold</answerText>

questionId

Integer

Unique identifier of the question. This ID is generated by the ScholarOne system.

<questionId>175158</questionId>

displayQuestionName

String

The checklist question name visible to the user.

<displayQuestionName>Publication old</displayQuestionName>

questionName

String

The configured name of a checklist question.

<questionName>Publication old</questionName>

questionStatus

String

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

<questionStatus>ACTIVE</questionStatus>

questionText

String

The checklist question text.

<questionText>Comments to OUP production</questionText>

taskId

Integer

Global unique identifier of the task. This ID is generated by the ScholarOne system.

<taskId>202885</taskId>

taskName

String

Name of the task as configured in the site workflow.

<taskName>Production Checklist</taskName>

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

documentIdLatest

Integer

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

<documentIdLatest>22130607</documentIdLatest>

documentIdOriginal

Integer

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

<documentIdOriginal>22130607</documentIdOriginal>

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>WRK4-15-Dec-0033</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 Submission ID – Latest will be the Manuscript ID of that second, revised manuscript.

<submissionIdLatest>WRK4-15-Dec-0033.R1</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-15-Dec-0033</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:

decisionName, documentStatusId, documentStatusName, inDraftFlag

decisionName

String

The name of the decision rendered on the submission.

<decisionName>Accept</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>

transferSubId

String

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

<transferSubId>11932fd6-fbeb-4bdb-a344-60d94da7d7c21</transferSubId>