makeEditorAssignment

This API call works best in tandem with other API endpoints such as getEditorAssignmentsByDate and getSubmissionInfoFull, which allow retrieval of the personId, documentId, and documentTaskId values required to make assignments.

📘
NOTE: This API only allows assignments through Assign tasks. The system validates permissions, task relationships, and email configuration before processing the assignment.

Method: POST

Resource

/api/s1m/v2/task/full/makeAssignment

Request Parameters

Element	Type	Description	Required	Example or Default Value
makeEditorAssignment	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
site_name	String	Site short name. The short name is the abbreviated or truncated name of the journal, society, publisher, or family.	Yes	salesdemo
url	String	The Web Service URL, which identifies the specific service to handle the request.	Yes	v2/task/full/makeAssignment
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

Request Body Elements

The request body must be in JSON format.

{
  "input": {
    "personId": 87654321,
    "documentId": 12345678,
    "documentTaskId": 213141
  }
}

Request Body Elements Description

Request Body Element	Type	Description	Required	Example or Default Value
Input	Object	This is the root object containing all the data required for making an editor assignment.	Yes
personId	Integer	The unique identifier of the person to whom the manuscript task will be assigned. This must be a valid person ID in the system with appropriate permissions to perform the assignment action.	Yes	"personId": 87654321
documentId	Integer	The unique identifier of the manuscript that is being assigned. This must correspond to an existing manuscript in the system.	Yes	"documentId": 12345678
documentTaskId	Integer	The unique identifier of the specific task within the manuscript workflow. This task must be an Assign task type and must be related to the specified documentId.	Yes	"documentTaskId": 213141

Responses

Success Response

A successful assignment will return a confirmation response with the assignment details.

Error Responses

The API returns specific error codes for different failure scenarios:

Error Code	Description
WVLD-11172	User does not have permission to perform action. The authenticated API user lacks the necessary permissions to create assignments in the system.
WVLD-11173	Assignment has already been processed for the specified documentId. The system prevents duplicate assignments to avoid workflow conflicts.
WVLD-11174	Person with the specified personId cannot be assigned to the task due to insufficient rights. The assignee lacks the required role or permissions to perform the task action.
WVLD-11175	The specified documentId and documentTaskId are not related. The task does not belong to the specified manuscript, indicating a data integrity issue.
WVLD-11176	Document Task with the specified documentTaskId was not found. Verify that the task ID is valid and exists in the system.
WVLD-11177	Document with the specified documentId was not found. Verify that the document ID is valid and exists in the system.
WVLD-11178	Person with the specified personId was not found. Verify that the person ID is valid and exists in the system.
WVLD-11182	Edit Before Send flag has been activated for the assignment task email template. The assignment cannot proceed automatically when this flag is enabled, as manual review is required before sending the notification.
WVLD-11199	Assignment for the specified task type is not allowed. Only Assign task types are supported through this API endpoint.