getSubmissionConfigurationByJournal

Required Parameters

Site Short Name

Optional Parameters

Locale ID
_type
External ID
msType

Resource

/api/s1m/v3/configuration/full/submissionConfigurationByJournal

Request Parameters

Element	Type	Description	Required	Example or Default Value
getSubmissionConfigurationByJournal	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	salesdemoplus
url	String	The Web Service URL, which identifies the specific service to handle the request.	Yes	/v3/configuration/full/submissionConfigurationByJournal
msType	String	Filters the response to a single manuscript type. When provided, the endpoint returns configuration data, submission groups, custom questions, file designations, and related settings - only for the manuscript type matching this value, rather than for all manuscript types configured on the journal. The accepted value is the manuscript type name as configured for the specified journal (for example, Article, Communication, or Review). Manuscript types are defined per journal in Config Center, so valid values vary by site and are not drawn from a fixed, global list	No	Article
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 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/ Example or Default Value	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.

configSubmissionGroups Complex Child of *Parent Root* Includes the following response elements: configSubmissionGroup	Complex	Container for one or more submission group configurations. Each submission group represents a distinct submission pathway within the journal.

configSubmissionGroup Complex Child of *configSubmissionGroups* Includes the following response elements: defaultFl, manuscriptPages, manuscriptStatuses, manuscriptTypes, subGroupParameters	Complex	Individual container for the submission configuration group
defaultFl `<defaultFl>false</defaultFl>`	Boolean	Indicates whether this submission group is the default option.

manuscriptPages Complex Child of *configSubmissionGroup* Includes the following response elements: manuscriptPage	Complex	Collection of manuscript pages that define the submission workflow

manuscriptPage Complex Child of *manuscriptPages* Includes the following response elements: pageDisplayName, pageName	Complex	Defines individual pages in the submission workflow.
pageDisplayName `<pageDisplayName>File Upload</pageDisplayName>`	String	Human-readable name shown to users during submission.
pageName `<pageName>AUTHOR_FILE_UPLOAD</pageName>`	String	Internal system identifier for the page.

manuscriptStatuses Complex Child of *configSubmissionGroup* Includes the following response elements: manuscriptStatus	Complex	Collection of manuscript statuses available in this submission group.

manuscriptStatus Complex Child of *manuscriptStatuses* Includes the following response elements: statusDisplayName, statusName	Complex	Defines available manuscript statuses within the submission group.
statusDisplayName `<statusDisplayName>Submitted</statusDisplayName>`	String	Human-readable status name shown to users.
statusName `<statusName>STATUS_SUBMITTED</statusName>`	String	Internal system identifier for the status.

manuscriptTypes Complex Child of *configSubmissionGroup* Includes the following response elements: manuscriptType	Complex	Collection of manuscript type names available for this submission group.
manuscriptType	String	Contains a string value representing an available manuscript type name.

subGroupParameters Complex Child of *configSubmissionGroup* Includes the following response elements: subGroupParameter	Complex	Collection of configuration parameters that control submission behavior and validation rules

subGroupParameter Complex Child of *subGroupParameters* Includes the following response elements: parameterId, parameterName, parameterValue, type	Complex	Configuration parameters that control submission behavior, validation, and data collection requirements.
parameterId `<parameterId>6287676</parameterId>`	String	Unique identifier for this parameter.
parameterName `<parameterName>AUTHOR_TITLE_MAX_DISPLAY</parameterName>`	String	System name of the parameter.
parameterValue `<parameterValue>50</parameterValue>`	String	Current value of the parameter. May be empty for some parameters.
type `<type>TEXT</type>`	String	Data type of the parameter. Values: TEXT, CHECKBOX, SELECT

detailGroups Complex Child of *Parent Root* Includes the following response elements: detailGroup	Complex	Container for detail group configurations that define custom questions and data collection forms.

detailGroup Complex Child of *detailGroups* Includes the following response elements: customQuestions, detailGroupId, detailGroupName, detailGroupTypeId, detailGroupTypeName, submissionGroups	Complex	Represents a logical grouping of custom questions and configuration options.

customQuestions Complex Child of *detailGroup* Includes the following response elements: customQuestion	Complex	Collection of custom questions within this detail group.

customQuestion Complex Child of *customQuestions* Includes the following response elements: answerType, customAnswers, customQuestionId, isDisplayedInLayout, order, questionName, questionStatus, questionText, required	Complex	Defines individual questions or data collection fields within a detail group.
answerType `<answerType>TYPE_SELECT</answerType>`	String	The answerType element defines the expected format and behavior of responses for a customQuestion.

customAnswers Complex Child of *customQuestion* Includes the following response elements: abbreviatedResponse, responseId, responseName, responseStatus, responseText, authorVisible, order	Complex	Defines individual answer options available for a custom question.
abbreviatedResponse `<abbreviatedResponse>CIC</abbreviatedResponse>`	String	Abbreviated version of the response.
responseId `<responseId>287825</responseId>`	Integer	Unique identifier for this response option.
responseName `<responseName>Yes</responseName>`	String	Internal name of the response.
responseStatus `<responseStatus>INACTIVE</responseStatus>`	String	Status of this response option. Values: ACTIVE, INACTIVE
responseText `<responseText>Yes</responseText>`	String	Full text of the response displayed to users.
authorVisible `<authorVisible>false</authorVisible>`	Boolean	Whether this response option is visible to authors.
order `<order>5</order>`	Integer	Display order of this answer option.

customQuestionId `<customQuestionId>84160</customQuestionId>`	Integer	Unique identifier for this question.
isDisplayedInLayout `<isDisplayedInLayout>false</isDisplayedInLayout>`	Boolean	Whether this question is displayed in the submission layout.
order `<order>0</order>`	Integer	Display order of this question relative to other questions.
questionName `<questionName>Please select appropriate Committee</questionName>`	String	Internal name of the question.
questionStatus `<questionStatus>ACTIVE</questionStatus>`	String	Status of the question. Values: ACTIVE, INACTIVE
questionText `<questionText>Please select appropriate Committee</questionText>`	String	The actual question text displayed to users.
required `<required>true</required>`	Boolean	Whether answering this question is mandatory.

detailGroupId `<detailGroupId>18507</detailGroupId>`	Integer	Unique identifier for this detail group.
detailGroupName `<detailGroupName>Committee</detailGroupName>`	String	Name of the detail group.
detailGroupTypeId `<detailGroupTypeId>1</detailGroupTypeId>`	Integer	Identifier for the detail group type.
detailGroupTypeName `<detailGroupTypeName>DOCUMENT</detailGroupTypeName>`	String	Type name of the detail group.
order `<order>0</order>`	Integer	Specifies the display order of the detail group element within its parent container.
pageName `<pageName>AUTHOR_ATTRIBUTES</pageName>`	String	Identifies the logical application page or configuration context in which the detail group is rendered and managed.

submissionGroups Complex Child of *detailGroup* Includes the following response elements: submissionGroup	Complex	Collection of submission groups where this detail group is active.

submissionGroup Complex Child of *submissionGroups* Includes the following response elements: submissionGroupId, submissionGroupName	Complex	Links detail groups to specific submission groups.
submissionGroupId `<submissionGroupId>36130</submissionGroupId>`	Integer	Unique identifier for the submission group.
submissionGroupName `<submissionGroupName>Author Portal</submissionGroupName>`	String	Name of the submission group.

dependencies	Complex	Container element for configuration dependencies. May be empty in some configurations.

attributeTypes Complex Child of *Parent Root* Includes the following response elements: attributeType	Complex	Container for attribute type configurations, primarily used for file designation and classification.

attributeType Complex Child of *attributeTypes* Includes the following response elements: attributeTypeId, attributeTypeName, attributes, onlyLeaf, noTop, searchable, fileDesignation, noAttribs, fileCollect, fileMax, fileMin, order, submissionGroups	Complex	Defines a category of attributes and their available values.
attributeTypeId `<attributeTypeId>7187</attributeTypeId>`	Integer	Unique identifier for this attribute type.
attributeTypeName `<attributeTypeName>File Designation</attributeTypeName>`	String	Name of the attribute type.
attributes Complex Child of *attributeType* Includes the following response elements: attribute	Complex	Collection of individual attributes within this type

attribute Complex Child of *attributes* Includes the following response elements: active, attributeName, fileExtensionsPermitted, required, visibleToAuthor	Complex	Defines individual attribute values within an attribute type, particularly for file designations.
active `<active>true</active>`	Boolean	Whether this attribute is currently active and available for use
attributeName `<attributeName>Main Document</attributeName>`	String	Name of the attribute.
fileExtensionsPermitted `<fileExtensionsPermitted>PDF</fileExtensionsPermitted>`	String	Comma-separated list of allowed file extensions.
required `<required>true</required>`	Boolean	Whether this file designation is required for submission.
visibleToAuthor `<visibleToAuthor>true</visibleToAuthor>`	Boolean	Whether this file designation is visible to authors during submission

onlyLeaf `<onlyLeaf>false</onlyLeaf>`	Boolean	Configuration flag for attribute hierarchy restrictions.
noTop `<noTop>false</noTop>`	Boolean	Configuration flag for top-level attribute restrictions.
searchable `<searchable>false</searchable>`	Boolean	Whether this attribute type is searchable.
fileDesignation `<fileDesignation>true</fileDesignation>`	Boolean	Whether this attribute type is used for file designation.
noAttribs `<noAttribs>9</noAttribs>`	Integer	Number of attributes in this type.
fileCollect `<fileCollect>true</fileCollect>`	Boolean	Whether file collection is enabled for this attribute type.
fileMax `<fileMax>1</fileMax>`	Integer	Maximum number of files allowed.
fileMin `<fileMin>1</fileMin>`	Integer	Minimum number of files required.
order `<order>2</order>`	Integer	Display order of this attribute type.

submissionGroups Complex Child of *attributeType* Includes the following response elements: submissionGroup	Complex	Container element that defines which submission types or workflow stages will display this attribute type to authors during manuscript submission.
submissionGroup `<submissionGroup>Revised Submission</submissionGroup>`	String	Specifies a single workflow stage where the parent attribute type will be available to authors.

Required Parameters

Optional Parameters

Resource

Request Parameters

Response Elements

What’s Next