getAbstractsByID
getAbstractsByID API call retrieves detailed information for a specified abstract within the database. It accepts an abstract (or control) ID or IDs and returns a structured response that includes comprehensive details on the abstract's category, authors, content, session assignments, decision status, and presentation preferences.
Method: GET
Required Parameters
- Site Short Name
- Abstract (or Control) ID(s) - up to 25
Optional Parameters
- _type
- External ID
Base URL
api.abstractcentral.com
Resource
/api/s1a/v3/abstracts/full/abstractsbyid
Request Parameters
Request Element with Example or Default Value
| Type | Description | Req |
|---|---|---|---|
abstractsbyid | 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 abstract 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 element 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. |
abstractCategory categoryGroup | Complex | Contains information about the abstract's category, including specific groups and subcategories. |
categoryGroup category, categoryId, subCategory | Complex | Defines a group within the category. |
category | String | Specifies the category name related to the research topic. |
categoryId | Integer | A unique identifier for the category. |
subCategory | String | Additional categorization level, which can be empty if not applicable. |
subCategoryId | Integer | A unique identifier for the sub-category. |
abstractDetails detailGroup | Complex | Holds specific information or properties related to the abstract. |
detailGroup detail, id | Complex | A collection of specific details about the abstract. |
detail detailName, id, fileLocation, responseName, responseValue | Complex | A single abstract detail, including names and associated response values. |
detailName | String | Describes the main feature or topic of this detail. |
id | Integer | Unique identifier for each detail. |
fileLocation | String | For details which are a file type – the URL pointing to the file. |
responseName | String | Title for the response associated with the detail. |
responseValue | String | The actual value related to the responseName. |
abstractDisclosures absDisc | Complex | Represents a single disclosure item within the abstract disclosures. |
absDisc answer, id, name, question | Complex | Represents a single disclosure item within the abstract disclosures. |
answer | String | Disclosure answer chosen (text depends on site configuration). |
disclosureAffl | String | Disclosure affiliation entered. |
id | Integer | Unique identifier for the disclosure item. |
name | String | Disclosure name (text depends on site configuration). |
question | String | A prompt related to the disclosure content. |
id | Integer | Abstract detail group identifier. |
authors author | Complex | A collection of all contributing authors with detailed attributes. |
author address1, address2, affiliations, city, country, degree, designations, | Complex | This element provides detailed information about an individual author contributing to the abstract, including personal details, contact information, and roles. |
address1 | String | The first line of the author's address. |
address2 | String | The second line of the author's address, typically used for apartment numbers, suites, or additional location details. |
affiliations affl | Complex | Contains list of all organization affiliations for the author. |
affl authorOrder, city, country, dept, inst, number, state | Complex | This element encapsulates details about the affiliations of an author, including their institutional, geographical, and hierarchical information. |
authorOrder | Integer | Order of author in the abstract author list. |
city | String | The city where the affiliated institution is located. |
country | String | The country of the affiliated institution. |
dept | String | The department within the affiliated institution. |
inst | String | The name of the affiliated institution. |
number | Integer | Numerical identifier for the affiliation within the response structure. Used to differentiate between multiple affiliations for a single author. |
ringgoldId | Integer | Institution Ringgold ID identifier. |
state | String | The state or province where the affiliated institution is situated. |
city | String | The city associated with the author's location. |
country | String | The country of the author's residence. |
degree | String | Represents the academic degree of the author. |
designations desig | Complex | A list of professional designations for the author, indicating their status\ |
desig data, name | Complex | Container element for each designation. |
data | String | Specifies if the designation is selected or not. |
name | String | The label of the designation |
authorDisclosures authDisc | Complex | Represents a collection of disclosure details for authors associated with the abstract. |
authDisc answer, id, name, question | Complex | Contains detailed information about an individual author's disclosure. |
answer | String | Indicates the response provided by the author to disclosure question. |
disclosureAffl affInfo, affName, affSpeaker, affType | Complex | A container element that encapsulates disclosure information associated with an affiliation. Multiple instances of this element can be present, representing distinct disclosures for the same or different affiliations. |
affInfo | String | Reserved for additional metadata or contextual details about the affiliation. |
affName | String | The name of the affiliated organization or entity. This represents the organization involved in the disclosure. |
affSpeaker | String | Author disclosure affiliation info speaker text. |
affType | String | Specifies the type of disclosure related to the affiliation. |
id | Integer | A unique identifier for the disclosure entry. |
name | String | Specifies the category or type of disclosure. |
question | String | Contains the full disclosure question posed to the author. |
email | String | The author's email address for correspondence. |
fax | String | The author's fax number. |
fname | String | The first or given name of the author. |
lname | String | The last name (surname or family name) of the author. |
memberId | Integer | A unique identifier for the author in the society's membership system. |
mname | String | The middle name of the author. |
order | Integer | Specifies the author's overall position in the list of all contributing authors for the abstract. |
personId | Integer | A unique identifier for the author, used for internal tracking and reference. |
phone | String | The author's phone number for contact. |
postalCode | String | The postal or ZIP code associated with the author's address. |
presenter | Boolean | A Boolean value indicating whether the author is the presenter of the abstract. |
sal | String | The salutation or title for the author (e.g., Mr., Ms., Dr.) |
state | String | The state or province associated with the author's address. |
stateAbbrev | String | The abbreviated form of the state or province. |
awards award | Complex | A container element that encapsulates multiple award objects. Each award object provides details about a specific award related to the abstract submission. |
award desc, id, name | Complex | Represents an individual award. |
desc | String | A descriptive field providing detailed information about the award, including eligibility criteria, benefits, and additional instructions. |
id | Integer | A unique identifier for the award. |
name | String | The name of the award. |
body section | Complex | The body element encapsulates the textual content of the abstract. |
section partOfBody, sectionName, text | Complex | Represents a distinct segment of the abstract body, allowing for modular and hierarchical organization of information. Each section can contain metadata and the text content associated with it. |
partOfBody | Integer | The order abstract body fields are displayed in the ScholarOne Abstracts system. |
sectionName bold. italic, name, nameAppears, underline | Complex | Defines metadata and formatting attributes for the section name. |
bold | Boolean | Indicates whether the section name is bolded. |
italic | Boolean | Indicates whether the section name is italicized. |
name | String | The actual name of the section. |
nameAppears | Boolean | Specifies whether the name is displayed to the submitting author. |
underline | Boolean | Indicates whether the section name is underlined. |
text | String | Abstract body text as entered by submitting author. |
controlId | Integer | A unique identifier assigned to the specific abstract submission. |
customField1 | String | A customizable field that stores auxiliary information about the submission. |
dateTimeModified | dateTime | The timestamp indicating the last modification to the submission. |
decisionHistory | String | Logs the decision-making history associated with the submission. |
decisionStatus | String | Represents the current decision status for the submission. |
finalIds finalId | Complex | This element encapsulates the identifiers assigned to the abstract submission after final processing. |
finalId id, doi | Complex | Represents a single final identifier associated with the submission. |
doi | String | Digital object indentifer for the abstract. |
id | String | Final ID value assigned to the abstract. |
images image | Complex | A container for image metadata associated with the response. |
image caption, description, fileLocation, imageName | Complex | Represents a single image and provides metadata and references to its content. |
caption | String | Specifies the textual description or title of the image, often used to provide context or summarize its contents. |
description | String | Optional field for additional information about the image. |
fileLocation | String | The URL or file path that points to the abstract image. |
imageName | String | The file name of the uploaded image. |
keywords keyword | Complex | A container for keywords metadata associated with the response. |
keyword | String | Abstract keyword value (values may be pre-configured list depending on site config). |
payments payment | Complex | This is a container for payment-related information included in the API response. It captures details of transactions associated with the submission, such as payment amounts, payer details, and authorization codes. |
payment authCode, ccType, payAmount, payFname, payLname, payType, paymentDate, | Complex | Represents a single transaction and includes detailed metadata about the payment process. |
authCode | String | The authorization code provided by the payment gateway to confirm the transaction's validity. |
ccType | Integer | Indicates the type of credit card used for the transaction. |
payAmount | Decimal | The monetary amount processed for the transaction. |
payFname | String | The first or given name of the payer from the submission payment form. |
payLname | String | The last name (surname or family name) of the payer from the submission payment form. |
payType | String | Specifies the payment type or method used (Empty if no specific payment type is recorded.) |
paymentDate day, dayName, month, year | Complex | Captures the date of the transaction. |
day | Integer | The day of the transaction. |
dayName | String | The name of the day of the week. |
month | Integer | The month of the transaction. |
year | Integer | The year of the transaction. |
paymentStatus | Integer | Indicates the current status of the payment. |
pnref | String | The unique payment reference number assigned by the payment gateway. |
responseMessage | String | A message returned by the payment provider describing the transaction's status (Might be empty). |
presentationType | String | Selected abstract Presentation Type. |
reviews avgScore, review, stdDev | Complex | This element provides detailed feedback and evaluation data from reviewers regarding the submission. |
avgScore | Float | The average score given to the submission, calculated from all individual reviewer scores. |
review comment, commentToAuthor, conflictFl, disregardFl, reviewer, score, userDefined1, wrongCatFl | Complex | This element provides detailed feedback and evaluation data from reviewers regarding the submission. |
comment | String | Reviewer comments or general feedback on the submission. Usually comment is for admin. |
commentToAuthor | String | Feedback specifically directed at the submitting author. |
conflictFl | Boolean | Flag to indicate a conflict of interest with this reviewer and abstract. |
disregardFl | Boolean | Specifies whether the review has been flagged to be disregarded. |
recommendation recommendationDesc, recommendationName, recommendationRole | Complex | This is the parent element encapsulating details about a specific recommendation associated with the abstract. |
recommendationDesc | String | Recommendation description as defined by submission site. |
recommendationName | String | Recommendation name as defined by submission site. |
recommendationRole | String | ScholarOne Abstracts Role of the person making the recommendation. |
reviewer memberId, personId, reviewerFirstName, reviewerLastName, reviewerMiddleName | Complex | Contains metadata about the reviewer providing the feedback. |
memberId | String | Society Membership number of the reviewer. |
personId | Integer | A unique identifier associated with the reviewer’s personal profile. |
reviewerFirstName | String | The first name of the reviewer. |
reviewerLastName | String | The last name of the reviewer. |
reviewerMiddleName | String | The middle name or initial of the reviewer, if applicable. |
score scoreColumnDesc, scoreColumnName, scoreColumnRole, scoreName, scoreValue | Complex | Contains scoring details provided by the reviewer for the submission. |
scoreColumnDesc | String | A descriptive label for the scoring column. |
scoreColumnName | String | The name of the score column. |
scoreColumnRole | String | Specifies the role or context of the score. |
scoreName | String | The name assigned to the score value. |
scoreValue | Float | The numerical score value assigned by the reviewer. |
userDefined1 | Boolean | User defined flag 1 – configured per site for an abstract score. |
userDefined2 | Boolean | User defined flag 2 – configured per site for an abstract score. |
wrongCatFl | Boolean | Indicates whether the reviewer flagged the submission as being in the wrong category. |
stdDev | Float | Calculated standard deviation of score numeric values for this abstract. |
sessionedAbstract csid, duration, finalId, id, inIp, invitation, isInvited, isTicketed, itinLevelId, parentItinLevelId,\ | Complex | This element provides details about the session in which the abstract has been assigned. This includes session metadata, scheduling information, and the abstract's relationship to the session. |
csid | Integer | The unique identifier for the session associated with the abstract. |
duration | Integer | Specifies the duration of the session in minutes. |
finalId | String | The final assigned identifier for the abstract within the session. |
id | Integer | A unique identifier for the abstract within the session. |
inIp | Boolean | Flag to indicate to include session in IP. |
invitation dateAcceptanceDecline, dateLastSent, emailTemplateName, id, invitationStatus, lastSent, | Complex | Contains metadata about the invitation sent to the presenter or author for the session. |
dateAcceptanceDecline day, month, year | Complex | The deadline date by which the invitation must be accepted or declined. |
day | Integer | Specifies the day of the month for the deadline. |
month | Integer | Specifies the month of the year for the deadline. |
year | Integer | Specifies the year for the deadline. |
dateLastSent day, month, year | Complex | The date when the invitation was last sent. |
day | Integer | Specifies the day of the month when the invitation was last sent. |
month | Integer | Specifies the month of the year when the invitation was last sent. |
year | Integer | Specifies the year when the invitation was last sent. |
emailTemplateName | String | The name of the email template used for the invitation communication. |
id | Integer | A unique identifier for the invitation. |
invitationStatus | String | The current status of the invitation. |
lastSent | String | Indicates when the invitation was last sent |
messageTemplateName | String | The name of the message template used for the invitation correspondence. |
personId | Integer | A unique identifier for the person associated with the invitation. |
role | String | The role of the person in the session (e.g., Presenter). |
isInvited | Boolean | Flag that indicates whether the abstract invited speaker submission. |
isTicketed | Boolean | Flag that indicates whether the abstract is ticketed. |
itinLevelId | Integer | Internal system itinerary level Id |
parentItinLevelId | Integer | Internal ID of the Parent level. |
presentationEndTime amPm, hour, minute | Complex | Specifies the session's end time in hours and minutes. |
amPm | String | Indicates whether the time is AM or PM. |
hour | Integer | The hour in 12-hour format. |
minute | Integer | The minute. |
presentationStartTime amPm, hour, minute | Complex | Specifies the session's start time in hours and minutes. |
amPm | String | Indicates whether the time is AM or PM. |
hour | Integer | The hour in 12-hour format. |
minute | Integer | The minute. |
programId | Integer | The unique identifier for the program under which the session is listed. |
sessSort | Integer | A sorting order or priority for session display. |
sessionId | Integer | The unique identifier for the session. |
sessionKind | String | The type of session (e.g., Session, Workshop). |
sessionStatus | String | Indicates the status of the session (e.g., created by admin). |
sessionTitle | String | The title of the session. |
showAbstrTimes | Boolean | Boolean flag indicating whether abstract-specific times are displayed. |
userDefined1 | Integer | Reserved for additional custom data. |
withdrawnFromSession | Boolean | Indicates whether the abstract has been withdrawn from the session. |
status | String | Indicates the current status of the abstract or submission within the system. It reflects the stage or decision associated with the submission process. |
submissionRole roleId, roleName | Complex | This element identifies the specific role associated with the submission process for the API user. |
roleId | Integer | A unique identifier for the submission role. |
roleName | String | A descriptive label for the submission role. |
submitter address1, address2, city, country, degree, dept, email, fax, fname, inst, lname, | Complex | This element contains detailed metadata about the individual who submitted the abstract. |
address1 | String | The primary address line of the submitter's location from the person record. Typically contains the street name and number. |
address2 | String | The secondary address line, often used for additional details such as apartment or suite number. |
city | String | The city name of the submitting author, as recorded in the person record. |
country | String | The country of the submitter, from the person record. |
degree | String | The degree field of the submitting author as recorded in the person's record. |
dept | String | Submitting author department field from the person record. |
email | String | The email address of the submitting author as recorded in the person's profile. |
fax | String | The fax number of the submitting author as specified in the person record. |
fname | String | The first or given name of the submitting author. |
inst | String | The institution field associated with the submitting author, derived from the person record. |
lname | String | Last name or surname of the submitting author. |
memberId | String | Society Membership number of the submitting author. |
mname | String | The middle name of the submitting author. |
phone | String | Phone number of the submitting author, as listed in the person record. |
postalCode | String | Postal code of the submitting author. |
ringgoldId | Integer | The Ringgold identifier for the submitter's affiliated institution, used for consistent institution identification. |
sal | String | Salutation designated for the submitting author in the person record. |
state | String | The state of the submitting author as recorded in the person record. |
stateAbbrev | String | Abbreviation of the state name for the submitting author. |
systemTags systemTag | Complex | The container element that holds one or more |
systemTag order, tagName, tagValue | Complex | Each individual system tag contains a pair of name-value elements that correspond to information in the submission context. |
order | Integer | The order system tags are displayed in the ScholarOne Abstracts system. |
tagName | String | The name or identifier for the system tag (based on site configuration). |
tagValue | String | The system tag value (based on site config). |
title | String | The title of the submitted abstract. |
Updated 5 months ago
