getReviewFilesFull
getReviewFilesFull sends a request containing either a Document ID or IDs, or a Submission ID or IDs, and retrieves signed URLs for all files attached to decision letters, author responses, and reviewer reports.
When this API call is made, if a file does not exist in the file system, the response will only include the name of the file. The response will not include a link or generate the files.
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/v3/submissions/full/review_files/documentids - By submissionID:
/api/s1m/v3/submissions/full/review_files/submissionids
Request Parameters
| Element | Type | Description | Required | Example or Default Value |
|---|---|---|---|---|
| getReviewFilesFull | 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 | v3/submissions/full/review_files/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.<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> |
| 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>40702045</documentId> |
| signedFilesInfo | Complex | Represents a collection of elements that offer additional information about the review files. |
|
| displayName | String | The file name, uploaded as part of the review process, including the file extension. | <displayName>Author_response.docx</displayName> |
| docLink | String | Link to access the review files uploaded by the Author or the Editorial staff. | <docLink>https://clarivate-scholarone-prod-us-west-2-s1m-files.s3.us-west-2.amazonaws.com/docfiles/prod1/salesdemoplus/2021/02/40702045/docfiles/original-files/40702045_File000004_1361483448.docx</docLink> |
| fileType | String | The system label for the file added as part of the review process. Current file types are: scoresheet, response_to_decision, decision_letter. | <fileType>response_to_decision</fileType> |
| 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-21-Feb-0002</submissionId> |