Documentation

getIDsByDate

getIDsByDate API call retrieves a list of all document IDs within a specified time period, as defined by the from_time and to_time parameters.
This API call can be run at the portal level to return a list of all document IDs across all journals.
The API call can return a maximum of fewer than 1000 document IDs for the specified time range.

Required Parameters

  • from_time
  • to_time
  • Site Short Name

Optional Parameters

  • role_type
  • custom_question
  • Locale ID
  • _type
  • External ID

Resource

  • /api/s1m/v4/submissions/full/idsByDate

Request Parameters

Element Type Description Required Example or Default Value
getIDsByDate 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
from_time dateTime Specifies the start date for counting documents within the defined date range. Yes 2022-06-01T00:00:00Z \*Dates are required and in UTC format
to_time dateTime Specifies the end date for counting documents within the defined date range. Yes 2023-05-30T11:59:59Z \*Dates are required and in UTC format
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/idsByDate
document_status String An optional parameter that refines the output based on the document status. When specifying multiple document statuses, separate each status with a comma. No DOCUMENT_STATUS_DRAFT
Or if a list is being requested:
DOCUMENT_STATUS_REVISION,DOCUMENT_STATUS_APPEAL
criteria String An optional parameter that filters output based on the document datetime value. It defaults to finding document IDs on datetime_added (Created date) No datetime_submitted
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 ElementTypeDescriptionExample or default Value
StatusStringState of a given request call

Can be one of SUCCESS, FAILURE, or MAINTENANCE. 

<status>SUCCESS</status>

callIDStringThe 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>
profileCallIdStringAn id value that is set by the client for call tracking.  Set by the request’s external_id element.<profileCallId>111111</profileCallId>
submissionComplexRepresents a collection of response elements for each document submission within the specified timeframe.
  • Complex Child_ of Parent Root
    Includes the following response elements:\
datetimeCreated, documentId,
documentIdLatest, documentIdOriginal, documentStatusName, previousDocumentId, previousSiteName, submissionId,
submissionIdLatest, submissionIdOriginal, submittingAuthorId, transferStartedDatetime, transferSubId, transferredDatetime
datetimeCreateddateTimeIndicates the date and time the document was created within the system.
<datetimeCreated>
2023-06-30T10:20:14Z
</datetimeCreated>
documentIdIntegerUnique identifier of the document. Unique identifier for each Manuscript Revision in the ScholarOneManuscripts system. Internally to ScholarOne, this is a numeric value.<documentId>50792278</documentId>
documentIdLatestIntegerA unique identifier for the most recent submitted (not draft) version of the manuscript.<documentIdLatest>49952200</documentIdLatest>
documentIdOriginalIntegerA unique identifier given to the first iteration of a manuscript.<documentIdOriginal>49952200</documentIdOriginal>
documentStatusNameStringStatus Name of the document.<documentStatusName>Accepted</documentStatusName>
previousDocumentIdIntegerDocument ID assigned to the document on the site from which it was transferred.<previousDocumentId>50667686</previousDocumentId>
previousSiteNameStringThe previous site short name from which the document was transferred.<previousSiteName>salesdemoplus</previousSiteName>
submissionIdStringAlso 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-23-Apr-0005</submissionId>
submissionIdLatestStringA 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 Subsmission ID – Latest will be the Manuscript ID of that second, revised manuscript<submissionIdLatest>WRK4-23-Apr-0005</submissionIdLatest>
submissionIdOriginalStringA 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-23-Apr-0005</submissionIdOriginal>
submittingAuthorIdIntegerA unique numeric identifier associated with a person record (not the user's User ID used for accessing ScholarOne).<submittingAuthorId>193979047</submittingAuthorId>
transferStartedDatetimedateTimeThe date and time when the transfer process was initiated within the system.
<transferStartedDatetime>
2023-06-30T10:20:31Z
</transferStartedDatetime>
transferSubIdStringA unique identifier assigned to each submission, enabling tracking even when the submission is transferred across ScholarOne sites.<transferSubId>ac6828d7-b1c3-4561-9933-9d37680226f21</transferSubId>
transferredDatetimedateTimeThe date and time when the transfer process was completed within the system.
<transferredDatetime>
2023-06-30T10:20:31Z
</transferredDatetime>