{ "openapi": "3.0.3", "info": { "title": "Bildungsportal", "description": "", "contact": { "email": "support@bildung.gv.at" }, "version": "0.1" }, "externalDocs": { "description": "Infobox", "url": "https://bip.gv.at/infobox" }, "servers": [ { "url": "https://www.bildung.gv.at" } ], "components": { "requestBodies": {}, "schemas": {}, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "paths": { "/local/eduportal/webservice/server.php/local_eduportal_iface_delivery": { "post": { "tags": [ "Nutzerinteraktion" ], "summary": "Delivery & official signature", "description": "# Submit document\n\nThis interface allows a partner application to submit PDF-documents on behalf of an organization. The document must be approved by\na staff member of the organization (e.g. headmaster or other entitled person).\n\nA document can be related to a particular person by use of the bPK-BF of that person.\n", "requestBody": { "description": "Parameters for local_eduportal_iface_delivery", "content": { "application/json": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "the orgid on behalf of which the document is submitted." }, "bpkbf": { "type": "string", "default": "", "description": "the bpk-bf of the referenced person" }, "onbehalfofbpkbf": { "type": "string", "default": "", "description": "the bpk-bf of the sending person" }, "description": { "type": "string", "description": "a description of the document must be provided, e.g. 'certificate of school year 2024/25'" }, "signature_page": { "type": "string", "default": "last_page", "description": "place on 'new_page', 'last_page' or page number" }, "signature_x_align": { "type": "string", "default": "center", "description": "horizontal position from 'center' or 'left' or 'right'" }, "signature_x_offset": { "type": "integer", "default": 0, "description": "offset in mm from given horizontal position" }, "signature_y_align": { "type": "string", "default": "bottom", "description": "vertical position from 'center' or 'top' or 'bottom'" }, "signature_y_offset": { "type": "integer", "default": 25, "description": "offset in mm from given vertical position" }, "publishdate": { "type": "integer", "default": 0, "description": "the date when a document should be published at the earliest" }, "expirationtime": { "type": "string", "default": "2 months", "description": "indicate how long a document shall be kept: 2 months | 6 months | 1 year | 2 years | 10 years | 60 years" }, "deliveryway": { "type": "string", "default": "self", "description": "how the delivery shall take place: self (= only sign) | electronic (= 1. try electronic delivery, 2. fallback to self) | dual (= 1. try electronic delivery, 2. try phyiscal delivery, 3. fallback to self)" }, "verifiable": { "type": "integer", "default": 0, "description": "if the delivery must be verifiable (RSa-quality) 1, else 0" }, "filename": { "type": "string", "default": "", "description": "A filename that should be meaningful to the user" }, "file_attached": { "type": "string", "default": "", "description": "The PDF-Document" }, "file_url": { "type": "string", "format": "uri", "default": "", "description": "URL where file can be obtained" } }, "required": [ "orgid", "description" ] } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "the orgid on behalf of which the document is submitted." }, "bpkbf": { "type": "string", "default": "", "description": "the bpk-bf of the referenced person" }, "onbehalfofbpkbf": { "type": "string", "default": "", "description": "the bpk-bf of the sending person" }, "description": { "type": "string", "description": "a description of the document must be provided, e.g. 'certificate of school year 2024/25'" }, "signature_page": { "type": "string", "default": "last_page", "description": "place on 'new_page', 'last_page' or page number" }, "signature_x_align": { "type": "string", "default": "center", "description": "horizontal position from 'center' or 'left' or 'right'" }, "signature_x_offset": { "type": "integer", "default": 0, "description": "offset in mm from given horizontal position" }, "signature_y_align": { "type": "string", "default": "bottom", "description": "vertical position from 'center' or 'top' or 'bottom'" }, "signature_y_offset": { "type": "integer", "default": 25, "description": "offset in mm from given vertical position" }, "publishdate": { "type": "integer", "default": 0, "description": "the date when a document should be published at the earliest" }, "expirationtime": { "type": "string", "default": "2 months", "description": "indicate how long a document shall be kept: 2 months | 6 months | 1 year | 2 years | 10 years | 60 years" }, "deliveryway": { "type": "string", "default": "self", "description": "how the delivery shall take place: self (= only sign) | electronic (= 1. try electronic delivery, 2. fallback to self) | dual (= 1. try electronic delivery, 2. try phyiscal delivery, 3. fallback to self)" }, "verifiable": { "type": "integer", "default": 0, "description": "if the delivery must be verifiable (RSa-quality) 1, else 0" }, "filename": { "type": "string", "default": "", "description": "A filename that should be meaningful to the user" }, "file_attached": { "type": "string", "default": "", "description": "The PDF-Document" }, "file_url": { "type": "string", "format": "uri", "default": "", "description": "URL where file can be obtained" } }, "required": [ "orgid", "description" ] } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "object", "properties": { "dailycurrent": { "type": "integer", "description": "the amount of messages sent today" }, "dailylimit": { "type": "integer", "description": "the maximum amount of messages per day" }, "error": { "type": "string", "description": "optional error message" }, "timeaccepted": { "type": "integer", "description": "UNIX timestamp when the notification was accepted by education portal" } }, "required": [ "dailycurrent", "dailylimit", "error", "timeaccepted" ] } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_edtechhub": { "post": { "tags": [ "Marktplatz Lernapps" ], "summary": "EdTech Hub", "description": "# EdTech Hub\n\nDiese Schnittstelle erlaubt den Zugang zu einer Liste aller mit dem Bildungsportal verbundenen Partnern und Anwendungen.\n", "requestBody": { "description": "Parameters for local_eduportal_iface_edtechhub", "content": { "application/json": { "schema": { "type": "object", "properties": {} } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "partnerid": { "type": "integer" }, "name": { "type": "string", "description": "name of partner" }, "email": { "type": "string", "description": "primary contact e-mail" }, "phone": { "type": "string", "description": "primary contact phone" }, "street": { "type": "string", "description": "the street including street number" }, "zip": { "type": "string", "description": "the zip" }, "city": { "type": "string", "description": "the city" }, "district": { "type": "string", "description": "the district" }, "country": { "type": "string", "description": "the country code" }, "approved_data": { "type": "integer", "description": "a value greater than 0 indicates, the data was approved" }, "approved_avv": { "type": "integer", "description": "a value greater than 0 indicates, the AVV was approved" }, "uid": { "type": "string", "description": "the VAT number" }, "fn": { "type": "string", "description": "the company registration number" }, "managers": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the bpkBF of the person" }, "role": { "type": "string", "description": "the name of the role" } } } }, "apps": { "type": "array", "items": { "type": "object", "properties": { "appid": { "type": "integer", "description": "the id of the app" }, "name": { "type": "string", "description": "name of app" }, "isactive": { "type": "integer", "description": "whether this app is active (1) or not (0)" }, "shortname": { "type": "string", "description": "the shortname of the app (unique across the eduportal)" }, "ssourl": { "type": "string", "description": "the url to initiate the sso login" }, "managers": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the bpkBF of the person" }, "role": { "type": "string", "description": "the name of the role" } } } } }, "required": [ "appid" ] } } }, "required": [ "partnerid" ] } } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_educluster": { "post": { "tags": [ "Schuldaten" ], "summary": "Schulcluster", "description": "# Schulcluster\n\nDiese Schnittstelle erlaubt den Zugang zu einer Liste aller Schulcluster.\n", "requestBody": { "description": "Parameters for local_eduportal_iface_educluster", "content": { "application/json": { "schema": { "type": "object", "properties": {} } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "educluster": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "educluster", "name" ] } } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_eduregion": { "post": { "tags": [ "Schuldaten" ], "summary": "Bildungsregionen", "description": "# Bildungsregionen\n\nDiese Schnittstelle erlaubt den Zugang zu einer Liste aller Bildungsregionen.\n", "requestBody": { "description": "Parameters for local_eduportal_iface_eduregion", "content": { "application/json": { "schema": { "type": "object", "properties": {} } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "eduregion": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "eduregion", "name" ] } } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_getuserphoto": { "post": { "tags": [ "Nutzerdaten" ], "summary": "Personenfotos", "description": "Diese Schnittstelle erm\u00f6glicht den Abruf von Profil- und/oder Passfotos.", "requestBody": { "description": "Parameters for local_eduportal_iface_getuserphoto", "content": { "application/json": { "schema": { "type": "object", "properties": { "hash": { "type": "string", "description": "photo hash" } }, "required": [ "hash" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "hash": { "type": "string", "description": "photo hash" } }, "required": [ "hash" ] } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "string", "description": "no json return value, the file content is returned as request body!" } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_group_create": { "post": { "tags": [ "Marktplatz Lernapps" ], "summary": "Gruppen anlegen", "description": "# Gruppen anlegen\n\n\u00dcber diese Schnittstelle k\u00f6nnen Fremdanwendungen globale Gruppen (Kohorten) im Schuljahres-Kursbereich einer Schule anlegen, Mitglieder zuweisen und optional App-Berechtigungen f\u00fcr die Gruppe setzen.\n\nDie Kohorte wird mit description=external angelegt und \u00fcber die idnumber (appshortname_externalid) eindeutig identifiziert.\n\n## Parameter\n\n- **externalid**: Eindeutige ID der Gruppe im Quellsystem\n- **name**: Name der Gruppe\n- **orgid**: Schulkennzahl der Organisation\n- **members**: Liste der Mitglieder mit bPK-BF und Rollentyp\n- **apps**: Optionale Liste an App-Shortnames f\u00fcr Gruppenberechtigungen\n- **validstart**: G\u00fcltigkeitsbeginn (UNIX-Timestamp, 0 = aktuelles Datum)\n- **validend**: G\u00fcltigkeitsende (UNIX-Timestamp, 0 = Ende des aktuellen Schuljahres)\n\nBei erneutem Aufruf mit derselben externalid und orgid wird die bestehende Gruppe aktualisiert (Upsert).", "requestBody": { "description": "Parameters for local_eduportal_iface_group_create", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalid": { "type": "string", "description": "unique ID of the group in the source system (max. 38 characters)" }, "name": { "type": "string", "description": "name of the group" }, "orgid": { "type": "integer", "description": "Orgid (Schulkennzahl) of the organisation" }, "members": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "bPK-BF of the person" }, "role": { "type": "string", "default": "std", "description": "role type (e.g. std, tch, lgn, ...)" } }, "required": [ "bpkbf" ] }, "description": "list of group members (empty = remove all members)" }, "apps": { "type": "array", "items": { "type": "string", "description": "shortname of an application" }, "description": "optional list of app shortnames for which group permissions are set" }, "validstart": { "type": "integer", "default": 0, "description": "validity start as UNIX timestamp (0 = current date)" }, "validend": { "type": "integer", "default": 0, "description": "validity end as UNIX timestamp (0 = end of current school year)" } }, "required": [ "externalid", "name", "orgid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "externalid": { "type": "string", "description": "unique ID of the group in the source system (max. 38 characters)" }, "name": { "type": "string", "description": "name of the group" }, "orgid": { "type": "integer", "description": "Orgid (Schulkennzahl) of the organisation" }, "members": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "bPK-BF of the person" }, "role": { "type": "string", "default": "std", "description": "role type (e.g. std, tch, lgn, ...)" } }, "required": [ "bpkbf" ] }, "description": "list of group members (empty = remove all members)" }, "apps": { "type": "array", "items": { "type": "string", "description": "shortname of an application" }, "description": "optional list of app shortnames for which group permissions are set" }, "validstart": { "type": "integer", "default": 0, "description": "validity start as UNIX timestamp (0 = current date)" }, "validend": { "type": "integer", "default": 0, "description": "validity end as UNIX timestamp (0 = end of current school year)" } }, "required": [ "externalid", "name", "orgid" ] } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "object", "properties": { "success": { "type": "boolean", "description": "success" } }, "required": [ "success" ] } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_manageuserdata_address_v1": { "post": { "tags": [ "Datenverbund Schulen" ], "summary": "Nutzerdaten verwalten: Adresse", "description": "# Nutzerdaten verwalten: Adresse\n\nDiese Schnittstelle erm\u00f6glicht es einer Partneranwendung, Adressdaten zus\u00e4tzlich zu bzw. vor dem Schulverwaltungssystem zu verwalten. Ziel ist es, den Prozess der Schulanmeldung zu optimieren.\nAdressdaten, die von der jeweiligen Schule ge\u00e4ndert, ausgew\u00e4hlt oder eingegeben wurden, m\u00fcssen unverz\u00fcglich an diese Schnittstelle \u00fcbermittelt werden.\n\nDas Bildungsportal speichert den offiziellen Hauptwohnsitz und etwaige Zweitwohnsitze direkt aus dem zentralen Melderegister. Zus\u00e4tzlich kann jede Schule pro Person eine eigene Adresse hinterlegen.\nNur diese Adresse der Schule wird \u00fcber diese Schnittstelle verwaltet.\n\n- **set**: Die im Objekt \"address\" \u00fcbergebene Adresse wird gespeichert und ersetzt eine bereits vorhandene Adresse dieser Schule f\u00fcr diese Person vollst\u00e4ndig. Stra\u00dfe, Hausnummer, Postleitzahl und Ort m\u00fcssen angegeben werden.\n- **remove**: Die Adresse dieser Schule f\u00fcr diese Person wird gel\u00f6scht. Das Objekt \"address\" darf dabei nicht mitgeschickt werden. Hat die Schule f\u00fcr die Person keine Adresse hinterlegt, liefert der Aufruf den Fehler 404 (notfound).\n\n## Parameter\n\n- **orgid**: Schulkennzahl der Schule, die die Adresse pflegt. Die Anwendung muss an dieser Schule im Einsatz sein.\n- **bpkbf**: bPK-BF der Person (mit oder ohne Pr\u00e4fix \"BF:\")\n- **action**: \"set\" oder \"remove\"\n- **address**: die Adresse (Pflichtfeld bei \"set\", nicht erlaubt bei \"remove\")\n - **street**: Stra\u00dfe (Pflichtfeld)\n - **streetnumber**: Hausnummer (Pflichtfeld)\n - **zip**: Postleitzahl (Pflichtfeld)\n - **city**: Ort (Pflichtfeld)\n - **district**: Bezirk\n - **country**: Land\n\n## Beispiel: Adresse setzen\n
\n{\n    \"orgid\": 900001,\n    \"bpkbf\": \"BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=\",\n    \"action\": \"set\",\n    \"address\": {\n        \"street\": \"Musterstra\u00dfe\",\n        \"streetnumber\": \"1a\",\n        \"zip\": \"4020\",\n        \"city\": \"Linz\"\n    }\n}\n
\n\n## Beispiel: Adresse entfernen\n
\n{\n    \"orgid\": 900001,\n    \"bpkbf\": \"BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=\",\n    \"action\": \"remove\"\n}\n
", "requestBody": { "description": "Parameters for local_eduportal_iface_manageuserdata_address_v1", "content": { "application/json": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "Orgid (Schulkennzahl) of the organisation that maintains the address", "example": 900001 }, "bpkbf": { "type": "string", "description": "The bPK-BF of the person", "maxLength": 31, "example": "BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=" }, "action": { "type": "string", "description": "Whether to set or remove the address of this organisation", "enum": [ "set", "remove" ] }, "address": { "type": "object", "properties": { "street": { "type": "string", "description": "The street", "maxLength": 100 }, "streetnumber": { "type": "string", "description": "The street number", "maxLength": 45 }, "zip": { "type": "string", "description": "The zip code", "maxLength": 40 }, "city": { "type": "string", "description": "The city", "maxLength": 45 }, "district": { "type": "string", "description": "The district", "maxLength": 45 }, "country": { "type": "string", "description": "The country", "maxLength": 45 } }, "required": [ "street", "streetnumber", "zip", "city" ], "description": "The address (required for set, not allowed on remove)" } }, "required": [ "orgid", "bpkbf", "action" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "Orgid (Schulkennzahl) of the organisation that maintains the address", "example": 900001 }, "bpkbf": { "type": "string", "description": "The bPK-BF of the person", "maxLength": 31, "example": "BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=" }, "action": { "type": "string", "description": "Whether to set or remove the address of this organisation", "enum": [ "set", "remove" ] }, "address": { "type": "object", "properties": { "street": { "type": "string", "description": "The street", "maxLength": 100 }, "streetnumber": { "type": "string", "description": "The street number", "maxLength": 45 }, "zip": { "type": "string", "description": "The zip code", "maxLength": 40 }, "city": { "type": "string", "description": "The city", "maxLength": 45 }, "district": { "type": "string", "description": "The district", "maxLength": 45 }, "country": { "type": "string", "description": "The country", "maxLength": 45 } }, "required": [ "street", "streetnumber", "zip", "city" ], "description": "The address (required for set, not allowed on remove)" } }, "required": [ "orgid", "bpkbf", "action" ] } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Success" } }, "required": [ "success" ] } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_manageuserdata_communication_v1": { "post": { "tags": [ "Datenverbund Schulen" ], "summary": "Nutzerdaten verwalten: Kommunikationsdaten", "description": "# Nutzerdaten verwalten: Kommunikationsdaten\n\nDiese Schnittstelle erm\u00f6glicht es einer Partneranwendung, Kommunikationsdaten zus\u00e4tzlich zu bzw. vor dem Schulverwaltungssystem zu verwalten. Ziel ist es, den Prozess der Schulanmeldung zu optimieren.\nKommunikationsdaten, die von der jeweiligen Schule ge\u00e4ndert, ausgew\u00e4hlt oder eingegeben wurden, m\u00fcssen unverz\u00fcglich an diese Schnittstelle \u00fcbermittelt werden.\n\nKommunikationsdaten sind eine E-Mail-Adresse und bis zu zwei Telefonnummern. Jede Schule pflegt pro Person ihre eigenen Werte, je Feld ist ein Wert m\u00f6glich.\n\nIm Objekt \"communication\" werden nur die \u00fcbergebenen Felder ge\u00e4ndert: Ein angegebener Wert ersetzt den bisherigen Wert dieser Schule, ein leerer Wert (\"\") entfernt ihn.\nEin nicht angegebenes Feld bleibt unver\u00e4ndert. Der Wert null wird nicht angenommen.\n\n## Parameter\n\n- **orgid**: Schulkennzahl der Schule, die die Daten pflegt. Die Anwendung muss an dieser Schule im Einsatz sein.\n- **bpkbf**: bPK-BF der Person (mit oder ohne Pr\u00e4fix \"BF:\")\n- **communication**: die zu \u00e4ndernden Kommunikationsdaten\n - **email**: E-Mail-Adresse\n - **phone1**: erste Telefonnummer\n - **phone2**: zweite Telefonnummer\n\n## Beispiel\n
\n{\n    \"orgid\": 900001,\n    \"bpkbf\": \"BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=\",\n    \"communication\": {\n        \"email\": \"abcdefgh@example.com\",\n        \"phone2\": \"\"\n    }\n}\n
", "requestBody": { "description": "Parameters for local_eduportal_iface_manageuserdata_communication_v1", "content": { "application/json": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "Orgid (Schulkennzahl) of the organisation that maintains the data", "example": 900001 }, "bpkbf": { "type": "string", "description": "The bPK-BF of the person", "maxLength": 31, "example": "BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=" }, "communication": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "Email address\n\nNot sent = unchanged, empty ('') = remove the value of this organisation", "maxLength": 255 }, "phone1": { "type": "string", "description": "First phone number\n\nNot sent = unchanged, empty ('') = remove the value of this organisation", "maxLength": 255 }, "phone2": { "type": "string", "description": "Second phone number\n\nNot sent = unchanged, empty ('') = remove the value of this organisation", "maxLength": 255 } }, "description": "The communication data to change" } }, "required": [ "orgid", "bpkbf", "communication" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "Orgid (Schulkennzahl) of the organisation that maintains the data", "example": 900001 }, "bpkbf": { "type": "string", "description": "The bPK-BF of the person", "maxLength": 31, "example": "BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=" }, "communication": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "Email address\n\nNot sent = unchanged, empty ('') = remove the value of this organisation", "maxLength": 255 }, "phone1": { "type": "string", "description": "First phone number\n\nNot sent = unchanged, empty ('') = remove the value of this organisation", "maxLength": 255 }, "phone2": { "type": "string", "description": "Second phone number\n\nNot sent = unchanged, empty ('') = remove the value of this organisation", "maxLength": 255 } }, "description": "The communication data to change" } }, "required": [ "orgid", "bpkbf", "communication" ] } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Success" } }, "required": [ "success" ] } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_manageuserdata_relatives_v1": { "post": { "tags": [ "Datenverbund Schulen" ], "summary": "Nutzerdaten verwalten: Erziehungsberechtigte", "description": "# Nutzerdaten verwalten: Erziehungsberechtigte\n\nDiese Schnittstelle erm\u00f6glicht es einer Partneranwendung, Sch\u00fcler/innen zus\u00e4tzlich zu bzw. vor dem Schulverwaltungssystem mit ihren Bezugspersonen zu verkn\u00fcpfen. Ziel ist es, den Prozess der Schulanmeldung zu optimieren.\n\nAlle Bezugspersonen von Kindern werden an Schulen h\u00e4ufig als \"Erziehungsberechtigte\" bezeichnet, unabh\u00e4ngig von der eigentlichen rechtlichen Einstufung. Das Bildungsportal verwendet daher f\u00fcr alle Bezugspersonen\nden gebr\u00e4uchlichen Begriff \"Erziehungsberechtigte\" und kennzeichnet die rechtliche Einstufung mit dem Kennzeichen \"islgn\". In bestimmten F\u00e4llen haben Bezugspersonen \"islgn\" auf \"false\" gesetzt,\nsind jedoch zahlungspflichtig (\"ispayer\" auf \"true\").\n\nDie Verkn\u00fcpfung gilt schul\u00fcbergreifend und nicht nur f\u00fcr die angegebene Schule. Deshalb wird hier nicht der Soll-Zustand \u00fcbertragen, sondern pro Aufruf genau eine Bezugsperson hinzugef\u00fcgt oder entfernt:\n\n- **add**: Die angegebene Bezugsperson wird mit dem Kind verkn\u00fcpft. Besteht die Verkn\u00fcpfung bereits, werden ihre Angaben aktualisiert. Eine Bezugsperson, die rechtlich nicht als \"echte\" Erziehungsberechtigte\n eingestuft ist, wird nicht entfernt, sondern mit \"islgn\" auf \"false\" erneut hinzugef\u00fcgt.\n- **remove**: Die angegebene Bezugsperson wird vollst\u00e4ndig vom Kind entfernt. Es wird nur die bPK-BF der Bezugsperson \u00fcbergeben, \"type\", \"islgn\" und \"ispayer\" d\u00fcrfen dabei nicht mitgeschickt werden. Besteht keine Verkn\u00fcpfung, liefert der Aufruf den Fehler 404 (notfound).\n\n## Parameter\n\n- **orgid**: Schulkennzahl der Schule, in deren Auftrag der Aufruf erfolgt. Die Anwendung muss an dieser Schule im Einsatz sein.\n- **bpkbf**: bPK-BF des Kindes (mit oder ohne Pr\u00e4fix \"BF:\")\n- **action**: \"add\" oder \"remove\"\n- **relative**: die Bezugsperson, aufgebaut wie ein Eintrag von \"relatives\" in readuserdata_v3\n - **bpkbf**: bPK-BF der Bezugsperson (mit oder ohne Pr\u00e4fix \"BF:\")\n - **type**: Art der Beziehung: mother, father, grandMother, grandFather, sister, brother oder other (Pflichtfeld bei \"add\", nicht erlaubt bei \"remove\")\n - **islgn**: rechtliche Einstufung als Erziehungsberechtigte/r (Pflichtfeld bei \"add\", nicht erlaubt bei \"remove\")\n - **ispayer**: Bezugsperson ist zahlungspflichtig (Pflichtfeld bei \"add\", nicht erlaubt bei \"remove\")\n\n## Beispiel\n
\n{\n    \"orgid\": 900001,\n    \"bpkbf\": \"BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=\",\n    \"action\": \"add\",\n    \"relative\": {\n        \"bpkbf\": \"BF:YWJjZGVmZ2hpajAxMjM0NTY3ODk=\",\n        \"type\": \"mother\",\n        \"islgn\": true,\n        \"ispayer\": false\n    }\n}\n
", "requestBody": { "description": "Parameters for local_eduportal_iface_manageuserdata_relatives_v1", "content": { "application/json": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "Orgid (Schulkennzahl) of the organisation on whose behalf the call is made", "example": 900001 }, "bpkbf": { "type": "string", "description": "The bPK-BF of the child", "maxLength": 31, "example": "BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=" }, "action": { "type": "string", "description": "Whether to add or remove the given relative", "enum": [ "add", "remove" ] }, "relative": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "The bPK-BF of the relative", "maxLength": 31, "example": "BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=" }, "type": { "type": "string", "description": "Type of relationship (required for add, not allowed on remove)", "enum": [ "mother", "father", "grandMother", "grandFather", "sister", "brother", "other" ] }, "islgn": { "type": "boolean", "description": "Whether the relative is legally classified as legal guardian (required for add, not allowed on remove)" }, "ispayer": { "type": "boolean", "description": "Whether the relative has the payment duty (required for add, not allowed on remove)" } }, "required": [ "bpkbf" ], "description": "The relative to add or remove" } }, "required": [ "orgid", "bpkbf", "action", "relative" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "Orgid (Schulkennzahl) of the organisation on whose behalf the call is made", "example": 900001 }, "bpkbf": { "type": "string", "description": "The bPK-BF of the child", "maxLength": 31, "example": "BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=" }, "action": { "type": "string", "description": "Whether to add or remove the given relative", "enum": [ "add", "remove" ] }, "relative": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "The bPK-BF of the relative", "maxLength": 31, "example": "BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=" }, "type": { "type": "string", "description": "Type of relationship (required for add, not allowed on remove)", "enum": [ "mother", "father", "grandMother", "grandFather", "sister", "brother", "other" ] }, "islgn": { "type": "boolean", "description": "Whether the relative is legally classified as legal guardian (required for add, not allowed on remove)" }, "ispayer": { "type": "boolean", "description": "Whether the relative has the payment duty (required for add, not allowed on remove)" } }, "required": [ "bpkbf" ], "description": "The relative to add or remove" } }, "required": [ "orgid", "bpkbf", "action", "relative" ] } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Success" } }, "required": [ "success" ] } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_manageuserdata_role_v1": { "post": { "tags": [ "Datenverbund Schulen" ], "summary": "Nutzerdaten verwalten: Rolle", "description": "# Nutzerdaten verwalten: Rolle\n\n\u00dcber diese Schnittstelle legt eine Partneranwendung im Bereich der Schulanmeldung fest, ob ein/e Sch\u00fcler/in an einer Schule vorgemerkt ist oder einen Fixplatz hat:\n\n- **std_preregistered** (Vormerkung): muss gesetzt werden, wenn sich ein/e Sch\u00fcler/in an einer Schule bewirbt, aber noch nicht von der Schule best\u00e4tigt wurde. Ein/e Sch\u00fcler/in kann an mehreren Schulen vorgemerkt sein.\n- **std_admitted** (Fixplatz): muss gesetzt werden, sobald die Schule die Aufnahme best\u00e4tigt, damit ein/e Sch\u00fcler/in nicht von zwei Schulen angenommen werden kann. Es ist nur ein Fixplatz gleichzeitig zul\u00e4ssig.\n\nBeide Zuordnungen sind zeitlich begrenzt und laufen automatisch aus, sobald das n\u00e4chste Schuljahr beginnt.\n\nDer Aufruf \u00fcbertr\u00e4gt den Soll-Zustand an der angegebenen Schule: Die \u00fcbergebene Rolle ersetzt die bisherige, aus einer Vormerkung wird so mit einem Aufruf ein Fixplatz. Der Wert \"none\" entfernt\nVormerkung und Fixplatz an dieser Schule. Der Parameter \"role\" muss immer angegeben werden. Die \u00c4nderung gilt sofort.\n\nHat die Person bereits einen Fixplatz an einer anderen Schule, wird \"std_admitted\" mit dem Fehler 409 (conflict) abgelehnt.\n\nDie Rolle als regul\u00e4re/r \"Sch\u00fcler/in\" wird \u00fcber das Sch\u00fclerverwaltungssystem an das Bildungsportal \u00fcbertragen und ist nicht Bestandteil dieser Schnittstelle. Auch die Rolle der Erziehungsberechtigten ergibt sich\naus der Sch\u00fclerrolle innerhalb einer Organisation und wird nicht \u00fcber diese Schnittstelle festgelegt.\n\n## Parameter\n\n- **orgid**: Schulkennzahl der Schule, an der die Rolle gilt. Die Anwendung muss an dieser Schule im Einsatz sein.\n- **bpkbf**: bPK-BF der Sch\u00fclerin bzw. des Sch\u00fclers (mit oder ohne Pr\u00e4fix \"BF:\")\n- **role**: \"std_preregistered\", \"std_admitted\" oder \"none\"\n\n## Beispiel\n
\n{\n    \"orgid\": 900001,\n    \"bpkbf\": \"BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=\",\n    \"role\": \"std_preregistered\"\n}\n
", "requestBody": { "description": "Parameters for local_eduportal_iface_manageuserdata_role_v1", "content": { "application/json": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "Orgid (Schulkennzahl) of the organisation the role applies to", "example": 900001 }, "bpkbf": { "type": "string", "description": "The bPK-BF of the person", "maxLength": 31, "example": "BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=" }, "role": { "type": "string", "description": "The role at this organisation, \"none\" removes both roles", "enum": [ "std_preregistered", "std_admitted", "none" ] } }, "required": [ "orgid", "bpkbf", "role" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "Orgid (Schulkennzahl) of the organisation the role applies to", "example": 900001 }, "bpkbf": { "type": "string", "description": "The bPK-BF of the person", "maxLength": 31, "example": "BF:MDEyMzQ1Njc4OWFiY2RlZmdoaWo=" }, "role": { "type": "string", "description": "The role at this organisation, \"none\" removes both roles", "enum": [ "std_preregistered", "std_admitted", "none" ] } }, "required": [ "orgid", "bpkbf", "role" ] } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Success" } }, "required": [ "success" ] } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_notification": { "post": { "tags": [ "Nutzerinteraktion" ], "summary": "Benachrichtigungen", "description": "# Benachrichtigung senden\n\nDiese Schnittstelle erm\u00f6glicht es einer Partneranwendung, eine Benachrichtigung zu senden. Abh\u00e4ngig von der Benutzerpr\u00e4ferenz sendet das Bildungsportal die Benachrichtigung entweder als Push-Benachrichtigung oder als E-Mail.\n\nJede Benachrichtigung muss an einen bestimmten Sch\u00fcler gerichtet sein. Mit Hilfe der Parameter dieser Schnittstelle kann entschieden werden, ob die Nachricht (1) nur an den Sch\u00fcler, (2) nur an die Erziehungsberechtigten oder (3) an alle Empf\u00e4nger gesendet werden soll.\n\nGilt ein Sch\u00fcler als selbstberechtigt (es gibt keine Erziehungsberechtigten), wird die Nachricht immer nur an den Sch\u00fcler gesendet.\n", "requestBody": { "description": "Parameters for local_eduportal_iface_notification", "content": { "application/json": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "the orgid on behalf of which the notification is sent." }, "bpkbf": { "type": "string", "description": "the bpk-bf of the referenced person" }, "message": { "type": "string", "description": "the message" }, "notifyperson": { "type": "integer", "description": "1 to notify person, 0 if not" }, "notifylgn": { "type": "integer", "description": "1 to notify legal guardians, 0 if not, in case there are no legal guardians fallback to notifyperson" }, "subject": { "type": "string", "default": "", "description": "the subject (maximum: 100 characters)" }, "url": { "type": "string", "format": "uri", "default": "", "description": "an optional url" } }, "required": [ "orgid", "bpkbf", "message", "notifyperson", "notifylgn" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "the orgid on behalf of which the notification is sent." }, "bpkbf": { "type": "string", "description": "the bpk-bf of the referenced person" }, "message": { "type": "string", "description": "the message" }, "notifyperson": { "type": "integer", "description": "1 to notify person, 0 if not" }, "notifylgn": { "type": "integer", "description": "1 to notify legal guardians, 0 if not, in case there are no legal guardians fallback to notifyperson" }, "subject": { "type": "string", "default": "", "description": "the subject (maximum: 100 characters)" }, "url": { "type": "string", "format": "uri", "default": "", "description": "an optional url" } }, "required": [ "orgid", "bpkbf", "message", "notifyperson", "notifylgn" ] } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "object", "properties": { "dailycurrent": { "type": "integer", "description": "the amount of messages sent today" }, "dailylimit": { "type": "integer", "description": "the maximum amount of messages per day" }, "error": { "type": "string", "description": "optional error message" }, "timeaccepted": { "type": "integer", "description": "UNIX timestamp when the notification was accepted by education portal" } }, "required": [ "dailycurrent", "dailylimit", "error", "timeaccepted" ] } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_permission": { "post": { "tags": [ "Nutzerinteraktion" ], "summary": "App-Berechtigungen festlegen", "description": "# App-Berechtigungen festlegen\n\nDiese Schnittstelle erm\u00f6glicht es einer Partneranwendung, ihre eigenen App-Berechtigungen im Rahmen der Organisationen, auf die sie Zugriff hat, zu verwalten.\n\nAbh\u00e4ngig von der Konfiguration der Anwendung, die von der Bildungsportal-Websiteadministration verwaltet wird, kann eine Anwendung die Berechtigungen\npro Benutzergruppe (std, tch, lgn, ...) oder f\u00fcr bestimmte Benutzer steuern.\n", "requestBody": { "description": "Parameters for local_eduportal_iface_permission", "content": { "application/json": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "the orgid on behalf of which the document is submitted." }, "change": { "type": "string", "default": "add", "description": "either \"add\" or \"remove\" the permission" }, "usergroups": { "type": "array", "items": { "type": "string", "description": "user-group for ad group permission (e.g. std, tch, lgn, ...)" }, "description": "list of user-groups" }, "users": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the bpk-bf of the user" }, "role": { "type": "string", "description": "the role of the user (std, tch, lgn, ...)" } }, "required": [ "bpkbf", "role" ] }, "description": "list of users and their roles to toggle ad personam permissions" } }, "required": [ "orgid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "orgid": { "type": "integer", "description": "the orgid on behalf of which the document is submitted." }, "change": { "type": "string", "default": "add", "description": "either \"add\" or \"remove\" the permission" }, "usergroups": { "type": "array", "items": { "type": "string", "description": "user-group for ad group permission (e.g. std, tch, lgn, ...)" }, "description": "list of user-groups" }, "users": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the bpk-bf of the user" }, "role": { "type": "string", "description": "the role of the user (std, tch, lgn, ...)" } }, "required": [ "bpkbf", "role" ] }, "description": "list of users and their roles to toggle ad personam permissions" } }, "required": [ "orgid" ] } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "boolean", "description": "success" } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_readorgdata": { "post": { "tags": [ "Schuldaten" ], "summary": "Stammdaten \u00fcber Schulen abrufen", "description": "# Stammdaten \u00fcber Schulen abrufen\n\nDiese Schnittstelle liefert einer Partneranwendung Stammdaten \u00fcber jene Schulen, auf die sie zugreifen darf.\n\nWenn Sie das Feld `orgids` leer lassen, erhalten Sie Daten aller Schulen, die Ihre Anwendung abrufen darf.\n\n__Bitte beachten Sie, dass diese Dokumentation das Maximum an Daten darstellt, die mit Hilfe dieser Schnittstelle abgerufen werden k\u00f6nnen.\nIm Hinblick auf Datenminimierung kann die Anzahl der Attribute oder der verf\u00fcgbaren Benutzertypen f\u00fcr Ihre Anwendung reduziert werden.__\n", "requestBody": { "description": "Parameters for local_eduportal_iface_readorgdata", "content": { "application/json": { "schema": { "type": "object", "properties": { "orgids": { "type": "string", "default": "", "description": "the orgids delimited by comma" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "orgids": { "type": "string", "default": "", "description": "the orgids delimited by comma" } } } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "orgid": { "type": "integer" }, "orgtype": { "type": "string", "description": "authority, federal, municipal, private, unknown" }, "eduregion": { "type": "string", "description": "the eduregion id" }, "educluster": { "type": "string", "description": "the educluster id" }, "name": { "type": "string" }, "officialname": { "type": "string" }, "shortname": { "type": "string" }, "email": { "type": "string", "description": "official email address of org" }, "phone": { "type": "string", "description": "official phone number" }, "street": { "type": "string" }, "zip": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "classes": { "type": "array", "items": { "type": "string", "description": "the class name" } }, "classcount": { "type": "integer", "description": "number of classes within the current school year" }, "departments": { "type": "array", "items": { "type": "object", "properties": { "department": { "type": "string", "description": "the department name" }, "classes": { "type": "array", "items": { "type": "string", "description": "the class name" } } }, "required": [ "department", "classes" ] } }, "genuine": { "type": "integer", "description": "whether this is a real org (1) or a demo org (0)" }, "operational": { "type": "integer", "description": "whether this org is operational (1) or not (0)" }, "timechanged": { "type": "integer", "description": "UNIX timestamp of most currently changed item" } }, "required": [ "orgid", "timechanged" ] } } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_readuserapps_v1": { "post": { "tags": [ "OBSOLET - NICHT MEHR VERWENDEN!" ], "summary": "Nutzeranwendungen V1", "description": "# Nutzeranwendungen\n\nDiese Schnittstelle erm\u00f6glicht es einer Partneranwendung, eine Liste aller Anwendungen, die ein bestimmter Benutzer starten kann, mit ihren jeweiligen Deep Links zu erhalten.\n", "requestBody": { "description": "Parameters for local_eduportal_iface_readuserapps_v1", "content": { "application/json": { "schema": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the bpkbf or vbpkbf of the user" } }, "required": [ "bpkbf" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the bpkbf or vbpkbf of the user" } }, "required": [ "bpkbf" ] } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "appid": { "type": "integer", "description": "the internal appid of this app" }, "role": { "type": "string", "description": "the role with which the user is permitted to use this application" }, "orgid": { "type": "integer", "description": "the orgid in which the user is permitted to use this application" }, "deeplink": { "type": "string", "format": "uri", "description": "the deep link to launch this application" }, "name": { "type": "string", "description": "the name of the application" }, "mfa": { "type": "boolean", "description": "whether the application requires multi factor authentication (means: ID Austria)" } }, "required": [ "appid", "role", "orgid", "deeplink", "name", "mfa" ] } } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_readuserdata_v2": { "post": { "tags": [ "OBSOLET - NICHT MEHR VERWENDEN!" ], "summary": "[DEPRECATED] Stammdaten \u00fcber Personen abrufen V2", "description": "THIS INTERFACE IS DEPRECATED, PLEASE SWITCH TO ITS NEWER ALTERNATIVE AS SOON AS POSSIBLE!\n\n# Benutzerdaten lesen\n\nDiese Schnittstelle erm\u00f6glicht es Partneranwendungen Daten \u00fcber Personen einer Organisation auszulesen, auf die die Anwendung zugreifen darf.\n\nWenn Sie alle Felder leer lassen, erhalten Sie alle Daten, die Ihre Anwendung abrufen darf.\nSie k\u00f6nnen Ihre Abfrage jedoch effizienter gestalten, indem Sie die Filterattribute nutzen.\n\n**Es wird dringend empfohlen den Parameter `timechanged` zu verwenden, damit nur jene Organisationen abgerufen werden, die sich seit dem angegebenen Zeitstempel ge\u00e4ndert haben.**\n", "requestBody": { "description": "Parameters for local_eduportal_iface_readuserdata_v2", "content": { "application/json": { "schema": { "type": "object", "properties": { "orgids": { "type": "string", "default": "", "description": "the orgids delimited by comma" }, "usertypes": { "type": "string", "default": "", "description": "requested user types (std, lgn, tch, dir) as comma separated list" }, "timechanged": { "type": "integer", "default": 0, "description": "request only items that were changed since given timestamp" }, "limitnum": { "type": "integer", "default": 1000, "description": "limit item count" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "orgids": { "type": "string", "default": "", "description": "the orgids delimited by comma" }, "usertypes": { "type": "string", "default": "", "description": "requested user types (std, lgn, tch, dir) as comma separated list" }, "timechanged": { "type": "integer", "default": 0, "description": "request only items that were changed since given timestamp" }, "limitnum": { "type": "integer", "default": 1000, "description": "limit item count" } } } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the bpkbf prefixed with BF:" }, "idp_subjectid_v1": { "type": "string", "description": "the global subject id based on bpkbf (v1)" }, "deleted": { "type": "boolean", "description": "user account is deleted" }, "suspended": { "type": "boolean", "description": "user account is suspended" }, "timechanged": { "type": "integer", "description": "UNIX timestamp of last change" }, "firstname": { "type": "string" }, "middlename": { "type": "string" }, "lastname": { "type": "string" }, "title_acad_prefix": { "type": "string" }, "title_acad_suffix": { "type": "string" }, "title_job": { "type": "string" }, "title_official": { "type": "string" }, "email": { "type": "string" }, "phone1": { "type": "string" }, "phone2": { "type": "string" }, "dateofbirth": { "type": "string", "description": "date of birth in format YYYY-mm-dd" }, "gender": { "type": "string", "description": "m = male | w = female | d = diverse | o = open | i = inter | k = not specified | u = unknown" }, "photo_official_hash": { "type": "string", "description": "contenthash of the official photograph" }, "photo_profile_hash": { "type": "string", "description": "contenthash of the profile picture" }, "street": { "type": "string" }, "zip": { "type": "string" }, "city": { "type": "string" }, "district": { "type": "string" }, "country": { "type": "string" }, "children": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the bpkbf prefixed with BF:" } }, "required": [ "bpkbf" ] } }, "relatives": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the bpkbf prefixed with BF:" }, "type": { "type": "string", "description": "ENUM(\"father\", \"mother\", \"grandmother\")" }, "islgn": { "type": "boolean", "description": "is legal guardian" }, "ispayer": { "type": "boolean", "description": "is payer" } }, "required": [ "bpkbf", "type", "islgn", "ispayer" ] } }, "assignedorgids": { "type": "array", "items": { "type": "string", "description": "role" } }, "mainorgids": { "type": "array", "items": { "type": "string", "description": "role" } }, "sapids": { "type": "array", "items": { "type": "string", "description": "sapid" } }, "sokratesids": { "type": "array", "items": { "type": "string", "description": "sokratesid" } }, "orgs": { "type": "array", "items": { "type": "object", "properties": { "orgid": { "type": "string", "description": "orgid" }, "roles": { "type": "array", "items": { "type": "string", "description": "role" } }, "classes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "name" } }, "required": [ "name" ] } }, "departments": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "name" } }, "required": [ "name" ] } } }, "required": [ "orgid" ] } }, "idpusername": { "type": "string", "description": "A unique username for local use" } }, "required": [ "bpkbf", "deleted", "suspended", "timechanged", "orgs" ] } } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_readuserdata_v3": { "post": { "tags": [ "Nutzerdaten" ], "summary": "Stammdaten \u00fcber Personen abrufen V3", "description": "# Benutzerdaten lesen\n\nDiese Schnittstelle erm\u00f6glicht es Partneranwendungen Daten \u00fcber Personen einer Organisation auszulesen, auf die die Anwendung zugreifen darf.\n\nWenn Sie alle Felder leer lassen, erhalten Sie alle Daten, die Ihre Anwendung abrufen darf.\nSie k\u00f6nnen Ihre Abfrage jedoch effizienter gestalten, indem Sie die Filterattribute nutzen.\n\n**Es wird dringend empfohlen den Parameter `cursor` zu verwenden, damit nur jene Personen abgerufen werden, die sich seit Ihrer letzten Abfrage ge\u00e4ndert haben.**\n\nJede Antwort mit Personen enth\u00e4lt in `meta` einen `next_cursor`:\n\n- Solange `has_more` true ist, \u00fcbergeben Sie ihn als `cursor`, um die n\u00e4chste Seite abzurufen.\n- Speichern Sie den letzten `next_cursor` und \u00fcbergeben Sie ihn bei Ihrem n\u00e4chsten Abgleich als `cursor`.\n- Eine Antwort ohne Personen enth\u00e4lt keinen `next_cursor`, verwenden Sie den bisherigen weiter.\n\n`cursor` und `timechanged` k\u00f6nnen nicht kombiniert werden.\n", "requestBody": { "description": "Parameters for local_eduportal_iface_readuserdata_v3", "content": { "application/json": { "schema": { "type": "object", "properties": { "orgids": { "type": "string", "default": "", "description": "comma-delimited list of organization IDs to query, empty = all accessible orgs" }, "usertypes": { "type": "string", "default": "", "description": "requested user types (std, lgn, tch, dir) as comma-separated list, empty = all allowed types" }, "timechanged": { "type": "integer", "default": 0, "description": "UNIX timestamp - only return users modified since this time, use 0 for all users" }, "limitnum": { "type": "integer", "default": 50000, "description": "maximum number of users to return (for pagination)" }, "cursor": { "type": "string", "default": "", "description": "pagination cursor from previous response" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "orgids": { "type": "string", "default": "", "description": "comma-delimited list of organization IDs to query, empty = all accessible orgs" }, "usertypes": { "type": "string", "default": "", "description": "requested user types (std, lgn, tch, dir) as comma-separated list, empty = all allowed types" }, "timechanged": { "type": "integer", "default": 0, "description": "UNIX timestamp - only return users modified since this time, use 0 for all users" }, "limitnum": { "type": "integer", "default": 50000, "description": "maximum number of users to return (for pagination)" }, "cursor": { "type": "string", "default": "", "description": "pagination cursor from previous response" } } } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the BPK-BF prefixed with BF:" }, "idp_subjectid_v1": { "type": "string", "description": "the global subject ID" }, "deleted": { "type": "boolean", "description": "whether the user account has been deleted" }, "suspended": { "type": "boolean", "description": "whether the user account is suspended" }, "timechanged": { "type": "integer", "description": "UNIX timestamp of last modification" }, "firstname": { "type": "string", "description": "first name" }, "firstname_official": { "type": "string", "description": "officially registered firstname" }, "middlename": { "type": "string", "description": "middle name" }, "lastname": { "type": "string", "description": "last name" }, "dateofbirth": { "type": "string", "description": "date of birth (YYYY-MM-DD)" }, "gender": { "type": "string", "description": "gender code" }, "photo_official_hash": { "type": "string", "description": "official photo hash" }, "photo_profile_hash": { "type": "string", "description": "profile photo hash" }, "title_acad_prefix": { "type": "string", "description": "academic title prefix" }, "title_acad_suffix": { "type": "string", "description": "academic title suffix" }, "title_job": { "type": "string", "description": "job title" }, "title_official": { "type": "string", "description": "official title" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "field identifier" }, "value": { "type": "string", "description": "email address" }, "orgid": { "type": "string", "description": "organization ID" }, "official": { "type": "boolean", "description": "true if this is an official email address, false if it is private" }, "preferred": { "type": "string", "description": "preferred flag" } }, "required": [ "field", "value", "orgid", "official", "preferred" ] } }, "phonenumbers": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "field identifier" }, "value": { "type": "string", "description": "phone number" }, "orgid": { "type": "string", "description": "organization ID" }, "official": { "type": "boolean", "description": "true if this is an official phone number, false if it is private" }, "preferred": { "type": "string", "description": "preferred flag" } }, "required": [ "field", "value", "orgid", "official", "preferred" ] } }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "address type" }, "street": { "type": "string", "description": "street" }, "streetnumber": { "type": "string", "description": "street number" }, "zip": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "city" }, "district": { "type": "string", "description": "district" }, "country": { "type": "string", "description": "country" }, "orgid": { "type": "string", "description": "organization ID" } }, "required": [ "orgid" ] } }, "children": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "child BPK-BF" } }, "required": [ "bpkbf" ] } }, "relatives": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "relative BPK-BF" }, "type": { "type": "string", "description": "relationship type" }, "islgn": { "type": "boolean", "description": "is legal guardian" }, "ispayer": { "type": "boolean", "description": "is payer" } }, "required": [ "bpkbf", "type", "islgn", "ispayer" ] } }, "assignedorgids": { "type": "array", "items": { "type": "string", "description": "org ID" } }, "mainorgids": { "type": "array", "items": { "type": "string", "description": "org ID" } }, "sapids": { "type": "array", "items": { "type": "object", "properties": { "orgid": { "type": "string", "description": "organization ID" }, "sapid": { "type": "integer", "description": "SAP ID" }, "role": { "type": "string" }, "roletype": { "type": "string", "description": "role (same as the role field, this is deprecated and will be removed)" } }, "required": [ "orgid", "sapid", "role", "roletype" ] } }, "sokratesids": { "type": "array", "items": { "type": "string", "description": "Sokrates ID" } }, "orgs": { "type": "array", "items": { "type": "object", "properties": { "orgid": { "type": "string", "description": "organization ID" }, "roles": { "type": "array", "items": { "type": "string", "description": "role name" } }, "classes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "class name" } }, "required": [ "name" ] } }, "departments": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "department name" } }, "required": [ "name" ] } }, "externalgroups": { "type": "array", "items": { "type": "object", "properties": { "uniqid": { "type": "string", "description": "a unique id" }, "name": { "type": "string", "description": "display name of the group" }, "roletype": { "type": "string", "description": "the role the user as within the group (std, tch, ...)" }, "validstart": { "type": "string", "description": "when the group was started (Y-m-d H:i:s)" }, "validend": { "type": "string", "description": "when the groups ends (Y-m-d H:i:s)" } }, "required": [ "uniqid", "name" ] } }, "lessongroups": { "type": "array", "items": { "type": "object", "properties": { "uniqid": { "type": "string", "description": "a unique id" }, "name": { "type": "string", "description": "display name of the group" }, "roletype": { "type": "string", "description": "the role the user as within the group (std, tch, ...)" }, "validstart": { "type": "string", "description": "when the group was started (Y-m-d H:i:s)" }, "validend": { "type": "string", "description": "when the groups ends (Y-m-d H:i:s)" } }, "required": [ "uniqid", "name" ] } }, "orgfunctions": { "type": "array", "items": { "type": "object", "properties": { "uniqid": { "type": "string", "description": "a unique id" }, "name": { "type": "string", "description": "display name of the group" }, "roletype": { "type": "string", "description": "the role the user as within the group (std, tch, ...)" }, "validstart": { "type": "string", "description": "when the group was started (Y-m-d H:i:s)" }, "validend": { "type": "string", "description": "when the groups ends (Y-m-d H:i:s)" } }, "required": [ "uniqid", "name" ] } } }, "required": [ "orgid" ] } }, "unassigned_orgs": { "type": "array", "items": { "type": "object", "properties": { "orgid": { "type": "string", "description": "organization ID" }, "role": { "type": "string", "description": "removed role" }, "timechanged": { "type": "integer", "description": "removal timestamp" } }, "required": [ "orgid", "role", "timechanged" ] } }, "idpusername": { "type": "string", "description": "IDP username" } }, "required": [ "bpkbf", "deleted", "suspended", "timechanged", "orgs", "unassigned_orgs" ] } }, "meta": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "whether there are more results" }, "next_cursor": { "type": "string", "description": "cursor for next page / next sync" } }, "required": [ "has_more" ] } }, "required": [ "type", "meta" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_searchuserdata_v2": { "post": { "tags": [ "OBSOLET - NICHT MEHR VERWENDEN!" ], "summary": "[DEPRECATED] Stammdaten \u00fcber Personen suchen V2", "description": "THIS INTERFACE IS DEPRECATED, PLEASE SWITCH TO ITS NEWER ALTERNATIVE AS SOON AS POSSIBLE!\n\n# Nutzerdaten suchen\n\nDiese Schnittstelle erm\u00f6glicht es Partneranwendungen Daten \u00fcber Personen einer Organisation zu suchen, auf die die Anwendung zugreifen darf.\n\nSie __m\u00fcssen mindestens__ eines der folgenden Kriterien angeben\n- `bpkbf` _oder_\n- `idp_subjectid_v1` _oder_\n- `sapid` _oder_\n- `sokratesid` _oder_\n- `dateofbirth` _und_ `zip`\n\nSie __k\u00f6nnen__ Ihre Suche spezifischer machen, indem Sie einen Namen angeben.\nBeliebige Teile des Namens oder mehrere durch Leerzeichen getrennte Namensteile sind erlaubt.\nGro\u00df- und Kleinschreibung wird ignoriert, die Akzentsensibilit\u00e4t ist deaktiviert (bspw. wird eine Suche nach \"Hacek\" auch den Namen \"Ha\u010dek\" finden).\nMit dem Attribut `usertypes` k\u00f6nnen Sie steuern, dass Sie nur Benutzer aus dem jeweiligen Benutzertyp erhalten. Wenn Sie das Feld leer lassen, erhalten Sie alle Benutzertypen\nauf die Ihre Anwendung zugreifen darf.\n\n__Bitte beachten Sie, dass diese Dokumentation das Maximum an Daten darstellt, die mit Hilfe dieser Schnittstelle abgerufen werden k\u00f6nnen.\nIm Hinblick auf Datenminimierung kann die Anzahl der Attribute oder der verf\u00fcgbaren Benutzertypen f\u00fcr Ihre Anwendung reduziert werden.__\n", "requestBody": { "description": "Parameters for local_eduportal_iface_searchuserdata_v2", "content": { "application/json": { "schema": { "type": "object", "properties": { "bpkbf": { "type": "string", "default": "", "description": "search for a bpkbf" }, "idp_subjectid_v1": { "type": "string", "default": "", "description": "search for a BiP Identity" }, "sapid": { "type": "integer", "default": 0, "description": "search for a sapid" }, "sokratesid": { "type": "integer", "default": 0, "description": "search for a sokratesid" }, "dateofbirth": { "type": "string", "default": 0, "description": "search for a dateofbirth (YYYY-MM-DD), must be used in conjunction with zip" }, "zip": { "type": "integer", "default": 0, "description": "search within a known ZIP, must be used in conjunction with dateofbirth" }, "name": { "type": "string", "default": "", "description": "search for name" }, "usertypes": { "type": "string", "default": "", "description": "requested user types as comma separated list" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bpkbf": { "type": "string", "default": "", "description": "search for a bpkbf" }, "idp_subjectid_v1": { "type": "string", "default": "", "description": "search for a BiP Identity" }, "sapid": { "type": "integer", "default": 0, "description": "search for a sapid" }, "sokratesid": { "type": "integer", "default": 0, "description": "search for a sokratesid" }, "dateofbirth": { "type": "string", "default": 0, "description": "search for a dateofbirth (YYYY-MM-DD), must be used in conjunction with zip" }, "zip": { "type": "integer", "default": 0, "description": "search within a known ZIP, must be used in conjunction with dateofbirth" }, "name": { "type": "string", "default": "", "description": "search for name" }, "usertypes": { "type": "string", "default": "", "description": "requested user types as comma separated list" } } } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the bpkbf prefixed with BF:" }, "idp_subjectid_v1": { "type": "string", "description": "the global subject id based on bpkbf (v1)" }, "deleted": { "type": "boolean", "description": "user account is deleted" }, "suspended": { "type": "boolean", "description": "user account is suspended" }, "timechanged": { "type": "integer", "description": "UNIX timestamp of last change" }, "firstname": { "type": "string" }, "middlename": { "type": "string" }, "lastname": { "type": "string" }, "title_acad_prefix": { "type": "string" }, "title_acad_suffix": { "type": "string" }, "title_job": { "type": "string" }, "title_official": { "type": "string" }, "email": { "type": "string" }, "phone1": { "type": "string" }, "phone2": { "type": "string" }, "dateofbirth": { "type": "string", "description": "date of birth in format YYYY-mm-dd" }, "gender": { "type": "string", "description": "m = male | w = female | d = diverse | o = open | i = inter | k = not specified | u = unknown" }, "photo_official_hash": { "type": "string", "description": "contenthash of the official photograph" }, "photo_profile_hash": { "type": "string", "description": "contenthash of the profile picture" }, "street": { "type": "string" }, "zip": { "type": "string" }, "city": { "type": "string" }, "district": { "type": "string" }, "country": { "type": "string" }, "children": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the bpkbf prefixed with BF:" } }, "required": [ "bpkbf" ] } }, "relatives": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the bpkbf prefixed with BF:" }, "type": { "type": "string", "description": "ENUM(\"father\", \"mother\", \"grandmother\")" }, "islgn": { "type": "boolean", "description": "is legal guardian" }, "ispayer": { "type": "boolean", "description": "is payer" } }, "required": [ "bpkbf", "type", "islgn", "ispayer" ] } }, "assignedorgids": { "type": "array", "items": { "type": "string", "description": "role" } }, "mainorgids": { "type": "array", "items": { "type": "string", "description": "role" } }, "sapids": { "type": "array", "items": { "type": "string", "description": "sapid" } }, "sokratesids": { "type": "array", "items": { "type": "string", "description": "sokratesid" } }, "orgs": { "type": "array", "items": { "type": "object", "properties": { "orgid": { "type": "string", "description": "orgid" }, "roles": { "type": "array", "items": { "type": "string", "description": "role" } }, "classes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "name" } }, "required": [ "name" ] } }, "departments": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "name" } }, "required": [ "name" ] } } }, "required": [ "orgid" ] } }, "idpusername": { "type": "string", "description": "A unique username for local use" } }, "required": [ "bpkbf", "deleted", "suspended", "timechanged", "orgs" ] } } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_eduportal_iface_searchuserdata_v3": { "post": { "tags": [ "Nutzerdaten" ], "summary": "Stammdaten \u00fcber Personen suchen V3", "description": "# Nutzerdaten suchen\n\nDiese Schnittstelle erm\u00f6glicht es Partneranwendungen Daten \u00fcber Personen einer Organisation zu suchen, auf die die Anwendung zugreifen darf.\n\nSie __m\u00fcssen mindestens__ eines der folgenden Kriterien angeben\n- `bpkbf` _oder_\n- `idp_subjectid_v1` _oder_\n- `sapid` _oder_\n- `sokratesid` _oder_\n- `dateofbirth` _und_ `zip`\n\nSie __k\u00f6nnen__ Ihre Suche spezifischer machen, indem Sie einen Namen angeben.\nBeliebige Teile des Namens oder mehrere durch Leerzeichen getrennte Namensteile sind erlaubt.\nGro\u00df- und Kleinschreibung wird ignoriert, die Akzentsensibilit\u00e4t ist deaktiviert (bspw. wird eine Suche nach \"Hacek\" auch den Namen \"Ha\u010dek\" finden).\nMit dem Attribut `usertypes` k\u00f6nnen Sie steuern, dass Sie nur Benutzer aus dem jeweiligen Benutzertyp erhalten. Wenn Sie das Feld leer lassen, erhalten Sie alle Benutzertypen\nauf die Ihre Anwendung zugreifen darf.\n\n__Bitte beachten Sie, dass diese Dokumentation das Maximum an Daten darstellt, die mit Hilfe dieser Schnittstelle abgerufen werden k\u00f6nnen.\nIm Hinblick auf Datenminimierung kann die Anzahl der Attribute oder der verf\u00fcgbaren Benutzertypen f\u00fcr Ihre Anwendung reduziert werden.__\n", "requestBody": { "description": "Parameters for local_eduportal_iface_searchuserdata_v3", "content": { "application/json": { "schema": { "type": "object", "properties": { "bpkbf": { "type": "string", "default": "", "description": "search for a bpkbf" }, "documentid": { "type": "string", "default": "", "description": "search for a documentid for the official signature service" }, "idp_subjectid_v1": { "type": "string", "default": "", "description": "search for a BiP Identity" }, "sapid": { "type": "integer", "default": 0, "description": "search for a sapid" }, "sokratesid": { "type": "integer", "default": 0, "description": "search for a sokratesid" }, "dateofbirth": { "type": "string", "default": 0, "description": "search for a dateofbirth (YYYY-MM-DD), must be used in conjunction with zip" }, "zip": { "type": "integer", "default": 0, "description": "search within a known ZIP, must be used in conjunction with dateofbirth" }, "name": { "type": "string", "default": "", "description": "search for name" }, "usertypes": { "type": "string", "default": "", "description": "requested user types as comma separated list" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bpkbf": { "type": "string", "default": "", "description": "search for a bpkbf" }, "documentid": { "type": "string", "default": "", "description": "search for a documentid for the official signature service" }, "idp_subjectid_v1": { "type": "string", "default": "", "description": "search for a BiP Identity" }, "sapid": { "type": "integer", "default": 0, "description": "search for a sapid" }, "sokratesid": { "type": "integer", "default": 0, "description": "search for a sokratesid" }, "dateofbirth": { "type": "string", "default": 0, "description": "search for a dateofbirth (YYYY-MM-DD), must be used in conjunction with zip" }, "zip": { "type": "integer", "default": 0, "description": "search within a known ZIP, must be used in conjunction with dateofbirth" }, "name": { "type": "string", "default": "", "description": "search for name" }, "usertypes": { "type": "string", "default": "", "description": "requested user types as comma separated list" } } } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "the BPK-BF prefixed with BF:" }, "idp_subjectid_v1": { "type": "string", "description": "the global subject ID" }, "deleted": { "type": "boolean", "description": "whether the user account has been deleted" }, "suspended": { "type": "boolean", "description": "whether the user account is suspended" }, "timechanged": { "type": "integer", "description": "UNIX timestamp of last modification" }, "firstname": { "type": "string", "description": "first name" }, "firstname_official": { "type": "string", "description": "officially registered firstname" }, "middlename": { "type": "string", "description": "middle name" }, "lastname": { "type": "string", "description": "last name" }, "dateofbirth": { "type": "string", "description": "date of birth (YYYY-MM-DD)" }, "gender": { "type": "string", "description": "gender code" }, "photo_official_hash": { "type": "string", "description": "official photo hash" }, "photo_profile_hash": { "type": "string", "description": "profile photo hash" }, "title_acad_prefix": { "type": "string", "description": "academic title prefix" }, "title_acad_suffix": { "type": "string", "description": "academic title suffix" }, "title_job": { "type": "string", "description": "job title" }, "title_official": { "type": "string", "description": "official title" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "field identifier" }, "value": { "type": "string", "description": "email address" }, "orgid": { "type": "string", "description": "organization ID" }, "official": { "type": "boolean", "description": "true if this is an official email address, false if it is private" }, "preferred": { "type": "string", "description": "preferred flag" } }, "required": [ "field", "value", "orgid", "official", "preferred" ] } }, "phonenumbers": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "field identifier" }, "value": { "type": "string", "description": "phone number" }, "orgid": { "type": "string", "description": "organization ID" }, "official": { "type": "boolean", "description": "true if this is an official phone number, false if it is private" }, "preferred": { "type": "string", "description": "preferred flag" } }, "required": [ "field", "value", "orgid", "official", "preferred" ] } }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "address type" }, "street": { "type": "string", "description": "street" }, "streetnumber": { "type": "string", "description": "street number" }, "zip": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "city" }, "district": { "type": "string", "description": "district" }, "country": { "type": "string", "description": "country" }, "orgid": { "type": "string", "description": "organization ID" } }, "required": [ "orgid" ] } }, "children": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "child BPK-BF" } }, "required": [ "bpkbf" ] } }, "relatives": { "type": "array", "items": { "type": "object", "properties": { "bpkbf": { "type": "string", "description": "relative BPK-BF" }, "type": { "type": "string", "description": "relationship type" }, "islgn": { "type": "boolean", "description": "is legal guardian" }, "ispayer": { "type": "boolean", "description": "is payer" } }, "required": [ "bpkbf", "type", "islgn", "ispayer" ] } }, "assignedorgids": { "type": "array", "items": { "type": "string", "description": "org ID" } }, "mainorgids": { "type": "array", "items": { "type": "string", "description": "org ID" } }, "sapids": { "type": "array", "items": { "type": "object", "properties": { "orgid": { "type": "string", "description": "organization ID" }, "sapid": { "type": "integer", "description": "SAP ID" }, "role": { "type": "string" }, "roletype": { "type": "string", "description": "role (same as the role field, this is deprecated and will be removed)" } }, "required": [ "orgid", "sapid", "role", "roletype" ] } }, "sokratesids": { "type": "array", "items": { "type": "string", "description": "Sokrates ID" } }, "orgs": { "type": "array", "items": { "type": "object", "properties": { "orgid": { "type": "string", "description": "organization ID" }, "roles": { "type": "array", "items": { "type": "string", "description": "role name" } }, "classes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "class name" } }, "required": [ "name" ] } }, "departments": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "department name" } }, "required": [ "name" ] } }, "externalgroups": { "type": "array", "items": { "type": "object", "properties": { "uniqid": { "type": "string", "description": "a unique id" }, "name": { "type": "string", "description": "display name of the group" }, "roletype": { "type": "string", "description": "the role the user as within the group (std, tch, ...)" }, "validstart": { "type": "string", "description": "when the group was started (Y-m-d H:i:s)" }, "validend": { "type": "string", "description": "when the groups ends (Y-m-d H:i:s)" } }, "required": [ "uniqid", "name" ] } }, "lessongroups": { "type": "array", "items": { "type": "object", "properties": { "uniqid": { "type": "string", "description": "a unique id" }, "name": { "type": "string", "description": "display name of the group" }, "roletype": { "type": "string", "description": "the role the user as within the group (std, tch, ...)" }, "validstart": { "type": "string", "description": "when the group was started (Y-m-d H:i:s)" }, "validend": { "type": "string", "description": "when the groups ends (Y-m-d H:i:s)" } }, "required": [ "uniqid", "name" ] } }, "orgfunctions": { "type": "array", "items": { "type": "object", "properties": { "uniqid": { "type": "string", "description": "a unique id" }, "name": { "type": "string", "description": "display name of the group" }, "roletype": { "type": "string", "description": "the role the user as within the group (std, tch, ...)" }, "validstart": { "type": "string", "description": "when the group was started (Y-m-d H:i:s)" }, "validend": { "type": "string", "description": "when the groups ends (Y-m-d H:i:s)" } }, "required": [ "uniqid", "name" ] } } }, "required": [ "orgid" ] } }, "unassigned_orgs": { "type": "array", "items": { "type": "object", "properties": { "orgid": { "type": "string", "description": "organization ID" }, "role": { "type": "string", "description": "removed role" }, "timechanged": { "type": "integer", "description": "removal timestamp" } }, "required": [ "orgid", "role", "timechanged" ] } }, "idpusername": { "type": "string", "description": "IDP username" } }, "required": [ "bpkbf", "deleted", "suspended", "timechanged", "orgs", "unassigned_orgs" ] } } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_rsv_iface_search_parents": { "post": { "tags": [ "Register- und Systemverbund" ], "summary": "Elterninformationen im RSV abrufen", "description": "# Eltern im RSV suchen\n\nDiese Schnittstelle erm\u00f6glicht es einer Partneranwendung, die Eltern einer Person im RSV zu suchen, auf die sie zugreifen darf.\n\n__Bitte beachten Sie, dass diese Dokumentation das Maximum an Daten darstellt, die mit Hilfe dieser Schnittstelle abgerufen werden k\u00f6nnen.\nIm Hinblick auf Datenminimierung kann die Anzahl der Attribute oder der verf\u00fcgbaren Benutzertypen f\u00fcr Ihre Anwendung reduziert werden.__\n", "requestBody": { "description": "Parameters for local_rsv_iface_search_parents", "content": { "application/json": { "schema": { "type": "object", "properties": { "vbpkzp": { "type": "string", "description": "search for parents of the person with this vbpkzp" } }, "required": [ "vbpkzp" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "vbpkzp": { "type": "string", "description": "search for parents of the person with this vbpkzp" } }, "required": [ "vbpkzp" ] } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "father": { "type": "object", "properties": { "firstname": { "type": "string", "description": "first name" }, "lastname": { "type": "string", "description": "last name" }, "titleprefix": { "type": "string", "description": "title prefix" }, "titlesuffix": { "type": "string", "description": "title suffix" }, "vbpkzp": { "type": "string", "description": "vbPK:ZP" }, "dateofbirth": { "type": "string", "description": "date of birth" }, "country": { "type": "string", "description": "country" }, "street": { "type": "string", "description": "street" }, "streetnumber": { "type": "string", "description": "street number" }, "zip": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "city" }, "bpkbf": { "type": "string", "description": "bPK:BF" } } }, "mother": { "type": "object", "properties": { "firstname": { "type": "string", "description": "first name" }, "lastname": { "type": "string", "description": "last name" }, "titleprefix": { "type": "string", "description": "title prefix" }, "titlesuffix": { "type": "string", "description": "title suffix" }, "vbpkzp": { "type": "string", "description": "vbPK:ZP" }, "dateofbirth": { "type": "string", "description": "date of birth" }, "country": { "type": "string", "description": "country" }, "street": { "type": "string", "description": "street" }, "streetnumber": { "type": "string", "description": "street number" }, "zip": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "city" }, "bpkbf": { "type": "string", "description": "bPK:BF" } } } } } } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/local/eduportal/webservice/server.php/local_rsv_iface_search_person": { "post": { "tags": [ "Register- und Systemverbund" ], "summary": "Stammdaten \u00fcber Personen im RSV abrufen", "description": "# Personen im RSV suchen\n\nDiese Schnittstelle erm\u00f6glicht es einer Partneranwendung, Personen im RSV zu suchen, auf die sie zugreifen darf.\n\n__Bitte beachten Sie, dass diese Dokumentation das Maximum an Daten darstellt, die mit Hilfe dieser Schnittstelle abgerufen werden k\u00f6nnen.\nIm Hinblick auf Datenminimierung kann die Anzahl der Attribute oder der verf\u00fcgbaren Benutzertypen f\u00fcr Ihre Anwendung reduziert werden.__\n", "requestBody": { "description": "Parameters for local_rsv_iface_search_person", "content": { "application/json": { "schema": { "type": "object", "properties": { "firstname": { "type": "string", "default": "", "description": "search for a firstname" }, "lastname": { "type": "string", "default": "", "description": "search for a lastname" }, "dateofbirth": { "type": "string", "default": "", "description": "search for a dateofbirth (YYYY-MM-DD), must be used in conjunction with zip" }, "zip": { "type": "string", "default": 0, "description": "search within a known ZIP, must be used in conjunction with dateofbirth" }, "vbpkzp": { "type": "string", "description": "search for a person with vbpkzp" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "firstname": { "type": "string", "default": "", "description": "search for a firstname" }, "lastname": { "type": "string", "default": "", "description": "search for a lastname" }, "dateofbirth": { "type": "string", "default": "", "description": "search for a dateofbirth (YYYY-MM-DD), must be used in conjunction with zip" }, "zip": { "type": "string", "default": 0, "description": "search within a known ZIP, must be used in conjunction with dateofbirth" }, "vbpkzp": { "type": "string", "description": "search for a person with vbpkzp" } } } } } }, "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "success" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "street": { "type": "string", "description": "street" }, "streetnumber": { "type": "string", "description": "street number" }, "zip": { "type": "integer", "description": "ZIP code" }, "city": { "type": "string", "description": "city" }, "country": { "type": "string", "description": "country" }, "vbpkzp": { "type": "string", "description": "vbPK:ZP" }, "bpkbf": { "type": "string", "description": "bPK:BF" } } } } }, "required": [ "type" ] } } } }, "400": { "description": "invalid parameter", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "401": { "description": "authentication failed or request expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "access to this interface or data not allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "404": { "description": "requested object not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "409": { "description": "request conflicts with the current state", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "500": { "description": "other error", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "501": { "description": "requested functionality is not implemented", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "error" ], "properties": { "type": { "type": "string", "enum": [ "error" ] }, "error": { "type": "object", "required": [ "message" ], "properties": { "errorcode": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "security": [ { "basicAuth": [] } ] } } }, "tags": [ { "name": "Datenverbund Schulen" }, { "name": "Marktplatz Lernapps" }, { "name": "Nutzerdaten" }, { "name": "Nutzerinteraktion" }, { "name": "OBSOLET - NICHT MEHR VERWENDEN!" }, { "name": "Register- und Systemverbund" }, { "name": "Schuldaten" } ] }