getEditorAssignmentsByDate

getEditorAssignmentsByDate retrieves essential metadata related to the number of editor assignments within a specified time period, defined by the from_time and to_time parameters. This metadata pertains exclusively to original submissions and resubmissions, excluding revisions from the count. The date range specified by the from_time and to_time parameters must not exceed one year.

Required Parameters

from_time
to_time
Site Short Name

Optional Parameters

role_type
custom_question
Locale ID
_type
External ID

Resource

/api/s1m/v1/submissions/full/editorAssignmentsByDate

Request Parameters

Element	Type	Description	Required	Example or Default Value
getEditorAssignmentsByDate	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	Indicates the start date for editor assignments count within the specified date range, based on the assignmentDate task. *The date range specified by the from_time and to_time parameters must not exceed one year.	Yes	2022-06-01T00:00:00Z *Dates are required and in UTC format
to_time	dateTime	Indicates the end date for editor assignments count within the specified date range, based on the assignmentDate task. *The date range specified by the from_time and to_time parameters must not exceed one year.	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	v1/submissions/full/editorAssignmentsByDate
role_type	String	Optional parameter that refines the output specifically for the roles of EDITOR and EDITOR_IN_CHIEF, based on the provided type.	No	EDITOR
custom_question	String	When parameter custom_question is used, the response should return assignments grouped by custom question.	No	Special_Issue_Question
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 getEditorAssignmentByDate	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>`

assignedCount	Integer	Total number of manuscripts assigned within the specified time range.	`<assignedCount>8</assignedCount>`
personId	Integer	Unique identifier of the Person.	`<personId>51457403</personId>`
roleName	String	The name of the role that the editor holds, such as "Assistant Editor".	`<roleName>Assistant Editor</roleName>`

customQuestions	Complex	Represents a collection of customQuestion elements. `This element is displayed only when the optional custom_question request parameter is specified.`	Complex Child of Parent Root Includes the following response elements: customQuestion
customQuestion	Complex	Represents a collection of questionResponses elements. `This element contains two attributes: detailName and name.`	Complex Child of customQuestions Includes the following response elements: questionResponses
questionResponses	Complex	Represents a collection of questionResponse elements.	Complex Child of customQuestion Includes the following response elements: questionResponse
questionResponse	String	Includes a pre-configured response to a custom question. `The assignedCount attribute of this element represents the total number of manuscripts assigned within the specified time range, categorized by custom question.`	`<questionResponse assignedCount="2"> Atmospheric Analysis as Related to Climate Change</questionResponse>`

Updated 5 months ago