getAttributeListConfiguration

Required Parameters

Site Short Name

Optional Parameters

Locale ID
_type
External ID

Resource

/api/s1m/v3/configuration/full/attributeList

Request Parameters

Element	Type	Description	Required	Example or Default Value
getAttributeListConfiguration	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	v3/configuration/full/attributeList
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	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>`

attributeList	Complex	List of configured Attribute Types for a specific site.	Complex Child_ of Parent Root Includes the following response elements:\ attributType

attributType	Complex	Represents a specific attribute type configuration for a site.	Complex Child_ of attributeList Includes the following response elements: associatedTypes, attributes, childLevelsDeep, count, selectionOption

associatedTypes	Complex	Contains a list of associated types related to the attribute type.	Complex Child_ of attributType Includes the following response elements: associatedType
associatedType	String	element specifies the type of entity or resource that the attribute list is associated with.	`<associatedType>FILE</associatedType>`
attributes	Complex	Represents a collection of attributes associated with the attribute type.	Complex Child_ of attributType Includes the following response elements: attribute

attribute	Complex	Defines a single attribute, including its name, unique identifier, and status.	Complex Child_ of attributes Includes the following response elements: attributeName, id, status, parentId
attributeName	String	The name of the attribute.	`<attributeName>software: machine learning</attributeName>`
id	Integer	The unique identifier for the attribute.	`<id>165833410</id>`
status	String	Indicates the current status of the attribute. Status can be "active" or "inactive"	`<status>active</status>`
parentId	Integer	The unique identifier of the parent attribute to which the current attribute is related.	`<parentId>98318363</parentId>`

childLevelsDeep	Integer	Specifies the depth level of child attributes associated with the attribute type.	`<childLevelsDeep>1</childLevelsDeep>`
count	Integer	The total number of attributes defined within the attributes element.	`<count>5</count>`
selectionOption	String	Describes any selection restrictions applied to the attributes.	`<selectionOption>No restrictions</selectionOption>`
typeName	String	Indicates the designation or category name for the attribute type.	`<typeName>File Designation</typeName>`