getPersonByDate
getPersonByDate API call retrieves a list of Person 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/personids
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 |
from_time
| dateTime | Specifies the start of the date range in UTC. Only persons added or modified after this date will be included in the retrieval. | Yes |
to_time
| dateTime | End of the date range in UTC. Only persons added or modified before this date will be included in the retrieval. | 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. |
personIdList Complex Child of Parent Root personId | Complex | Container element that holds a collection of personid elements. It represents a list of unique person identifiers that match the specified query parameters (such as date range, site name, and type). |
personId
| Integer | Unique identifier for each person in the ScholarOne Conferences system. Internally to ScholarOne, this is a numeric value. |
Updated 5 months ago
