API docs by Redocly

Openstapps Backend (2.0.0)

Download OpenAPI specification:Download

Openstapps Team: app@uni-frankfurt.de URL: https://gitlab.com/openstapps/backend License: AGPL 3.0

Introduction

This is a human readable documentation of the backend OpenAPI representation.

Request meta information about the deployment

header Parameters
X-StApps-Version
required
string
Example: 2.0.0
Request Body schema: application/json

A response to an index request

object (SCIndexRequest)

Index request

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "app": {
    },
  • "auth": {
    },
  • "backend": {
    }
}

Updating existing things

path Parameters
TYPE
required
string (SCThingType)
Enum: "assessment" "academic event" "article" "book" "periodical" "building" "catalog" "contact point" "course of study" "date series" "diff" "dish" "favorite" "floor" "message" "organization" "person" "point of interest" "publication event" "room" "semester" "setting" "sport course" "study module" "ticket" "todo" "tour" "video"

Types a thing can be

UID
required
string (SCUuid) ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89...

Universally unique identifier of the thing

header Parameters
X-StApps-Version
required
string
Example: 2.0.0
Request Body schema: application/json

Response for an entity update request

Any of
Any of
alternateNames
Array of strings

Alternate names of the thing

description
string non-empty

Description of the thing

object (SCMap<string>)

Capsulation for a map with a string as key with values of type T

!!! BEWARE !!! Can't be refactored to a Map<K, V>, because it can't be serialized via JSON.stringify(map)

image
string

URL of an image of the thing

name
required
string non-empty

Name of the thing

sameAs
string

URL of a reference Web page that unambiguously indicates the item's identity

E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

object (SCTranslations<SCAssessmentTranslatableProperties>)

Translations for specific languages

type
required
string

Type of an assessment

Value: "assessment"
uid
required
string (SCUuid) ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89...

Universally unique identifier of the thing

categories
required
Array of strings (SCAssessmentCategories)

Categories of a thing with categories

object (SCMap<SCThingWithCategoriesSpecificValues>)

Capsulation for a map with a string as key with values of type T

!!! BEWARE !!! Can't be refactored to a Map<K, V>, because it can't be serialized via JSON.stringify(map)

required
SCThingRemoteOrigin (object) or SCThingUserOrigin (object)

Origin of the thing

attempt
number

Number of attempts

date
string (SCISO8601Date) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])...

An ISO8601 date

ects
number

ECTS (credit-points)

grade
required
string

Grade

status
string

Current status

object (SCCourseOfStudyWithoutReferences)

A course of study without references

Array of objects (SCAssessmentWithoutReferences)

An array of assessments from the 'level 0' (root) assessment to the direct parent

Responses

Request samples

Content type
application/json
Example
{
  • "alternateNames": [
    ],
  • "description": "string",
  • "identifiers": {
    },
  • "image": "string",
  • "name": "string",
  • "sameAs": "string",
  • "translations": {
    },
  • "type": "assessment",
  • "uid": "string",
  • "categories": [
    ],
  • "categorySpecificValues": {
    },
  • "origin": {
    },
  • "attempt": 0,
  • "date": "string",
  • "ects": 0,
  • "grade": "string",
  • "status": "string",
  • "courseOfStudy": {
    },
  • "superAssessments": [
    ]
}

Response samples

Content type
application/json
{ }

Book availability

This checks if a book is available in a library.

Example:

POST https://example.com/bookAvailability

{
  "isbn": "978-3-16-148410-0"
}
header Parameters
X-StApps-Version
required
string
Example: 2.0.0
Request Body schema: application/json

List of availabilities of a book

Any of
isbn
required
string

ISBN of the book to check availability for

Responses

Request samples

Content type
application/json
Example
{
  • "isbn": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Feedback submission

header Parameters
X-StApps-Version
required
string
Example: 2.0.0
Request Body schema: application/json

A response to a feedback request

alternateNames
Array of strings

Alternate names of the thing

description
string non-empty

Description of the thing

object (SCMap<string>)

Capsulation for a map with a string as key with values of type T

!!! BEWARE !!! Can't be refactored to a Map<K, V>, because it can't be serialized via JSON.stringify(map)

image
string

URL of an image of the thing

name
required
string non-empty

Name of the thing

sameAs
string

URL of a reference Web page that unambiguously indicates the item's identity

E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

object (SCTranslations<SCMessageTranslatableProperties>)

Translations for specific languages

type
required
string

Type of a message

Value: "message"
uid
required
string (SCUuid) ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89...

Universally unique identifier of the thing

categories
required
Array of strings (SCMessageCategories)

Categories of a message

object (SCMap<SCThingWithCategoriesSpecificValues>)

Capsulation for a map with a string as key with values of type T

!!! BEWARE !!! Can't be refactored to a Map<K, V>, because it can't be serialized via JSON.stringify(map)

availableLanguages
Array of strings (SCLanguageCode)
Items Enum: "aa" "ab" "ae" "af" "ak" "am" "an" "ar" "as" "av" "ay" "az" "ba" "be" "bg" "bh" "bi" "bm" "bn" "bo" "br" "bs" "ca" "ce" "ch" "co" "cr" "cs" "cu" "cv" "cy" "da" "de" "dv" "dz" "ee" "el" "en" "eo" "es" "et" "eu" "fa" "ff" "fi" "fj" "fl" "fo" "fr" "fy" "ga" "gd" "gl" "gn" "gu" "gv" "ha" "he" "hi" "ho" "hr" "ht" "hu" "hy" "hz" "ia" "id" "ig" "ii" "ik" "io" "is" "it" "iu" "ja" "jv" "ka" "kg" "ki" "kj" "kk" "kl" "km" "kn" "ko" "kr" "ks" "ku" "kv" "kw" "ky" "la" "lb" "lg" "li" "ln" "lo" "lt" "lu" "lv" "mg" "mh" "mi" "mk" "ml" "mn" "mr" "ms" "mt" "my" "na" "nb" "nd" "ne" "ng" "nl" "nn" "no" "nr" "nv" "ny" "oc" "oj" "om" "or" "os" "pa" "pi" "pl" "ps" "pt" "qu" "rm" "rn" "ro" "ru" "rw" "sa" "sc" "sd" "se" "sg" "si" "sk" "sl" "sm" "sn" "so" "sq" "sr" "ss" "st" "su" "sv" "sw" "ta" "te" "tg" "th" "ti" "tk" "tl" "tn" "to" "tr" "ts" "tt" "tw" "ty" "ug" "uk" "ur" "uz" "ve" "vi" "vo" "wa" "wo" "xh" "yi" "yo" "za" "zh" "zu"

Languages this creative work is available in

datePublished
string (SCISO8601Date) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])...

An ISO8601 date

edition
string

Edition of a creative work (e.g. the book edition or edition of an article)

firstPublished
string

Date (in text form) the creative work was published for the first time

inLanguage
string (SCLanguageCode)
Enum: "aa" "ab" "ae" "af" "ak" "am" "an" "ar" "as" "av" "ay" "az" "ba" "be" "bg" "bh" "bi" "bm" "bn" "bo" "br" "bs" "ca" "ce" "ch" "co" "cr" "cs" "cu" "cv" "cy" "da" "de" "dv" "dz" "ee" "el" "en" "eo" "es" "et" "eu" "fa" "ff" "fi" "fj" "fl" "fo" "fr" "fy" "ga" "gd" "gl" "gn" "gu" "gv" "ha" "he" "hi" "ho" "hr" "ht" "hu" "hy" "hz" "ia" "id" "ig" "ii" "ik" "io" "is" "it" "iu" "ja" "jv" "ka" "kg" "ki" "kj" "kk" "kl" "km" "kn" "ko" "kr" "ks" "ku" "kv" "kw" "ky" "la" "lb" "lg" "li" "ln" "lo" "lt" "lu" "lv" "mg" "mh" "mi" "mk" "ml" "mn" "mr" "ms" "mt" "my" "na" "nb" "nd" "ne" "ng" "nl" "nn" "no" "nr" "nv" "ny" "oc" "oj" "om" "or" "os" "pa" "pi" "pl" "ps" "pt" "qu" "rm" "rn" "ro" "ru" "rw" "sa" "sc" "sd" "se" "sg" "si" "sk" "sl" "sm" "sn" "so" "sq" "sr" "ss" "st" "su" "sv" "sw" "ta" "te" "tg" "th" "ti" "tk" "tl" "tn" "to" "tr" "ts" "tt" "tw" "ty" "ug" "uk" "ur" "uz" "ve" "vi" "vo" "wa" "wo" "xh" "yi" "yo" "za" "zh" "zu"

A List of all possible Languages as ISO 639-1 Codes

keywords
Array of strings

Keywords of the creative work

lastPublished
string

Date (in text form) the creative work was most recently

Array of objects (SCOrganizationWithoutReferences)

Organizational unit for which the message is intended

audiences
required
Array of strings (SCUserGroup)
Items Enum: "students" "employees" "guests"

Roles for which the message is intended

dateCreated
string (SCISO8601Date) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])...

An ISO8601 date

messageBody
required
string

Message itself

sequenceIndex
number

An index for applying a custom sorting of multiple messages

required
SCThingRemoteOrigin (object) or SCThingUserOrigin (object)

Origin of the thing

Array of objects (SCPersonWithoutReferences)

Authors of the creative work

object (SCCreativeWorkWithoutReferences)

A creative work without references

Array of objects (SCPublicationEventWithoutReferences)

List of events at which the creative work was published

Array of SCPersonWithoutReferences (object) or SCOrganizationWithoutReferences (object)

List of publishers of the creative work

sourceOrganization
string

A text representing on organization on whose behalf the creator was working

object (SCFeedbackRequestMetaData)

Request Meta Data

Responses

Request samples

Content type
application/json
{
  • "alternateNames": [
    ],
  • "description": "string",
  • "identifiers": {
    },
  • "image": "string",
  • "name": "string",
  • "sameAs": "string",
  • "translations": {
    },
  • "type": "message",
  • "uid": "string",
  • "categories": [
    ],
  • "categorySpecificValues": {
    },
  • "availableLanguages": [
    ],
  • "datePublished": "string",
  • "edition": "string",
  • "firstPublished": "string",
  • "inLanguage": "aa",
  • "keywords": [
    ],
  • "lastPublished": "string",
  • "audienceOrganizations": [
    ],
  • "audiences": [
    ],
  • "dateCreated": "string",
  • "messageBody": "string",
  • "sequenceIndex": 0,
  • "origin": {
    },
  • "authors": [
    ],
  • "isPartOf": {
    },
  • "publications": [
    ],
  • "publishers": [
    ],
  • "sourceOrganization": "string",
  • "metaData": {
    }
}

Response samples

Content type
application/json
{ }

Register plugins

header Parameters
X-StApps-Version
required
string
Example: 2.0.0
Request Body schema: application/json

Plugin register response

Any of
action
required
string

The desired action, so whether the plugin should be added or removed

Value: "add"
required
object (SCPluginMetaData)

Plugin meta data - contains needed information for a plugin registration

Responses

Request samples

Content type
application/json
Example
{
  • "action": "add",
  • "plugin": {
    }
}

Response samples

Content type
application/json
{
  • "success": true
}

Rating submission

header Parameters
X-StApps-Version
required
string
Example: 2.0.0
Request Body schema: application/json

A response to a rating request

rating
required
number
Enum: 1 2 3 4 5

Number of rating stars

userGroup
string (SCUserGroup)
Enum: "students" "employees" "guests"

Types of data consumers

uid
required
string (SCUuid) ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89...

Universally unique identifier of the thing

Responses

Request samples

Content type
application/json
{
  • "rating": 1,
  • "userGroup": "students",
  • "uid": "string"
}

Response samples

Content type
application/json
{ }

Bulk

Bulk creation

header Parameters
X-StApps-Version
required
string
Example: 2.0.0
Request Body schema: application/json

Requested Bulk from backend

expiration
string (SCISO8601Date) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])...

An ISO8601 date

source
required
string

Source of data for this bulk

A short "description" of the source of the data to identify it inside the database. A second bulk with the same source overrides the data of the first bulk once it is done.

type
required
string (SCThingType)
Enum: "assessment" "academic event" "article" "book" "periodical" "building" "catalog" "contact point" "course of study" "date series" "diff" "dish" "favorite" "floor" "message" "organization" "person" "point of interest" "publication event" "room" "semester" "setting" "sport course" "study module" "ticket" "todo" "tour" "video"

Types a thing can be

Responses

Request samples

Content type
application/json
{
  • "expiration": "string",
  • "source": "string",
  • "type": "assessment"
}

Response samples

Content type
application/json
{
  • "expiration": "string",
  • "source": "string",
  • "type": "assessment",
  • "state": "in progress",
  • "uid": "string"
}

Indexing sc things in a bulk

path Parameters
UID
required
string (SCUuid) ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89...

Universally unique identifier of the thing

header Parameters
X-StApps-Version
required
string
Example: 2.0.0
Request Body schema: application/json

Response to a request to add a thing to a bulk

Any of
Any of
alternateNames
Array of strings

Alternate names of the thing

description
string non-empty

Description of the thing

object (SCMap<string>)

Capsulation for a map with a string as key with values of type T

!!! BEWARE !!! Can't be refactored to a Map<K, V>, because it can't be serialized via JSON.stringify(map)

image
string

URL of an image of the thing

name
required
string non-empty

Name of the thing

sameAs
string

URL of a reference Web page that unambiguously indicates the item's identity

E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

object (SCTranslations<SCAssessmentTranslatableProperties>)

Translations for specific languages

type
required
string

Type of an assessment

Value: "assessment"
uid
required
string (SCUuid) ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89...

Universally unique identifier of the thing

categories
required
Array of strings (SCAssessmentCategories)

Categories of a thing with categories

object (SCMap<SCThingWithCategoriesSpecificValues>)

Capsulation for a map with a string as key with values of type T

!!! BEWARE !!! Can't be refactored to a Map<K, V>, because it can't be serialized via JSON.stringify(map)

required
SCThingRemoteOrigin (object) or SCThingUserOrigin (object)

Origin of the thing

attempt
number

Number of attempts

date
string (SCISO8601Date) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])...

An ISO8601 date

ects
number

ECTS (credit-points)

grade
required
string

Grade

status
string

Current status

object (SCCourseOfStudyWithoutReferences)

A course of study without references

Array of objects (SCAssessmentWithoutReferences)

An array of assessments from the 'level 0' (root) assessment to the direct parent

Responses

Request samples

Content type
application/json
Example
{
  • "alternateNames": [
    ],
  • "description": "string",
  • "identifiers": {
    },
  • "image": "string",
  • "name": "string",
  • "sameAs": "string",
  • "translations": {
    },
  • "type": "assessment",
  • "uid": "string",
  • "categories": [
    ],
  • "categorySpecificValues": {
    },
  • "origin": {
    },
  • "attempt": 0,
  • "date": "string",
  • "ects": 0,
  • "grade": "string",
  • "status": "string",
  • "courseOfStudy": {
    },
  • "superAssessments": [
    ]
}

Response samples

Content type
application/json
{ }

Closing bulks

path Parameters
UID
required
string (SCUuid) ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89...

Universally unique identifier of the thing

header Parameters
X-StApps-Version
required
string
Example: 2.0.0
Request Body schema: application/json

Response to a request to change the state of a bulk to done

object (SCBulkDoneRequest)

Request to change the bulk state to done (close the bulk process)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Search

Searching things

header Parameters
X-StApps-Version
required
string
Example: 2.0.0
Request Body schema: application/json

A search response

context
string (SCSearchContext)
Enum: "default" "dining" "place"

Possible context names to be used by the search request

SCSearchAvailabilityFilter (object) or SCSearchBooleanFilter (object) or SCSearchDistanceFilter (object) or SCSearchValueFilter (object) or SCSearchNumericRangeFilter (object) or SCSearchDateRangeFilter (object) or SCGeoFilter (object) (SCSearchFilter)

Available filter instructions

from
number

Number of things to skip in result set (paging)

query
string

A term to search for

size
number

Number of things to have in the result set (paging)

Array of SCDistanceSort (object) or SCPriceSort (object) or SCDucetSort (object) or SCGenericSort (object) (SCSearchSort)

A list of sorting parameters to order the result set by

Responses

Request samples

Content type
application/json
{
  • "context": "default",
  • "filter": {
    },
  • "from": 0,
  • "query": "string",
  • "size": 0,
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "facets": [
    ],
  • "pagination": {
    },
  • "stats": {
    }
}

Submission of multiple search requests at once

header Parameters
X-StApps-Version
required
string
Example: 2.0.0
Request Body schema: application/json

A multi search response

additional property
object (definitions-SCSearchQuery)

A search query

Responses

Request samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}