getEditorListConfiguration

getEditorListConfiguration submits a request using the Site Short Name parameter to retrieve a list of Editors for a specified site.
This API call can be further refined by including optional request parameters: role_type and role_name.

Required Parameters

Site Short Name

Optional Parameters

role_type
role_name
Locale ID
_type
External ID

Resource

/api/s1m/v2/configuration/full/editorList

Request Parameters

Element	Type	Description	Required	Example or Default Value
getEditorList	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
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	v2/configuration/full/editorList
role_type	String	Optional request parameter that refines the output specifically for the roles of EDITOR or EDITOR_IN_CHIEF, based on the provided type.	No	EDITOR
role_name	String	Optional request parameter that refines the output specifically by the name of the role.	No	Assistant Editor
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: 1 (United States English) 2 (Simplified Chinese, Pinyin ordering) 3 (French)
_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>`
editorList	Complex	A container element that includes one or more editor elements. Represents the collection of editors for the specified site.	Complex Child_ of Parent Root Includes the following response elements: editor
editor	Complex	Represents an individual editor's details. This element is repeated for each editor in the list.	Complex Child_ of editorList Includes the following response elements: email, firstName, institution, lastName, personId, roleName, roleType
email	String	The email address of the editor.	`<email>[email protected]</email>`
firstName	String	The first name of the editor.	`<firstName>Louise</firstName>`
institution	Complex	A container element that holds the details of the editor's institution.	Complex Child_ of editor Includes the following response elements: institutionName, ringgoldId
institutionName	String	The name of the institution where the editor works.	`<institutionName>ScholarOne</institutionName>`
ringgoldId	String	An optional identifier for the institution, provided by Ringgold, which is a database of organizational identifiers.	`<ringgoldId>11466</ringgoldId>`
lastName	String	The last name of the editor.	`<lastName>Smith</lastName>`
personId	Integer	A unique numeric identifier associated with a person record (not the user's User ID used for accessing ScholarOne).	`<personId>79563477</personId>`
roleName	String	The name of the role that the editor holds, such as "Assistant Editor".	`<roleName>Assistant Editor</roleName>`
roleType	String	The type of role that the editor holds, such as "EDITOR_IN_CHIEF".	`<roleType>EDITOR_IN_CHIEF</roleType>`