getDecisionCorrespondence
getDecisionCorrespondence submits a request consisting of a Document ID or IDs or a Submission ID or IDs and returns decision letters corresponding to the submissions once a decision has been made.
Required Parameters
- Submission ID(s) or Document ID(s) - up to 25
- Site Short Name
Optional Parameters
- Locale ID
- _type
- External ID
Resource
- By documentID:
/api/s1m/v5/submissions/full/decisioncorrespondence/documentids - By submissionID:
/api/s1m/v5/submissions/full/decisioncorrespondence/submissionids
Request Parameters
| Element | Type | Description | Required | Example or Default Value |
|---|---|---|---|---|
| getDecisionCorrespondence | 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 |
| ids† | Integer or Integer Array | Document Id or Ids. Unique identifier for each Manuscript Revision in the ScholarOne Manuscripts system. Internally to ScholarOne, this is a numeric value. Each entry must be surrounded by single or double quotes and comma separated when more than one entry is specified. | Yes, if submission IDs are not used. | ’88026’ Or if a list is being requested: '88026','88087','89328' |
| ids†† | String or String Array | Submission Id or Ids. Also known as the Manuscript ID or Document Number. Identifier that is seen in the ScholarOne UI for each Manuscript. Submission Ids are case-sensitive. Each entry must be surrounded by single or double quotes and comma separated when more than one entry is specified. | Yes, if document IDs are not used. | 'WEB-2013-0002' Or if a list is being requested: 'WEB-2013-0002','WEB-2013-0003' |
| 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 | v5/submissions/full/decisioncorrespondence/documentids |
| 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 |
Response Elements
| Response Element | Type | Description | Example or default Value |
|---|---|---|---|
| Status | String | State of a given request call | Can be one of SUCCESS, FAILURE, or MAINTENANCE.
|
| 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> |
| decisionLetter | Complex | Container element that holds details related to the decision letter sent to the author. |
|
| decisionBody | String | Contains the main body of the decision letter. |
Thank you for your submission. Best regards, Dr. Jane Doe |
| decisionCc | String | Specifies the email address that was copied (Cc) on the decision letter. | <decisionCc>[email protected]</decisionCc> |
| decisionBcc | String | Specifies the email address that was blind copied (Bcc) on the decision letter. | <decisionBcc>[email protected]</decisionBcc> |
| decisionFrom | String | Contains the email address of the sender of the decision letter. | <decisionFrom>[email protected]</decisionFrom> |
| decisionSentDate | dateTime | The date and time when the decision letter was sent. | <decisionSentDate>2023-08-17 19:43:06.846</decisionSentDate> |
| decisionSubject | String | Subject line of the decision letter, which usually includes the journal name, manuscript ID, and a brief description of the decision. | <decisionSubject>ES: ES-22-0573-MJ.R2</decisionSubject> |
| decisionTo | String | Email address of the primary recipient or recipients of the decision letter. | <decisionTo>[email protected]</decisionTo> |
| documentId | Integer | Unique identifier of the document. Unique identifier for each Manuscript Revision in the ScholarOneManuscripts system. Internally to ScholarOne, this is a numeric value. | <documentId>49952200</documentId> |
| documentIdLatest | Integer | A unique identifier for the most recent submitted (not draft) version of the manuscript. | <documentIdLatest>49952200</documentIdLatest> |
| documentIdOriginal | Integer | A unique identifier given to the first iteration of a manuscript. | <documentIdOriginal>49952200</documentIdOriginal> |
| inputIndex | Integer | Provides caller the ability to correlate requested document or submission IDs to the appropriate response element. The inputIndex will be randomly chosen when a document or submission id is entered more than once. |
This is a zero-based value. That is, if a single document ID is requested, theinputIndex is 0 |
| responseToDecision | String | The response Author provided to the decision. | <responseToDecision>Thank you for the review. We have made the necessary revisions and look forward to your feedback. </responseToDecision> |
| responseToDecisionFiles | Complex | Represents a collection of all files author provided in the response to the decision. |
|
| customerFileName | String | The file name and type provided by the author in response to the decision. | <customerFileName>Response Letter.pdf</customerFileName> |
| docLink | String | A time-limited, pre-signed URL to the original file attached by the author as their response to the decision letter. | <docLink>https://clarivate-scholarone-...amazonaws.com/.../responsetodecisionletter3.doc?X-Amz-Signature= ...</docLink> |
| submissionId | String | Also 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> |
| submissionIdLatest | String | A 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> |
| submissionIdOriginal | String | A 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> |