getAuthorInfoBasic
getAuthorInfoBasic sends a request with either a Document ID or IDs, or a Submission ID or IDs, and retrieves basic metadata about the author or authors of a particular manuscript or group of manuscripts.
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/v3/person/basic/personids/search - By PrimaryEmailAddress:
/api/s1m/v3/person/basic/email/search
Request Parameters
| Element | Type | Description | Required | Example or Default Value |
|---|---|---|---|---|
| getPersonInfoBasic | 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 | v3/person/basic/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. | <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. | |
| accountDeletedDate | Timestamp | Timestamp indicating when the person's account was deleted due to an account merge. | |
| activeFlag | Boolean | Person's account activation status. | <activeFlag>1</activeFlag> |
| firstName | String | Person's first name. | <firstName>Elizabeth</firstName> |
| gdprRemovedFlag | Boolean | Indicates whether the person's account has been GDPR removed. | <gdprRemovedFlag>false</gdprRemovedFlag> |
| 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> |
| membershipStatus | String | Person's membership status. | <membershipStatus>Active</membershipStatus> |
| 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. | <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> |
| personId | Integer | Person's unique identifier. | <personId>120250516</personId> |
| primaryEmailAddress | String | Person's primary email address. | |
| 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> |
| userId | String | Unique userID of the person. | <userId>[email protected]</userId> |