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:
|
| _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. |
|
profileCallId | String | An id value that is set by the client for call tracking. Set by the request’s external_id element. |
|
authorFullName | String | The full name of the author in the format “Lastname Suffix, Salutation Firstname Middlename”. Submitting Author or Submitting Agent. |
|
authorMembershipId | String | Society Membership number of the user. |
|
authorORCIDId | String | The ORCID is a nonproprietary alphanumeric code to uniquely identify scientific and other academic authors. |
|
authorORCIDIdValidation | Boolean | Indication of whether that author ORCID has been validated by the author. |
|
authorPersonId | Integer | A unique numeric identifier associated with a person record (not the user's User ID used for accessing ScholarOne). |
|
authorResearcherId | String | Provides solution to Author ambiguity by assigning a unique identifier for scientific authors. |
|
authorSuffix | String | The suffix chosen in the author’s account record. |
|
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. |
|
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. |
|
journalDigitalIssn | String | The configured digital International Standard Serial Number for the publication on ScholarOne site. |
|
journalPrintIssn | String | The configured print International Standard Serial Number for the publication on S1 site |
|
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'. | |
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. |
|
submissionTitle | String | The title of a manuscript submitted to a publication. | |
submissionType | String | The Submission Type refers to the name of the group or collection of attributes chosen by the author to classify a submission. |
|
transferSubId | String | A unique identifier assigned to each submission, enabling tracking even when the submission is transferred across ScholarOne sites. |
|
submissionStatus | Complex | The status of a submission. Lists open tasks (action items) and any decision made on that submission. |
decisionName, documentStatusId, documentStatusName, inDraftFlag, task |
decisionName | String | The name of the decision rendered on the submission. |
|
documentStatusId | Integer | Key identifier for document status. |
|
documentStatusName | String | User-friendly name of a document’s status in the journal’s submission workflow. |
|
inDraftFlag | Boolean | Indicates whether the manuscript is currently in DRAFT status. |
|
task | Complex | Activity currently being performed for the current manuscript. |
taskId, taskName, taskStatus, taskStatusName |
taskId | Integer | Global unique identifier of the task. |
|
taskName | String | Name of task as configured in the site workflow. |
|
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. |
|
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. |
|
Updated 5 months ago
