## Index

### Enumerations

- SCRouteHttpVerbs
- SCThingOriginType
- SCThingType
- SCToDoPriority

### Classes

- SCAbstractRoute
- SCAcademicDegreeMeta
- SCAcademicEventMeta
- SCAcademicTermWithoutReferencesMeta
- SCArticleMeta
- SCBookAvailabilityRoute
- SCBookMeta
- SCBuildingMeta
- SCBulkAddRoute
- SCBulkDoneRoute
- SCBulkRoute
- SCCatalogMeta
- SCCourseOfStudiesMeta
- SCCreativeWorkMeta
- SCDateSeriesMeta
- SCDiffMeta
- SCDishMeta
- SCError
- SCEventMeta
- SCFavoriteMeta
- SCFeedbackRoute
- SCFloorMeta
- SCIndexRoute
- SCInternalServerErrorResponse
- SCMessageMeta
- SCMethodNotAllowedErrorResponse
- SCMultiSearchRoute
- SCNotFoundErrorResponse
- SCOrganizationMeta
- SCPersonMeta
- SCPlaceWithoutReferencesMeta
- SCPointOfInterestMeta
- SCRequestBodyTooLargeErrorResponse
- SCRoomMeta
- SCSearchRoute
- SCSemesterMeta
- SCSettingMeta
- SCSportCourseMeta
- SCSyntaxErrorResponse
- SCThingInPlaceMeta
- SCThingMeta
- SCThingThatAcceptsPaymentsWithoutReferencesMeta
- SCThingTranslator
- SCThingUpdateRoute
- SCThingWithCategoriesWithoutReferencesMeta
- SCTicketMeta
- SCToDoMeta
- SCTooManyRequestsErrorResponse
- SCTourMeta
- SCUnsupportedMediaTypeErrorResponse
- SCValidationErrorResponse
- SCVideoMeta

### Interfaces

- SCAcademicDegree
- SCAcademicDegreeWithoutReferences
- SCAcademicEvent
- SCAcademicEventTranslatableProperties
- SCAcademicEventWithoutReferences
- SCAcademicPriceGroup
- SCAcademicTermWithoutReferences
- SCAppConfiguration
- SCAppConfigurationFeature
- SCAppConfigurationMenuCategory
- SCAppConfigurationMenuCategoryTranslationName
- SCAppConfigurationMenuItem
- SCAppConfigurationMenuItemTranslationTitle
- SCAppConfigurationStoreUrl
- SCArticle
- SCArticleTranslatableProperties
- SCArticleWithoutReferences
- SCAvailabilityFilterArguments
- SCBackendAggregationConfiguration
- SCBackendConfiguration
- SCBackendConfigurationDatabaseConfiguration
- SCBackendConfigurationSearchBoosting
- SCBackendConfigurationSortableField
- SCBackendInternalConfiguration
- SCBook
- SCBookAvailabilityRequestByIsbn
- SCBookAvailabilityRequestByUuid
- SCBookTranslatableFields
- SCBookWithoutReferences
- SCBooleanFilterArguments
- SCBuilding
- SCBuildingTranslatableProperties
- SCBuildingWithoutReferences
- SCBulkAddResponse
- SCBulkDoneRequest
- SCBulkDoneResponse
- SCBulkParameters
- SCBulkRequest
- SCBulkResponse
- SCCatalog
- SCCatalogWithoutReferences
- SCConfigFile
- SCContactPoint
- SCCourseOfStudies
- SCCourseOfStudiesTranslatableProperties
- SCCourseOfStudiesWithoutReferences
- SCCreativeWork
- SCCreativeWorkTranslatableProperties
- SCCreativeWorkWithoutReferences
- SCDateSeries
- SCDateSeriesTranslatableProperties
- SCDateSeriesWithoutReferences
- SCDiff
- SCDiffWithoutReferences
- SCDish
- SCDishCharacteristic
- SCDishTranslatableProperties
- SCDishWithoutReferences
- SCDistanceFilterArguments
- SCDistanceSort
- SCDistanceSortArguments
- SCDucetSort
- SCErrorResponse
- SCEvent
- SCEventWithoutReferences
- SCFacet
- SCFacetBucket
- SCFavorite
- SCFeedbackRequest
- SCFeedbackRequestMetaData
- SCFeedbackResponse
- SCFloor
- SCFloorFeatureCollectionWithPlaces
- SCFloorFeatureWithPlace
- SCFloorTranslatableProperties
- SCFloorWithoutReferences
- SCGeoInformation
- SCInPlace
- SCIndexRequest
- SCIndexResponse
- SCLanguage
- SCMap
- SCMessage
- SCMessageTranslatableProperties
- SCMessageWithoutReferences
- SCMetaTranslations
- SCMonitoringAction
- SCMonitoringConfiguration
- SCMonitoringLogAction
- SCMonitoringMailAction
- SCMonitoringMaximumLengthCondition
- SCMonitoringMinimumLengthCondition
- SCMonitoringTrigger
- SCMonitoringWatcher
- SCNutritionInformation
- SCOrganization
- SCOrganizationWithoutReferences
- SCPerson
- SCPersonWithoutReferences
- SCPlaceWithoutReferences
- SCPlaceWithoutReferencesTranslatableProperties
- SCPointOfInterest
- SCPointOfInterestWithoutReferences
- SCPostalAddress
- SCPriceGroup
- SCPriceSort
- SCPriceSortArguments
- SCRoom
- SCRoomSpecificValues
- SCRoomWithoutReferences
- SCRoute
- SCSaveableThing
- SCSearchAbstractFilter
- SCSearchAbstractSort
- SCSearchAbstractSortArguments
- SCSearchAvailabilityFilter
- SCSearchBooleanFilter
- SCSearchDistanceFilter
- SCSearchQuery
- SCSearchRequest
- SCSearchResponse
- SCSearchResponsePagination
- SCSearchResponseSearchEngineStats
- SCSearchResult
- SCSearchValueFilter
- SCSemester
- SCSemesterWithoutReferences
- SCSetting
- SCSettingMultipleChoice
- SCSettingNumber
- SCSettingPassword
- SCSettingSingleChoice
- SCSettingText
- SCSettingValueTranslatableProperties
- SCSettingWithoutReferences
- SCSportCourse
- SCSportCoursePriceGroup
- SCSportCourseWithoutReferences
- SCThing
- SCThingInPlace
- SCThingOrigin
- SCThingRemoteOrigin
- SCThingThatAcceptsPaymentsWithoutReferences
- SCThingThatCanBeOffered
- SCThingThatCanBeOfferedOffer
- SCThingThatCanBeOfferedTranslatableProperties
- SCThingTranslatableProperties
- SCThingTranslatablePropertyOrigin
- SCThingUpdateResponse
- SCThingUserOrigin
- SCThingWithCategoriesSpecificValues
- SCThingWithCategoriesTranslatableProperties
- SCThingWithCategoriesWithoutReferences
- SCThingWithTranslations
- SCTicket
- SCTicketWithoutReferences
- SCToDo
- SCToDoWithoutReferences
- SCTour
- SCTourResolvedElement
- SCTourResolvedEvent
- SCTourResolvedLocation
- SCTourResolvedLocationTypeIs
- SCTourResolvedLocationTypeMatch
- SCTourResolvedMenu
- SCTourStepLocation
- SCTourStepMenu
- SCTourStepTooltip
- SCTourWithoutReferences
- SCTranslations
- SCValueFilterArguments
- SCVideo
- SCVideoSource
- SCVideoTrack
- SCVideoWithoutReferences

### Type aliases

- RecursivePartial
- SCAcademicEventCategories
- SCArticleCategories
- SCBookAvailabilityRequest
- SCBookAvailabilityResponse
- SCBuildingCategories
- SCBulkAddRequest
- SCCatalogCategories
- SCCourseOfStudiesMode
- SCCourseOfStudiesTimeMode
- SCDishCategories
- SCErrorResponseConstructor
- SCFavoriteDataTypes
- SCGermanAcademicDegree
- SCISO8601Date
- SCISO8601Duration
- SCISO8601Time
- SCLanguageCode
- SCLanguageName
- SCLicensePlate
- SCMessageAudience
- SCMonitoringExecutionCalendarEvents
- SCMultiSearchRequest
- SCMultiSearchResponse
- SCNationality
- SCPersonGender
- SCPointOfInterestCategories
- SCRequests
- SCRequiredTranslation
- SCRequiredTranslationKeys
- SCResponses
- SCRoomCategories
- SCSearchAbstractFilterArguments
- SCSearchFilter
- SCSearchFilterType
- SCSearchSort
- SCSearchSortType
- SCSettingCategories
- SCSettingInputType
- SCSettingValue
- SCThingThatAcceptsPaymentsAcceptedPayments
- SCThingThatCanBeOfferedAvailability
- SCThingThatCanBeOfferedProvider
- SCThingUpdateRequest
- SCThings
- SCThingsField
- SCThingsWithoutDiff
- SCTourStep
- SCUuid
- SCVideoMimeType
- SCVideoTrackTypes

### Variables

- SCClasses
- SCNamespaces

### Functions

- isBulkResponse
- isMultiSearchResponse
- isSearchResponse
- isThing
- isThingWithTranslations

## Type aliases

### RecursivePartial

RecursivePartial: object

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4948

Type to represent requiredness of translation properties. Will be changed from RecursivePartial to RecursiveRequired in the future. (Source: https://stackoverflow.com/a/51365037)

#### Type declaration

### SCAcademicEventCategories

SCAcademicEventCategories: "lecture" | "seminar" | "integrated course" | "written exam" | "tutorial" | "project" | "colloquium" | "practicum" | "introductory class" | "course" | "practicum introduction" | "excursion" | "special"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:1799

Categories of academic events

### SCArticleCategories

SCArticleCategories: "unipedia"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:1899

Categories of articles

### SCBookAvailabilityRequest

SCBookAvailabilityRequest: SCBookAvailabilityRequestByIsbn | SCBookAvailabilityRequestByUuid

- Defined in node_modules/@openstapps/core/lib/index.d.ts:973

Request to check the availability of books

validatable

### SCBookAvailabilityResponse

SCBookAvailabilityResponse: Array<SCThingThatCanBeOfferedOffer<SCAcademicPriceGroup>>

- Defined in node_modules/@openstapps/core/lib/index.d.ts:1019

List of availabilities of a book

validatable

### SCBuildingCategories

SCBuildingCategories: "cafe" | "education" | "library" | "office" | "canteen" | "student canteen" | "restaurant" | "restroom"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:2065

### SCBulkAddRequest

SCBulkAddRequest: SCThings

- Defined in node_modules/@openstapps/core/lib/index.d.ts:1098

Request to add a thing to a bulk

validatable

### SCCatalogCategories

SCCatalogCategories: "university events"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:2248

Categories of catalogs

### SCCourseOfStudiesMode

SCCourseOfStudiesMode: "combination" | "dual" | "double-degree" | "standard"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:2369

Types of (german) course of studies modes

### SCCourseOfStudiesTimeMode

SCCourseOfStudiesTimeMode: "fulltime" | "parttime"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:2373

Types of (german) course of studies time modes

### SCDishCategories

SCDishCategories: "appetizer" | "salad" | "main dish" | "dessert" | "soup" | "side dish"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:2670

A list of categories for dishes

### SCErrorResponseConstructor

SCErrorResponseConstructor: object

- Defined in node_modules/@openstapps/core/lib/index.d.ts:1461

The constructor of an error response

#### Type declaration

### SCFavoriteDataTypes

SCFavoriteDataTypes: SCAcademicEventWithoutReferences | SCArticleWithoutReferences | SCBookWithoutReferences | SCBuildingWithoutReferences | SCPersonWithoutReferences | SCPointOfInterestWithoutReferences | SCRoomWithoutReferences | SCSportCourseWithoutReferences | SCToDoWithoutReferences

- Defined in node_modules/@openstapps/core/lib/index.d.ts:2769

Types that can be made a favorite (added as a favorite)

### SCGermanAcademicDegree

SCGermanAcademicDegree: "bachelor" | "diploma" | "doctor" | "licentiate" | "magister" | "master" | "master pupil" | "state examination"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:83

Types of (german) academic degrees

### SCISO8601Date

SCISO8601Date: string

- Defined in node_modules/@openstapps/core/lib/index.d.ts:5162

An ISO8601 date

pattern

  ^([+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([.,]\d+(?!:))?)?(\17[0-5]\d([.,]\d+)?)?([zZ]|([+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$

see

  https://gist.github.com/philipashlock/8830168

### SCISO8601Duration

SCISO8601Duration: string

- Defined in node_modules/@openstapps/core/lib/index.d.ts:5169

An ISO8601 duration

pattern

  ^(R\d*/)?P(?:\d+(?:.\d+)?Y)?(?:\d+(?:.\d+)?M)?(?:\d+(?:.\d+)?W)?(?:\d+(?:.\d+)?D)?(?:T(?:\d+(?:.\d+)?H)?(?:\d+(?:.\d+)?M)?(?:\d+(?:.\d+)?S)?)?$

see

  https://gist.github.com/philipashlock/8830168

### SCISO8601Time

SCISO8601Time: string

- Defined in node_modules/@openstapps/core/lib/index.d.ts:5175

An ISO8601 time

pattern

  \d{2}:\d{2}(:\d{2})?

### SCLanguageCode

SCLanguageCode: "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" | "ia" | "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"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4921

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

see

  https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

### SCLanguageName

SCLanguageName: "afar" | "abkhazian" | "avestan" | "afrikaans" | "akan" | "amharic" | "aragonese" | "arabic" | "assamese" | "avaric" | "aymara" | "azerbaijani" | "bashkir" | "belarusian" | "bulgarian" | "bihari languages" | "bislama" | "bambara" | "bengali" | "tibetan" | "breton" | "bosnian" | "catalan; valencian" | "chechen" | "chamorro" | "corsican" | "cree" | "czech" | "church slavic; old slavonic; church slavonic; old bulgarian; old church slavonic" | "chuvash" | "welsh" | "danish" | "german" | "divehi; dhivehi; maldivian" | "dzongkha" | "ewe" | "greek, modern (1453-)" | "english" | "esperanto" | "spanish; castilian" | "estonian" | "basque" | "persian" | "fulah" | "finnish" | "fijian" | "filipino" | "faroese" | "french" | "western frisian" | "irish" | "gaelic; scottish gaelic" | "galician" | "guarani" | "gujarati" | "manx" | "hausa" | "hebrew" | "hindi" | "hiri motu" | "croatian" | "haitian; haitian creole" | "hungarian" | "armenian" | "herero" | "interlingua (international auxiliary language association)" | "indonesian" | "interlingue; occidental" | "igbo" | "sichuan yi; nuosu" | "inupiaq" | "ido" | "icelandic" | "italian" | "inuktitut" | "japanese" | "javanese" | "georgian" | "kongo" | "kikuyu; gikuyu" | "kuanyama; kwanyama" | "kazakh" | "kalaallisut; greenlandic" | "central khmer" | "kannada" | "korean" | "kanuri" | "kashmiri" | "kurdish" | "komi" | "cornish" | "kirghiz; kyrgyz" | "latin" | "luxembourgish; letzeburgesch" | "ganda" | "limburgan; limburger; limburgish" | "lingala" | "lao" | "lithuanian" | "luba-katanga" | "latvian" | "malagasy" | "marshallese" | "maori" | "macedonian" | "malayalam" | "mongolian" | "marathi" | "malay" | "maltese" | "burmese" | "nauru" | "bokmål, norwegian; norwegian bokmål" | "ndebele, north; north ndebele" | "nepali" | "ndonga" | "dutch; flemish" | "norwegian nynorsk; nynorsk, norwegian" | "norwegian" | "ndebele, south; south ndebele" | "navajo; navaho" | "chichewa; chewa; nyanja" | "occitan (post 1500); provençal" | "ojibwa" | "oromo" | "oriya" | "ossetian; ossetic" | "panjabi; punjabi" | "pali" | "polish" | "pushto; pashto" | "portuguese" | "quechua" | "romansh" | "rundi" | "romanian; moldavian; moldovan" | "russian" | "kinyarwanda" | "sanskrit" | "sardinian" | "sindhi" | "northern sami" | "sango" | "sinhala; sinhalese" | "slovak" | "slovenian" | "samoan" | "shona" | "somali" | "albanian" | "serbian" | "swati" | "sotho, southern" | "sundanese" | "swedish" | "swahili" | "tamil" | "telugu" | "tajik" | "thai" | "tigrinya" | "turkmen" | "tagalog" | "tswana" | "tonga (tonga islands)" | "turkish" | "tsonga" | "tatar" | "twi" | "tahitian" | "uighur; uyghur" | "ukrainian" | "urdu" | "uzbek" | "venda" | "vietnamese" | "volapük" | "walloon" | "wolof" | "xhosa" | "yiddish" | "yoruba" | "zhuang; chuang" | "chinese" | "zulu"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4915

A list of possible languages in english

see

  https://en.wikipedia.org/wiki/ISO_639-1

### SCLicensePlate

SCLicensePlate: "ac-kf" | "ac-fk" | "ac-fh" | "ac-hm" | "ac-th" | "dn-fh" | "aa-fh" | "sig-f2" | "su-ah" | "rd-vf" | "am-f2" | "am-fh" | "an-fh" | "ik-fh" | "ab-fh" | "asl-vf" | "a-hm" | "a-u" | "a-fh" | "hef-fh" | "hg-hs" | "su-if" | "cw-ih" | "tbb-dh" | "eu-vf" | "los-pf" | "esw-pf" | "ba-u" | "bt-kh" | "bt-u" | "gap-kh" | "wr-vf" | "pb-f2" | "b-ah" | "b-am" | "b-fs" | "b-ab" | "b-pf" | "b-tf" | "b-mu" | "b-dk" | "b-p2" | "b-bs" | "b-eh" | "b-hw" | "b-es" | "b-em" | "b-ec" | "b-ef" | "b-vf" | "b-gb" | "b-hs" | "b-pk" | "b-mh" | "b-ft" | "b-p3" | "b-fb" | "b-wt" | "b-u2" | "b-u" | "b-v2" | "b-fw" | "b-p4" | "b-ih" | "b-kf" | "b-mf" | "b-dh" | "b-pu" | "b-ph" | "b-qh" | "b-ot" | "b-fh" | "b-su" | "b-tk" | "b-tc" | "b-hk" | "b-wb" | "b-fp" | "b-v3" | "b-fu" | "b-h3" | "b-hm" | "b-kh" | "b-h4" | "b-f3" | "b-f5" | "b-f2" | "b-tu" | "ber-vf" | "bbg-fh" | "bbg-hs" | "w-k2" | "bi-kh" | "bc-fh" | "bi-du" | "bi-fm" | "pb-f4" | "bi-u" | "bi-fh" | "bi-vf" | "wm-hs" | "mz-fh" | "tr-f2" | "bo-eb" | "bo-fh" | "bo-f1" | "bo-fg" | "bo-hm" | "bo-f3" | "bo-kf" | "bo-u" | "bn-sg" | "bn-pf" | "bn-vf" | "bn-fh" | "bn-u" | "bot-fh" | "brb-vf" | "brb-fh" | "bs-fh" | "bs-hk" | "bs-tu" | "hb-ah" | "hb-hi" | "hb-fh" | "hb-iu" | "hb-hk" | "hb-u" | "hb-vf" | "hb-h" | "ka-pu" | "bm-eu" | "bm-fb" | "std-hs" | "std-fh" | "cw-fh" | "cw-hs" | "ce-pf" | "c-tu" | "c-th" | "gs-tu" | "co-fh" | "co-hs" | "co-f2" | "cb-fh" | "cb-tu" | "da-kf" | "da-vf" | "da-fh" | "da-pf" | "da-tu" | "da-v2" | "deg-fh" | "de-fh" | "dt-fl" | "lip-h2" | "lip-hm" | "dt-hm" | "da-v3" | "dh-fh" | "do-fh" | "do-mh" | "do-is" | "do-pf" | "do-u" | "do-hm" | "do-vf" | "dd-ec" | "dd-fh" | "dd-hs" | "dd-ak" | "dd-ph" | "dd-pf" | "dd-pu" | "dd-hl" | "dd-ht" | "dd-hk" | "dd-ma" | "dd-hm" | "dd-p2" | "dd-p3" | "dd-tu" | "dd-hv" | "d-iu" | "du-hm" | "du-pf" | "du-ug" | "du-vf" | "du-u" | "d-am" | "d-eb" | "d-ff" | "d-pf" | "d-fh" | "d-vf" | "d-hk" | "d-hm" | "d-u" | "bar-fh" | "ew-fh" | "eck-fh" | "ld-vf" | "ei-u" | "pi-f2" | "ol-f2" | "hvl-hs" | "hvl-fh" | "emd-fh" | "ed-pf" | "ef-fh" | "ef-mh" | "ef-pf" | "ef-kh" | "ef-u" | "ef-ph" | "er-u" | "e-fh" | "e-p2" | "e-pf" | "e-uk" | "e-u" | "e-ug" | "e-hm" | "es-ft" | "es-fs" | "fl-fh" | "fl-ph" | "fl-u" | "f-hb" | "f-ms" | "f-u" | "f-v2" | "f-fh" | "f-hk" | "f-hm" | "f-kh" | "f-pf" | "f-vf" | "ff-eu" | "fg-u" | "fr-fh" | "fr-kf" | "fr-u" | "fr-hm" | "fr-ph" | "fb-fh" | "hal-kh" | "fn-dh" | "fn-u" | "fd-fh" | "fd-kh" | "ffb-vf" | "vs-fh" | "wi-f2" | "ul-f2" | "ge-f3" | "ge-fh" | "ge-f2" | "ge-vf" | "g-pf" | "ger-u" | "gi-ft" | "gi-fh" | "gi-vf" | "gi-u" | "gp-fh" | "zi-hw" | "gth-vf" | "g-hs" | "goe-fh" | "goe-u" | "goe-pf" | "gw-u" | "nb-u" | "gw-u2" | "gw-u1" | "hgw-u" | "gue-fh" | "gue-vf" | "pb-f3" | "gt-pf" | "ww-vf" | "ha-ug" | "ha-fh" | "ha-f2" | "ha-vf" | "hbs-fh" | "hbs-vf" | "hal-eh" | "hal-hk" | "hal-ph" | "hal-u" | "hal-u2" | "koet-ph" | "hal-uw" | "hh-am" | "hh-bs" | "hh-pf" | "hh-bc" | "hh-ef" | "hh-fh" | "hh-hu" | "hh-ub" | "hh-ff" | "hh-vf" | "hh-fi" | "hh-ba" | "hh-ib" | "hh-mf" | "hh-ms" | "hh-hf" | "hh-u" | "hh-hs" | "hh-uk" | "hh-fs" | "hh-hk" | "hh-hm" | "hh-tu" | "hm-hs" | "ham-f2" | "ham-fh" | "h-fg" | "h-fh" | "h-hm" | "h-vf" | "h-la" | "h-u" | "h-fb" | "h-kf" | "h-mh" | "h-f3" | "h-pf" | "h-ti" | "hei-fh" | "hd-hm" | "hd-ph" | "hd-kh" | "hd-u" | "hd-fh" | "hdh-dh" | "hn-dh" | "hn-bs" | "hn-fh" | "hn-f2" | "su-f3" | "su-k2" | "he-hk" | "sta-v2" | "hi-fg" | "hi-fs" | "hi-fh" | "hi-v2" | "hi-vf" | "hi-u" | "hi-v3" | "ho-fh" | "ho-f2" | "ho-vf" | "s-u2" | "ww-fh" | "hol-fh" | "fds-dh" | "hx-fh" | "lip-h3" | "hx-ug" | "tr-f3" | "mz-f5" | "wi-f5" | "wi-f4" | "rued-pf" | "ik-tu" | "il-th" | "in-fh" | "in-u" | "mk-ts" | "mk-fh" | "rv-pf" | "j-fh" | "j-u" | "kl-fh" | "kl-u" | "wes-fh" | "ka-dh" | "ka-fh" | "ka-pf" | "ka-u" | "ka-hk" | "ka-hg" | "ka-hm" | "ka-ph" | "ks-cv" | "ks-pf" | "ks-fh" | "ks-ms" | "ks-u3" | "ks-ug" | "ks-vf" | "ks-u2" | "og-vf" | "ke-fh" | "ki-u" | "ki-fh" | "ki-f2" | "ki-f6" | "ki-hk" | "ki-f3" | "ki-f4" | "ki-f5" | "ki-ph" | "kle-fh" | "ko-fh" | "ko-u3" | "ko-u" | "ko-vf" | "k-iu" | "k-cb" | "k-fm" | "k-fp" | "k-kf" | "k-mf" | "k-p2" | "k-u" | "k-fb" | "k-u2" | "k-fh" | "k-vf" | "k-hk" | "k-hm" | "k-pf" | "k-v2" | "k-f2" | "kw-fh" | "kn-fh" | "kn-f2" | "kn-u" | "koet-fh" | "koet-th" | "koet-u" | "kr-fh" | "og-fw" | "ld-u" | "la-fh" | "da-v4" | "ler-fh" | "l-fb" | "l-f2" | "l-kh" | "l-h3" | "l-hh" | "l-hm" | "l-h2" | "l-ph" | "l-hs" | "l-ht" | "l-th" | "l-u" | "mer-th" | "lev-pf" | "lev-fh" | "fg-fh" | "lip-f2" | "lip-h1" | "lip-fh" | "so-f2" | "loe-dh" | "hl-fh" | "hl-vf" | "hl-f3" | "hl-uk" | "hl-u" | "hl-f2" | "hl-hm" | "lb-v2" | "lb-fh" | "lb-ph" | "lb-p2" | "lb-vf" | "lu-fh" | "lu-kf" | "lg-u" | "lg-fh" | "md-f2" | "md-fh" | "md-tu" | "md-f3" | "md-mh" | "md-ph" | "md-u" | "mz-f4" | "mz-u2" | "mz-vf" | "mz-f3" | "mz-f2" | "mz-u" | "mz-kf" | "ma-dh" | "ma-fg" | "ma-ft" | "ma-ba" | "ma-v3" | "ma-v2" | "ma-hm" | "ma-fs" | "ma-u" | "mr-eh" | "mr-fh" | "mr-u" | "re-pf" | "myk-vf" | "mgn-vf" | "mei-fh" | "mei-fv" | "mei-f2" | "sk-hs" | "hal-fh" | "hsk-fh" | "me-fh" | "rt-hs" | "mi-fh" | "c-fh" | "mw-ht" | "hc-ih" | "mtw-ht" | "mg-fh" | "z-fh" | "mos-dh" | "mh-fh" | "m-am" | "m-b2" | "m-bw" | "m-ea" | "m-vf" | "m-as" | "m-mf" | "m-hk" | "m-hs" | "m-fh" | "m-kf" | "m-hm" | "m-kh" | "m-hp" | "m-fp" | "m-tu" | "m-u" | "gap-ks" | "m-u2" | "m-t2" | "ms-ph" | "ms-kf" | "ms-u" | "ms-fh" | "ms-vf" | "ms-hk" | "ms-hm" | "ms-kh" | "ms-v2" | "nmb-kh" | "nb-fh" | "m-ah" | "m-k3" | "ne-eu" | "ne-hs" | "ne-pf" | "nu-fh" | "h-f2" | "ndh-fh" | "coe-vf" | "n-kf" | "n-hm" | "n-hk" | "n-k1" | "n-k2" | "n-k3" | "n-fh" | "n-u" | "nt-fh" | "nt-f3" | "gp-f2" | "gr-kh" | "hg-kh" | "wi-eb" | "of-hk" | "fr-f2" | "ol-fh" | "ol-pf" | "ol-u" | "os-f2" | "os-fh" | "os-f3" | "os-u" | "os-kf" | "ver-fh" | "pb-fh" | "pb-kf" | "pb-kh" | "pb-ug" | "pb-f1" | "pb-u2" | "pa-u" | "pf-fg" | "pf-fh" | "ps-fh" | "pl-fh" | "p-bs" | "p-f2" | "p-sh" | "p-pf" | "p-u" | "p-fh" | "p-hf" | "brb-f2" | "dd-f2" | "rv-fh" | "rv-dh" | "r-kh" | "r-u" | "r-fh" | "rd-v2" | "ko-f2" | "rd-bf" | "rd-fh" | "rt-fh" | "rt-ts" | "rt-ft" | "su-f2" | "st-mh" | "bc-f2" | "rie-fh" | "shg-vf" | "ro-fh" | "ros-hm" | "ros-im" | "hro-hu" | "hro-u" | "hro-hm" | "rof-vf" | "nol-fh" | "tue-fh" | "wi-f3" | "sb-f2" | "sb-hm" | "sb-hs" | "sb-vf" | "sb-hk" | "sb-fh" | "sb-kf" | "sb-u" | "sz-fh" | "sm-fh" | "aa-fg" | "aa-ph" | "sha-ht" | "sha-kh" | "sad-pf" | "ru-fh" | "wue-f2" | "lds-bc" | "sn-hm" | "hd-vf" | "sfb-fh" | "si-pf" | "si-ug" | "sig-fh" | "so-fh" | "so-vf" | "so-ug" | "sp-u" | "su-fh" | "su-kh" | "sta-vf" | "st-fh" | "sdl-fh" | "hst-fh" | "hst-f2" | "sr-fh" | "og-fh" | "s-dp" | "s-dh" | "s-f2" | "s-im" | "s-kf" | "s-u" | "s-va" | "s-wh" | "s-hk" | "s-fh" | "s-fb" | "s-hm" | "s-mf" | "s-f3" | "s-th" | "ue-fh" | "k-v3" | "k-f3" | "tr-fh" | "tr-kh" | "tr-u" | "an-f2" | "tut-hm" | "tue-u" | "tut-f3" | "ul-fh" | "ul-f4" | "ul-u" | "myk-kh" | "vec-fh" | "vec-u" | "vec-kf" | "bo-f2" | "vs-vf" | "vs-dh" | "vs-f2" | "ros-hs" | "ro-vf" | "pi-fh" | "fs-fh" | "we-hm" | "we-u" | "we-vf" | "we-th" | "kn-ph" | "rv-ph" | "wsf-pf" | "wr-fh" | "wr-v2" | "qlb-vf" | "ldk-fh" | "wi-bs" | "wi-v1" | "wi-fh" | "wi-vf" | "kw-th" | "whv-fh" | "hwi-fh" | "wis-th" | "wis-fh" | "en-u" | "wf-fh" | "wob-fh" | "wo-fh" | "w-hm" | "w-kh" | "w-ug" | "w-vf" | "wue-hm" | "wue-u" | "wue-fh" | "wue-f3" | "zi-ht" | "zi-ih" | "zi-th" | "zw-fh" | "z-t3" | "z-t2" | "z-pf" | "z-hs" | "z-ph" | "z-th" | "z-tu" | "z-ht" | "rc-hs" | "z-p2"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4998

The license plate of a university e.g. the UID of the university

### SCMessageAudience

SCMessageAudience: "students" | "employees" | "guests"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:2956

Audiences for messages

### SCMonitoringExecutionCalendarEvents

SCMonitoringExecutionCalendarEvents: "hourly" | "daily" | "weekly" | "monthly"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4611

A list of events to describe the execution interval of monitoring triggers

### SCMultiSearchRequest

SCMultiSearchRequest: SCMap<SCSearchQuery>

- Defined in node_modules/@openstapps/core/lib/index.d.ts:1261

A multi search request

This is a map of SCSearchRequests indexed by name.

CAUTION: This is limited to an amount of queries. Currently this limit is 5.

validatable

### SCMultiSearchResponse

SCMultiSearchResponse: SCMap<SCSearchResult>

- Defined in node_modules/@openstapps/core/lib/index.d.ts:1281

A multi search response

This is a map of SCSearchResponses indexed by name

validatable

### SCNationality

SCNationality: "Afghanistan" | "Åland Islands" | "Albania" | "Algeria" | "American Samoa" | "Andorra" | "Angola" | "Anguilla" | "Antarctica" | "Antigua and Barbuda" | "Argentina" | "Armenia" | "Aruba" | "Australia" | "Austria" | "Azerbaijan" | "Bahamas" | "Bahrain" | "Bangladesh" | "Barbados" | "Belarus" | "Belgium" | "Belize" | "Benin" | "Bermuda" | "Bhutan" | "Bolivia (Plurinational State of)" | "Bonaire, Sint Eustatius and Saba" | "Bosnia and Herzegovina" | "Botswana" | "Bouvet Island" | "Brazil" | "British Indian Ocean Territory" | "Brunei Darussalam" | "Bulgaria" | "Burkina Faso" | "Burundi" | "Cambodia" | "Cameroon" | "Canada" | "Cabo Verde" | "Cayman Islands" | "Central African Republic" | "Chad" | "Chile" | "China" | "Christmas Island" | "Cocos (Keeling) Islands" | "Colombia" | "Comoros" | "Congo" | "Congo (Democratic Republic of the)" | "Cook Islands" | "Costa Rica" | "Côte d'Ivoire" | "Croatia" | "Cuba" | "Curaçao" | "Cyprus" | "Czech Republic" | "Denmark" | "Djibouti" | "Dominica" | "Dominican Republic" | "Ecuador" | "Egypt" | "El Salvador" | "Equatorial Guinea" | "Eritrea" | "Estonia" | "Ethiopia" | "Falkland Islands (Malvinas)" | "Faroe Islands" | "Fiji" | "Finland" | "France" | "French Guiana" | "French Polynesia" | "French Southern Territories" | "Gabon" | "Gambia" | "Georgia" | "Germany" | "Ghana" | "Gibraltar" | "Greece" | "Greenland" | "Grenada" | "Guadeloupe" | "Guam" | "Guatemala" | "Guernsey" | "Guinea" | "Guinea-Bissau" | "Guyana" | "Haiti" | "Heard Island and McDonald Islands" | "Holy See" | "Honduras" | "Hong Kong" | "Hungary" | "Iceland" | "India" | "Indonesia" | "Iran (Islamic Republic of)" | "Iraq" | "Ireland" | "Isle of Man" | "Israel" | "Italy" | "Jamaica" | "Japan" | "Jersey" | "Jordan" | "Kazakhstan" | "Kenya" | "Kiribati" | "Korea (Democratic People's Republic of)" | "Korea (Republic of)" | "Kuwait" | "Kyrgyzstan" | "Lao People's Democratic Republic" | "Latvia" | "Lebanon" | "Lesotho" | "Liberia" | "Libya" | "Liechtenstein" | "Lithuania" | "Luxembourg" | "Macao" | "Macedonia (the former Yugoslav Republic of)" | "Madagascar" | "Malawi" | "Malaysia" | "Maldives" | "Mali" | "Malta" | "Marshall Islands" | "Martinique" | "Mauritania" | "Mauritius" | "Mayotte" | "Mexico" | "Micronesia (Federated States of)" | "Moldova (Republic of)" | "Monaco" | "Mongolia" | "Montenegro" | "Montserrat" | "Morocco" | "Mozambique" | "Myanmar" | "Namibia" | "Nauru" | "Nepal" | "Netherlands" | "New Caledonia" | "New Zealand" | "Nicaragua" | "Niger" | "Nigeria" | "Niue" | "Norfolk Island" | "Northern Mariana Islands" | "Norway" | "Oman" | "Pakistan" | "Palau" | "Palestine, State of" | "Panama" | "Papua New Guinea" | "Paraguay" | "Peru" | "Philippines" | "Pitcairn" | "Poland" | "Portugal" | "Puerto Rico" | "Qatar" | "Réunion" | "Romania" | "Russian Federation" | "Rwanda" | "Saint Barthélemy" | "Saint Helena, Ascension and Tristan da Cunha" | "Saint Kitts and Nevis" | "Saint Lucia" | "Saint Martin (French part)" | "Saint Pierre and Miquelon" | "Saint Vincent and the Grenadines" | "Samoa" | "San Marino" | "Sao Tome and Principe" | "Saudi Arabia" | "Senegal" | "Serbia" | "Seychelles" | "Sierra Leone" | "Singapore" | "Sint Maarten (Dutch part)" | "Slovakia" | "Slovenia" | "Solomon Islands" | "Somalia" | "South Africa" | "South Georgia and the South Sandwich Islands" | "South Sudan" | "Spain" | "Sri Lanka" | "Sudan" | "Suriname" | "Svalbard and Jan Mayen" | "Swaziland" | "Sweden" | "Switzerland" | "Syrian Arab Republic" | "Taiwan, Province of China" | "Tajikistan" | "Tanzania, United Republic of" | "Thailand" | "Timor-Leste" | "Togo" | "Tokelau" | "Tonga" | "Trinidad and Tobago" | "Tunisia" | "Turkey" | "Turkmenistan" | "Turks and Caicos Islands" | "Tuvalu" | "Uganda" | "Ukraine" | "United Arab Emirates" | "United Kingdom of Great Britain and Northern Ireland" | "United States of America" | "United States Minor Outlying Islands" | "Uruguay" | "Uzbekistan" | "Vanuatu" | "Venezuela (Bolivarian Republic of)" | "Viet Nam" | "Virgin Islands (British)" | "Virgin Islands (U.S.)" | "Wallis and Futuna" | "Western Sahara" | "Yemen" | "Zambia" | "Zimbabwe"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4927

A list of possible nationalities

see

  https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

### SCPersonGender

SCPersonGender: "male" | "female" | "inter" | "undefined"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:3214

Gender of a person

### SCPointOfInterestCategories

SCPointOfInterestCategories: "computer" | "validator" | "card charger" | "printer" | "disabled access"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:3256

Categories of a point of interest

### SCRequests

SCRequests: SCBookAvailabilityRequest | SCBulkRequest | SCBulkAddRequest | SCBulkDoneRequest | SCFeedbackRequest | SCIndexRequest | SCMultiSearchRequest | SCSearchRequest | SCThingUpdateRequest

- Defined in node_modules/@openstapps/core/lib/index.d.ts:1511

Possible requests

### SCRequiredTranslation

SCRequiredTranslation: object

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4960

Type that allows mapping from available keys of SCTranslations to SCRequiredTranslationKeys

#### Type declaration

### SCRequiredTranslationKeys

SCRequiredTranslationKeys: object

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4954

Type to recursively map keys in to a string value (used for translation)

#### Type declaration

### SCResponses

SCResponses: SCBookAvailabilityResponse | SCBulkResponse | SCBulkAddResponse | SCBulkDoneResponse | SCFeedbackResponse | SCIndexResponse | SCMultiSearchResponse | SCSearchResponse | SCThingUpdateResponse

- Defined in node_modules/@openstapps/core/lib/index.d.ts:1515

Possible responses

### SCRoomCategories

SCRoomCategories: "cafe" | "canteen" | "computer" | "education" | "laboratory" | "learn" | "library" | "lounge" | "office" | "restaurant" | "restroom" | "student canteen" | "student union"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:3314

Categories of a room

### SCSearchAbstractFilterArguments

SCSearchAbstractFilterArguments: SCMap<any>

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4719

Arguments for the filter instruction

### SCSearchFilter

SCSearchFilter: SCSearchAvailabilityFilter | SCSearchBooleanFilter | SCSearchDistanceFilter | SCSearchValueFilter

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4723

Available filter instructions

### SCSearchFilterType

SCSearchFilterType: "availability" | "boolean" | "distance" | "value"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4702

Filter instruction types

### SCSearchSort

SCSearchSort: SCDistanceSort | SCPriceSort | SCDucetSort

- Defined in node_modules/@openstapps/core/lib/index.d.ts:5096

A sort instruction

### SCSearchSortType

SCSearchSortType: "distance" | "price" | "ducet"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:5092

Type of a sort instruction

### SCSettingCategories

SCSettingCategories: string

- Defined in node_modules/@openstapps/core/lib/index.d.ts:3512

### SCSettingInputType

SCSettingInputType: SCSettingSingleChoice | SCSettingMultipleChoice | SCSettingNumber | SCSettingText | SCSettingPassword

- Defined in node_modules/@openstapps/core/lib/index.d.ts:3537

The types of input/value a setting object can carry

### SCSettingValue

SCSettingValue: string | number | boolean

- Defined in node_modules/@openstapps/core/lib/index.d.ts:3567

### SCThingThatAcceptsPaymentsAcceptedPayments

SCThingThatAcceptsPaymentsAcceptedPayments: "Cash" | "Credit" | "Cafeteria Card"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:513

Types of payment that are accepted at a place.

### SCThingThatCanBeOfferedAvailability

SCThingThatCanBeOfferedAvailability: "in stock" | "out of stock" | "online only" | "limited availability"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:656

Availability of an Offer

### SCThingThatCanBeOfferedProvider

SCThingThatCanBeOfferedProvider: SCOrganizationWithoutReferences | SCPersonWithoutReferences

- Defined in node_modules/@openstapps/core/lib/index.d.ts:652

Entity responsible for the offer

### SCThingUpdateRequest

SCThingUpdateRequest: SCThings

- Defined in node_modules/@openstapps/core/lib/index.d.ts:1423

Request to update an existing thing

validatable

### SCThings

SCThings: SCThingsWithoutDiff | SCDiff

- Defined in node_modules/@openstapps/core/lib/index.d.ts:799

An object that exists in the StAppsCore

### SCThingsField

SCThingsField: keyof SCThings | string

- Defined in node_modules/@openstapps/core/lib/index.d.ts:803

A field of a thing

### SCThingsWithoutDiff

SCThingsWithoutDiff: SCAcademicEvent | SCArticle | SCBook | SCBuilding | SCCatalog | SCCourseOfStudies | SCDateSeries | SCDish | SCFavorite | SCFloor | SCMessage | SCOrganization | SCPerson | SCPointOfInterest | SCRoom | SCSemester | SCSetting | SCSportCourse | SCTicket | SCToDo | SCTour | SCVideo

- Defined in node_modules/@openstapps/core/lib/index.d.ts:795

### SCTourStep

SCTourStep: SCTourStepMenu | SCTourStepLocation | SCTourStepTooltip

- Defined in node_modules/@openstapps/core/lib/index.d.ts:3926

A step in a tour

### SCUuid

SCUuid: string

- Defined in node_modules/@openstapps/core/lib/index.d.ts:5187

Universally unique identifier of the thing

pattern

  ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

see

  http://stackoverflow.com/questions/7905929/how-to-test-valid-uuid-guid

### SCVideoMimeType

SCVideoMimeType: "video/mp4" | "video/ogg" | "video/webm" | "application/vnd.apple.mpegurl" | "application/dash+xml"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4180

Video Encoding Formats

### SCVideoTrackTypes

SCVideoTrackTypes: "captions" | "chapters" | "description" | "metadata" | "subtitles"

- Defined in node_modules/@openstapps/core/lib/index.d.ts:4184

Video Track Types

## Variables

### Const SCClasses

SCClasses: object

- Defined in node_modules/@openstapps/core/lib/index.d.ts:792

A map of things, from type to meta data

#### Type declaration

### Const SCNamespaces

SCNamespaces: object

- Defined in node_modules/@openstapps/core/lib/index.d.ts:5002

Namespaces for universities for UUID generation

#### Type declaration

## Functions

### isBulkResponse

- isBulkResponse(something: any): boolean

- - Defined in node_modules/@openstapps/core/lib/index.d.ts:4878

  Type guard to check if something is a bulk response

  #### Parameters

  - ##### something: any

    Something to check

  #### Returns boolean

### isMultiSearchResponse

- isMultiSearchResponse(something: any): boolean

- - Defined in node_modules/@openstapps/core/lib/index.d.ts:4891

  Type guard to check if something is a multi search response

  #### Parameters

  - ##### something: any

    Something to check

  #### Returns boolean

### isSearchResponse

- isSearchResponse(something: any): boolean

- - Defined in node_modules/@openstapps/core/lib/index.d.ts:4884

  Type guard to check if something is a search response

  #### Parameters

  - ##### something: any

    Something to check

  #### Returns boolean

### isThing

- isThing(something: any): boolean

- - Defined in node_modules/@openstapps/core/lib/index.d.ts:4866

  Type guard to check if something is a SCThing

  #### Parameters

  - ##### something: any

    Something to check

  #### Returns boolean

### isThingWithTranslations

- isThingWithTranslations(thing: SCThing): boolean

- - Defined in node_modules/@openstapps/core/lib/index.d.ts:4872

  Type guard to check if translations exist

  #### Parameters

  - ##### thing: SCThing

    Thing to check

  #### Returns boolean

Generated using TypeDoc