setStandardFlagsList

setStandardFlagsList This API endpoint allows users to set or clear standard flags on singe or multiple documents.
This API call supports applying or removing standard flags on specific documents, identified by their unique documentId.

Method: POST

Resource

  • /api/s1m/v2/submissions/full/setStandardFlagsList

Request Parameters

<th style={{ width: "10%" }}>Type</th>
<th style={{ width: "30%" }}>Description</th>
<th style={{ width: "10%" }}>Required</th>
<th style={{ width: "30%" }}>Example or Default Value</th>
setStandardFlagsList 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 web_svcs url String The Web Service URL, which identifies the specific service to handle the request. Yes v2/submissions/full/setStandardFlagsList 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, 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
Element

Request Body Elements

  • The request body must be in JSON format and passed using the raw option.

Request Body Elements example

{
    "input": {
        "standardFlagsList": [
            {
                "documentId": 4830672,
                "flagId": 200,
                "setFl": 1
            },
            {
                "documentId": 4830673,
                "flagName": "MS_FLAG_RED_DOT_NAME",
                "setFl":  0
            }
        ]
    }
}

Request Body Elements Description

<th style={{ width: "10%" }}>Type</th>
<th style={{ width: "30%" }}>Description</th>
<th style={{ width: "10%" }}>Required</th>
<th style={{ width: "30%" }}>Example or Default Value</th>
Input Object This is the root object containing all the data required for setting standard flags on manuscripts. Yes standardFlagsList Array An array of objects, where each object represents an operation to set or clear a standard flag on a specific manuscript. Multiple documents can be processed in a single request. Yes documentId Integer The unique identifier of the manuscript on which the flag is to be set or cleared. Yes "documentId": 4830672 flagId Integer The unique identifier of the standard flag to be applied or removed. This field is required if flagName is not provided. This ID must correspond to a predefined standard flag in the system. Yes, if flagName is not provided "flagId": 200 flagName String The name of the standard flag to be applied or removed. This field is required if flagId is not provided. The name must match a predefined standard flag in the system. Yes, if flagId is not provided "flagName": "MS_FLAG_RED_DOT_NAME" setFl Integer Indicates whether the flag should be set or cleared:
1: Set the flag on the document.
0: Clear the flag from the document. Yes "setFl": 1
Request Body Element

List of available Standard Flags in ScholarOne Manuscripts

flagIdflagName
100MS_FLAG_BLUE_DOT_NAME
200MS_FLAG_RED_DOT_NAME
300MS_FLAG_GREEN_DOT_NAME
400MS_FLAG_PURPLE_DOT_NAME
500MS_FLAG_PINK_X_NAME
510MS_FLAG_BLUE_BOX_NAME
520MS_FLAG_DN_TRIANGLE_NAME
530MS_FLAG_ORANGE_TRIANGLE_NAME
540MS_FLAG_YELLOW_DIAMOND_NAME
550MS_FLAG_GRAY_CHECK_NAME
600MS_FLAG_YELLOW_STAR_NAME
700MS_FLAG_LIGHTBLUE_STAR_NAME
800MS_FLAG_ORANGE_SQUARE_NAME
900MS_FLAG_RED_SQUARE_NAME
1000MS_FLAG_LIGHTGREEN_SQUARE_NAME
1100MS_FLAG_GREEN_LINE_NAME
1110MS_FLAG_GREEN_VERTICAL_NAME
1120MS_FLAG_GREEN_X_NAME