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>

authorFirstName

String

The first or given name of the author.

<authorFirstName>Cody</authorFirstName>

authorFullAddress

String

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

<authorFullAddress>350 Greenbrier Dr; Charlottesville, Virginia; 22901; United States</authorFullAddress>

authorFullName

String

The full name of the author in the format “Lastname Suffix, Salutation Firstname Middlename”. Submitting Author or Submitting Agent.

<authorFullName>Hucho, Dr. Tim</authorFullName>

authorLastName

String

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

<authorLastName>Dupree</authorLastName>

authorMembershipId

String

Society Membership number of the user.

<authorMembershipId>society_123</authorMembershipId>

authorMiddleName

String

The middle name of the author.

<authorMiddleName>J</authorMiddleName>

authorORCIDId

String

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

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

authorORCIDIdValidation

Boolean

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

<authorORCIDIdValidation>TRUE</authorORCIDIdValidation>

authorOrderNumber

Integer

Order in which the author is listed on the document. Order number of the author as entered in the Author & Institutions page during submission.

<authorOrderNumber>1</authorOrderNumber>

authorPersonId

Integer

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

<authorPersonId>686975</authorPersonId>

authorPrimaryEmailAddress

String

The primary e-mail address of the author.

<authorPrimaryEmailAddress>
[[email protected]]
<authorPrimaryEmailAddress>

authorResearcherId

String

Provides solution to Author ambiguity by assigning a unique identifier for scientific authors.

<authorReseacherId>A1061-2007</authorResearcherId>

authorSalutation

String

The salutation chosen for an author in their account record, often Dr., Miss, or Mr.

<authorSalutation>Dr.</authorSalutation>

authorSuffix

String

The suffix chosen in the author’s account record.

<authorSuffix>III</authorSuffix>

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>88026</documentId>

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.

<inputIndex>4</inputIndex>  
This is a zero-based value.That is, if a single document id is requested, theinputIndex is 0

invitedAuthorDateAssigned

dateTime

The date an invited author was assigned to submit the manuscript (the date the author was assigned to the given stub).

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

invitedAuthorDateInvited

dateTime

The date an invited author was invited to submit the given manuscript.

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

invitedAuthorDateResponse

dateTime

The date an invited author responded to the invitation to submit a manuscript.

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

invitedAuthorDateSelected

dateTime

The date an invited author was selected to submit the given manuscript.

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

invitedAuthorInvitationResponse

String

The answer an invited author gave in response to the invitation to submit the given manuscript.

<invitedAuthorInvitationResponse>
Agreed
</invitedAuthorInvitationResponse>

invitedAuthorInvitationResponseId

Integer

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

<invitedAuthorInvitationResponseId>
336
</invitedAuthorInvitationResponseId>

isCoAuthor

Boolean

Indication of whether that author is of type Co-Author on the given manuscript. “true” indicates that author is a co-author for that submission.

<isCoAuthor>false</isCoAuthor>

isContact

Boolean

Indication of whether that author is of type Contact Author on the given manuscript (as opposed to Submitting Author, for example). The contact author will be contacted during the peer review process and used for email tags.

<isContact>true</isContact>

isCorresponding

Boolean

Indication of whether that author is of type Corresponding Author on the given manuscript (as opposed to Submitting Author, for example).

<isCorresponding>true</isCorresponding>

isInvited

Boolean

Indication of whether that author is the invited author on the given manuscript.

<isInvited>false</isInvited>

isSubmittingAgent

Boolean

Indication if the individual submitting the manuscript is one of the co-authors representing themselves and their collaborators, or if they are an external submitting agent not listed as an author.

<isSubmittingAgent>false</isSubmittingAgent>

isSubmittingAuthor

Boolean

Indication of whether that author is of type Submitting Author on the given manuscript(as opposed to a Co-Author, for example).

<isSubmittingAuthor>true</isSubmittingAuthor>

submissionId

String

Also known as the Manuscript Id or Document Number. A unique identifier given to each submitted manuscript. Submission IDs are case-sensitive, they are not necessarily unique.

<submissionId>Sensors00996-2005\</submissionId

departments

Complex

The connection between the author and their departmental affiliation(s). It retains address information from the time of submission rather than updating it to the current details for the person.

Complex Child of Parent Root
Includes following response elements: address1, address2, address3, affiliationOrderNumber, city, country, countryCode, department,fax, institution, phone1, phone2, postalCode, roomOrSuite, stateOrProvince, title

address1

String

Author's department address line 1 from the author >> department record.

<address1>c1 address A1</address1>

address2

String

Author's department address line 2 from the author >> department record.

<address1>c1 address B2</address1>

address3

String

Author's department address line 3 from the author >> department record.

<address1>c1 address B3</address1>

affiliationOrderNumber

Integer

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

<affiliationOrderNumber>
1
</affiliationOrderNumber>

city

String

Author's department city name from the author>>department record.

<city>Ann Arbor</city>

country

String

Author's department country name from the author>>department record.

<country>United States</country>

countryCode

String

Author's department standard country code; foreign key to the Country table.

<countryCode>US</countryCode>

department

String

Author's affiliated department name from the author>>department record.

<department>c1 department 2</department>

fax

String

Author's department fax number from the author>>department record.

<fax>c1 fax 2 333-000-3333</fax>

institution

String

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

<institution>UMich</institution>

phone1

String

Author's department primary phone number from the author>>department record.

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

phone2

String

Author's department alternate phone number from the author>>department record.

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

postalCode

String

Author's department zip code from the author>>department record.

<postalCode>SW1A 1AA</postalCode>

ringgoldId

String

Author's institution Ringgold ID identifier.

<ringgoldId>1355</ringgoldId>

roomOrSuite

String

Author's department state or providence name from the author>>department record.

<stateOrProvince>Michigan</stateOrProvince>

stateOrProvince

String

Author's department state or providence name from the author>>department record.

<stateOrProvince>Michigan</stateOrProvince>

title

String

Author's department title from the author>>department record.

<title>c1 title</title>