System Options Service

Back

Overview

System Options represent configurable settings that affect system behavior.

They provide a consistent reference for:

• feature toggles
• tenant-specific configuration values
• controlling system behaviors dynamically

System options are tenant-scoped and are referenced by multiple modules.

All operations are tenant-aware and scoped to the current tenant.

Endpoints

Back to Reference

GET

/api/v1/SystemOptions

Returns all system options for the current tenant.

Behavior:

• Returns a list of system options
• Returns 404 if no system options exist

Authorization:

• Requires Bearer Token

GET

/api/v1/SystemOptions/{id}

Returns a single system option by its numeric identifier.

Behavior:

• Looks up a system option by ID
• Returns 404 if the system option does not exist

Authorization:

• Requires Bearer Token

POST

/api/v1/SystemOptions

Creates a new system option.

Request body:

• SystemOptionTypeId (int, required)
• Value (string, required)
• IsActive (bool, optional)
• CreatedAt (DateTime, optional)

Behavior:

• Validation is handled in the service layer via IsReadyToAdd()
• Successful creation writes an audit log entry

Errors:

• Returns 400 if validation -

Authorization:

• Requires Bearer Token

PUT

/api/v1/SystemOptions/{id}

Updates an existing system option.

Request body:

• Same fields as POST

Behavior:

• ID is taken from the route
• Partial updates are not supported
• Successful update writes an audit log entry

Errors:

• Returns 400 if validation - or system option does not exist

Authorization:

• Requires Bearer Token

DELETE

/api/v1/SystemOptions/{id}

Deletes a system option by its ID.

Behavior:

• Performs a hard delete
• Record is permanently removed from the database
• Successful deletion writes an audit log entry

Errors:

• Returns 400 if system option does not exist or deletion -

Authorization:

• Requires Bearer Token

Notes

• Validation is enforced in the service layer
• Deleting a system option does not cascade changes
• All state-changing operations are audited
• Internal errors are logged but not exposed to clients