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:
  • 1 (United States English)
  • 2 (Simplified Chinese, Pinyin ordering)
  • 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

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>

commentsToAuthor

String

Text comments provided by the reviewer to the author in the ‘Comments to Author’ section of the Scoresheet.

<commentsToAuthor>
Please change figure 2
</commentsToAuthor>

commentsToEditor

String

Text comments provided by the reviewer to the editor in the ‘Comments to Editor’ section of the Scoresheet.

<commentsToEditor>
Article would benefit from language editing</commentsToEditor>

departments

Complex

Relationship Between Reviewer and Departmental Affiliation(s).

  • Complex Child_ of Parent Root
    Includes the following response elements:\

address1, address2, address3, affiliationOrderNumber, city, country,
countryCode, department, fax, institution, phone1, phone2, postalCode, roomOrSuite, stateOrProvince, title

address1

String

Reviewer's department address line 1 from the reviewer >> department record.

<address1>One Shields Ave.
</address1>

address2

String

Reviewer's department address line 2 from the reviewer >> department record.

<address2>City Hospital campus Hucknall Road</address2>

address3

String

Reviewer's department address line 3 from the reviewer >> department record.

<address3>500 University Drive</address3>

affiliationOrderNumber

Integer

The order contributing reviewers entered their affiliations into the ScholarOne Manuscripts system. An affiliation at the time research was completed.

<affiliationOrderNumber>1</affiliationOrderNumber>

city

String

Reviewer's department city name from the reviewer >> department record.

<city>Dallas</city>

country

String

Reviewer's department country name from the reviewer >> department record.

<country>United States</country>

countryCode

String

Reviewer's department standard country code. Foreign key to the Country table.

<countryCode>US</countryCode>

department

String

Reviewer's affiliated department name from the reviewer >> department record.

<department>
Physics and Astronomy
</department>

fax

String

Reviewer's department fax number from the reviewer >> department record.

<fax>c1 2 333-0003333</fax>

institution

String

Institution name of the reviewer from the reviewer >> department record.

<institution>University of California Davis</institution>

phone1

String

Reviewer's department primary phone number from the reviewer >> department record.

<phone1>c1 phone 3333-3333</phone1>

phone2

String

Reviewer's department alternate phone number from the reviewer >> department record.

<phone2>c1 phone 3333-4444</phone2>

postalCode

String

Reviewer's department zip code from the reviewer >> department record.

<postalCode>95616-5270</postalCode>

roomOrSuite

String

Reviewer's department room or suite number from the reviewer >> department record.

<roomOrSuite>C1</roomOrSuite>

stateOrProvince

String

Reviewer's department state or province name from the reviewer >> department record.

<stateOrProvince>California</stateOrProvince>

title

String

Reviewer's department title from the reviewer >> department record.

<title>c1 title</title>

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.

<documentId>46939470</documentId>

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.

<inputIndex>0</inputIndex>

This is a zero-based value, that is, if a single document ID is requested, the inputIndex is 0

  • numberOfDaysFromReview
    AssignmentToCompletion
    *

Integer

The number of days between the date the reviewer was assigned to review the submission and the date the review was submitted.

<numberOfDaysFromReviewAssignment..>
15
</numberOfDaysFromReviewAssignment..>

publonsOptIn

String

Reviewer's response to Publons participation question.

<publonsOptIn>yes</publonsOptIn>

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.

<reviewAverageMScore>4.0</reviewAverageMScore>

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.

<reviewRScore>3.0</reviewRScore>

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.

<reviewSumMScore>26.0</reviewSumMScore>

reviewerAssignmentStatus

String

An indication of whether the reviewer has been selected, invited, assigned, uninvited or unassigned.

<reviewerAssignmentStatus>
ASSIGNED
</reviewerAssignmentStatus>

reviewerDateAssigned

dateTime

The date and time when the reviewer was assigned to review the submission.

<reviewerDateAssigned>
2022-07-25T10:21:21Z
</reviewerDateAssigned>

reviewerDateInvited

dateTime

The date and time when the reviewer was invited to review the submission.

<reviewerDateInvited>
2022-07-21T04:00:00Z
</reviewerDateInvited>

reviewerDateResponded

dateTime

The date and time when the reviewer responded to the invitation to review the submission.

<reviewerDateResponded>
2022-07-25T10:21:21Z
</reviewerDateResponded>

reviewerDateSelected

dateTime

The date and time when the reviewer was selected to review the submission.

<reviewerDateSelected>
2022-07-20T20:14:35Z
</reviewerDateSelected>

reviewerFirstName

String

The first or given name of the reviewer.

<reviewerFirstName>Cody</reviewerFirstName>

reviewerFullAddress

String

Concatenated address fields of the reviewer in the format “address1; address2; address3; city, stateOrProvidence; postalCode; country”

<reviewerFullAddress>Ann Arbor, Michigan; United States</reviewerFullAddress>

reviewerFullName

String

The full name of the reviewer in the format “Lastname Suffix, Salutation Firstname Middlename”.

<reviewerFullName>
Huch o, Dr Tim
</reviewerFullName>

reviewerInvitationResponse

String

The reviewer's response to the invitation or assignment to review the given manuscript.

<reviewerInvitationResponse>
Agreed-Main Journal
</reviewerInvitationResponse>

reviewerInvitationResponseId

Integer

Unique ID of the invitation response in the ScholarOne Manuscripts database.

<reviewerInvitationResponseId>
8100
</reviewerInvitationResponseId>

reviewerLastName

String

The last name (surname or family name) of the reviewer.

<reviewerLastName>Dupree</reviewerLastName>

reviewerMembershipId

String

Society Membership number of the user.

<reviewerMembershipId>
society_123
</reviewerMembershipId>

reviewerMiddleName

String

The middle name of the reviewer.

<reviewerMiddleName>J</reviewerMiddleName>

reviewerORCIDId

String

The ORCID is a nonproprietary alphanumeric code to uniquely identify scientific and other academic reviewers.

<reviewerORCIDId>
0000-0002-6167-6691
</reviewerORCIDId >

reviewerORCIDIdValidation

Boolean

Indication of whether that author ORCID has been validated by the reviewer.

<reviewerORCIDIdValidation>
true
</reviewerORCIDIdValidation>

reviewerPersonId

Integer

A unique numeric identifier associated with a person's record (not the user's User ID used for accessing ScholarOne).

<reviewerPersonId>30616594</reviewerPersonId>

reviewerPrimaryEmailAddress

String

The primary e-mail address of the reviewer for the manuscript.

<reviewerPrimaryEmailAddress>
[email protected]
</reviewerPrimaryEmailAddress>
  • reviewerRatingCustom
    Questions
    *

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.

  • Complex Child_ of Parent Root
    Includes the following response elements:\

answerType, customQuestionId, questionName, questionStatus, questionText, reviewerRatingCustomAnswers

answerType

String

Standard HTML input options. Available answer types are Checkbox, Radio, Select, Multiselect, Textarea, Text or Calendar.

<answerType>TYPE_RADIO
</answerType>

customQuestionId

Integer

Unique identifier of the custom question.

<customQuestionId>342636</customQuestionId>

questionName

String

The configured name of a question asked during the reviewer rating process.

<questionName>Quality Assessment</questionName>

questionStatus

String

Current status of a custom question. Valid values are ‘ACTIVE’ or ‘INACTIVE’.

<questionStatus>ACTIVE</questionStatus>

questionText

String

The text of a question asked during the reviwer rating process.

<questionText>How would you 
rate the quality of this review overall?</questionText>

reviewerRatingCustom
Answer

Complex

Reviewer Rating Form custom answers refer to answers provided by editors to each Custom Question on the reviewer rating form.

  • Complex Child_ of Parent reviewerRatingCustomQuestions
    Includes the following response elements:\

abbreviatedResponse, answerId, answerName, answerStatus, answerText, numericValue

abbreviatedResponse

String

Abbreviated custom question response as configured in Reviewer Rating Form Custom Questions.

<abbreviatedResponse>msid</abbreviatedResponse >

answerId

Integer

Numeric value representing the unique answer.

<answerId>700700</answerId>

answerName

String

Human-recognizable name given to the answer to aid in configuration-user lookup.

<answerName>5 (excellent)</answerName>

answerStatus

String

Indication whether answer is turned on or off. Can be ‘ACTIVE’ or ‘INACTIVE’.

<answerStatus>ACTIVE</answerStatus>

answerText

String

The response to a reviewer rating form question to be entered or selected by the editor.

<answerText>5 (excellent)</answerText>

numericValue

Integer

The numeric value (or score) assigned to a response selected or entered by an Editor during the reviewer rating process.

<numericValue>5.0</numericValue>

reviewerResearcherId

String

Provides solution to Reviewer ambiguity by assigning a unique identifier for scientific reviewers.

<reviewerReseacherId >
A-1061-2007
</reviewerResearcherId >

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.

<reviewerRatingFormName>
Reviewer Rating Form
</reviewerRatingFormName>

reviewerRecommendation

String

The text of the recommendation from the given Reviewer's score sheet for that manuscript.

<reviewerRecommendation>
Major Revision
</reviewerRecommendation>

reviewerRecommendation
NumericValue

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..>
3.0 </reviewerRecommendationNumeric..>

reviewerSalutation

String

The salutation designated for the reviewer in the account record. Typical salutations are Dr., Miss, or Mr.

<reviewerSalutation>Dr.</reviewerSalutation>

reviewerSuffix

String

The suffix designated in the reviewer’s account record.

<reviewerSuffix>III</reviewerSuffix>

scoreSheetCompletedDate

dateTime

The date and time the reviewer completed the review of that submission.

<scoreSheetCompletedDate>
2024-05-13T18:07:05Z
</scoreSheetCompletedDate>

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.

  • Complex Child_ of Parent Root
    Includes the following response elements:\

answerType, customQuestionId, questionName, questionStatus, questionText, ScoreSheetCustomAnswers

answerType

String

Standard HTML input options. Available answer types are Checkbox, Radio, Select, Multiselect, Textarea, Text or Calendar.

<answerType>TYPE_RADIO</answerType>

customQuestionId

Integer

Unique identifier of the custom question.

<customQuestionId>342636</customQuestionId>

questionName

String

The configured name of a question asked during the reviewer score sheet process.

<questionName>
If not, please supply details or discuss with the editor
</questionName>

questionStatus

String

Current status of a custom question. Valid values are ‘ACTIVE’ or ‘INACTIVE’.

<questionStatus>ACTIVE</questionStatus>

questionText

String

The text of a question asked during the reviwer score sheet process.

<questionText>Please enter your name:</questionText>

scoreSheetCustomAnswer

Complex

Reviewer Score Sheet custom answers refer to answers provided by reviewers to each Custom Question on the reviewer score sheet form.

  • Complex Child_ of Parent scoreSheetCustomQuestions
    Includes the following response elements:\

abbreviatedResponse, answerId, answerName, answerStatus, answerText, numericValue

abbreviatedResponse

String

Abbreviated custom question response as configured in Reviewer Score Sheet Custom Questions.

<abbreviatedResponse>msid</abbreviatedResponse >

answerId

Integer

Numeric value representing the unique answer.

<answerId>700700</answerId>

answerName

String

Human-recognizable name given to the answer to aid in configuration-user lookup.

<answerName>Institution</answerName>

answerStatus

String

Indication whether answer is turned on or off. Can be ‘ACTIVE’ or ‘INACTIVE’.

<answerStatus>ACTIVE</answerStatus>

answerText

String

The response to a reviewer score sheet question to be entered or selected by the reviewer.

<answerText>No</answerText>

numericValue

Integer

The numeric value (or score) assigned to a response selected or entered by an Reviewer during the reviewer score sheet process.

<numericValue>5.0</numericValue>

scoreSheetDueDate

dateTime

The scheduled or past due date for the reviewer's evaluation of the given submission.

<scoreSheetDueDate>
2023-05-27T01:28:38Z
</scoreSheetDueDate>

scoreSheetNewDueDate

dateTime

The extended or updated date the reviewer’s review is or was due for the given submission.

<scoreSheetNewDueDate>
2013-10-21T19:24:29Z
</scoreSheetNewDueDate>

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.

<scoreSheetName>JCN Scoresheet</scoreSheetName>

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.

<submissionId>WRK4-23-Apr-0009</submissionId>