Klassen
class	AdminSettings

class	DashboardController

class	DepartmentController

class	HolidayApiController

class	UrlaubController

class	UrlaubDepartmentController

class	UrlaubYearController

class	UserManagement

Funktionen
path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response(response:404, description:"User profile not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public getProfile( $userID new OA	Property (property:"last_name", type:"string", example:"Doe")

Variablen
title	__pad0__

title	version

	$format = 'json'

path	__pad1__
	HTTP-spezifischer Kontext.

path	tags

path	summary

path	parameters

path	in

path	required

path	description

path	schema

path	example

path	responses

path	content

path	type

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response(response:404, description:"User profile not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public function getProfile($userID)	path
	HTTP-spezifischer Kontext.

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response(response:404, description:"User profile not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public function getProfile($userID	requestBody

Dokumentation der Funktionen

◆ Property()

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response(response:404, description:"User profile not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public getProfile($userID new OA App::Controllers::Api::Property	(	property:"last_name"	,
		type:"string"	,
		example:"Doe"	)

protected

Variablen-Dokumentation

◆ $format

App::Controllers::Api::$format = 'json'

protected

◆ pad0

title App::Controllers::Api::__pad0__

AccountSettings Controller

Controller für das Verwalten von Benutzereinstellungen und -profilen.

◆ pad1

path App::Controllers::Api::__pad1__

protected

HTTP-spezifischer Kontext.

Benutzerprofil abrufen

Diese Methode gibt das Benutzerprofil basierend auf der Benutzer-ID zurück.

Parameter

int $userID ID des Benutzers

Rückgabe: Namespace: CodeIgniter; JSON-Antwort mit Benutzerprofil oder Fehlermeldung

API-Endpunkt {get} /api/account-settings/:userID Benutzerprofil abrufen

API Name: \1 GetProfile

API Group: \1 AccountSettings

API Parameter: \1 {Number} userID Die ID des Benutzers

API Success: \1 {String} status Status der Anfrage (success)

API Success: \1 {Object} data Das Benutzerprofil

API Error: \1 404 Benutzerprofil nicht gefunden

◆ content

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response(response:404, description:"User profile not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public getProfile($userID new OA new OA Property(property:"email", type:"string", example:"john.doe@example.com") new OA Property (property:"phone", type:"string", example:"+491234567890")] App::Controllers::Api::content

protected

◆ description

path App::Controllers::Api::description

protected

◆ example

path App::Controllers::Api::example

protected

◆ in

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response (response:404, description:"User profile not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public function getProfile( $userID App::Controllers::Api::in

protected

◆ parameters

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response (response:404, description:"User profile not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public function getProfile( $userID App::Controllers::Api::parameters

protected

◆ path

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response (response:404, description:"User profile not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public function getProfile( $userID) App::Controllers::Api::path

protected

HTTP-spezifischer Kontext.

Benutzerprofil aktualisieren

Diese Methode aktualisiert das Benutzerprofil basierend auf der Benutzer-ID und den übergebenen Daten.

Parameter

int $userID ID des Benutzers

Rückgabe: Namespace: CodeIgniter; JSON-Antwort mit Erfolgsmeldung oder Fehlermeldung

API-Endpunkt {put} /api/account-settings/:userID Benutzerprofil aktualisieren

API Name: \1 UpdateProfile

API Group: \1 AccountSettings

API Parameter: \1 {Number} userID Die ID des Benutzers

API Parameter: \1 {String} first_name Der Vorname des Benutzers

API Parameter: \1 {String} last_name Der Nachname des Benutzers

API Parameter: \1 {String} email Die E-Mail-Adresse des Benutzers

API Parameter: \1 {String} [phone] Die Telefonnummer des Benutzers (optional)

API Success: \1 {String} status Status der Anfrage (success)

API Success: \1 {String} message Erfolgsnachricht

API Error: \1 400 Validierungsfehler oder fehlende Daten

API Error: \1 404 Benutzerprofil nicht gefunden

◆ requestBody

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response (response:404, description:"User profile not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public function getProfile( $userID App::Controllers::Api::requestBody

protected

◆ required

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response (response:404, description:"User profile not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public function getProfile( $userID App::Controllers::Api::required

protected

◆ responses

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response(response:404, description:"User profile not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public getProfile($userID new OA new OA Property(property:"email", type:"string", example:"john.doe@example.com") new OA Property (property:"phone", type:"string", example:"+491234567890")])) App::Controllers::Api::responses

protected

◆ schema

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response (response:404, description:"User profile not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public function getProfile( $userID App::Controllers::Api::schema

protected

◆ summary

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response (response:404, description:"User profile not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public function getProfile( $userID App::Controllers::Api::summary

protected

◆ tags

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response (response:404, description:"User profile not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public function getProfile( $userID App::Controllers::Api::tags

protected

◆ type

path new OA Property(property:"data", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"first_name", type:"string", example:"John"), new OA\Property(property:"last_name", type:"string", example:"Doe"), new OA\Property(property:"email", type:"string", example:"john.doe@example.com"), new OA\Property(property:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])])) new OA Response(response:404, description:"User profile not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzerprofil nicht gefunden.")]))])] public getProfile($userID new OA new OA Property(property:"email", type:"string", example:"john.doe@example.com") new OA Property (property:"phone", type:"string", example:"+491234567890")] App::Controllers::Api::type

protected

◆ version

title App::Controllers::Api::version

Klassen

Funktionen

Variablen

Dokumentation der Funktionen

◆ Property()

Variablen-Dokumentation

◆ $format

◆ __pad0__

◆ __pad1__

◆ content

◆ description

◆ example

◆ in

◆ parameters

◆ path

◆ requestBody

◆ required

◆ responses

◆ schema

◆ summary

◆ tags

◆ type

◆ version

◆ pad0

◆ pad1