getExternalDocumentIdsFull

username
sample_user

String

"Profile” Username.
This designation refers to the username used within the application system, distinct from a ScholarOne Manuscripts user. This information is sourced from the caller's profile.

Yes

Password
SRU4DQ5WOJ2PX8CA

String

The API Key
Encrypted value uniquely identifying/authenticating Caller

Yes

from_time
'2025-04-01 00:00:00.000000'

*Dates are required and in UTC format

dateTime

Indicates the start date for the specified date range.
*The date range specified by the from_time and to_time parameters must not exceed one week.

Yes

to_time
'2025-04-07 23:59:59.999999'

*Dates are required and in UTC format

dateTime

Indicates the end date for the specified date range.
*The date range specified by the from_time and to_time parameters must not exceed one week.

Yes

integration_key
2da1b4dc-6240-4a17-9b4e-2be929574a73

String

The submission integration key uniquely identifying integration. This is the value contained in the element in the header of the .go file

Yes

site_name
salesdemoplus

String

Site short name. The short name is the abbreviated or truncated name of the journal, society, publisher, or family.

Yes

url
v2/submissions/full/externaldocids

String

The Web Service URL, which identifies the specific service to handle the request.

Yes

locale_id
Options are: 1 (United States English) 2 (Simplified Chinese, Pinyin ordering) 3 (French)

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 ScholarOne Manuscripts profile.

No

_type
Can be xml (default if omitted), or json

String

The data type requested from the Service xml or json. This defaults to xml

No

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>

dateTimeProcessed

dateTime

The datetime when ScholarOne processed the ingestion package.

<dateTimeProcessed>2020-06-08 07:58:47.45859</dateTimeProcessed>

documentId

Integer

The document ID of the created draft (returned only upon successful ingestion).

<documentId>1035693</documentId>

externalDocumentId

String

The unique identifier assigned by the sending system to the document.

<externalDocumentId>ex-sys-94586942</externalDocumentId >

failureErrorCode

Integer

The error code associated with the ingestion failure experienced (only appears for failures)

<failureErrorCode >31</failureErrorCode >

siteShortName

String

Short name of the ingestion's target site on ScholarOne.

<siteShortName>salesdemoplus</siteShortName>

submissionId

String

Displays the manuscript ID for drafts that have been successfully submitted and ingested intoS1 from their initial draft state. If the ingestion process has not yet been completed, the field will display "Draft" instead.

<submissionId>sdp-2020-4356a\</submissionId>
<submissionId >draft</submissionId>

transferDocumentId

String

A unique identifier assigned to a document upon successful ingestion from the draft state. This ID remains consistent across document versions and journal transfers.
(Note: Only applicable to successfully ingested submissions originating from the draft state.)

<transferDocumentId>
23abe1b1-31b1-4db3-ac33-50e7a8ae051d
</transferDocumentId>