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:
|
| _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. |
|
accountCreatedDate | Timestamp | Timestamp of the person's account creation date. | |
accountDeletedDate | Timestamp | Timestamp indicating when the person's account was deleted due to an account merge. | |
activeFlag | Boolean | Person's account activation status. |
|
alternateContactEmail | String | Person's alternate contact email address. | |
alternateContactEnd | Timestamp | Person's alternate contact email end date. | |
alternateContactStart | Timestamp | Person's alternate contact email start date. | |
comments | String | Comments linked to the person account. |
|
degree | String | Degree linked to the person account. |
|
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. |
address1, address2, address3, affiliationOrderNumber, city, country, countryCode, department, fax, institution, phone1, phone2, postalCode, |
address1 | String | Person's department address line 1 from the author >> department record. |
|
address2 | String | Person's department address line 2 from the author >> department record. |
|
address3 | String | Person's department address line 3 from the author >> department record. |
|
affiliationOrderNumber | Integer | The order contributing authors entered their affiliations into the ScholarOne Manuscripts system. An affiliation at the time research was completed. |
|
city | String | Person's department city name from the author>>department record. |
|
country | String | Person's department country name from the author>>account record. |
|
countryCode | String | Person's Department Standard Country Code. Foreign key linking to the Country table. |
|
department | String | Person's affiliated department name from the person>>department record. |
|
fax | String | Person's department fax number from the person>>department record. |
|
institution | String | Person's institution name from the person>>department record. |
|
institutionId | String | Unique ID for the named Institution. |
|
institutionIdType | String | The type of institutional ID used. |
|
phone1 | String | Person's department primary phone number from the person>>department record. |
|
phone2 | String | Person's department alternate phone number from the person>>department record. | |
postalCode | String | Person's department zip code from the person>>department record. |
|
roomOrSuite | String | Person's department state or providence name from the person>>department record. |
|
stateOrProvince | String | Person's department state or providence name from the person>>department record. |
|
title | String | Person's department title from the author>>department record |
|
designations | Complex | Person Designations tied to the person account. |
designationId, designationName |
designationId | Integer | Identifier of the Designation associated to the person account. |
|
designationName | String | Identifier Designation Name of the Designation associated to the person account. |
|
files | Complex | Files associated to the person account. |
customerFileName |
customerFileName | String | File Name associated to the person account. |
|
attributes | Complex | Details regarding the attributes entered in a person's account. |
attributeId, attributeName, attributeTypeId, attributeTypeName |
attributeId | Integer | Identifier of an attribute associated to a person account. |
|
attributeName | String | Name of the attribute identifier associated to the person account. |
|
attributeTypeId | Integer | Attribute group identifier of attributes associated to the person account. |
|
attributeTypeName | String | Attribute group identifier name for attributes associated with the person account. |
|
firstName | String | Person's first name. |
|
fullAddress | String | Person's full address. |
|
fullName | String | Person's full name includes salutation, firstname, middlename and lastname. |
|
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. |
|
gdprRemovedFlag | Boolean | Indicates whether the person's account has been GDPR removed. |
|
Initials | String | Person's initials. |
|
lastModifiedDate | Timestamp | Timestamp of the last modification to the person's records. | |
lastName | String | Person's last name. |
|
localeId | Integer | Persons localeID as Integer, Ex. 1 = EN(English), 2 = CN(China). |
|
marketingPreference | String | Marketing Preference linked to the person's account. |
|
marketingPreference | Timestamp | Date when the current marketing preference was linked to the account. | |
membershipStatus | String | Person's membership status. |
|
middleName | String | Person’s middle name. |
|
orcidId | String | Oauth access details of the person to the ORCID site. | |
orcidAccessToken | String | Oauth access token of the person to access ORCID details. | |
orcidScope | String | Orcid Scope to access resources on the ORCID site. |
|
orcidTokenType | String | Orcid Token Type. |
|
orcidValidation | Boolean | Whether the ORCID token is validated successfully. |
|
ORCIDRefreshToken | String | Oauth refresh token of the person to access orcid details. | |
personId | Integer | Person's unique identifier. |
|
personRoles | Complex | Roles Associated to the person. |
roleId, roleName, roleType, roleTypeId |
roleId | String | Identifier of the Role associated with the person. |
|
roleName | String | Name of the Role associated with the person. |
|
roleType | String | Name of the RoleType associated with the role of a Person. |
|
roleTypeId | Integer | Identifier of the RoleType associated to the role of a person. |
|
primaryCCEmailAddress | String | Person's primary CC email address. | |
primaryEmailAddress | String | Person's primary email address. | |
researchInterests | String | Person's Research Interests. |
|
salutation | String | Person's account salutation. |
|
secondaryCCEmail | String | Person's secondary CC email address. | |
secondaryEmailAddress | String | Person's secondary email address. | |
secureToken | String | secureToken associated with the person's account. | |
secureTokenCreateDate | Timestamp | SecureToken date created, associated with the person, secure token. | |
secureTokenExpiration | Timestamp | The expiration date of the secure token associated with the person. |
|
signature | String | Person's signature. |
|
ssoStatusId | Integer | Person's SSO status if the site is SSO enabled. |
|
ssoStatusName | String | Person's SSO status name. |
|
suffix | String | Suffix associated to aperson. |
|
unavailableExemption | Timestamp | Person's unavailable exemption end date. | |
unavailableExemption | String | Person's unavailable exemption name. |
|
unavailableExemption | Timestamp | Person's unavailable exemption start date. | |
userId | String | Unique userID of the person. |
|
Updated 4 months ago
