getSubmissionVersions

getSubmissionVersions accepts one or more Document IDs or Submission IDs (Manuscript Numbers) as input and returns a complete list of the submission versions.

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/v2/submissions/full/revisions/documentids
By submissionID: /api/s1m/v2/submissions/full/revisions/submissionids

Request Parameters

Element	Type	Description	Required	Example or Default Value
getSubmissionVersions	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/revisions/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>`

addedDate	dateTime	Indicates the date when the document version was initially created in the system. This field refers to the draft creation date, not the submission date.	`<addedDate>2022-02-16 12:29:11.822</addedDate>`
documentId	Integer	Unique identifier for each document and manuscript revision in the ScholarOne Manuscripts system. Internally to ScholarOne, this identifier is a numeric value.	`<documentId>45167893</documentId>`
inputIndex	String	Provides caller the ability to correlate requested document or submission IDs to the appropriate response element.	`<inputIndex>MN-22-0570-MJ.R2</inputIndex>`
revisionNumber	Integer	Revision number of the submission or document.	`<revisionNumber>0</revisionNumber>`
submissionId	String	Also known as the Manuscript Id or Document Number. Identifier given to each submitted manuscript. Submission IDs are case-sensitive, they are not necessarily unique.	`<submissionId>MN-22-0570-MJ</submissionId>`

submissionStatus	Complex	Provides the complete status details of a submission or document if the document is a draft, first look, accepted etc.,	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>`

Updated 5 months ago