getReviewerInfoFull
getReviewerInfoFull submits a request consisting of a Document ID or IDs or a Submission ID or IDs and returns detailed metadata about a reviewer or reviewers from a specific manuscript or set of manuscripts.
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/v2/submissions/full/reviewer/documentids - By submissionID:
/api/s1m/v2/submissions/full/reviewer/submissionids
Request Parameters
| Element | Type | Description | Required | Example or Default Value |
|---|---|---|---|---|
| getReviewerInfoFull | 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 | v2/submissions/full/reviewer/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. |
|
profileCallId | String | An id value that is set by the client for call tracking. Set by the request’s external_id element. |
|
commentsToAuthor | String | Text comments provided by the reviewer to the author in the ‘Comments to Author’ section of the Scoresheet. | |
commentsToEditor | String | Text comments provided by the reviewer to the editor in the ‘Comments to Editor’ section of the Scoresheet. | |
departments | Complex | Relationship Between Reviewer and Departmental Affiliation(s). |
address1, address2, address3, affiliationOrderNumber, city, country, |
address1 | String | Reviewer's department address line 1 from the reviewer >> department record. | |
address2 | String | Reviewer's department address line 2 from the reviewer >> department record. |
|
address3 | String | Reviewer's department address line 3 from the reviewer >> department record. |
|
affiliationOrderNumber | Integer | The order contributing reviewers entered their affiliations into the ScholarOne Manuscripts system. An affiliation at the time research was completed. |
|
city | String | Reviewer's department city name from the reviewer >> department record. |
|
country | String | Reviewer's department country name from the reviewer >> department record. |
|
countryCode | String | Reviewer's department standard country code. Foreign key to the Country table. |
|
department | String | Reviewer's affiliated department name from the reviewer >> department record. | |
fax | String | Reviewer's department fax number from the reviewer >> department record. |
|
institution | String | Institution name of the reviewer from the reviewer >> department record. |
|
phone1 | String | Reviewer's department primary phone number from the reviewer >> department record. |
|
phone2 | String | Reviewer's department alternate phone number from the reviewer >> department record. |
|
postalCode | String | Reviewer's department zip code from the reviewer >> department record. |
|
roomOrSuite | String | Reviewer's department room or suite number from the reviewer >> department record. |
|
stateOrProvince | String | Reviewer's department state or province name from the reviewer >> department record. |
|
title | String | Reviewer's department title from the reviewer >> department record. |
|
documentId | Integer | Unique identifier of the document. Unique identifier for each Manuscript Revision in the ScholarOne Manuscripts system. Internally to ScholarOne, this is a numeric value. |
|
inputIndex | Integer | Provides the caller with the ability to correlate requested document or submission IDs to the corresponding response element. The inputIndex is randomly assigned when a document or submission ID is entered multiple times. |
This is a zero-based value, that is, if a single document ID is requested, the inputIndex is 0 |
| Integer | The number of days between the date the reviewer was assigned to review the submission and the date the review was submitted. | |
publonsOptIn | String | Reviewer's response to Publons participation question. |
|
reviewAverageMScore | Integer | The M-Score (Avg) field contains an average of the values of the responses on the given review form for the given manuscript. Review forms may have numeric values associated with responses, the averaged M-Score is the average of those numeric values for this particular review. |
|
reviewRScore | Integer | The score an Editor has given the reviewer for the review of the given manuscript. Specifically, the R-Score for a given reviewer’s review is the average numeric value of all responses to questions on the Rating Form completed by the Editor for that review. |
|
reviewSumMScore | Integer | The M-Score (Sum) field contains a sum of the values of the responses on the given review form for the given manuscript. Review forms may have numeric values associated with responses, the summed M-Score is the total of those numeric values for this particular review. |
|
reviewerAssignmentStatus | String | An indication of whether the reviewer has been selected, invited, assigned, uninvited or unassigned. | |
reviewerDateAssigned | dateTime | The date and time when the reviewer was assigned to review the submission. | |
reviewerDateInvited | dateTime | The date and time when the reviewer was invited to review the submission. | |
reviewerDateResponded | dateTime | The date and time when the reviewer responded to the invitation to review the submission. | |
reviewerDateSelected | dateTime | The date and time when the reviewer was selected to review the submission. | |
reviewerFirstName | String | The first or given name of the reviewer. |
|
reviewerFullAddress | String | Concatenated address fields of the reviewer in the format “address1; address2; address3; city, stateOrProvidence; postalCode; country” |
|
reviewerFullName | String | The full name of the reviewer in the format “Lastname Suffix, Salutation Firstname Middlename”. | |
reviewerInvitationResponse | String | The reviewer's response to the invitation or assignment to review the given manuscript. | |
reviewerInvitationResponseId | Integer | Unique ID of the invitation response in the ScholarOne Manuscripts database. | |
reviewerLastName | String | The last name (surname or family name) of the reviewer. |
|
reviewerMembershipId | String | Society Membership number of the user. | |
reviewerMiddleName | String | The middle name of the reviewer. |
|
reviewerORCIDId | String | The ORCID is a nonproprietary alphanumeric code to uniquely identify scientific and other academic reviewers. | |
reviewerORCIDIdValidation | Boolean | Indication of whether that author ORCID has been validated by the reviewer. | |
reviewerPersonId | Integer | A unique numeric identifier associated with a person's record (not the user's User ID used for accessing ScholarOne). |
|
reviewerPrimaryEmailAddress | String | The primary e-mail address of the reviewer for the manuscript. | |
| Complex | Reviewer Rating Form custom questions refer to questions that editors answer as part of their reviewer rating. Custom questions without an answer are not included in the response. Custom questions with the answer types Label, URL, or Image are not included in the response. |
answerType, customQuestionId, questionName, questionStatus, questionText, reviewerRatingCustomAnswers |
answerType | String | Standard HTML input options. Available answer types are Checkbox, Radio, Select, Multiselect, Textarea, Text or Calendar. | |
customQuestionId | Integer | Unique identifier of the custom question. |
|
questionName | String | The configured name of a question asked during the reviewer rating process. |
|
questionStatus | String | Current status of a custom question. Valid values are ‘ACTIVE’ or ‘INACTIVE’. |
|
questionText | String | The text of a question asked during the reviwer rating process. | |
reviewerRatingCustom | Complex | Reviewer Rating Form custom answers refer to answers provided by editors to each Custom Question on the reviewer rating form. |
abbreviatedResponse, answerId, answerName, answerStatus, answerText, numericValue |
abbreviatedResponse | String | Abbreviated custom question response as configured in Reviewer Rating Form Custom Questions. |
|
answerId | Integer | Numeric value representing the unique answer. |
|
answerName | String | Human-recognizable name given to the answer to aid in configuration-user lookup. |
|
answerStatus | String | Indication whether answer is turned on or off. Can be ‘ACTIVE’ or ‘INACTIVE’. |
|
answerText | String | The response to a reviewer rating form question to be entered or selected by the editor. |
|
numericValue | Integer | The numeric value (or score) assigned to a response selected or entered by an Editor during the reviewer rating process. |
|
reviewerResearcherId | String | Provides solution to Reviewer ambiguity by assigning a unique identifier for scientific reviewers. | |
reviewerRatingFormName | String | The name as configured for the reviewer rating form completed for the review of the manuscript. The Reviewer Rating Form Name is generally a descriptor of that review rating form. | |
reviewerRecommendation | String | The text of the recommendation from the given Reviewer's score sheet for that manuscript. | |
reviewerRecommendation | Integer | The numeric value of the recommendation selected by the reviewer. The numeric value is used in the calculation of the review M-Score (if configured). | <reviewerRecommendationNumeric..> |
reviewerSalutation | String | The salutation designated for the reviewer in the account record. Typical salutations are Dr., Miss, or Mr. |
|
reviewerSuffix | String | The suffix designated in the reviewer’s account record. |
|
scoreSheetCompletedDate | dateTime | The date and time the reviewer completed the review of that submission. | |
scoreSheetCustomQuestions | Complex | Score Sheet custom questions refer to questions that reviewers answer as part of their manuscript review. Custom questions without an answer are not included in the response. Custom questions with the answer types Label, URL, or Image are not included in the response. |
answerType, customQuestionId, questionName, questionStatus, questionText, ScoreSheetCustomAnswers |
answerType | String | Standard HTML input options. Available answer types are Checkbox, Radio, Select, Multiselect, Textarea, Text or Calendar. |
|
customQuestionId | Integer | Unique identifier of the custom question. |
|
questionName | String | The configured name of a question asked during the reviewer score sheet process. | |
questionStatus | String | Current status of a custom question. Valid values are ‘ACTIVE’ or ‘INACTIVE’. |
|
questionText | String | The text of a question asked during the reviwer score sheet process. |
|
scoreSheetCustomAnswer | Complex | Reviewer Score Sheet custom answers refer to answers provided by reviewers to each Custom Question on the reviewer score sheet form. |
abbreviatedResponse, answerId, answerName, answerStatus, answerText, numericValue |
abbreviatedResponse | String | Abbreviated custom question response as configured in Reviewer Score Sheet Custom Questions. |
|
answerId | Integer | Numeric value representing the unique answer. |
|
answerName | String | Human-recognizable name given to the answer to aid in configuration-user lookup. |
|
answerStatus | String | Indication whether answer is turned on or off. Can be ‘ACTIVE’ or ‘INACTIVE’. |
|
answerText | String | The response to a reviewer score sheet question to be entered or selected by the reviewer. |
|
numericValue | Integer | The numeric value (or score) assigned to a response selected or entered by an Reviewer during the reviewer score sheet process. |
|
scoreSheetDueDate | dateTime | The scheduled or past due date for the reviewer's evaluation of the given submission. | |
scoreSheetNewDueDate | dateTime | The extended or updated date the reviewer’s review is or was due for the given submission. | |
scoreSheetName | String | The name configured for the score sheet used in the manuscript review is known as the Score Sheet Name. This name typically serves as a descriptor for that specific review form. |
|
submissionId | String | Also known as the Manuscript Id or Document Number. An identifier given to each submitted manuscript. Submission IDs are casesensitive, they are not necessarily unique. |
|
Updated 5 months ago
