getStaffInfoFull
getStaffInfoFull API allows you to input one or more Document IDs or Submission IDs (Manuscript Numbers) and returns a comprehensive list of standard fields from the ScholarOne system.
Required Parameters
- Submission ID(s) or Document ID(s) - up to 25
- Site Short Name
Optional Parameters
- Locale ID
- _type
- External ID
Resource
- By documentID:
/api/s1m/v3/submissions/full/staff_users/documentids - By submissionID:
/api/s1m/v3/submissions/full/staff_users/submissionids
Request Parameters
| Element | Type | Description | Required | Example or Default Value |
|---|---|---|---|---|
| getStaffInfoFull | Root | Yes | ||
| username | String | Profile User Name. This is the user name used by the API, not a ScholarOne Manuscripts user. This is from the Caller’s profile. | Yes | sample_user |
| password | String | The API Key. Encrypted value uniquely identifying and authenticating Caller | Yes | SRU4DQ5WOJ2PX8CA |
| ids† | Integer or Integer Array | Document Id or Ids. Unique identifier for each Manuscript Revision in the ScholarOne Manuscripts system. Internally to ScholarOne, this is a numeric value. Each entry must be surrounded by single or double quotes and comma separated when more than one entry is specified. | Yes, if submission IDs are not used. | ’88026’ Or if a list is being requested: '88026','88087','89328' |
| ids†† | String or String Array | Submission Id or Ids. Also known as the Manuscript ID or Document Number. Identifier that is seen in the ScholarOne UI for each Manuscript. Submission Ids are case-sensitive. Each entry must be surrounded by single or double quotes and comma separated when more than one entry is specified. | Yes, if document IDs are not used. | 'WEB-2013-0002' Or if a list is being requested: 'WEB-2013-0002','WEB-2013-0003' |
| site_name | String | Site short name. The short name is the abbreviated or truncated name of the journal, society, publisher, or family. | Yes | web_svcs |
| url | String | The Web Service URL, which identifies the specific service to handle the request. | Yes | v3/submissions/full/staff_users/submissions |
| external_id | String | An id value that can be set by the client for call tracking. Caller supplied Text string to be stored with Audit History information. | No | 123456 |
| locale_id | Integer | The unique identifier for a specific language. The value of the locale_id must match to the specific language as defined in the Caller’s profile. | No | Options are:
|
| _type | String | The data type requested from the Service <xml> or <json>. This defaults to <xml>. | No | xml (default if omitted), or json |
Response Elements
| Response Element | Type | Description | Example or default Value |
|---|---|---|---|
| Status | String | State of a given request call | Can be one of SUCCESS, FAILURE, or MAINTENANCE. <status>SUCCESS</status> |
| callID | String | The CALL_ID is the unique identifier for a given Web Services call. Generated by the ScholarOne Web Services application. | <callId>63631fe1-7378-4cc1-ab18-87c06c2eff58</callId> |
| profileCallId | String | An id value that is set by the client for call tracking. Set by the request’s external_id element. | <profileCallId>111111</profileCallId> |
| documentId | Integer | Unique identifier for each Manuscript Revision in the ScholarOne Manuscripts system. Internally to ScholarOne, this is a numeric value. | <documentId>46939470</documentId> |
| staffUserPerson | Complex | Staff user Person details. |
|
| firstName | String | Person’s first name. | <firstName>John</firstName> |
| fullName | String | The full name of the person in the format “Lastname Suffix, Salutation Firstname Middlename”. | <fullName>Grammaticus, Dr John</fullName> |
| lastName | String | Person’s last name. | <lastName>Grammaticus</lastName> |
| middleName | String | Person’s middle name. | <middleName>M</middleName> |
| ORCIDId | String | Oauth access details of the person to the orcid site. | <ORCIDId>1111-0003-4738-1544</ORCIDId> |
| personId | Integer | Unique identifier of the Person. | <personId>51457403</personId> |
| primaryEmailAddress | String | Person's primary email address. | <primaryEmailAddress> [email protected] </primaryEmailAddress> |
| roleName | String | Name of the Role associated with the Staff Person. | <roleName>Editor-in-Chief</roleName> |
| roleType | String | Name of the Role Type associated with the Staff Person. | <roleType>Editor</roleType> |
| submissionId | String | Also known as the Manuscript ID or Document Number. Identifier given to each submitted manuscript. Submission IDs are case-sensitive; they are not necessarily unique. | <submissionId>WRK4-22-Apr-0006</submissionId> |