1"use strict";(globalThis.webpackChunkschulconnex=globalThis.webpackChunkschulconnex||[]).push([[4898],{13697(e,n,i){i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>d,frontMatter:()=>a,metadata:()=>t,toc:()=>l});const t=JSON.parse('{"id":"schnittstellen/vendor-extensions","title":"Anbieterspezifische Attribute","description":"F\xfcr Anbieter von Serverimplementierungen besteht die M\xf6glichkeit, Schulconnex um eigene, anbieterspezifische Attribute (Vendor Extensions) zu erweitern.","source":"@site/docs/schnittstellen/vendor-extensions.md","sourceDirName":"schnittstellen","slug":"/schnittstellen/vendor-extensions","permalink":"/docs/schnittstellen/vendor-extensions","draft":false,"unlisted":false,"tags":[{"inline":true,"label":"Verbindlich","permalink":"/docs/tags/verbindlich"}],"version":"current","frontMatter":{"title":"Anbieterspezifische Attribute","tags":["Verbindlich"]},"sidebar":"specSidebar","previous":{"title":"Gew\xe4hrleistung von Datenschutzzielen durch Schulconnex","permalink":"/docs/allgemeines-datenschutz"},"next":{"title":"Empfehlungen f\xfcr anbieterspezifische Attribute","permalink":"/docs/schnittstellen/vendor-extensions-best-practices"}}');var r=i(74848),s=i(28453);const a={title:"Anbieterspezifische Attribute",tags:["Verbindlich"]},c="Erweiterung der API um anbieterspezifische Attribute",o={},l=[{value:"Beispiel der Erweiterung um eine Personalnummer",id:"beispiel-der-erweiterung-um-eine-personalnummer",level:2}];function u(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"erweiterung-der-api-um-anbieterspezifische-attribute",children:"Erweiterung der API um anbieterspezifische Attribute"})}),"\n",(0,r.jsx)(n.p,{children:"F\xfcr Anbieter von Serverimplementierungen besteht die M\xf6glichkeit, Schulconnex um eigene, anbieterspezifische Attribute (Vendor Extensions) zu erweitern."}),"\n",(0,r.jsx)(n.p,{children:"Anbieterspezifische Attribute werden innerhalb eines anbieterspezifischen Objekts gekapselt."}),"\n",(0,r.jsxs)(n.p,{children:["Der Name eines anbieterspezifischen Attributs muss ein g\xfcltiger Uniform Resource Name (URN) (nach ",(0,r.jsx)(n.a,{href:"https://datatracker.ietf.org/doc/html/rfc8141",children:"RFC 8141"}),") sein."]}),"\n",(0,r.jsx)(n.p,{children:"Der Wert eines anbieterspezifischen Attributs kann ein primitiver Typ, ein Array von primitiven Typen, ein komplexes Objekt oder ein Array von Objekten sein. Es besteht nicht die Notwendigkeit, f\xfcr Attributnamen innerhalb von anbieterspezifischen Objekten URNs zu nutzen."}),"\n",(0,r.jsx)(n.p,{children:"Betreiber von Schulconnex-Servern, die anbieterspezifische Attribute verwenden, m\xfcssen definieren, ob und nach welchen Kriterien solche Attribute auch an Dienste ausgeliefert werden und wie viele Elemente die Antwort enthalten kann oder muss. Hierzu ist das Datenmodell f\xfcr Dienste, wo erforderlich, um diese Attribute zu erweitern und, analog zu den standardisierten Attributen, die auszuliefernde Anzahl und die Notwendigkeit einer Freigabe zu spezifizieren."}),"\n",(0,r.jsx)(n.h2,{id:"beispiel-der-erweiterung-um-eine-personalnummer",children:"Beispiel der Erweiterung um eine Personalnummer"}),"\n",(0,r.jsxs)(n.p,{children:["Im folgenden Beispiel wird der Datensatz einer Person um die Personalnummer dieser Person bei der Stammorganisation erweitert.\n",(0,r.jsx)(n.code,{children:"schulsystemix"})," ist hierbei der Name eines fiktiven Anbieters."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'{\n "person": {\n "id": "a6e1a860-8d44-4b2b-aef7-aa2c8bf5beb5",\n "mandant": "58f45270-8e54-40c6-a212-980307fc19be",\n "referrer": "125",\n "stammorganisation": "ad4a5d27-631d-49a3-bc0a-cc28614f8443",\n "urn:schulsystemix:params:schulconnex:schemas:core:2.0:personerweiterung": {\n "personalnummer": "NM 1356"\n },\n "name": {\n "familienname": "von Musterfrau",\n "vorname": "Natalie"\n },\n "vertrauensstufe": "Voll",\n "auskunftssperre": "Nein",\n "revision": "1"\n }\n}\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},28453(e,n,i){i.d(n,{R:()=>a,x:()=>c});var t=i(96540);const r={},s=t.createContext(r);function a(e){const n=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);
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.