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

getPersonByID

Type

Description

Req

personids

Root

Yes

username

sample_user

String

"Profile” Username.
This designation refers to the username used within the application system, distinct from a ScholarOne Conferences user. This information is sourced from the caller's profile.

Yes

Password

SRU4DQ5WOJ2PX8CA

String

The API Key
Encrypted value uniquely identifying/authenticating Caller

Yes

site_name

acdemo

String

Site short name. The short name is the abbreviated or truncated name of the society, publisher, or family.

Yes

ids

'1464540'
Or if a list is being requested:
'1544715','4121010','5050114'

Integer or
Integer Array

A distinct identifier assigned to each person within the ScholarOne Conferences system.
When specifying multiple entries, each must be enclosed in single or double quotes and separated by comma.

Yes

url

v3/abstracts/full/personids

String

The Web Service URL, which identifies the specific service to handle the request.

Yes

external_id

123456

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

Can be xml (default if omitted), or json

String

The data type requested from the Service xml or JSON. This defaults to xml

No


Response Elements

Response elements with Example or Default Value

getPersonByID

Type

Description

Status

Can be one of SUCCESS, FAILURE, or MAINTENANCE. <status>SUCCESS</status>

String

State of a given request call.

callID

<callId>63631fe1-7378-4cc1-ab18-87c06c2eff58</callId>

String

The CALL_ID is the unique identifier for a given Web Services call. Generated by the ScholarOne Web Services application.

profileCallId

<profileCallId>111111</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
Includes the following response elements:

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

<accountStatus>Active</accountStatus>

String

Indicates the account's current status.

address1

<address1>Sestara Ninkovic 5</address1>

String

The primary address line of the person.

address2

<address2>Suite 200</address2>

String

Additional address details, such as suite or building information.

city

<city>Novi Sad</city>

String

The city associated with the person's address.

country

<country>Serbia</country>

String

The country associated with the person's address.

degree

<degree>MD</degree>

String

The academic or professional degree of the person.

department

<department>Surgery</department>

String

The department where the person works.

email

<email>[email protected]</email>

String

The person's primary email address.

fax

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

String

The fax number associated with the person, if available.

fname

<fname>John</fname>

String

The first or given name of the person.

id

<id>7099300</id>

Integer

The unique identifier assigned to the person.
(not the user's User ID used for accessing ScholarOne).

institution

<institution>Wayland Yutani</institution>

String

The name of the institution with which the person is affiliated.

lastLoggedIn

<lastLoggedIn>2023-06-10 10:08:26.677</lastLoggedIn>

dateTime

The date and time the person last accessed their account.

linkedin

<linkedin>www.linkedin.com/JohnDoe</linkedin>

String

The person's LinkedIn profile URL, if provided.

lname

<lname>Grammaticus</lname>

String

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

memberId

<memberId>soc -00041650</memberId>

String

Society Membership number of the person.

mname

<mname>H.</mname>

String

The person's middle name or initial.

personDetails

Complex Child of Person
Includes the following response elements:

detailGroup

Complex

Contains additional details about the person, structured into groups and sub-details.

detailGroup

Complex Child of personDetails
Includes the following response elements:

detail, id

Complex

Represents a grouping of specific details about the person.

detail

Complex Child of detailGroup
Includes the following response elements:

detailName, id, responseName, responseValue

Complex

Individual detail items in the group.

detailName

<detailName>Primary Institution Type</detailName>

String

The name of the detail.

id

<id>248041</id>

Integer

The unique identifier for the detail within the system.

responseName

<responseName>ACADEMIC</responseName>

String

A short-form identifier for the detail.

responseValue

<responseValue>ACADEMIC</responseValue>

String

The value associated with the detail.

id

<id>24010</id>

Integer

The unique identifier for the detail group within the system.

personDisclosures

Complex Child of person
Includes the following response elements:

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
Includes the following response elements:

answer,disclosureAffl, id, name, question

Complex

A container element for an individual disclosure.

answer

<answer>Asian</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
Includes the following response elements:

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

<affInfo>conflict</affInfo>

String

Disclosure affiliation info (site specific)

affName

<affName>watson company</affName>

String

Disclosure affiliation name (site specific)

affSpeaker

<affSpeaker>John Smith</affSpeaker>

String

Disclosure affiliation speaker (site specific)

affType

<affType>watson conflict</affType>

String

Disclosure affiliation type (site specific)

id

<id>23021</id>

Integer

A unique identifier for the disclosure, used to reference or categorize the specific type of disclosure.

name

<name>Race</name>

String

The title or label of the disclosure. It describes the purpose or type of information being collected.

question

<question>I consent to receive offers from sponsoring societies and partners.</question>

String

A question related to the disclosure, if applicable.

phone

<phone>+43-3434-343-434</phone>

String

The person's primary phone number.

postalCode

<postalCode>A-21201</postalCode>

String

The postal code associated with the person's address. (ZIP code)

potentialReviewerFl

<potentialReviewerFl>true</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

<profTitle>Dr</profTitle>

String

The professional title of the person.

salutation

<salutation>Dr.</salutation>

String

The salutation designated for the person in his or her account record.

stateAbbrev

<stateAbbrev>VA</stateAbbrev>

String

State abbreviation (Only for country US, Canada or Austraila)

stateName

<stateName>Virginia</stateName>

String

Full state name (Fixed for country US, Canada or Austraila. Freeform for all other countries)

suffix

<suffix>III</suffix>

String

The suffix designated in the person’s account record.

twitter

<twitter>@TwitterProfile</twitter>

String

The person's Twitter handle, if provided.

userId

<userId>JDoe2024</userId>

String

Person user id

userRoles

Complex Child of person
Includes the following response elements:

roleName

Complex

A list of roles assigned to the user.

roleName

<roleName>Abstract Submission</roleName>

String

The name of the specific role assigned to the person (names will be site specific).