getPersonByID
getPersonByID submits a request consisting of a Person ID or IDs and retrieves detailed information about a person based on their unique identifier. The API provides a structured response containing personal, professional, and account details.
Method: GET
Required Parameters
- Site Short Name
- Person ID(s) - up to 25
Optional Parameters
- _type
- External ID
Base URL
api.abstractcentral.com
Resource
/api/s1a/v3/abstracts/full/personsbyid
Request Parameters
Request Element with Example or Default Value
| Type | Description | Req |
|---|---|---|---|
personids | Root | Yes | |
username
| String | "Profile” Username. | Yes |
Password
| String | The API Key | Yes |
site_name
| String | Site short name. The short name is the abbreviated or truncated name of the society, publisher, or family. | Yes |
ids
| Integer or | A distinct identifier assigned to each person within the ScholarOne Conferences system. | Yes |
url
| String | The Web Service URL, which identifies the specific service to handle the request. | Yes |
external_id
| String | An id value that can be set by the client for call tracking. API Caller supplied Text string to be stored with Audit History information. | No |
_type
| String | The data type requested from the Service | No |
Response Elements
Response elements with Example or Default Value
| Type | Description |
|---|---|---|
Status Can be one of SUCCESS, FAILURE, or MAINTENANCE.
| String | State of a given request call. |
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. |
person Complex Child of Parent Root accountStatus, address1, address2, city, country, degree, department, email, fax, fname, id, institution, lastLoggedIn, linkedin, lname, memberId, mname, personDetails,personDisclosures, phone, postalCode, potentialReviewerFl, profTitle, salutation, stateAbbrev, stateName, suffix, twitter, userId, userRoles | Complex | The person container element encapsulates the core information about an individual retrieved by the getPersonByID API call. This element organizes data into various fields that describe the personal, professional, and account-related attributes of the person. |
accountStatus
| String | Indicates the account's current status. |
address1
| String | The primary address line of the person. |
address2
| String | Additional address details, such as suite or building information. |
city
| String | The city associated with the person's address. |
country
| String | The country associated with the person's address. |
degree
| String | The academic or professional degree of the person. |
department
| String | The department where the person works. |
| String | The person's primary email address. |
fax
| String | The fax number associated with the person, if available. |
fname
| String | The first or given name of the person. |
id
| Integer | The unique identifier assigned to the person. |
institution
| String | The name of the institution with which the person is affiliated. |
lastLoggedIn
| dateTime | The date and time the person last accessed their account. |
| String | The person's LinkedIn profile URL, if provided. |
lname
| String | The last name (surname or family name) of the person. |
memberId
| String | Society Membership number of the person. |
mname
| String | The person's middle name or initial. |
personDetails Complex Child of Person detailGroup | Complex | Contains additional details about the person, structured into groups and sub-details. |
detailGroup Complex Child of personDetails detail, id | Complex | Represents a grouping of specific details about the person. |
detail Complex Child of detailGroup detailName, id, responseName, responseValue | Complex | Individual detail items in the group. |
detailName
| String | The name of the detail. |
id
| Integer | The unique identifier for the detail within the system. |
responseName
| String | A short-form identifier for the detail. |
responseValue
| String | The value associated with the detail. |
id
| Integer | The unique identifier for the detail group within the system. |
personDisclosures Complex Child of person personDisc | Complex | The parent container holding one or more personDisc elements. Each personDisc represents a specific disclosure detail associated with the person. |
personDisc Complex Child of personDisclosures answer,disclosureAffl, id, name, question | Complex | A container element for an individual disclosure. |
answer
| String | The respondent's answer to the disclosure or question. This field captures the information or confirmation provided by the person. (site specific) |
disclosureAffl Complex Child of personDisc affInfo, affName, affSpeaker, affType | Complex | This container element is used to represent information about a person's affiliations and their disclosure status related to those affiliations. |
affInfo
| String | Disclosure affiliation info (site specific) |
affName
| String | Disclosure affiliation name (site specific) |
affSpeaker
| String | Disclosure affiliation speaker (site specific) |
affType
| String | Disclosure affiliation type (site specific) |
id
| Integer | A unique identifier for the disclosure, used to reference or categorize the specific type of disclosure. |
name
| String | The title or label of the disclosure. It describes the purpose or type of information being collected. |
question
| String | A question related to the disclosure, if applicable. |
phone
| String | The person's primary phone number. |
postalCode
| String | The postal code associated with the person's address. (ZIP code) |
potentialReviewerFl
| String | A flag indicating whether the person is a potential reviewer. “true” indicates that the person responded “yes” to the potential reviewer user account question. |
profTitle
| String | The professional title of the person. |
salutation
| String | The salutation designated for the person in his or her account record. |
stateAbbrev
| String | State abbreviation (Only for country US, Canada or Austraila) |
stateName
| String | Full state name (Fixed for country US, Canada or Austraila. Freeform for all other countries) |
suffix
| String | The suffix designated in the person’s account record. |
| String | The person's Twitter handle, if provided. |
userId
| String | Person user id |
userRoles Complex Child of person roleName | Complex | A list of roles assigned to the user. |
roleName
| String | The name of the specific role assigned to the person (names will be site specific). |
Updated 5 months ago
