Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yonsei University prize API

The prize API from Yonsei University — 29 operation(s) for prize.

Yonsei University prize API is one of 38 APIs that Yonsei University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include prize. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 34 operations across 29 paths, and defines 62 schemas. It is described by OpenAPI 3.0.1, at version 5.35.3-4.

Requests are made against a single base URL, https://yonsei.elsevierpure.com/ws/api.

34 operations 29 paths 62 schemas 1 DELETE24 GET4 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.35.3-4
Server
https://yonsei.elsevierpure.com/ws/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Yonsei University prize API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key). By default, every request must be authenticated.

  • api-key — Security mechanism for the API

Paths & Operations 34

Across 29 paths, the API surfaces 34 operations — 1 DELETE, 24 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

prize 34
GET
/prizes
Lists all prizes
prize_list 3 params → 200
PUT
/prizes
Create prize
prize_create body → 201400
GET
/prizes/allowed-categories
A list of allowed classifications for the category property
prize_getAllowedCategories → 200
GET
/prizes/allowed-classified-identifier-types
A list of allowed classified identifier types
prize_getAllowedClassifiedIdentifierTypes → 200
GET
/prizes/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the prize
prize_getAllowedCustomDefinedFieldClassifications 1 param → 200400404
GET
/prizes/allowed-degree-of-recognitions
A list of allowed classifications for the degree of recognition
prize_getAllowedDegreeOfRecognitions → 200
GET
/prizes/allowed-description-types
A list of allowed classifications for the descriptions property
prize_getAllowedDescriptionsTypes → 200
GET
/prizes/allowed-document-licenses
A list of allowed document licenses
prize_getAllowedDocumentLicenses → 200
GET
/prizes/allowed-document-types
A list of allowed document types
prize_getAllowedDocumentTypes → 200
GET
/prizes/allowed-image-types
A list of allowed image types
prize_getAllowedImageTypes → 200
GET
/prizes/allowed-keyword-group-configurations
A list of keyword group configurations
prize_getAllowedKeywordGroupConfigurations → 200
GET
/prizes/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
prize_getAllowedKeywordGroupConfigurationClassifications 1 param → 200
GET
/prizes/allowed-link-types
A list of allowed link types
prize_getAllowedLinkTypes → 200
GET
/prizes/allowed-locales
A list of allowed locales in localized strings
prize_getAllowedLocales → 200
GET
/prizes/allowed-receivers-of-prize-roles
A list of allowed receiver of prize roles
prize_getAllowedReceiversOfPrizeRoles → 200
GET
/prizes/allowed-types
A list of allowed classifications for the type property
prize_getAllowedTypes → 200
GET
/prizes/allowed-workflow-steps
A list of allowed workflow steps
prize_getAllowedWorkflowSteps → 200
GET
/prizes/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
prize_getAllowedDisciplineSchemes → 200
GET
/prizes/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
prize_getAllowedDisciplines 3 params → 200
POST
/prizes/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with prizes
prize_listDisciplineAssociations 1 param body → 200400
PUT
/prizes/file-uploads
Upload file for a specific prize
prize_fileUploads 1 param body → default
GET
/prizes/orderings
Lists available orderings
prize_getOrderings → 200
POST
/prizes/search
Query operation for prizes
prize_query body → 200400
GET
/prizes/{uuid}
Get prize
prize_get 1 param → 200301404
PUT
/prizes/{uuid}
Update prize
prize_update 1 param body → 200400404409
DELETE
/prizes/{uuid}
Delete prize
prize_delete 1 param → 204404409
POST
/prizes/{uuid}/actions/lock
Lock the content
prize_lock 1 param → 204404409
POST
/prizes/{uuid}/actions/unlock
Unlock the content
prize_unlock 1 param → 204404409
GET
/prizes/{uuid}/dependents
Lists all dependents to a prize
prize_dependents 2 params → 200
GET
/prizes/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the prize
prize_getDisciplineAssociation 2 params → 200404
PUT
/prizes/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the prize
prize_putDisciplineAssociation 2 params body → 200400404
GET
/prizes/{uuid}/files/{fileId}
Get file from the prize
prize_getFile 2 params → 200
GET
/prizes/{uuid}/notes
Lists notes
prize_listNotes 3 params → 200404
PUT
/prizes/{uuid}/notes
Create note
prize_createNote 1 param body → 200400

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are Prize (38 properties), Document (17 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 properties). Each schema is shown below with its type and property counts.

DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties 1 required
Visibility
object
Visibility of an object
2 properties 1 required
ContentRef
object
2 properties 2 required
PageInformation
object
Information about pages
2 properties
PrizeEquipmentAssociation
object
An association to a piece of equipment.
1 property 1 required
EventRef
object
A reference to an event
1 required
CompoundDate
object
A date that can be defined by only year, year and month or a full date
3 properties 1 required
OrganizationRef
object
A reference to an organization in the institution
1 required
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
ProjectRef
object
A reference to project
1 required
OrganizationOrExternalOrganizationRef
object
A reference to an organization in the institution or an external organization
2 properties
PrizeResearchOutputAssociation
object
An association to a research output.
1 property 1 required
ClassificationRef
object
A reference to a classification value
2 properties 1 required
PrizeDataSetAssociation
object
An association to a dataset.
1 property 1 required
UploadedFile
object
Information about the uploaded file
7 properties 1 required
Link
object
A hyperlink describing a location on the web.
5 properties 1 required
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties 2 required
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties 2 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
StudentThesisRef
object
A reference to student thesis
1 required
PrizeStudentThesisAssociation
object
An association to a student thesis.
1 property 1 required
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties 1 required
Workflow
object
Information about workflow
2 properties 1 required
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties 1 required
PrizeRef
object
A reference to a prize
1 required
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
KeywordGroup
object
4 properties 2 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
WorkflowListResult
object
List of workflow steps.
1 property
ClassificationRefList
object
List of classification references
1 property
LocalesList
object
List of available locales
1 property
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
Prize
object
A prize.
38 properties 4 required
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property 1 required
PrizeListResult
object
List of prizes. Can contain a subset of all items along with the full count
3 properties
ActivityRef
object
A reference to an activity
1 required
NoteListResult
object
List of notes
3 properties
Note
object
A note
3 properties 1 required
Document
object
Document
17 properties 4 required
OrderingsList
object
List of available orderings
1 property
AbstractPrizeReceiverAssociation
object
An association between prize and a receiver of prize
5 properties 2 required
PrizeAssociation
object
An association to a prize.
1 property 1 required
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 properties
Name
object
A name describing a person, made up of given- and family name
2 properties
ProblemDetails
object
RFC7807 Error details
5 properties
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties 4 required
ImageFile
object
An image file
15 properties 2 required
Identifier
object
1 property 1 required
PrizesQuery
object
Create a query for prizes
6 properties
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
PrizeProjectAssociation
object
An association to a project.
1 property 1 required
ResearchOutputRef
object
A reference to a research output
1 required
ContentRefListResult
object
List of Content Refs
1 property
DataSetRef
object
A reference to a data set
1 required
PrizeActivityAssociation
object
An association to an activity.
1 property 1 required
EquipmentRef
object
A reference to a piece of equipment
1 required
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yonsei-prize-api-openapi.yml Raw ↑

Other APIs Yonsei University publishes across the network.

YUHSpace Institutional Repository (DSpace)
Yonsei University activity API
Yonsei University application API
Yonsei University authorCollaboration API
Yonsei University award API
Yonsei University classificationScheme API
Yonsei University concept API
Yonsei University conferenceSeries API
Yonsei University contract API
Yonsei University course API
Yonsei University dataSet API
Yonsei University education API