getSessionsByDate

getSessionsByDate API call retrieves a list of Session IDs based on a specified date range from ScholarOne Conferences system.

Method: GET

Required Parameters

  • Site Short Name
  • from_time
  • to_time

Optional Parameters

  • _type
  • External ID

Base URL

  • api.abstractcentral.com

Resource

  • /api/s1a/v3/abstracts/full/sessionids

Request Parameters

Request Element with Example or Default Value

getSessionsByDate

Type

Description

Req

sessionids

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

from_time

'2024-04-01 00:00:00.000000'

dateTime

Start of the date range in UTC for sessions. Only sessions created or modified after this date will be retrieved.
Formatted as (YYYY-MM-DD HH:MM:SS.SSSSSS)

Yes

to_time

'2024-10-20 23:59:59.999999'

dateTime

End of the date range in UTC. Only sessions created or modified before this date will be included.
Formatted as (YYYY-MM-DD HH:MM:SS.SSSSSS)

Yes

url

v3/abstracts/full/sessionids

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

getSessionsByDate

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.

sessionIdList

Complex Child_of _Parent Root
Includes the following response elements:

sessionId

Complex

Container element that holds a collection of sessionId elements. It represents a list of unique session identifiers that match the specified query parameters (such as date range, site name, and type).

sessionId

<sessionId>494886</sessionId>

Integer

Unique identifier for each session within ScholarOne Conferences system. Internally to ScholarOne, this is a numeric value.