1"use strict";(globalThis.webpackChunkschulconnex=globalThis.webpackChunkschulconnex||[]).push([[1141],{28453(e,s,t){t.d(s,{R:()=>o,x:()=>a});var n=t(96540);const r={},i=n.createContext(r);function o(e){const s=n.useContext(i);return n.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),n.createElement(i.Provider,{value:s},e.children)}},45923(e,s,t){t.r(s),t.d(s,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"english-api-notes/code-lists","title":"Code Lists","description":"The API uses a number of code lists for many of the attributes, to ensure that attribute values","source":"@site/docs/english-api-notes/code-lists.md","sourceDirName":"english-api-notes","slug":"/english-api-notes/code-lists","permalink":"/docs/english-api-notes/code-lists","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"specSidebar","previous":{"title":"Data Models","permalink":"/docs/english-api-notes/data-models"},"next":{"title":"Versionshistorie","permalink":"/docs/versionshistorie"}}');var r=t(74848),i=t(28453);const o={},a="Code Lists",d={},l=[];function c(e){const s={h1:"h1",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"code-lists",children:"Code Lists"})}),"\n",(0,r.jsx)(s.p,{children:"The API uses a number of code lists for many of the attributes, to ensure that attribute values\nare consistent and that implementations do not use different representations for the same data."}),"\n",(0,r.jsx)(s.p,{children:"All codes in code lists are considered case-insensitive, so \u201eSCHULE\u201d, \u201eschule\u201d, \u201eSchule\u201d and\n\u201eScHuLe\u201d are considered equivalent and valid."}),"\n",(0,r.jsx)(s.p,{children:"As most of the codes map to meanings that are reflected in the GUI of software used in schools,\ntranslating the meaning of the individual codes will likely not be of much use. For providing\nthe GUI of a tool used in schools, it will be necessary to work with someone who has a good\nunderstanding of the German language."}),"\n",(0,r.jsx)(s.p,{children:"However, it is not necessary to understand the meaning of the individual codes to be able\nto use the API itself. To provide some basic idea of the purpose of the individual code lists,\na short description of all lists is provided, though a translation of the individual codes is not given."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Code list name"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Personenstatus"}),(0,r.jsx)(s.td,{children:"This is used to describe whether the dataset for a person is currently active."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Geschlecht"}),(0,r.jsx)(s.td,{children:"Options for the sex of a person (male/female/divers/not-given)."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Rolle"}),(0,r.jsx)(s.td,{children:"The role within an organisation, such as student, teacher or administrator."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Vertrauensstufe"}),(0,r.jsx)(s.td,{children:"Verification level of the owner of a (digital access) key, from untrusted or unknown to fully trusted."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Organisationstyp"}),(0,r.jsx)(s.td,{children:"Type of an organisation. Usually a school, but can be an external provider of educational content."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Jahrgangsstufe"}),(0,r.jsx)(s.td,{children:"Describes which form or level a student is in and for which a course is suitable for."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Boolean"}),(0,r.jsx)(s.td,{children:"Defines what terms are used for boolean values (\u201eja\u201d for true and \u201enein\u201d for false)."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Bundesland"}),(0,r.jsx)(s.td,{children:"Lists all German states."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Tr\xe4gerschaft"}),(0,r.jsx)(s.td,{children:"The \u201eownership\u201d of an organisation. Describes whether it is owned by the state, the county, the church or privately owned."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Gruppendifferenzierung"}),(0,r.jsx)(s.td,{children:"An attribute to specify a specific level of a course. Conceptually similar to denoting courses in the UK education system as \u201eA-Level\u201d or \u201eO-Level\u201c courses."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Gruppenoption"}),(0,r.jsx)(s.td,{children:"Currently there are no options implemented."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Gruppentyp"}),(0,r.jsx)(s.td,{children:"Classification of a group as \u201eclass\u201d, \u201ecourse\u201c or \u201eother\u201d. Classes are generally mandatory, while courses are often optional."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Gruppenrolle"}),(0,r.jsx)(s.td,{children:"Similar to \u201eRolle\u201d, but as this refers to roles in a group and not in an organisation, the options differ slightly. For example, groups cannot have system administrator, while organisations don't have group leaders."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Lernperiode"}),(0,r.jsx)(s.td,{children:"A teaching period, usually a year or a semester (trimesters are rare in Germany). A more specific description of the structure of codes from this list is given in 13.1.9 Lernperiode."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Lernperiodentyp"}),(0,r.jsx)(s.td,{children:"Type (essentially the length) of a teaching period Year or half-year"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"F\xe4cherkanon"}),(0,r.jsx)(s.td,{children:"Subjects that can be taught in a class or c
1ourse. Such as biology, French or natural sciences."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Bildungsziel"}),(0,r.jsx)(s.td,{children:"Type of school, based on likely qualification level upon leaving."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Erreichbarkeitstyp"}),(0,r.jsx)(s.td,{children:"Type of a channel that can be used to contact a person or organisation."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Beziehungen"}),(0,r.jsx)(s.td,{children:"Relations that can exist between two people, such as legal guardian, tutor or carer."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Organisationsbeziehungen"}),(0,r.jsx)(s.td,{children:"Relations between organisations, often between a school and its supervising authority."})]})]})]})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.