page title decoration image

Standard-Antworten — V1

Standard-Antworten — V1

Diese Antworten werden über $ref von praktisch jedem Endpoint referenziert. Hier nachschlagen, statt sie pro Endpoint einzeln zu lesen.

Name	Code	Beschreibung	Schema
Success	200	Successful operation	`SuccessResponse`
Success201	201	Successful operation	`SuccessResponse`
BadRequest	400	Invalid request or missing required parameters	`ErrorResponse`
JWTError	401	Authentication error (JWT token missing/invalid)	`ErrorResponse`
Forbidden	403	Access denied (insufficient permissions)	`ErrorResponse`
NotFound	404	Resource not found	`ErrorResponse`
Conflict	409	Locking conflict or version conflict	`ErrorResponse`
StandardError	500	Internal server error	`ErrorResponse`

Success

Successful operation

Content-Type: application/json
Schema: SuccessResponse → SuccessResponse

{
  "status": "success",
  "code": 200,
  "message": "Operation completed successfully",
  "details": []
}

Success201

Successful operation

Content-Type: application/json
Schema: SuccessResponse → SuccessResponse

{
  "status": "success",
  "code": 201,
  "message": "Operation completed successfully",
  "details": []
}

BadRequest

Invalid request or missing required parameters

Content-Type: application/json
Schema: ErrorResponse → ErrorResponse

{
  "status": "error",
  "code": 400,
  "message": "Invalid request",
  "details": "Validation error"
}

JWTError

Authentication error (JWT token missing/invalid)

Content-Type: application/json
Schema: ErrorResponse → ErrorResponse

{
  "status": "error",
  "code": 401,
  "message": "Authentication failed",
  "details": "JWT token not found"
}

Forbidden

Access denied (insufficient permissions)

Content-Type: application/json
Schema: ErrorResponse → ErrorResponse

{
  "status": "error",
  "code": 403,
  "message": "Access denied",
  "details": "Insufficient permissions"
}

NotFound

Resource not found

Content-Type: application/json
Schema: ErrorResponse → ErrorResponse

{
  "status": "error",
  "code": 404,
  "message": "Not found",
  "details": "The requested resource was not found"
}

Conflict

Locking conflict or version conflict

Content-Type: application/json
Schema: ErrorResponse → ErrorResponse

{
  "status": "error",
  "code": 409,
  "message": "Conflict",
  "details": "Locking conflict"
}

StandardError

Internal server error

Content-Type: application/json
Schema: ErrorResponse → ErrorResponse

{
  "status": "error",
  "code": 500,
  "message": "Internal server error",
  "details": "An internal server error occurred"
}