getMetadataInfo
The getMetadataInfo API is designed to provide metadata details for documents, replicating the content also available through the weekly CSV file. This API enables clients to programmatically retrieve document metadata for up to 25 documents in a single request.
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/v4/submissions/full/metadatainfo/documentids - By submissionID:
/api/s1m/v4/submissions/full/metadatainfo/submissionids
Request Parameters
| Element | Type | Description | Required | Example or Default Value |
|---|---|---|---|---|
| getMetadataInfo | 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 | v4/submissions/full/metadatainfo/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: getMetadaInfo Example/Default Value | Type | Description |
|---|---|---|
Status Can be one of SUCCESS, FAILURE, or MAINTENANCE.
| String | State of a given request call |
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. |
authorChoiceTransferOptions Complex Child of parent root Includes the following response elements:
| Complex | This element contains a list of available manuscript transfer destinations that the author may select from. These options are presented to the author after a transfer-eligible editorial decision (such as "Reject with Transfer") is made. |
authorChoiceTransferOption
| String | This element defines a single selectable manuscript transfer destination available to the author. |
authorFullName
| String | The full name of the author in the format “Lastname Suffix, Salutation Firstname Middlename”. Submitting Author or Submitting Agent. |
country
| String | Country associated with the corresponding author. |
datetimeDecisionOriginal
| dateTime | Timestamp indicating when the original editorial decision was made on the manuscript. |
datetimeSubmitted
| dateTime | Timestamp indicating when the manuscript was originally submitted to the system. |
decisionTypeOriginal
| String | Type of the original editorial decision (e.g., Revision, Accept, Reject). |
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. |
documentIdOriginal
| Integer | A unique identifier given to the original submission version of the document. |
documentNo
| String | Journal-specific manuscript reference number including revision indicators. Also called Manuscript ID |
documentTasks Complex Child of parent root Includes the following response elements:
| Complex | Container element that holds a list of all task entries associated with a specific manuscript throughout its workflow lifecycle. |
documentTask Complex Child of documentTasks Includes the following response elements:
| Complex | Represents a single workflow task instance performed on the manuscript, including timing, status, and assignee metadata. |
datetimeTaskCompleted
| dateTime | Timestamp when a specific task associated with the document was completed. |
datetimeTaskStarted
| dateTime | Timestamp when a specific task began processing. |
systemTaskResourceName
| String | Internal system resource identifier for the task type. |
taskAssignmentPersonFullName
| String | Full name of the individual assigned to the task, formatted as "last name, first name". |
taskAssignmentPersonId
| Integer | Unique person identifier (person_id) for the individual assigned to the task |
taskAssignmentPersonRole
| String | Editorial role of the person assigned to the task (e.g., Assistant Editor, Editor). |
taskCompletedByPersonId
| Integer | Unique person identifier (person_id) for the individual who completed the task |
taskDaysToComplete
| Integer | Number of days taken to complete the task. |
taskId
| Integer | Unique internal identifier for the task instance. |
taskName
| String | Human-readable name describing the specific task performed. |
taskStatusName
| String | Status of the task, such as "Completed", "Pending", or "Anytime". |
editorFullName
| String | Full name of the editor currently assigned to the manuscript. |
institutionName
| String | Name of the affiliated institution of the corresponding author. |
managingEditorFullName
| String | Full name of the managing editor. |
manuscriptStatus
| String | Current status or stage of the manuscript. |
msTrackingGuid
| String | Globally unique identifier (GUID) used to track the manuscript across systems. |
numberResubmissions
| Integer | Total number of times the manuscript was resubmitted. |
numberRevisions
| Integer | Total number of revision rounds completed for the manuscript. |
revisionNo
| Integer | Current revision number of the manuscript. |
ringgoldId
| String | Unique Ringgold organization identifier for the affiliated institution. |
shortName
| String | Journal or site short name. |
submissionType
| String | Type of manuscript submission, such as "Original Article" or "Special Issue". |