getPersonInfoFull

getPersonInfoFull sends a request with either a Primary Email Address or Person ID or IDs, and retrieves detailed information about a person/user record on a site's short name.

Required Parameters

  • Person ID or Primary Email Address
  • Site Short Name

Optional Parameters

  • Locale ID
  • _type
  • External ID
  • Is Deleted (true/false)

Resource

  • By personID: /api/s1m/v7/person/full/personids/search
  • By PrimaryEmailAddress: /api/s1m/v7/person/full/email/search

Request Parameters

Element Type Description Required Example or Default Value
getPersonInfoFull 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
Person ID or IDs
Unique numeric identifier assigned to each individual in the ScholarOne Manuscripts system. When specifying multiple Person IDs, each ID must be enclosed in single or double quotes and separated by commas.
Yes, if Primary Email Address is not used
’120250516’
Or if a list is being requested: '120250516','120250618'
primary_email String The primary e-mail address of the designated person. Yes, if person IDs are not used. [email protected]
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 v7/person/full/email/search
is_deleted Boolean Flag to retrieve the account details of a deleted person. No true/false
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>

accountCreatedDate

Timestamp

Timestamp of the person's account creation date.

<accountCreatedDate>
2024-01-22T10:33:19Z
</accountCreatedDate>

accountDeletedDate

Timestamp

Timestamp indicating when the person's account was deleted due to an account merge.

<accountDeletedDate>
2024-05-29T09:24:03Z
</accountDeletedDate>

activeFlag

Boolean

Person's account activation status.

<activeFlag>1</activeFlag>

alternateContactEmail
Address

String

Person's alternate contact email address.

<alternateContactEmailAddress>
[email protected]
</alternateContactEmailAddress>

alternateContactEnd
Date

Timestamp

Person's alternate contact email end date.

<alternateContactEndDate>
2018-10-25T:00:00-4:00
</alternateContactEndDate>

alternateContactStart
Date

Timestamp

Person's alternate contact email start date.

<alternateContactStartDate>
2018-10-25T:00:004:00
</alternateContactStartDate>

comments

String

Comments linked to the person account.

<comments>test comment</comments>

degree

String

Degree linked to the person account.

<degree>Ph.D</degree>

departments

Complex

Relationship between Author and Departmental Affiliation(s). Departmental affiliation(s) are recorded as they were at the time of submission. This ensures that the address information reflects the person's details during the submission period, rather than attempting to update it with current information.

  • 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

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

<address1>School of Physics</address1>

address2

String

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

<address2>c1 address B2</address2>

address3

String

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

<address3>c1 address B3</address3>

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

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

<city>Sydney</city>

country

String

Person's department country name from the author>>account record.

<country>Australia</country>

countryCode

String

Person's Department Standard Country Code. Foreign key linking to the Country table.

<countryCode>AU</countryCode>

department

String

Person's affiliated department name from the person>>department record.

<department>206653955</department>

fax

String

Person's department fax number from the person>>department record.

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

institution

String

Person's institution name from the person>>department record.

<institution>The University of Sydney</institution>

institutionId

String

Unique ID for the named Institution.

<institutionId>4334</institutionId>

institutionIdType

String

The type of institutional ID used.

<institutionIdType>RingGold</institutionIdType>

phone1

String

Person's department primary phone number from the person>>department record.

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

phone2

String

Person's department alternate phone number from the person>>department record.

c1 phone 333-333-4444

postalCode

String

Person's department zip code from the person>>department record.

<postalCode>2006</postalCode>

roomOrSuite

String

Person's department state or providence name from the person>>department record.

<stateOrProvince>New South Wales</stateOrProvince>

stateOrProvince

String

Person's department state or providence name from the person>>department record.

<stateOrProvince>New South Wales</stateOrProvince>

title

String

Person's department title from the author>>department record

<title>c1 title</title>

designations

Complex

Person Designations tied to the person account.

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

designationId, designationName

designationId

Integer

Identifier of the Designation associated to the person account.

<designationId>3</designationId>

designationName

String

Identifier Designation Name of the Designation associated to the person account.

<designationName>TEST-DES</designationName>

files

Complex

Files associated to the person account.

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

customerFileName

customerFileName

String

File Name associated to the person account.

<customerFileName>2017-Fall-Enrichment.pdf</customerFileName>

attributes

Complex

Details regarding the attributes entered in a person's account.

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

attributeId, attributeName, attributeTypeId, attributeTypeName

attributeId

Integer

Identifier of an attribute associated to a person account.

<attributeId>277237</attributeId>

attributeName

String

Name of the attribute identifier associated to the person account.

<attributeName>asteroseismology</attributeName>

attributeTypeId

Integer

Attribute group identifier of attributes associated to the person account.

<attributeTypeId>989</attributeTypeId>

attributeTypeName

String

Attribute group identifier name for attributes associated with the person account.

<attributeTypeName>Keywords</attributeTypeName>

firstName

String

Person's first name.

<firstName>Elizabeth</firstName>

fullAddress

String

Person's full address.

<fullAddress>4405 RD Glen Allen VA United States</fullAddress>

fullName

String

Person's full name includes salutation, firstname, middlename and lastname.

<fullName>Dr. John Grammaticus</fullName>

galleyDelivery

String

This element provides information regarding the status, schedule, and method of delivery for the galley version of a publication associated with a specific person.

<galleyDelivery>null</galleyDelivery>

gdprRemovedFlag

Boolean

Indicates whether the person's account has been GDPR removed.

<gdprRemovedFlag>false</gdprRemovedFlag>

Initials

String

Person's initials.

<initials>ks</intials>

lastModifiedDate

Timestamp

Timestamp of the last modification to the person's records.

<lastModifiedDate>
2024-05-29T09:19:55.573-04:00
</lastModifiedDate>

lastName

String

Person's last name.

<lastName>Smith</lastName>

localeId

Integer

Persons localeID as Integer,

Ex. 1 = EN(English), 2 = CN(China).

<localedId>1</localeId>

marketingPreference

String

Marketing Preference linked to the person's account.

<marketingPreference>Yes</marketingPreference>

marketingPreference
Date

Timestamp

Date when the current marketing preference was linked to the account.

<marketingPreferenceDate>
2018-06-09T00:19:30.755-04:00
</marketingPreferenceDate>

membershipStatus

String

Person's membership status.

<membershipStatus>Active</membershipStatus>

middleName

String

Person’s middle name.

<middleName>Lauren</middleName>

orcidId

String

Oauth access details of the person to the ORCID site.

<orcidId>0000-0002-9846-0608
</orcidId>

orcidAccessToken

String

Oauth access token of the person to access ORCID details.

<orcidAccessToken>
abcdef-12345-4ee2-9c1a
</orcidAccessToken>

orcidScope

String

Orcid Scope to access resources on the ORCID site.

<orcidScope>[/authenticate, .orcid-bio/readlimited]</orcidScope>

orcidTokenType

String

Orcid Token Type.

<orcidTokenType>bearer</orcidToken>

orcidValidation

Boolean

Whether the ORCID token is validated successfully.

<orcidValidation>true</orcidValidation>

ORCIDRefreshToken

String

Oauth refresh token of the person to access orcid details.

<ORCIDRefreshToken>
473f98e0-a78e-4266-9b7a-0c8704ebbbf8
</ORCIDRefreshToken>

personId

Integer

Person's unique identifier.

<personId>120250516</personId>

personRoles

Complex

Roles Associated to the person.

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

roleId, roleName, roleType, roleTypeId

roleId

String

Identifier of the Role associated with the person.

<roleId>2014</roleId>

roleName

String

Name of the Role associated with the person.

<roleName>Author</roleName>

roleType

String

Name of the RoleType associated with the role of a Person.

<roleType>AUTHOR</roleType>

roleTypeId

Integer

Identifier of the RoleType associated to the role of a person.

<roleTypeId>1</roleTypeId>

primaryCCEmailAddress

String

Person's primary CC email address.

<primaryCCEmailAddress>
[email protected]
</primaryCCEmailAddress >

primaryEmailAddress

String

Person's primary email address.

<primaryEmailAddress>
[email protected]
</primaryEmailAddress>

researchInterests

String

Person's Research Interests.

<researchInterests>Geography</researchInterests>

salutation

String

Person's account salutation.

<salutation>Dr</salutation>

secondaryCCEmail
Address

String

Person's secondary CC email address.

<secondaryCCEmailAddress>
[email protected]
</secondaryCCEmailAddress>

secondaryEmailAddress

String

Person's secondary email address.

<secondaryEmailAddress>
[email protected]
</secondaryEmailAddress>

secureToken

String

secureToken associated with the person's account.

<secureToken>token123
</secureToken>

secureTokenCreateDate

Timestamp

SecureToken date created, associated with the person, secure token.

<secureTokenCreateDate>
2018-10-25T:00:00-4:00
</secureTokenCreateDate>

secureTokenExpiration
Date

Timestamp

The expiration date of the secure token associated with the person.

<secureTokenExpirationDate >2018-10-25T:00:00-4:00</secureTokenExpirationDate >

signature

String

Person's signature.

<signature>Dr.Test</signature>

ssoStatusId

Integer

Person's SSO status if the site is SSO enabled.

<ssoStatusId>2</ssoStatusId>

ssoStatusName

String

Person's SSO status name.

<ssoStatusName>ELIGIBLE-NEVERLINKED</ssoStatusName>

suffix

String

Suffix associated to aperson.

<suffix>Dr.</suffix>

unavailableExemption
EndDate

Timestamp

Person's unavailable exemption end date.

<unavailableExemptionEndDate>
2018-10-25T:00:00-4:00
</unavailableExemptionEndDate>

unavailableExemption
Name

String

Person's unavailable exemption name.

<unavailableExemptionName>All Review Reminders</unavailableExemptionName>

unavailableExemption
StartDate

Timestamp

Person's unavailable exemption start date.

<unavailableExemptionStartDate>
2018-10-25T:00:00-4:00
</unavailableExemptionStartDate>

userId

String

Unique userID of the person.

<userId>[email protected]</userId>