Klassendiagramm für App::Controllers::Api::UserManagement:

Zusammengehörigkeiten von App::Controllers::Api::UserManagement:

[Legende]

Geschützte Methoden
path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers 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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")])]))

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response(response:404, description:"User not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public getUser( $userID new OA	Property (property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Employee"), new OA\Property(property:"department", type:"string", example:"HR")]))]))

Geschützte Attribute
	$modelName = 'App\Models\UserModel'

	$format = 'json'

path	: "/api/users"
	HTTP-spezifischer Kontext.

path	tags: ["Users"]

path	summary: "Retrieve all users with role and department information"

path	responses: [ new OA\Response( response: 200

path	description: "List of users retrieved successfully"

path	content: new OA\JsonContent( properties: [ new OA\Property(property: "status"

path	type: "string"

path	example: "success")

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers()	path: "/api/users/{userID}"
	HTTP-spezifischer Kontext.

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers	tags: ["Users"]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers	summary: "Retrieve a single user with role and department information"

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers	parameters: [ new OA\Parameter( name: "userID"

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers	in: "path"

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers	required: true

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers	description: "ID of the user"

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers	schema: new OA\Schema(type: "integer"

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers	example: 1) ) ]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers	responses: [ new OA\Response( response: 200

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers	content: new OA\JsonContent( properties: [ new OA\Property(property: "status"

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers	type: "string"

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response(response:404, description:"User not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser($userID)	path: "/api/users/department"
	HTTP-spezifischer Kontext.

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response(response:404, description:"User not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser($userID	tags: ["Users"]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response(response:404, description:"User not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser($userID	summary: "Retrieve users by department of the logged-in user"

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response(response:404, description:"User not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser($userID	responses: [ new OA\Response( response: 200

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response(response:404, description:"User not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser($userID	description: "Users retrieved successfully"

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response(response:404, description:"User not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser($userID	content: new OA\JsonContent( properties: [ new OA\Property(property: "status"

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response(response:404, description:"User not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser($userID	type: "string"

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response(response:404, description:"User not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser($userID	example: "success")

Ausführliche Beschreibung

UserManagement

Controller zur Verwaltung von Benutzern, Rollen und Abteilungen.

Dokumentation der Elementfunktionen

◆ Property() [1/2]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response(response:404, description:"User not found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public getUser($userID new OA App::Controllers::Api::UserManagement::Property	(	property:"data"	,
		type:"array"	,
		items:new OA\	Items 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:"role", type:"string", example:"Employee"), new OA\Property(property:"department", type:"string", example:"HR")] )

protected

◆ Property() [2/2]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA App::Controllers::Api::UserManagement::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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")] )

protected

Dokumentation der Datenelemente

◆ $format

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

protected

◆ $modelName

App::Controllers::Api::UserManagement::$modelName = 'App\Models\UserModel'

protected

◆ pad0

path App::Controllers::Api::UserManagement::__pad0__

protected

HTTP-spezifischer Kontext.

Liste aller Benutzer mit Rollen- und Abteilungsinformationen abrufen.

Rückgabe: Namespace: CodeIgniter; JSON-Antwort mit Benutzerinformationen

API-Endpunkt {get} /api/users Alle Benutzer abrufen

API Name: \1 GetAllUsers

API Group: \1 Benutzer

API Success: \1 {Object[]} data Liste aller Benutzer

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

API Error: \1 404 Keine Benutzer gefunden

◆ content [1/3]

path App::Controllers::Api::UserManagement::content

protected

◆ content [2/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response (response:404, description:"No users found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers App::Controllers::Api::UserManagement::content

protected

◆ content [3/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response (response:404, description:"User not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser( $userID App::Controllers::Api::UserManagement::content

protected

◆ description [1/3]

path App::Controllers::Api::UserManagement::description

protected

◆ description [2/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response (response:404, description:"No users found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers App::Controllers::Api::UserManagement::description

protected

◆ description [3/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response (response:404, description:"User not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser( $userID App::Controllers::Api::UserManagement::description

protected

◆ example [1/3]

path App::Controllers::Api::UserManagement::example

protected

◆ example [2/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response (response:404, description:"No users found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers App::Controllers::Api::UserManagement::example

protected

◆ example [3/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response (response:404, description:"User not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser( $userID App::Controllers::Api::UserManagement::example

protected

◆ in

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response (response:404, description:"No users found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers App::Controllers::Api::UserManagement::in

protected

◆ parameters

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response (response:404, description:"No users found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers App::Controllers::Api::UserManagement::parameters

protected

◆ path [1/2]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response (response:404, description:"No users found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers() App::Controllers::Api::UserManagement::path

protected

HTTP-spezifischer Kontext.

Einzelnen Benutzer mit Rollen- und Abteilungsinformationen abrufen.

Parameter

int $userID Die ID des Benutzers

Rückgabe: Namespace: CodeIgniter; JSON-Antwort mit Benutzerdetails

API-Endpunkt {get} /api/users/:userID Einzelnen Benutzer abrufen

API Name: \1 GetUser

API Group: \1 Benutzer

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

API Success: \1 {Object} data Benutzerdetails

API Error: \1 404 Benutzer nicht gefunden

◆ path [2/2]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response (response:404, description:"User not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser( $userID) App::Controllers::Api::UserManagement::path

protected

HTTP-spezifischer Kontext.

Benutzer nach Abteilung abrufen.

Rückgabe: Namespace: CodeIgniter; JSON-Antwort mit Benutzern derselben Abteilung

API-Endpunkt {get} /api/users/department Benutzer nach Abteilung abrufen

API Name: \1 GetUsersByDepartment

API Group: \1 Benutzer

API Success: \1 {Object[]} data Liste der Benutzer in der Abteilung

API Error: \1 401 Benutzer nicht angemeldet

API Error: \1 404 Benutzer oder Abteilung nicht gefunden

◆ required

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response (response:404, description:"No users found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers App::Controllers::Api::UserManagement::required

protected

◆ responses [1/3]

path App::Controllers::Api::UserManagement::responses

protected

◆ responses [2/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response (response:404, description:"No users found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers App::Controllers::Api::UserManagement::responses

protected

◆ responses [3/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response (response:404, description:"User not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser( $userID App::Controllers::Api::UserManagement::responses

protected

◆ schema

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response (response:404, description:"No users found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers App::Controllers::Api::UserManagement::schema

protected

◆ summary [1/3]

path App::Controllers::Api::UserManagement::summary

protected

◆ summary [2/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response (response:404, description:"No users found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers App::Controllers::Api::UserManagement::summary

protected

◆ summary [3/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response (response:404, description:"User not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser( $userID App::Controllers::Api::UserManagement::summary

protected

◆ tags [1/3]

path App::Controllers::Api::UserManagement::tags

protected

◆ tags [2/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response (response:404, description:"No users found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers App::Controllers::Api::UserManagement::tags

protected

◆ tags [3/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response (response:404, description:"User not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser( $userID App::Controllers::Api::UserManagement::tags

protected

◆ type [1/3]

path App::Controllers::Api::UserManagement::type

protected

◆ type [2/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response (response:404, description:"No users found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public function getAllUsers App::Controllers::Api::UserManagement::type

protected

◆ type [3/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(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:"role", type:"string", example:"Admin"), new OA\Property(property:"department", type:"string", example:"IT")]))])) new OA Response(response:404, description:"No users found", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Keine Benutzer gefunden.")]))])] public getAllUsers new OA new OA Response (response:404, description:"User not found", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Benutzer nicht gefunden.")]))])] public function getUser( $userID App::Controllers::Api::UserManagement::type

protected

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

app/Controllers/Api/UserManagement.php

Geschützte Methoden

Geschützte Attribute

Ausführliche Beschreibung

Dokumentation der Elementfunktionen

◆ Property() [1/2]

◆ Property() [2/2]

Dokumentation der Datenelemente

◆ $format

◆ $modelName

◆ __pad0__

◆ content [1/3]

◆ content [2/3]

◆ content [3/3]

◆ description [1/3]

◆ description [2/3]

◆ description [3/3]

◆ example [1/3]

◆ example [2/3]

◆ example [3/3]

◆ in

◆ parameters

◆ path [1/2]

◆ path [2/2]

◆ required

◆ responses [1/3]

◆ responses [2/3]

◆ responses [3/3]

◆ schema

◆ summary [1/3]

◆ summary [2/3]

◆ summary [3/3]

◆ tags [1/3]

◆ tags [2/3]

◆ tags [3/3]

◆ type [1/3]

◆ type [2/3]

◆ type [3/3]

◆ pad0