Guides
Start typing to search…

getCustomQuestionListConfiguration

getCustomQuestionListConfiguration submits a request using the Site Short Name parameter and returns detailed metadata regarding the configured custom questions for a specified site.

Required Parameters

  • Site Short Name

Optional Parameters

  • Locale ID
  • _type
  • External ID

Resource

  • /api/s1m/v2/configuration/full/customQuestionList

Request Parameters

Element Type Description Required Example or Default Value
getCustomQuestionList 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/customQuestionList
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>

detailGroups

Complex

A collection of detail groups included in the response.

  • Complex Child_ of Parent Root
    Includes the following response elements:\

detailGroup

detailGroup

Complex

Represents a single group of custom questions.

  • Complex Child_ of detailGroups

Includes the following response elements:

customQuestions, detailGroupId, detailGroupName, detailGroupTypeId, detailGroupTypeName

customQuestions

Complex

A collection of custom questions within a detail group.

  • Complex Child_ of detailGroup

Includes the following response elements:

customQuestion

customQuestion

Complex

A collection of response elements related to a single custom question.

  • Complex Child_ of customQuestions

Includes the following response elements:

answerType, submissionCustomAnswers, customQuestionId, questionName, questionStatus, questionText

answerType

String

Standard HTML input options. Available answer types are Checkbox, Radio, Select, Multiselect, Textarea, Text or Calendar.

<answerType>TYPE_SELECT</answerType>

submissionCustomAnswers

Complex

A container for one or more possible answers to a custom question.

  • Complex Child_ of customQuestion

Includes the following response elements:

submissionCustomAnswer

submissionCustomAnswer

Complex

Represents a single possible answer to a custom question.

  • Complex Child_ of submissionCustomAnswers

Includes the following response elements:

abbreviatedResponse, answerId, answerName, answerStatus, answerText

abbreviatedResponse

String

Shortened custom question response as configured in Submission Custom Questions.

<abbreviatedResponse>msid</abbreviatedResponse>

answerId

Integer

The unique identifier for the answer.

<answerId>1387560</answerId>

answerName

String

Human-recognizable name given to the answer to aid in configuration-user lookup

<answerName>Manuscript Type</answerName>

answerStatus

String

Indicates whether the answer is enabled or disabled. The status can be 'ACTIVE' or 'INACTIVE'.

<answerStatus>INACTIVE</answerStatus>

answerText

String

The response to a submission question to be entered or selected by the author.

<answerText>Paper</answerText>

customQuestionId

Integer

Unique identifier of the custom question.

<customQuestionId>161933</customQuestionId>

questionName

String

The configured name of a question asked during the submission process.

<questionName>Manuscript Type</questionName>

questionStatus

String

Current status of a custom question. Valid values are ‘ACTIVE’ or ‘INACTIVE’.

<questionStatus>ACTIVE</questionStatus>

questionText

String

The full text of the custom question, often including detailed instructions or information.

<questionText>Manuscript Type:</questionText>

detailGroupId

Integer

The unique identifier for the detail group.

<detailGroupId>34926</detailGroupId>

detailGroupName

String

The configured name of the detail group.

<detailGroupName>Manuscript Type</detailGroupName>

detailGroupTypeId

Integer

The type identifier for the detail group.

<detailGroupTypeId>15</detailGroupTypeId>

detailGroupTypeName

String

The name corresponding to the detail group type.

<detailGroupTypeName>ROUTING_FIELD</detailGroupTypeName>

Updated 5 months ago