getChecklistById
getChecklistById submits a request that includes either a Document ID or IDs, or a Submission ID or IDs, and returns detailed information about all configured checklists, including additional field custom questions.
This request can be further refined by applying one of three optional ScholarOne system-generated ID parameters: task_id, detail_id, or question_id.
Required Parameters
- Submission ID(s) or Document ID(s) - up to 25
- Site Short Name
Optional Parameters
- Locale ID
- _type
- External ID
- task_id= S1 system generated ID
- detail_id= S1 system generated ID
- question_id= S1 system generated ID
Resource
- By documentID:
/api/s1m/v2/submissions/full/checklistsbyid/documentids - By submissionID:
/api/s1m/v2/submissions/full/checklistsbyid/submissionids
Request Parameters
| Element | Type | Description | Required | Example or Default Value |
|---|---|---|---|---|
| getChecklistById | 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 | v2/submissions/full/checklistsbyid/submissionids |
| task_id | Integer | A unique numeric identifier of the task. This ID is generated by the ScholarOne system. | No | 619646 |
| detail_id | Integer | A unique numeric identifier for each checklist. This ID is generated by the ScholarOne system. | No | 173451 |
| question_id | Integer | A unique numeric identifier of the checklist question. This ID is generated by the ScholarOne system. | No | 974904 |
| 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:
|
| _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.
|
| 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 |
|
| checkLists | Complex | Represents a collection of all checklist items. |
|
| checkList | Complex | A predefined list of questions that the Editorial Staff must review and complete throughout the manuscript workflow process. |
|
| 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. |
|
| question | Complex | Refer to the checklist question that the Editorial Staff answers as part of their manuscript workflow process. |
|
| 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. |
|
| answer | Complex | Refer to answers provided by the Editorial Staff to each checklist item. |
|
| 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. |
|
| 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> |