setExternalRevisionFlag
setExternalRevisionFlag API enables the S1 system to lock the ability to rescind a decision upon receiving a notification from the external system that a revision process has started, ensuring both systems remain synchronized.
Method: POST
Resource
/api/s1m/v2/integration/full/externalRevision
Request Parameters
| Element | Type | Description | Required | Example or Default Value |
|---|---|---|---|---|
| setExternalRevisionFlag | 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/integration/full/externalRevision |
| 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:
|
| _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 and passed using the raw option.
Request Body Elements example
{
"input":{
"documentId":12345,
"externalId":WS-213141,
"lockRevisionFl":1
}
}Request Body Elements Description
| Request Body Element | Type | Description | Required | Example or Default Value |
|---|---|---|---|---|
| Input | Object | Contains the details necessary for locking or unlocking the decision rescind in S1. | Yes | |
| documentId | Integer | The unique identifier of the manuscript within the S1 system. | Yes | 12345 |
| externalId | String | The identifier of the corresponding document within the external system. | Yes | "documentId": WS-213141 |
| lockRevisionFl | Integer | Flag indicating whether to lock or unlock the decision rescind functionality in S1. | Yes |
|
Updated 5 months ago