getSessionsByID

Method: GET

Required Parameters

Site Short Name
Session ID(s) - up to 25

Optional Parameters

_type
External ID

Base URL

api.abstractcentral.com

Resource

/api/s1a/v3/abstracts/full/sessionsbyid

Request Parameters

Request Element with Example or Default Value `getSessionsByID`	Type	Description	Req
sessionsbyid	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 `svcs2023`	String	Site short name. The short name is the abbreviated or truncated name of the society, publisher, or family.	Yes
ids `'494880'` Or if a list is being requested: '`494882','494883','494886'`	Integer or Integer Array	A distinct identifier assigned to each session 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/sessionsbyid`	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 `getSessionsByID`	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.

programs Complex Child of Parent Root Includes the following response elements: program	Complex	Defines the programs associated with the sessions.

program Complex Child of programs Includes the following response elements: dailyEndTime, dailyStartTime, endDate, name, programId, startDate, timeInterval	Complex	Contains data for an individual program.

dailyEndTime Complex Child of program Includes the following response elements: amPm, hour, minute	Complex	Specifies the conclusion of the daily schedule for the program.
amPm `<amPm>PM</amPm>`	String	Indicates program end time AM / PM.
hour `<hour>11</hour>`	Integer	Program end time hour.
minute `<minute>00</minute>`	Integer	Program end time minute.

dailyStartTime Complex Child of program Includes the following response elements: amPm, hour, minute	Complex	Specifies the start of the daily schedule for the program.
amPm `<amPm>AM</amPm>`	String	Indicates program start time AM / PM.
hour `<hour>08</hour>`	Integer	Program start time hour.
minute `<minute>00</minute>`	Integer	Program start time minute.

endDate Complex Child of program Includes the following response elements: day, dayName, month, year	Complex	Specifies the program's end date.
day `<day>06</day>`	Integer	Day of the month.
dayName `<dayName>Friday</dayName>`	String	Indicates the full name of the day corresponding to a specific date.
month `<month>12</month>`	Integer	Indicates the program's end date, month in numerical format.
year `<year>2024</year>`	Integer	Program end date year.

name `<name>Fall Meeting</name>`	String	The name of the program.
programId `<programId>6118</programId>`	Integer	A unique identifier for the program.

startDate Complex Child of program Includes the following response elements day, dayName, month, year	Complex	Specifies the program's start date.
day `<day>01</day>`	Integer	Day of the month.
dayName `<dayName>Sunday</dayName>`	String	Indicates the full name of the day corresponding to a specific date.
month `<month>12</month>`	Integer	Indicates the program's start date, month, in numerical format.
year `<year>2024</year>`	Integer	Program start date year.

timeInterval `<timeInterval>5</timeInterval>`	Integer	Configured program time interval in minutes.

sessions Complex Child of Parent Root Includes the following response elements session	Complex	A collection of session details.

session Complex Child of sessions Includes the following response elements csid, dateTimeModified, inIp, isInvited, isTicketed, itinLevelId, kind, levelName, parentItinLevelId, presentations, programId, sessId, sessionAbbr, sessionActualAttendance, sessionCreator, sessionDate, sessionDetails, sessionDurationMinutes, sessionEndTime, sessionExpectedAttendance, sessionHosts, sessionLearningObj01, sessionLearningObj02, sessionLearningObj03, sessionLocation, sessionNeeds, sessionNotes, sessionNotesAdmin, sessionProposalDateSubmitted, sessionSponsor, sessionStartTime, sessionStatus, sessionTitle, sessionTrack, sessionTrackDescription, sessionTrackDetails, sessionTrackOwners, sessionType, showAbstractTimes, symposiaName*	Complex	Represents a single session within the program.
csid `<csid>4700</csid>`	Integer	Client session id (value assigned by sessioner).
dateTimeModified `<dateTimeModified>2024-10-09 15:51:04</dateTimeModified>`	dateTime	The timestamp indicating the last modification to the session.
inIp `<inIp>true</inIp>`	Boolean	Flag to indicate whether to include the session in the IP.
isInvited `<isInvited>false</isInvited>`	Boolean	Flag to indicate whether the session is invited.
isTicketed `<isTicketed>false</isTicketed>`	Boolean	Flag to indicate whether the session is ticketed.
itinLevelId `<itinLevelId>32905</itinLevelId>`	Integer	Indicates internal system itinerary level Id.
kind `<kind>Session</kind>`	String	The type of session.
levelName `<levelName>Top Level</levelName>`	String	The name assigned to the level that the session is linked to (when using the level editor instead of the grid editor).
parentItinLevelId `<parentItinLevelId>0</parentItinLevelId>`	Integer	Internal ID of the Parent level.

presentations Complex Child of session Includes the following response elements presentation	Complex	Details about the presentations in a session.

presentation Complex Child of presentations Includes the following response elements controlId, dateTimeModified, desc, duration, finalId, id, presentationEndTime, presentationStartTime, sessSort, status, title, type, withdrawnFromSession	Complex	Represents a single presentation within a session.
controlId `<controlId>3971411</controlId>`	Integer	A unique identifier assigned to the specific abstract submission.
dateTimeModified `<dateTimeModified>2024-03-18 18:25:30</dateTimeModified>`	dateTime	The timestamp indicating the last modification date and time of this presentation record.
desc	String	A placeholder for an optional descriptive text associated with the presentation.
duration `<duration>18</duration>`	Integer	The duration of the presentation in minutes.
finalId `<finalId>Sp385</finalId>`	String	Final ID assigned to session abstract.
id `<id>3573716</id>`	Integer	A unique identifier for the presentation instance.

presentationEndTime Complex Child of presentation Includes the following response elements amPm, hour, minute	Complex	The scheduled end time of the presentation, defined in hours, minutes, and AM/PM format.
amPm `<amPm>AM</amPm>`	String	Specifies whether the time is AM or PM.
hour `<hour>08</hour>`	Integer	The hour component of the end time.
minute `<minute>36</minute>`	Integer	The minute component of the end time.

presentationStartTime Complex Child of presentation Includes the following response elements amPm, hour, minute	Complex	The scheduled start time of the presentation, defined in hours, minutes, and AM/PM format.
amPm `<amPm>AM</amPm>`	String	Specifies whether the time is AM or PM.
hour `<hour>08</hour>`	Integer	The hour component of the start time.
minute `<minute>18</minute>`	Integer	The minute component of the start time.

sessSort `<sessSort>2</sessSort>`	Integer	An integer value indicating the sort order of the presentation within a session.
status `<status>Sessioned</status>`	String	The current abstract status.
title `<title>POSITIONING IBD THERAPIES</title>`	String	The full title of the presentation.
type `<type>abstract</type>`	String	The type of the presentation.
withdrawnFromSession `<withdrawnFromSession>false</withdrawnFromSession>`	Boolean	A boolean value indicating whether the presentation has been withdrawn from the session.

programId `<programId>5931</programId>`	Integer	A unique identifier representing the specific program that the session is linked to.
sessId `<sessId>469308</sessId>`	Integer	A unique session identifier used to distinguish this session from others within the same program.
sessionAbbr `<sessionAbbr>IMIBD_CS_01</sessionAbbr>`	String	A shorthand code representing the session name or topic. Often includes abbreviations to provide a quick reference.
sessionActualAttendance `<sessionActualAttendance>45</sessionActualAttendance>`	Integer	The recorded number of attendees present in the session.

sessionCreator Complex Child of session Includes the following response elements email, fname, lname, memberId, mname, personId	Complex	This element encapsulates details about the individual responsible for creating a session.
email `<email>[email protected]</email>`	String	The email address associated with the session creator.
fname `<fname>Crystal</fname>`	String	The first name of the session creator.
lname `<lname>Smith</lname>`	String	The last name of the session creator.
memberId `<memberId>9c98f70b-4403-4605-aa3d-4cd87b0144f2</memberId>`	String	A unique identifier for the session creator in the society's membership system.
mname `<mname>M.</mname>`	String	The middle name or middle initial of the session creator.
personId `<personId>129577</personId>`	Integer	A unique identifier for the author, used for internal tracking and reference.

sessionDate Complex Child of session Includes the following response elements day, dayName, month, year	Complex	This element provides a structured representation of a specific session date.
day `<day>19</day>`	Integer	Specifies the day of the month in numerical format.
dayName `<dayName>Sunday</dayName>`	String	Represents the name of the day in the week corresponding to the specified date.
month `<month>05</month>`	Integer	Indicates the month of the year in numerical format.
year `<year>2024</year>`	Integer	Denotes the calendar year for the specified date.

sessionDetails Complex Child of session Includes the following response elements sessionDetail	Complex	This element serves as a collection of multiple sessionDetail elements, each describing a specific attribute or property of the session.

sessionDetail Complex Child of sessionDetails Includes the following response elements data, name	Complex	Represents a single detail or attribute of the session.
data `<data>Lecture</data>`	String	Holds the value or data corresponding to the session attribute specified by the name element.
name	String	A human-readable label for the attribute being described.

sessionDurationMinutes `<sessionDurationMinutes>90</sessionDurationMinutes>`	Integer	Specifies the total duration of the session in minutes.

sessionEndTime Complex Child of session Includes the following response elements amPm, hour, minute	Complex	Contains details about the time at which the session ends.
amPm `<amPm>AM</amPm>`	String	Specifies whether the time is AM or PM.
hour `<hour>09</hour>`	Integer	Represents the hour at which the session ends.
minute `<minute>30</minute>`	Integer	Represents the minute of the hour when the session ends.

sessionExpectedAttendance `<sessionExpectedAttendance>30</sessionExpectedAttendance>`	Integer	Indicates the number of participants anticipated for the session.

sessionHosts Complex Child of session Includes the following response elements sessionHost	Complex	Container element that encapsulates details of all session hosts.

sessionHost Complex Child of session Includes the following response elements address1, address2, city, country, degree, dept, email, fax, fname, inst, invitation, lname, memberId, mname, order, personId, phone, postalCode, ringgoldId, roleName, state, stateAbbrev	Complex	Represents an individual session host, including their personal details, role information, and invitation status.
address1 `<address1>176 Rocky Road</address1>`	String	The primary address of the session host.
address2 `<address2>Suite 5</address2>`	String	An optional secondary address line, often used for apartment numbers or suite designations.
city `<city>Charlottesville</city>`	String	The city associated with the session host's location.
country `<country>United States</country>`	String	The country of residence for the session host.
degre `<degree>MD</degree>`	String	The academic or professional degree of the session host.
dept `<dept>Surgery</dept>`	String	The department or division associated with the session host's institution.
email `<email>[email protected]</email>`	String	The email address of the session host.
fax `<fax>c1 fax 2 333-000-3333</fax>`	String	The fax number of the session host, if provided.
fname `<fname>Edward</fname>`	String	The first name of the session host.
inst `<inst>ScholarOne</inst>`	String	The institution or organization with which the session host is affiliated.

invitation Complex Child of sessionHost Includes the following response elements customMessage, dateAcceptanceDecline, dateInvitationClose, dateLastSent, declineReason, emailTemplateName, id, invitationStatus, lastSent, messageTemplateName, role	Complex	Contains details about the invitation sent to the session host.
customMessage `<customMessage>Please accept</customMessage>`	String	An optional custom message included with the invitation.

dateAcceptanceDecline Complex Child of invitation Includes the following response elements day, dayName, month, year	Complex	Indicates the date on which the invitation was accepted or declined.
day `<day>05</day>`	Integer	The day of the month when the invitation was accepted or declined.
dayName `<dayName>Thursday</dayName>`	String	The name of the day corresponding to the acceptance/decline date.
month `<month>10</month>`	Integer	The month in numeric format when the invitation was accepted or declined.
year `<year>2023</year>`	Integer	The year when the invitation was accepted or declined.

dateInvitationClose Complex Child of invitation Includes the following response elements amPm, day, dayName, hour, minute, month, year	Complex	Represents the closing date of the invitation.
amPm `<amPm>AM</amPm>`	String	Indicates whether the closing time is in AM or PM format.
day `<day>20</day>`	Integer	Specifies the day of the closing date.
dayName `<dayName>Thursday</dayName>`	String	The name of the day corresponding to the closing date.
hour `<hour>09</hour>`	Integer	Specifies the hour of the closing time.
minute `<minute>20</minute>`	Integer	Specifies the minute of the closing time.
month `<month>06</month>`	Integer	Specifies the month of the closing date.
year `<year>2023</year>`	Integer	Specifies the year of the closing date.

dateLastSent Complex Child of invitation Includes the following response elements day, dayName, month, year	Complex	Indicates the most recent date on which the invitation was sent.
day `<day>05</day>`	Integer	The day of the month when the invitation was last sent.
dayName `<dayName>Thursday</dayName>`	String	The name of the day corresponding to the last sent date.
month `<month>10</month>`	Integer	The month in numeric format when the invitation was last sent.
year `<year>2023</year>`	Integer	The year when the invitation was last sent.

declineReason `<declineReason>Sorry, I can't accept</declineReason>`	String	Specifies the reason for declining the invitation, if provided.
emailTemplateName `<emailTemplateName>Email Moderator</emailTemplateName>`	String	The name of the email template used for sending the invitation.
id `<id>1351583</id>`	Integer	A unique identifier for the invitation.
invitationStatus `<invitationStatus>Accepted</invitationStatus>`	String	Indicates the status of the invitation.
lastSent `<lastSent>Reminder</lastSent>`	String	The name of last sent email template sent.
messageTemplateName `<messageTemplateName>Moderator Invite</messageTemplateName>`	String	The name of the template used for the invitation message.
role `<role>Moderator</role>`	String	The assigned role of the session host.

lname `<lname>Vandalay</lname>`	String	The last name of the session host.
memberId `<memberId>7597a6a7-c7fb-4dda-a832-c3c7220deef2</memberId>`	String	A unique identifier for the session host in the society's membership system.
mname `<mname>C.</mname>`	String	The middle name or middle initial of the session host.
order `<order>1</order>`	Integer	A numeric value representing the sequence of the session host's role.
personId `<personId>4522186</personId>`	Integer	A unique identifier for the session host, used for internal tracking and reference.
phone `<phone>311-963-4241</phone>`	String	The contact phone number of the session host.
postalCode `<postalCode>21201</postalCode>`	String	The postal or ZIP code of the session host’s address.
ringgoldId `<ringgoldId>2569</ringgoldId>`	Integer	An institutional or organizational identifier linked to the session host.
roleName `<roleName>Moderator</roleName>`	String	The specific role assigned to the session host in the context of the session.
state `<state>New York</state>`	String	The full name of the state in which the session host resides or is associated.
stateAbbrev `<stateAbbrev>NY</stateAbbrev>`	String	The standardized two-letter abbreviation of the state in which the session host resides or is associated.

sessionLearningObj01 `<sessionLearningObj01>First learning objective</sessionLearningObj01>`	String	Specifies the first learning objective of the session.
sessionLearningObj02 `<sessionLearningObj02>Second learning objective</sessionLearningObj02>`	String	Outlines the second learning objective of the session.
sessionLearningObj03 `<sessionLearningObj03>Third learning objective</sessionLearningObj03>`	String	Details the third learning objective of the session.

sessionLocation Complex Child of session Includes the following response elements room, roomNotes, venue	Complex	Contains details about the session venue, including the specific room
room `<room>Ballroom B</room>`	String	Room where the session is scheduled.
roomNotes `<roomNotes>Sessions</roomNotes>`	String	Additional notes related to the room.
venue `<venue>Convention Center</venue>`	String	Venue where the session is scheduled.

sessionNeeds `<sessionNeeds>Need some AV equipment</sessionNeeds>`	String	Placeholder for any specific needs or requirements for the session.
sessionNotes `<sessionNotes>Management complexities</sessionNotes>`	String	Generic notes about the session.
sessionNotesAdmin `<sessionNotesAdmin>Please ensure that the handouts are printed ahead of time</sessionNotesAdmin>`	String	Reserved for administrative notes about the session.

sessionProposalDateSubmitted Complex Child of session Includes the following response elements day, dayName, month, year	Complex	Indicates when the session proposal was submitted.
day `<day>05</day>`	Integer	The day of the month when the session proposal was submitted.
dayName `<dayName>Tuesday</dayName>`	String	The session proposal date, day of week.
month `<month>08</month>`	Integer	Specifies the month when the session proposal was submitted.
year `<year>2023</year>`	Integer	Specifies the year when the session proposal was submitted.

sessionStartTime Complex Child of session Includes the following response elements amPm, hour, minute	Complex	Specifies the session's start time.
amPm `<amPm>AM</amPm>`	String	Specifies whether the time is AM or PM.
hour `<hour>08</hour>`	Integer	The hour component of the start time.
minute `<minute>00</minute>`	Integer	The minute component of the start time.

sessionStatus `<sessionStatus>admin_created</sessionStatus>`	String	Indicates the session's administrative status. When session proposal is enabled on the site: Possible values are `draft, returned_to_draft, deleted, submitted, resubmitted, scored, decisioned_rejected, decisioned_accepted, and admin_created`. When session proposal is disabled: Possible values are `admin_created and deleted`.
sessionTitle `<sessionTitle>Strategies and Solutions from the Experts</sessionTitle>`	String	Provides the full title of the session.
sessionTrack `<sessionTrack>TNB</sessionTrack>`	String	Categorizes the session within a specific track or theme.
sessionTrackDescription `<sessionTrackDescription>Desc.</sessionTrackDescription>`	String	A detailed description of the session track.

sessionTrackOwners Complex Child of session Includes the following response elements sessionTrackOwner	Complex	The root container element that holds information about all owners assigned to a specific session track.

sessionTrackOwner Complex Child of sessionTrackOwners Includes the following response elements email, fname, inst, lname, memberId, order, personId, roleName	Complex	Represents an individual assigned as an owner of the session track, including their personal and organizational details.
email `<email>[email protected]</email>`	String	The email address of the session track owner.
fname `<fname>Art</fname>`	String	The first name of the session track owner.
inst `<inst>University of New Mexico</inst>`	String	The name of the institution or organization associated with the session track owner.
lname `<lname>Vandalay</lname>`	String	The last name of the session track owner.
memberId `<memberId>11129673</memberId>`	String	A unique identifier for the session track owner in the society's membership system.
order `<order>1</order>`	Integer	Specifies the sequence of the session track owner relative to other owners.
personId `<personId>7151756</personId>`	Integer	A unique identifier for the session track owner, used for internal tracking and reference.
roleName `<roleName>Speaker</roleName>`	String	The role name of the session track owner.

sessionType `<sessionType>Clinical Symposium</sessionType>`	String	Specifies the type of session.
showAbstractTimes `<showAbstractTimes>true</showAbstractTimes>`	Boolean	A Boolean field indicating whether abstract times should be displayed for the session.
symposiaName `<symposiaName>Simposia</symposiaName>`	String	Placeholder for the name of the symposia to which the session belongs.

systemTags Complex Child of Parent Root Includes the following response elements systemTag	Complex	This is the root element that groups all system tags.

systemTag Complex Child of systemTags Includes the following response elements tagName, tagValue	Complex	This element represents an individual tag in the system.
tagName `<tagName>##SUBMISSION_CLOSE_TIME##</tagName>`	String	Specifies the name or identifier of the tag.
tagValue `<tagValue>9:00 p.m. EST</tagValue>`	String	Provides the value associated with the corresponding tagName.