{ "openapi": "3.2.0", "info": { "title": "Brilliance One API", "description": "Access is based on your login credentials. public static Tools are open for all to use ethically.", "contact": { "name": "Brilliance One Support", "url": "https://brillianceone.com/support" }, "license": { "name": "Proprietary License", "url": "https://brillianceone.com/Legal/api-license" }, "version": "v2026.10.24.1", "summary": "Enterprise SaaS ERP/CRM Infrastructure - Veteran Owned." }, "servers": [ { "url": "https://api.brillianceone.com" } ], "paths": { "/api/v1/health": { "get": { "tags": [ "Health" ], "summary": "System Health", "description": "Public system health endpoint for availability monitoring.", "operationId": "GetApiV1Health", "responses": { "200": { "description": "OK" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ ] } }, "/api/v1/health/internal": { "get": { "tags": [ "Health" ], "summary": "Internal Tenant Health", "description": "Checks tenant-scoped database latency and communication engine status.", "operationId": "GetApiV1HealthInternal", "responses": { "200": { "description": "OK" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/banks": { "get": { "tags": [ "Accounting" ], "summary": "Banking List", "description": "Retrieves a high-level summary of all registered bank accounts, credit cards, and loan accounts. Includes masked account numbers and current balances for dashboarding.", "operationId": "GetBankingGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankingDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Banking", "description": "Creates or updates financial account metadata. Validates account types and ensures unique external provider IDs to prevent duplicate account linking.", "operationId": "SaveBanking", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankingSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/banks/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Banking", "description": "Retrieves the full configuration for a specific account, including external provider links (Plaid/Yodlee) and institution metadata.", "operationId": "GetBanking", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankingDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Banking", "description": "Updates financial account metadata. Validates account types and ensures unique external provider IDs to prevent duplicate account linking.", "operationId": "SaveBankingWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankingSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/banking-transactions": { "get": { "tags": [ "Accounting" ], "summary": "Banking Transaction List", "description": "Retrieves a paginated history of transactions for a specific account. Supports filtering by date, merchant, and 'Pending' status.", "operationId": "GetBankingTransactionGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankingTransactionDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Banking Transaction", "description": "Manually records or updates a transaction. Implements idempotency logic via ExternalTransactionId to prevent double-entry during automated syncs.", "operationId": "SaveBankingTransaction", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankingTransactionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/banking-transactions/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Banking Transaction", "description": "Fetches the comprehensive data for a specific banking transaction, including the raw description from the financial institution, merchant metadata, and any associated external provider identifiers. This level of detail is critical for manual reconciliation and forensic financial auditing.", "operationId": "GetBankingTransaction", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankingTransactionDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Banking Transaction", "description": "Updates a transaction. Implements idempotency logic via ExternalTransactionId to prevent double-entry during automated syncs.", "operationId": "SaveBankingTransactionWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankingTransactionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/bank-reconciliations": { "get": { "tags": [ "Accounting" ], "summary": "Bank Reconciliation List", "description": "Provides a history of past bank reconciliations, showing statement dates and variances.", "operationId": "GetBankReconciliationGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankReconciliationDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Bank Reconciliation", "description": "Executes the finalization of a bank statement. Locks associated transactions to ensure they cannot be modified once cleared, satisfying SOC2 non-repudiation requirements.", "operationId": "SaveBankReconciliation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankReconciliationSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/bank-reconciliations/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Bank Reconciliation", "description": "Fetches the comprehensive data for a specific bank reconciliation. Includes statement dates, variances, and the linked transactions, providing the necessary detail for accurate financial reporting and SOC2-compliant auditing.", "operationId": "GetBankReconciliation", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankReconciliationDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Bank Reconciliation", "description": "Updates the finalization of a bank statement. Locks associated transactions to ensure they cannot be modified once cleared, satisfying SOC2 non-repudiation requirements.", "operationId": "SaveBankReconciliationWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankReconciliationSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/bank-reconciliation-item": { "get": { "tags": [ "Accounting" ], "summary": "Bank Reconciliation Item List", "description": "Retrieves a detailed list of all line items associated with a specific bank reconciliation event. This view allows auditors to verify which internal transactions have been successfully matched (cleared) against bank statement activity, ensuring the integrity of the cash-on-hand balance.", "operationId": "GetBankReconciliationItemGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankReconciliationItemDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Bank Reconciliation Item", "description": "Persists the cleared status of a transaction during the reconciliation process. Validates that items cannot be cleared against closed periods or mismatched account identifiers, maintaining the strict non-repudiation standards required by CMMC and SOC2.", "operationId": "SaveBankReconciliationItem", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankReconciliationItemSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/bank-reconciliation-item/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Bank Reconciliation Item", "description": "Fetches the specific details of a single reconciliation mapping. Includes the link between the internal transaction and the bank statement record, providing the granular evidence needed to resolve variances or discrepancies during financial audits.", "operationId": "GetBankReconciliationItem", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankReconciliationItemDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Bank Reconciliation Item", "description": "Updates the cleared status of a transaction during the reconciliation process. Validates that items cannot be cleared against closed periods or mismatched account identifiers, maintaining the strict non-repudiation standards required by CMMC and SOC2.", "operationId": "SaveBankReconciliationItemWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankReconciliationItemSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/bills": { "get": { "tags": [ "Accounting" ], "summary": "Bill List", "description": "Retrieves all outstanding bills from vendors. Essential for cash-flow forecasting and tracking \"Net-30\" or \"Net-60\" liabilities.", "operationId": "GetBillGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Bill", "description": "Creates or updates a bill. Includes an IsApproved workflow to ensure expenses are vetted before payment is authorized.", "operationId": "SaveBill", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/bills/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Bill", "description": "Fetches the comprehensive data for a specific vendor bill, including the original bill date, terms, and the linked Chart of Accounts (COA) identifiers. Provides the necessary detail for multi-stage approval workflows and financial auditing.", "operationId": "GetBill", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Bill", "description": "Updates a bill. Includes an IsApproved workflow to ensure expenses are vetted before payment is authorized.", "operationId": "SaveBillWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/chart-of-accounts": { "get": { "tags": [ "Accounting" ], "summary": "COA List", "description": "Retrieves the complete organizational structure of the ledger. Categorizes accounts by type (Asset, Liability, Equity, Revenue, Expense) to facilitate financial reporting and system-wide transaction mapping.", "operationId": "GetChartOfAccountGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChartOfAccountDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "COA", "description": "Creates or updates a ledger account. Enforces strict naming and numbering conventions to ensure consistency in the general ledger and compliance with enterprise financial standards.", "operationId": "SaveChartOfAccount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartOfAccountSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/chart-of-accounts/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "COA", "description": "Retrieves the specific configuration for a ledger account, including its classification, parent-child relationships, and its status within the accounting hierarchy.", "operationId": "GetChartOfAccount", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartOfAccountDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "COA", "description": "Updates a ledger account. Enforces strict naming and numbering conventions to ensure consistency in the general ledger and compliance with enterprise financial standards.", "operationId": "SaveChartOfAccountWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartOfAccountSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/credit-memos": { "get": { "tags": [ "Accounting" ], "summary": "Credit Memo List", "description": "Retrieves a paginated list of all credit memos issued within the system. Provides high-level visibility into financial offsets, allowing for the monitoring of returns, adjustments, and customer balances across the accounting module.", "operationId": "GetCreditMemoGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditMemoDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Credit Memo", "description": "Creates a formal adjustment to reduce a customer’s balance. Maintains the audit trail by offsetting an existing invoice rather than deleting financial history.", "operationId": "SaveCreditMemo", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditMemoSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/credit-memos/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Credit Memo", "description": "Fetches the full profile for a specific credit memo. Includes the original reference invoice if applicable, the calculated offset amount, and the justification reason. This data is essential for accurate accounts receivable reconciliation and financial auditing.", "operationId": "GetCreditMemo", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditMemoDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Credit Memo", "description": "Updates a formal adjustment to reduce a customer's balance. Maintains the audit trail by offsetting an existing invoice rather than deleting financial history.", "operationId": "SaveCreditMemoWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditMemoSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/expenses": { "get": { "tags": [ "Accounting" ], "summary": "Expense List", "description": "Retrieves a paginated list of all recorded expenses. This view provides an overview of operational spending, including vendor info, transaction dates, and total costs, allowing for rapid spend analysis and budget monitoring.", "operationId": "GetExpenseGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Expense", "description": "Records immediate outflows of cash, such as fuel, travel, meals, supplies, reimbursements, and other operational expenses. Validates against the Chart of Accounts to ensure correct tax classification.", "operationId": "SaveExpense", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/expenses/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Expense", "description": "Fetches the comprehensive data for a specific expense record. Includes detailed descriptions, tax and shipping breakdowns, and the linked Chart of Accounts (COA) identifiers required for accurate financial reporting and SOC2-compliant auditing.", "operationId": "GetExpense", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Expense", "description": "Updates an immediate outflow of cash, such as fuel, travel, meals, supplies, reimbursements, and other operational expenses. Validates against the Chart of Accounts to ensure correct tax classification.", "operationId": "SaveExpenseWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/investors": { "get": { "tags": [ "Accounting" ], "summary": "Investor List", "description": "Retrieves a list of equity stakeholders, including their ownership percentages and total historical contributions.", "operationId": "GetInvestorGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvestorDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Investor", "description": "Records new capital partners or updates existing stakeholder information. Tracks capital contributions and draws to maintain an accurate Equity section on the Balance Sheet.", "operationId": "SaveInvestor", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestorSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/investors/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Investor", "description": "Provides the full profile for a stakeholder, including distribution preferences and linked accounting identifiers for capital tracking.", "operationId": "GetInvestor", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestorDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Investor", "description": "Updates capital partner or stakeholder information. Tracks capital contributions and draws to maintain an accurate Equity section on the Balance Sheet.", "operationId": "SaveInvestorWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestorSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/investors/details": { "get": { "tags": [ "Accounting" ], "summary": "Investor Detail List", "description": "Retrieves a list of equity stakeholders, including their ownership percentages and total historical contributions.", "operationId": "GetInvestorDetailGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvestorDetailDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Investor Details", "description": "Records new capital partners or updates existing stakeholder information. Tracks capital contributions and draws to maintain an accurate Equity section on the Balance Sheet.", "operationId": "SaveInvestorDetail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestorDetailSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/investors/details/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Investor Details", "description": "Provides the full profile for a stakeholder, including distribution preferences and linked accounting identifiers for capital tracking.", "operationId": "GetInvestorDetail", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestorDetailDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Investor Details", "description": "Updates stakeholder information, ownership details, contribution records, and distribution preferences for capital tracking.", "operationId": "SaveInvestorDetailWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestorDetailSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/invoices": { "get": { "tags": [ "Accounting" ], "summary": "Invoice List", "description": "Retrieves a list of invoices with high-level status including Draft, Sent, and Overdue. Includes totals and balance-due calculations.", "operationId": "GetInvoiceGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Invoice", "description": "Handles creation and modification of invoices. Automatically calculates totals and triggers audit logs for status changes.", "operationId": "SaveInvoice", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/invoices/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Invoice", "description": "Fetches the complete invoice profile, including line items, tax breakdowns, and current payment status.", "operationId": "GetInvoice", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Invoice", "description": "Updates an invoice. Automatically calculates totals and triggers audit logs for status changes.", "operationId": "SaveInvoiceWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/invoices/{identifier}/email": { "post": { "tags": [ "Accounting" ], "summary": "Email Invoice", "description": "Emails an invoice individually to each active email recipient on the related account.", "operationId": "EmailInvoice", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfInvoiceEmailResultDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/invoices/totals/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Invoice Total", "description": "Fetches the overall totals of the invoice.", "operationId": "GetInvoiceTotal", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/invoice-line-items": { "get": { "tags": [ "Accounting" ], "summary": "Invoice Line Item List", "description": "Retrieves all granular line items associated with a specific invoice. Includes service descriptions, quantities, unit prices, and applied tax identifiers.", "operationId": "GetInvoiceLineItemGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GridResponseOfInvoiceLineItemGridDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Invoice Line Item", "description": "Creates a specific invoice line item. Triggers a recalculation of the parent invoice's TotalAmount and TaxAmount to ensure financial consistency.", "operationId": "SaveInvoiceLineItem", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceLineItemSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/invoice-line-items/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Invoice Line Item", "description": "Fetches the specific data for a single row item on an invoice. Used for detailed editing or when recalculating line-specific tax or discount logic.", "operationId": "GetInvoiceLineItem", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceLineItemDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Invoice Line Item", "description": "Updates a specific invoice line item. Triggers a recalculation of the parent invoice's TotalAmount and TaxAmount to ensure financial consistency.", "operationId": "SaveInvoiceLineItemWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceLineItemSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/invoice-notes": { "get": { "tags": [ "Accounting" ], "summary": "Invoice Note List", "description": "Retrieves a history of all internal and public notes associated with a specific invoice for audit and communication tracking.", "operationId": "GetInvoiceNoteGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceNoteDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Invoice Note", "description": "Saves a new note or interaction record. Captures the requester's IP address and geolocation as proof of origin, satisfying CMMC non-repudiation requirements for financial documents.", "operationId": "SaveInvoiceNote", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceNoteSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/invoice-notes/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Invoice Note", "description": "Fetches the full profile for a specific note, including non-repudiation metadata such as the author's IP address and geographic coordinates at the time of entry.", "operationId": "GetInvoiceNote", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceNoteDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Invoice Note", "description": "Updates an invoice note or interaction record. Captures the requester's IP address and geolocation as proof of origin, satisfying CMMC non-repudiation requirements for financial documents.", "operationId": "SaveInvoiceNoteWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceNoteSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/journal-entries": { "get": { "tags": [ "Accounting" ], "summary": "JE List", "description": "Retrieves the individual debit/credit legs associated with journal entries. Used for granular auditing of ledger activity and historical transaction research.", "operationId": "GetJournalEntryGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "JE", "description": "Allows authorized users to perform manual ledger adjustments. Validates that debits and credits are equal before persisting to maintain double-entry integrity.", "operationId": "SaveJournalEntry", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntrySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/journal-entries/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "JE", "description": "Fetches the complete profile for a specific journal entry header. This includes the entry's primary justification, fiscal period assignment, and the status of its balanced state, providing the necessary context for financial auditors.", "operationId": "GetJournalEntry", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "JE", "description": "Updates a manual ledger adjustment. Validates that debits and credits are equal before persisting to maintain double-entry integrity.", "operationId": "SaveJournalEntryWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntrySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/journal-entry-transactions": { "get": { "tags": [ "Accounting" ], "summary": "JE Transaction List", "description": "Retrieves a detailed ledger view of all individual debit and credit transactions. Provides a comprehensive audit trail of how funds are distributed across the Chart of Accounts, allowing for granular financial analysis and period-end verification.", "operationId": "GetJournalEntryTransactionGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryTransactionDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "JE Transaction", "description": "Creates a specific transaction leg. Implements rigorous validation to ensure data integrity and is typically used in conjunction with a parent Journal Entry save to maintain the fundamental accounting equation: Assets = Liabilities + Equity.", "operationId": "SaveJournalEntryTransaction", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryTransactionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/journal-entry-transactions/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "JE Transaction", "description": "Fetches the specific details of a single transaction leg. Includes the associated account identifier, the specific debit or credit amount, and audit metadata to ensure every ledger movement is traceable to its parent Journal Entry.", "operationId": "GetJournalEntryTransaction", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryTransactionDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "JE Transaction", "description": "Updates a specific transaction leg. Implements rigorous validation to ensure data integrity and is typically used in conjunction with a parent Journal Entry save to maintain the fundamental accounting equation: Assets = Liabilities + Equity.", "operationId": "SaveJournalEntryTransactionWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryTransactionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/payments": { "get": { "tags": [ "Accounting" ], "summary": "Payment List", "description": "Retrieves a paginated list of all inbound payments. This view provides a high-level summary of transaction dates, payment methods used, and the total funds applied to outstanding receivables.", "operationId": "GetPaymentGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Payment", "description": "Applies a payment to one or more invoices. Updates the IsPaid status and reduces the outstanding accounts receivable balance.", "operationId": "SavePayment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/payments/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Payment", "description": "Fetches the granular details of a specific payment transaction. Includes the link to the associated Invoice, the payment confirmation reference, and full audit metadata to satisfy SOC2 requirements for financial traceability.", "operationId": "GetPayment", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Payment", "description": "Updates a payment applied to one or more invoices. Updates the IsPaid status and reduces the outstanding accounts receivable balance.", "operationId": "SavePaymentWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/payments/process": { "post": { "tags": [ "Accounting" ], "summary": "Process Payment", "description": "Charges a card through the active payment gateway provider. Card data is scrubbed from memory immediately after the gateway responds. On success the vault token is persisted; the raw card number is never stored.", "operationId": "ProcessPayment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessPaymentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessPaymentResult" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/payment-vaults": { "get": { "tags": [ "Accounting" ], "summary": "Payment Vault List", "description": "Retrieves a list of vaulted payment tokens (Credit Cards/ACH) associated with accounts. Note: This endpoint never exposes raw PAN (Primary Account Number) data, complying with PCI-DSS and SOC2 standards.", "operationId": "GetPaymentVaultGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentVaultDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Payment Vault", "description": "Securely records payment metadata and external gateway tokens. This approach supports PCI-conscious vaulted payment storage, provider portability, and controlled access to sensitive payment data.", "operationId": "SavePaymentVault", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentVaultSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/payment-vaults/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Payment Vault", "description": "Fetches masked metadata and token status for a specific payment method to verify expiration dates and billing address association.", "operationId": "GetPaymentVault", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentVaultDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Payment Vault", "description": "Securely updates payment metadata and external gateway tokens. This approach supports PCI-conscious vaulted payment storage, provider portability, and controlled access to sensitive payment data.", "operationId": "SavePaymentVaultWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentVaultSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/tax-authorities": { "get": { "tags": [ "Accounting" ], "summary": "Tax Authority List", "description": "Retrieves a registry of all government entities including IRS, state departments of revenue, and local tax agencies to which the business remits taxes.", "operationId": "GetTaxAuthorityGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxAuthorityDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounting" ], "summary": "Tax Authority", "description": "Configures tax agencies and their respective rates. Essential for calculating sales tax on invoices and liability tracking for SOC2-compliant reporting.", "operationId": "SaveTaxAuthority", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxAuthoritySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounting/tax-authorities/{identifier}": { "get": { "tags": [ "Accounting" ], "summary": "Tax Authority", "description": "Fetches the specific configuration for a tax agency, including active tax rates, remittance schedules, and linked vendor accounts for automated AP generation.", "operationId": "GetTaxAuthority", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxAuthorityDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounting" ], "summary": "Tax Authority", "description": "Updates tax agencies and their respective rates. Essential for calculating sales tax on invoices and liability tracking for SOC2-compliant reporting.", "operationId": "SaveTaxAuthorityWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxAuthoritySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounts/accounts": { "get": { "tags": [ "Accounts" ], "summary": "Account List", "description": "Retrieves a list of accounts for the current account/tenant.", "operationId": "GetAccountGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Accounts" ], "summary": "Account", "description": "Creates an account. Returns the saved account result.", "operationId": "SaveAccount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/accounts/accounts/{identifier}": { "get": { "tags": [ "Accounts" ], "summary": "Account", "description": "Retrieves the full account profile for editing. Middleware handles the BrillianceApiResult wrapper.", "operationId": "GetAccount", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Accounts" ], "summary": "Account", "description": "Updates an account. Returns the saved account result.", "operationId": "SaveAccountWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/agency/agency": { "get": { "tags": [ "Agency" ], "summary": "Agency List", "description": "Retrieves a list of agencies for the current agency/tenant.", "operationId": "GetAgencyGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgencyDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Agency" ], "summary": "Agency", "description": "Creates an agency. Returns the saved agency result.", "operationId": "SaveAgency", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgencySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/agency/agency/{identifier}": { "get": { "tags": [ "Agency" ], "summary": "Agency", "description": "Retrieves the full agency profile for editing. Middleware handles the BrillianceApiResult wrapper.", "operationId": "GetAgency", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgencyDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Agency" ], "summary": "Agency", "description": "Updates an agency. Returns the saved agency result.", "operationId": "SaveAgencyWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgencySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/agency/api-key/{identifier}": { "get": { "tags": [ "Agency" ], "summary": "API Key", "description": "Retrieves the API key profile for editing. Sensitive API key values should be masked or protected by repository/model behavior.", "operationId": "GetAgencyApiKey", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgencyApiKeyDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Agency" ], "summary": "API Key", "description": "Updates an agency API key. API secrets should never be logged, exposed in metadata, or returned after creation unless explicitly designed as a one-time reveal.", "operationId": "SaveAgencyApiKeyWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgencyApiKeySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/agency/api-key/regarding/{regardingIdentifier}": { "get": { "tags": [ "Agency" ], "summary": "API Key by Agency", "description": "Retrieves the API key for a given agency regarding identifier. Sensitive API key values should be masked or protected by repository/model behavior.", "operationId": "GetAgencyApiKeyByRegarding", "parameters": [ { "name": "regardingIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgencyApiKeyDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/agency/api-key": { "post": { "tags": [ "Agency" ], "summary": "API Key", "description": "Creates an agency API key. API secrets should never be returned after creation unless explicitly designed as a one-time reveal.", "operationId": "SaveAgencyApiKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgencyApiKeySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/agency/connection/{identifier}": { "get": { "tags": [ "Agency" ], "summary": "Connection", "description": "Retrieves the full agency connection profile for editing. Sensitive connection values should be protected, audited, and never written to logs or sequence metadata.", "operationId": "GetConnection", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgencyConnectionDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Agency" ], "summary": "Connection", "description": "Updates an agency connection. Connection secrets should be encrypted before persistence and never exposed in logs, audit metadata, or sequence metadata.", "operationId": "SaveConnectionWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgencyConnectionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/agency/connection": { "post": { "tags": [ "Agency" ], "summary": "Connection", "description": "Creates an agency connection. Connection secrets should be encrypted before persistence and never exposed in logs, audit metadata, or sequence metadata.", "operationId": "SaveConnection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgencyConnectionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/agency/license": { "get": { "tags": [ "Agency" ], "summary": "License List", "description": "Retrieves a list of agency licenses for the current agency/tenant.", "operationId": "GetAgencyLicenseGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgencyLicenseGridDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Agency" ], "summary": "License", "description": "Creates or updates an agency license. Returns the saved agency license result.", "operationId": "SaveAgencyLicense", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgencyLicenseSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/agency/license/synchronize": { "post": { "tags": [ "Agency" ], "summary": "Synchronize License", "description": "Synchronizes the current agency/tenant license information with the tenant database.", "operationId": "SynchronizeAgencyLicense", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/agency/license/{agencyIdentifier}/synchronize": { "post": { "tags": [ "Agency" ], "summary": "Synchronize Agency License", "description": "Synchronizes license information for the specified agency with its tenant database.", "operationId": "SynchronizeAgencyLicenseByIdentifier", "parameters": [ { "name": "agencyIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/agency/task": { "post": { "tags": [ "Agency" ], "summary": "Agency Admin Task", "description": "Executes protected agency database provisioning tasks including database creation, user provisioning, and related administrative setup.", "operationId": "RunAdminTask", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgencyAdminTaskRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfAgencyAdminTaskResult" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/auth/login": { "post": { "tags": [ "Auth" ], "summary": "Login", "description": "Provides endpoints for handling authorization automations.", "operationId": "Login", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequestDto" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/auth/2fa/active": { "post": { "tags": [ "Auth" ], "summary": "Enable / Disable Two-Factor Authentication", "description": "Provides endpoints for handling authorization automations.", "operationId": "UpdateStatus", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TwoFactorToggleDto" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/auth/2fa/setup": { "get": { "tags": [ "Auth" ], "summary": "Initialize Two-Factor Authentication Setup", "description": "Provides endpoints for handling authorization automations.", "operationId": "Setup", "responses": { "200": { "description": "OK" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/auth/2fa/verify": { "post": { "tags": [ "Auth" ], "summary": "Verify Two-Factor Authentication Challenge", "description": "Provides endpoints for handling authorization automations.", "operationId": "Verify", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TwoFactorVerifyDto" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/auth/me": { "get": { "tags": [ "Auth" ], "summary": "Get current authenticated user", "description": "Provides endpoints for handling authorization automations.", "operationId": "GetCurrentUser", "responses": { "200": { "description": "OK" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/auth/register": { "post": { "tags": [ "Auth" ], "summary": "Register new user", "description": "Provides endpoints for handling authorization automations.", "operationId": "RegisterUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequestDto" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/auth/refresh": { "post": { "tags": [ "Auth" ], "summary": "Refresh access token (rotate refresh token)", "description": "Provides endpoints for handling authorization automations.", "operationId": "Refresh", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthRefreshRequestDto" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/auth/logout": { "post": { "tags": [ "Auth" ], "summary": "Logout (Revoke Session)", "description": "Provides endpoints for handling authorization automations.", "operationId": "Logout", "responses": { "200": { "description": "OK" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/auth/recover-password": { "post": { "tags": [ "Auth" ], "summary": "Request password recovery", "description": "Provides endpoints for handling authorization automations.", "operationId": "RecoverPassword", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecoveryRequestDto" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/auth/update-password": { "post": { "tags": [ "Auth" ], "summary": "Complete password recovery (update password)", "description": "Provides endpoints for handling authorization automations.", "operationId": "UpdatePassword", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePasswordDto" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/automations/automation/start": { "get": { "tags": [ "Automations" ], "summary": "Automation List", "description": "Retrieves a list of automations for the current account/tenant.", "operationId": "StartWorkflow", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/ada-components": { "get": { "tags": [ "CMS" ], "summary": "ADA Component List", "description": "Retrieves a high-level summary of all registered ADA components.", "operationId": "GetAdaComponentsGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdaComponentDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "CMS" ], "summary": "ADA Component", "description": "Creates or updates ADA component metadata.", "operationId": "SaveAdaComponents", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdaComponentSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/ada-components/{identifier}": { "get": { "tags": [ "CMS" ], "summary": "ADA Component", "description": "Retrieves the full configuration for a specific ADA component.", "operationId": "GetAdaComponents", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdaComponentDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "CMS" ], "summary": "ADA Component", "description": "Updates ADA component metadata.", "operationId": "SaveAdaComponentsWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdaComponentSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/blog-posts": { "get": { "tags": [ "CMS" ], "summary": "Blog Post List", "description": "Retrieves a grid/list of blog posts for the current tenant.", "operationId": "GetBlogPostGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlogPostDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "CMS" ], "summary": "Blog Post", "description": "Creates or saves a blog post.", "operationId": "SaveBlogPost", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlogPostSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/blog-posts/{identifier}": { "get": { "tags": [ "CMS" ], "summary": "Blog Post", "description": "Retrieves a specific blog post by identifier.", "operationId": "GetBlogPost", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BlogPostDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "CMS" ], "summary": "Blog Post", "description": "Updates a blog post.", "operationId": "SaveBlogPostWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlogPostSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/case-studies": { "get": { "tags": [ "CMS" ], "summary": "Case Study List", "description": "Retrieves a grid/list of case studies for the current tenant.", "operationId": "GetCaseStudyGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseStudyDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "CMS" ], "summary": "Case Study", "description": "Creates or saves a case study.", "operationId": "SaveCaseStudy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseStudySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/case-studies/{identifier}": { "get": { "tags": [ "CMS" ], "summary": "Case Study", "description": "Retrieves a specific case study by identifier.", "operationId": "GetCaseStudy", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseStudyDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "CMS" ], "summary": "Case Study", "description": "Updates a case study.", "operationId": "SaveCaseStudyWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseStudySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/faqs": { "get": { "tags": [ "CMS" ], "summary": "FAQ List", "description": "Retrieves a grid/list of FAQ headers for the current tenant.", "operationId": "GetFaqHeaderGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FaqHeaderDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "CMS" ], "summary": "FAQ", "description": "Creates or saves an FAQ header.", "operationId": "SaveFaqHeader", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaqHeaderSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/faqs/{identifier}": { "get": { "tags": [ "CMS" ], "summary": "FAQ", "description": "Retrieves a specific FAQ header by identifier.", "operationId": "GetFaqHeader", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FaqHeaderDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "CMS" ], "summary": "FAQ", "description": "Updates an FAQ header.", "operationId": "SaveFaqHeaderWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaqHeaderSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/faqs/details": { "get": { "tags": [ "CMS" ], "summary": "FAQ Detail List", "description": "Retrieves a grid/list of FAQ details for the current tenant.", "operationId": "GetFaqDetailGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FaqDetailDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "CMS" ], "summary": "FAQ Detail", "description": "Creates or saves an FAQ detail.", "operationId": "SaveFaqDetail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaqDetailSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/faqs/details/{identifier}": { "get": { "tags": [ "CMS" ], "summary": "FAQ Detail", "description": "Retrieves a specific FAQ detail by identifier.", "operationId": "GetFaqDetail", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FaqDetailDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "CMS" ], "summary": "FAQ Detail", "description": "Updates an FAQ detail.", "operationId": "SaveFaqDetailWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaqDetailSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/forms/{formIdentifier}": { "get": { "tags": [ "CMS" ], "summary": "Form Definition", "description": "Retrieves the public form definition and template for a specific form.", "operationId": "GetFormById", "parameters": [ { "name": "formIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicFormDefinitionResponseDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/forms/submit/{formIdentifier}": { "post": { "tags": [ "CMS" ], "summary": "Form Submission", "description": "Submits public form data for a specific form.", "operationId": "SubmitForm", "parameters": [ { "name": "formIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicFormSubmissionRequestDto" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/forms/fields": { "get": { "tags": [ "CMS" ], "summary": "Form Field List", "description": "Retrieves a grid/list of CMS form fields for the current tenant.", "operationId": "GetFormFieldGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FormFieldDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "CMS" ], "summary": "Form Field", "description": "Creates or saves a CMS form field.", "operationId": "SaveFormField", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormFieldSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/forms/fields/{identifier}": { "get": { "tags": [ "CMS" ], "summary": "Form Field", "description": "Retrieves a specific CMS form field by identifier.", "operationId": "GetFormField", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FormFieldDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "CMS" ], "summary": "Form Field", "description": "Updates a CMS form field.", "operationId": "SaveFormFieldWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormFieldSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/forms/modules": { "get": { "tags": [ "CMS" ], "summary": "Form Module List", "description": "Retrieves a grid/list view of CMS form modules for the authenticated tenant.", "operationId": "GetFormModuleGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FormModuleDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "CMS" ], "summary": "Form Module", "description": "Creates or updates a CMS form module configuration.", "operationId": "SaveFormModule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormModuleSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/forms/modules/{identifier}": { "get": { "tags": [ "CMS" ], "summary": "Form Module", "description": "Retrieves the full configuration for a specific CMS form module.", "operationId": "GetFormModule", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormModuleDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "CMS" ], "summary": "Form Module", "description": "Updates an existing CMS form module configuration.", "operationId": "SaveFormModuleWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormModuleSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/page-contents": { "get": { "tags": [ "CMS" ], "summary": "Page Content List", "description": "Retrieves a grid/list view of CMS page content records for the authenticated tenant.", "operationId": "GetPageContentGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PageContentDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "CMS" ], "summary": "Page Content", "description": "Creates or updates CMS page content.", "operationId": "SavePageContent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageContentSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/page-contents/{identifier}": { "get": { "tags": [ "CMS" ], "summary": "Page Content", "description": "Retrieves the full configuration and content for a specific CMS page content record.", "operationId": "GetPageContent", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageContentDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "CMS" ], "summary": "Page Content", "description": "Updates an existing CMS page content record.", "operationId": "SavePageContentWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageContentSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/page-contents/reserved": { "get": { "tags": [ "CMS" ], "summary": "Check Email Availability", "description": "Validates an email address and checks if it exists in subscribers, users, suppression list, or blocked sources.", "operationId": "CheckReservedUrlAvailability", "parameters": [ { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "checkSubscribers", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "checkAddress", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "checkUsers", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "checkSuppressionList", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "checkIntrusionDetections", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberEmailLookupResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/redirect-urls": { "get": { "tags": [ "CMS" ], "summary": "Redirect URL List", "description": "Retrieves a grid/list view of CMS redirect URL records for the authenticated tenant.", "operationId": "GetRedirectUrlGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RedirectUrlDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "CMS" ], "summary": "Redirect URL", "description": "Creates or updates a CMS redirect URL record.", "operationId": "SaveRedirectUrl", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedirectUrlSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/redirect-urls/{identifier}": { "get": { "tags": [ "CMS" ], "summary": "Redirect URL", "description": "Retrieves the full configuration for a specific CMS redirect URL record.", "operationId": "GetRedirectUrl", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedirectUrlDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "CMS" ], "summary": "Redirect URL", "description": "Updates an existing CMS redirect URL record.", "operationId": "SaveRedirectUrlWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedirectUrlSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/search-engines": { "get": { "tags": [ "CMS" ], "summary": "SEO List", "description": "Retrieves a grid/list view of CMS SEO metadata records for the authenticated tenant.", "operationId": "GetSeoGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeoDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "CMS" ], "summary": "SEO", "description": "Creates or updates CMS SEO metadata.", "operationId": "SaveSeo", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeoMetaDataSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/cms/search-engines/{identifier}": { "get": { "tags": [ "CMS" ], "summary": "SEO", "description": "Retrieves the full SEO metadata configuration for a specific CMS record.", "operationId": "GetSeo", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeoDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "CMS" ], "summary": "SEO", "description": "Updates an existing CMS SEO metadata record.", "operationId": "SaveSeoWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeoMetaDataSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/campaigns": { "get": { "tags": [ "Communications" ], "summary": "Campaign List", "description": "Retrieves a paginated, filterable, and sortable list of campaigns. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetCampaignGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Communications" ], "summary": "Campaign", "description": "Creates a new campaign. Validates all required fields and business rules before creation. Returns the created campaign with its assigned identifier.", "operationId": "SaveCampaign", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/campaigns/{identifier}": { "get": { "tags": [ "Communications" ], "summary": "Campaign", "description": "Retrieves a single campaign by its unique identifier. Returns the full campaign details including all related data.", "operationId": "GetCampaign", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Communications" ], "summary": "Campaign", "description": "Updates an existing campaign. Validates all required fields and business rules before updating.", "operationId": "SaveCampaignWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/campaigns/{campaignIdentifier}/send-campaign": { "post": { "tags": [ "Communications" ], "summary": "Send Campaign", "description": "Queues a campaign for delivery to the selected recipients and send mode.", "operationId": "SendCampaign", "parameters": [ { "name": "campaignIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignSendTestRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/events": { "get": { "tags": [ "Communications" ], "summary": "Event List", "description": "Retrieves a paginated, filterable, and sortable list of communication events. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetEventGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Communications" ], "summary": "Event", "description": "Creates a new communication event. Validates all required fields and business rules before creation.", "operationId": "SaveEvent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/events/{identifier}": { "get": { "tags": [ "Communications" ], "summary": "Event", "description": "Retrieves a single communication event by its unique identifier. Returns the full event details including all related data.", "operationId": "GetEvent", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Communications" ], "summary": "Event", "description": "Updates an existing communication event. Validates all required fields and business rules before updating.", "operationId": "SaveEventWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/groups": { "get": { "tags": [ "Communications" ], "summary": "Group List", "description": "Retrieves a paginated, filterable, and sortable list of communication groups. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetGroupGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Communications" ], "summary": "Group", "description": "Creates or updates a communication group. Validates all required fields and business rules before saving.", "operationId": "SaveGroup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/groups/{identifier}": { "get": { "tags": [ "Communications" ], "summary": "Group", "description": "Retrieves a single communication group by its unique identifier. Returns the full group details including all related data.", "operationId": "GetGroup", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Communications" ], "summary": "Group", "description": "Updates an existing communication group. Validates all required fields and business rules before updating.", "operationId": "SaveGroupWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/groups/subscribers/{identifier}": { "get": { "tags": [ "Communications" ], "summary": "Get Groups by Subscriber", "description": "Returns all communication groups that a subscriber belongs to.", "operationId": "GetGroupsBySubscriber", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/groups/subscribers": { "post": { "tags": [ "Communications" ], "summary": "Group Subscriber Add", "description": "Adds a subscriber to a communication group.", "operationId": "GroupSubscriberAdd", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupSubscriberAddRemoveDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/groups/subscribers/{id}": { "delete": { "tags": [ "Communications" ], "summary": "Group Subscriber Remove", "description": "Removes a subscriber from a communication group.", "operationId": "GroupSubscriberRemove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupSubscriberAddRemoveDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/keywords": { "get": { "tags": [ "Communications" ], "summary": "Keyword List", "description": "Retrieves a paginated, filterable, and sortable list of communication keywords. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetKeywordGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeywordDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Communications" ], "summary": "Keyword", "description": "Creates or updates a communication keyword. Validates all required fields and business rules before saving.", "operationId": "SaveKeyword", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/keywords/{identifier}": { "get": { "tags": [ "Communications" ], "summary": "Keyword", "description": "Retrieves a single communication keyword by its unique identifier. Returns the full keyword details including all related data.", "operationId": "GetKeyword", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Communications" ], "summary": "Keyword", "description": "Updates an existing communication keyword. Validates all required fields and business rules before updating.", "operationId": "SaveKeywordWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/messages": { "get": { "tags": [ "Communications" ], "summary": "Message List", "description": "Retrieves a paginated, filterable, and sortable list of communication messages. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetMessageGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Communications" ], "summary": "Message", "description": "Creates or updates a communication message. Validates all required fields and business rules before saving.", "operationId": "SaveMessage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/messages/{identifier}": { "get": { "tags": [ "Communications" ], "summary": "Message", "description": "Retrieves a single communication message by its unique identifier. Returns the full message details including related data.", "operationId": "GetMessage", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Communications" ], "summary": "Message", "description": "Updates an existing communication message. Validates all required fields and business rules before updating.", "operationId": "SaveMessageWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/subscribers": { "get": { "tags": [ "Communications" ], "summary": "Subscriber List", "description": "Retrieves a paginated, filterable, and sortable list of subscribers. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetSubscriberGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriberDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Communications" ], "summary": "Subscriber", "description": "Creates or updates a subscriber. Validates all required fields and business rules before saving.", "operationId": "SaveSubscriber", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/subscribers/{identifier}": { "get": { "tags": [ "Communications" ], "summary": "Subscriber", "description": "Retrieves a single subscriber by its unique identifier. Returns the full subscriber details including all related data.", "operationId": "GetSubscriber", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Communications" ], "summary": "Subscriber", "description": "Updates an existing subscriber. Validates all required fields and business rules before updating.", "operationId": "SaveSubscriberWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/communications/subscribers/email-lookup": { "get": { "tags": [ "Communications" ], "summary": "Check Email Availability", "description": "Validates an email address and checks if it exists in subscribers, users, suppression list, or blocked sources.", "operationId": "CheckEmailAvailability", "parameters": [ { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "checkSubscribers", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "checkAddress", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "checkUsers", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "checkSuppressionList", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "checkIntrusionDetections", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberEmailLookupResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/addresses": { "get": { "tags": [ "Core" ], "summary": "Address List", "description": "Retrieves a grid/list view of addresses for the authenticated tenant.", "operationId": "GetAddressGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Core" ], "summary": "Address", "description": "Creates or updates an address record.", "operationId": "SaveAddress", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/addresses/{identifier}": { "get": { "tags": [ "Core" ], "summary": "Address", "description": "Retrieves a single address by its unique identifier.", "operationId": "GetAddress", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Core" ], "summary": "Address", "description": "Updates an existing address record.", "operationId": "SaveAddressWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/auto-numbers/generate": { "get": { "tags": [ "Core" ], "summary": "AutoNumber Generate", "description": "Generates the next auto-number for a tenant and regarding identifier.", "operationId": "GetAutoNumber", "parameters": [ { "name": "RegardingIdentifier", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Prefix", "in": "query", "schema": { "type": "string" } }, { "name": "Identifier", "in": "query", "description": "Primary record identifier.", "required": true, "schema": { "type": "string" } }, { "name": "StartingNumber", "in": "query", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Suffix", "in": "query", "schema": { "type": "string" } }, { "name": "Separator", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoNumberResponseDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/cards": { "get": { "tags": [ "Core" ], "summary": "Card List", "description": "Retrieves a grid/list view of cards for the authenticated tenant.", "operationId": "GetCardGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CardDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Core" ], "summary": "Card", "description": "Creates or updates a card record.", "operationId": "SaveCard", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/cards/{identifier}": { "get": { "tags": [ "Core" ], "summary": "Card", "description": "Retrieves a single card by its unique identifier.", "operationId": "GetCard", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Core" ], "summary": "Card", "description": "Updates an existing card record.", "operationId": "SaveCardWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/custom-fields": { "get": { "tags": [ "Core" ], "summary": "Custom Field List", "description": "Retrieves a grid/list view of custom field definitions for the authenticated tenant.", "operationId": "GetCustomFieldGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Core" ], "summary": "Custom Field", "description": "Creates or updates a custom field definition.", "operationId": "SaveCustomField", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/custom-fields/{identifier}": { "get": { "tags": [ "Core" ], "summary": "Custom Field", "description": "Retrieves a single custom field definition by its unique identifier.", "operationId": "GetCustomField", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Core" ], "summary": "Custom Field", "description": "Updates an existing custom field definition.", "operationId": "SaveCustomFieldWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/dates": { "get": { "tags": [ "Core" ], "summary": "Date List", "description": "Retrieves a grid/list view of date records for the authenticated tenant.", "operationId": "GetDateGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DateDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Core" ], "summary": "Date", "description": "Creates or updates a date record.", "operationId": "SaveDate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/dates/{identifier}": { "get": { "tags": [ "Core" ], "summary": "Date", "description": "Retrieves a single date record by its unique identifier.", "operationId": "GetDate", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Core" ], "summary": "Date", "description": "Updates an existing date record.", "operationId": "SaveDateWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/defaults/{moduleName}": { "get": { "tags": [ "Core" ], "summary": "Default List", "description": "Retrieves default configuration values for the requested module.", "operationId": "GetDefaultList", "parameters": [ { "name": "moduleName", "in": "path", "description": "Target module logical name used for lookup/authorization context.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/defaults": { "post": { "tags": [ "Core" ], "summary": "Default", "description": "Creates or updates default configuration values.", "operationId": "SaveDefault", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/defaults/{category}": { "put": { "tags": [ "Core" ], "summary": "Default", "description": "Updates default configuration values for the requested category.", "operationId": "SaveDefaultWithCategory", "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/defaults/save-single": { "post": { "tags": [ "Core" ], "summary": "Save Single Default", "description": "Creates or updates a single default configuration value.", "operationId": "SaveDefaultSingle", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultSingleItem" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/email-addresses": { "get": { "tags": [ "Core" ], "summary": "Email Address List", "description": "Retrieves a grid/list view of email address records for the authenticated tenant.", "operationId": "GetEmailAddressGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailAddressDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Core" ], "summary": "Email Address", "description": "Creates or updates an email address record.", "operationId": "SaveEmailAddress", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailAddressSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/email-addresses/{identifier}": { "get": { "tags": [ "Core" ], "summary": "Email Address", "description": "Retrieves a single email address record by its unique identifier.", "operationId": "GetEmailAddress", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailAddressDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Core" ], "summary": "Email Address", "description": "Updates an existing email address record.", "operationId": "SaveEmailAddressWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailAddressSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/links": { "get": { "tags": [ "Core" ], "summary": "Link List", "description": "Retrieves a grid/list view of link records for the authenticated tenant.", "operationId": "GetLinkGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Core" ], "summary": "Link", "description": "Creates or updates a link record.", "operationId": "SaveLink", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/links/{identifier}": { "get": { "tags": [ "Core" ], "summary": "Link", "description": "Retrieves a single link record by its unique identifier.", "operationId": "GetLink", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Core" ], "summary": "Link", "description": "Updates an existing link record.", "operationId": "SaveLinkWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/notes": { "get": { "tags": [ "Core" ], "summary": "Note List", "description": "Retrieves a grid/list view of notes for the authenticated tenant.", "operationId": "GetNoteGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NoteDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Core" ], "summary": "Note", "description": "Creates or updates a note.", "operationId": "SaveNote", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/notes/{identifier}": { "get": { "tags": [ "Core" ], "summary": "Note", "description": "Retrieves a single note by its unique identifier.", "operationId": "GetNote", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Core" ], "summary": "Note", "description": "Updates an existing note.", "operationId": "SaveNoteWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/notes/category/{categoryIdentifier}": { "get": { "tags": [ "Core" ], "summary": "Notes by Category", "description": "Retrieves notes filtered by category and optional description snippet.", "operationId": "GetNoteByCategory", "parameters": [ { "name": "categoryIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "noteDescription", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NoteDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/phones": { "get": { "tags": [ "Core" ], "summary": "Phone List", "description": "Retrieves a grid/list view of phone records for the authenticated tenant.", "operationId": "GetPhoneGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Core" ], "summary": "Phone", "description": "Creates or updates a phone record.", "operationId": "SavePhone", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/phones/{identifier}": { "get": { "tags": [ "Core" ], "summary": "Phone", "description": "Retrieves a single phone record by its unique identifier.", "operationId": "GetPhone", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Core" ], "summary": "Phone", "description": "Updates an existing phone record.", "operationId": "SavePhoneWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/phone-lookup": { "get": { "tags": [ "Core" ], "summary": "Phone Lookup", "description": "Checks if a phone number is valid and available for use within the tenant.", "operationId": "GetPhoneLookup", "parameters": [ { "name": "phoneNumber", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfPhoneLookupData" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/relations": { "get": { "tags": [ "Core" ], "summary": "Relation List", "description": "Retrieves a grid/list view of relation records for the authenticated tenant.", "operationId": "GetRelationGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelationDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Core" ], "summary": "Relation", "description": "Creates or updates a relation record.", "operationId": "SaveRelation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/relations/{identifier}": { "get": { "tags": [ "Core" ], "summary": "Relation", "description": "Retrieves a single relation record by its unique identifier.", "operationId": "GetRelation", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Core" ], "summary": "Relation", "description": "Updates an existing relation record.", "operationId": "SaveRelationWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/social-profiles": { "get": { "tags": [ "Core" ], "summary": "Social Profile List", "description": "Retrieves a grid/list view of social profile records for the authenticated tenant.", "operationId": "GetSocialProfileGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SocialProfileDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Core" ], "summary": "Social Profile", "description": "Creates or updates a social profile record.", "operationId": "SaveSocialProfile", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialProfileSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/social-profiles/{identifier}": { "get": { "tags": [ "Core" ], "summary": "Social Profile", "description": "Retrieves a single social profile record by its unique identifier.", "operationId": "GetSocialProfile", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialProfileDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Core" ], "summary": "Social Profile", "description": "Updates an existing social profile record.", "operationId": "SaveSocialProfileWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialProfileSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/tags": { "get": { "tags": [ "Core" ], "summary": "Tag List", "description": "Retrieves a grid/list view of tag records for the authenticated tenant.", "operationId": "GetTagGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Core" ], "summary": "Tag", "description": "Creates or updates a tag record.", "operationId": "SaveTag", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/core/tags/{identifier}": { "get": { "tags": [ "Core" ], "summary": "Tag", "description": "Retrieves a single tag record by its unique identifier.", "operationId": "GetTag", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Core" ], "summary": "Tag", "description": "Updates an existing tag record.", "operationId": "SaveTagWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/courses/attendees": { "get": { "tags": [ "Courses" ], "summary": "Course Attendee List", "description": "Retrieves a grid/list view of course attendees for the authenticated tenant.", "operationId": "GetCourseAttendeeGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CourseAttendeeDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Courses" ], "summary": "Course Attendee", "description": "Creates or updates a course attendee record.", "operationId": "SaveCourseAttendee", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CourseAttendeeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/courses/attendees/{identifier}": { "get": { "tags": [ "Courses" ], "summary": "Course Attendee", "description": "Retrieves a single course attendee by its unique identifier.", "operationId": "GetCourseAttendee", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CourseAttendeeDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Courses" ], "summary": "Course Attendee", "description": "Updates an existing course attendee record.", "operationId": "SaveCourseAttendeeWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CourseAttendeeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/courses": { "get": { "tags": [ "Courses" ], "summary": "Course List", "description": "Retrieves a grid/list view of courses for the authenticated tenant.", "operationId": "GetCourseGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CourseDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Courses" ], "summary": "Course", "description": "Creates or updates a course record.", "operationId": "SaveCourse", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CourseSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/courses/{identifier}": { "get": { "tags": [ "Courses" ], "summary": "Course", "description": "Retrieves a single course by its unique identifier.", "operationId": "GetCourse", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CourseDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Courses" ], "summary": "Course", "description": "Updates an existing course record.", "operationId": "SaveCourseWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CourseSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/documents": { "get": { "tags": [ "Documents" ], "summary": "Document List", "description": "Retrieves a paginated, filterable, and sortable list of documents.", "operationId": "GetDocumentGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Documents" ], "summary": "Document", "description": "Creates or updates a document record.", "operationId": "SaveDocument", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/documents/{identifier}": { "get": { "tags": [ "Documents" ], "summary": "Document", "description": "Retrieves a single document by its unique identifier.", "operationId": "GetDocument", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/documents/relationship": { "get": { "tags": [ "Documents" ], "summary": "Document Relationship List", "description": "Retrieves document relationships.", "operationId": "GetDocumentRelationshipGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRelationshipGridDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Documents" ], "summary": "Document Relationship", "description": "Creates or updates a document relationship.", "operationId": "SaveDocumentRelationship", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRelationshipSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/documents/relationship/{identifier}": { "get": { "tags": [ "Documents" ], "summary": "Document Relationship", "description": "Retrieves a single document relationship.", "operationId": "GetDocumentRelationship", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRelationshipDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/documents/version": { "get": { "tags": [ "Documents" ], "summary": "Document Version List", "description": "Retrieves a paginated, filterable, and sortable list of document versions.", "operationId": "GetDocumentVersionGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentVersionDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Documents" ], "summary": "Document Version", "description": "Creates or updates a document version after validating the request.", "operationId": "SaveDocumentVersion", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentVersionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/documents/version/{identifier}": { "get": { "tags": [ "Documents" ], "summary": "Document Version", "description": "Retrieves a single document version by its unique identifier.", "operationId": "GetDocumentVersion", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentVersionDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/clients": { "get": { "tags": [ "Drug Testing" ], "summary": "Drug Testing Client List", "description": "Retrieves a grid/list view of drug testing clients for the authenticated tenant.", "operationId": "GetDrugTestingClientGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DrugTestingClientDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Drug Testing" ], "summary": "Drug Testing Client", "description": "Creates or updates a drug testing client record.", "operationId": "SaveDrugTestingClient", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingClientSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/clients/{identifier}": { "get": { "tags": [ "Drug Testing" ], "summary": "Drug Testing Client", "description": "Retrieves a single drug testing client by its unique identifier.", "operationId": "GetDrugTestingClient", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingClientDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Drug Testing" ], "summary": "Drug Testing Client", "description": "Updates an existing drug testing client record.", "operationId": "SaveDrugTestingClientWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingClientSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/cocs": { "get": { "tags": [ "Drug Testing" ], "summary": "Drug Testing COC List", "description": "Retrieves a grid/list view of drug testing chain-of-custody records for the authenticated tenant.", "operationId": "GetDrugTestingCocGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DrugTestingCocDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Drug Testing" ], "summary": "Drug Testing COC", "description": "Creates or updates a drug testing chain-of-custody record.", "operationId": "SaveDrugTestingCoc", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingCocSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/cocs/{identifier}": { "get": { "tags": [ "Drug Testing" ], "summary": "Drug Testing COC", "description": "Retrieves a single drug testing chain-of-custody record by its unique identifier.", "operationId": "GetDrugTestingCoc", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingCocDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Drug Testing" ], "summary": "Drug Testing COC", "description": "Updates an existing drug testing chain-of-custody record.", "operationId": "SaveDrugTestingCocWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingCocSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/coc-results": { "get": { "tags": [ "Drug Testing" ], "summary": "Drug Testing COC Result List", "description": "Retrieves a grid/list view of drug testing chain-of-custody result records for the authenticated tenant.", "operationId": "GetDrugTestingCocResultGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DrugTestingCocResultDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Drug Testing" ], "summary": "Drug Testing COC Result", "description": "Creates or updates a drug testing chain-of-custody result record.", "operationId": "SaveDrugTestingCocResult", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingCocResultSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/coc-results/{identifier}": { "get": { "tags": [ "Drug Testing" ], "summary": "Drug Testing COC Result", "description": "Retrieves a single drug testing chain-of-custody result record by its unique identifier.", "operationId": "GetDrugTestingCocResult", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingCocResultDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Drug Testing" ], "summary": "Drug Testing COC Result", "description": "Updates an existing drug testing chain-of-custody result record.", "operationId": "SaveDrugTestingCocResultWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingCocResultSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/drugs": { "get": { "tags": [ "Drug Testing" ], "summary": "Drug List", "description": "Retrieves a filtered grid of drug testing drug records for the current tenant.", "operationId": "GetDrugTestingDrugGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DrugTestingDrugDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Drug Testing" ], "summary": "Drug", "description": "Creates a drug testing drug record.", "operationId": "SaveDrugTestingDrug", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingDrugSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/drugs/{identifier}": { "get": { "tags": [ "Drug Testing" ], "summary": "Drug", "description": "Retrieves the full configuration for a specific drug testing drug record.", "operationId": "GetDrugTestingDrug", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingDrugDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Drug Testing" ], "summary": "Drug", "description": "Updates a drug testing drug record.", "operationId": "SaveDrugTestingDrugWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingDrugSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/groups": { "get": { "tags": [ "Drug Testing" ], "summary": "Group List", "description": "Retrieves a filtered grid of drug testing groups for the current tenant.", "operationId": "GetDrugTestingGroupGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DrugTestingGroupDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Drug Testing" ], "summary": "Group", "description": "Creates a drug testing group.", "operationId": "SaveDrugTestingGroup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingGroupSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/groups/{identifier}": { "get": { "tags": [ "Drug Testing" ], "summary": "Group", "description": "Retrieves the full configuration for a specific drug testing group.", "operationId": "GetDrugTestingGroup", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingGroupDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Drug Testing" ], "summary": "Group", "description": "Updates a drug testing group.", "operationId": "SaveDrugTestingGroupWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingGroupSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/information": { "get": { "tags": [ "Drug Testing" ], "summary": "Information List", "description": "Retrieves a filtered grid of drug testing information records for the current tenant.", "operationId": "GetDrugTestingInformationGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DrugTestingInformationDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Drug Testing" ], "summary": "Information", "description": "Creates a drug testing information record.", "operationId": "SaveDrugTestingInformation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingInformationSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/information/{identifier}": { "get": { "tags": [ "Drug Testing" ], "summary": "Information", "description": "Retrieves the full configuration for a specific drug testing information record.", "operationId": "GetDrugTestingInformation", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingInformationDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Drug Testing" ], "summary": "Information", "description": "Updates a drug testing information record.", "operationId": "SaveDrugTestingInformationWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingInformationSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/panel-drugs": { "get": { "tags": [ "Drug Testing" ], "summary": "Panel Drug List", "description": "Retrieves a filtered grid of drug testing panel drug records for the current tenant.", "operationId": "GetDrugTestingPanelDrugGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DrugTestingPanelDrugDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Drug Testing" ], "summary": "Panel Drug", "description": "Creates a drug testing panel drug record.", "operationId": "SaveDrugTestingPanelDrug", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingPanelDrugSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/panel-drugs/{identifier}": { "get": { "tags": [ "Drug Testing" ], "summary": "Panel Drug", "description": "Retrieves the full configuration for a specific drug testing panel drug record.", "operationId": "GetDrugTestingPanelDrug", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingPanelDrugDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Drug Testing" ], "summary": "Panel Drug", "description": "Updates a drug testing panel drug record.", "operationId": "SaveDrugTestingPanelDrugWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingPanelDrugSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/panels": { "get": { "tags": [ "Drug Testing" ], "summary": "Panel List", "description": "Retrieves a filtered grid of drug testing panels for the current tenant.", "operationId": "GetDrugTestingPanelGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DrugTestingPanelDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Drug Testing" ], "summary": "Panel", "description": "Creates a drug testing panel.", "operationId": "SaveDrugTestingPanel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingPanelSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/panels/{identifier}": { "get": { "tags": [ "Drug Testing" ], "summary": "Panel", "description": "Retrieves the full configuration for a specific drug testing panel.", "operationId": "GetDrugTestingPanel", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingPanelDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Drug Testing" ], "summary": "Panel", "description": "Updates a drug testing panel.", "operationId": "SaveDrugTestingPanelWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingPanelSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/quick-result-codes": { "get": { "tags": [ "Drug Testing" ], "summary": "Quick Result Code List", "description": "Retrieves a filtered grid of drug testing quick result codes for the current tenant.", "operationId": "GetDrugTestingQuickResultCodeGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DrugTestingQuickResultCodeDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Drug Testing" ], "summary": "Quick Result Code", "description": "Creates a drug testing quick result code.", "operationId": "SaveDrugTestingQuickResultCode", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingQuickResultCodeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/quick-result-codes/{identifier}": { "get": { "tags": [ "Drug Testing" ], "summary": "Quick Result Code", "description": "Retrieves the full configuration for a specific drug testing quick result code.", "operationId": "GetDrugTestingQuickResultCode", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingQuickResultCodeDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Drug Testing" ], "summary": "Quick Result Code", "description": "Updates a drug testing quick result code.", "operationId": "SaveDrugTestingQuickResultCodeWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingQuickResultCodeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/results": { "get": { "tags": [ "Drug Testing" ], "summary": "Result List", "description": "Retrieves a filtered grid of drug testing results for the current tenant.", "operationId": "GetDrugTestingResultGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DrugTestingResultDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Drug Testing" ], "summary": "Result", "description": "Creates a drug testing result.", "operationId": "SaveDrugTestingResult", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingResultSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/drug-testing/results/{identifier}": { "get": { "tags": [ "Drug Testing" ], "summary": "Result", "description": "Retrieves the full configuration for a specific drug testing result.", "operationId": "GetDrugTestingResult", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingResultDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Drug Testing" ], "summary": "Result", "description": "Updates a drug testing result.", "operationId": "SaveDrugTestingResultWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrugTestingResultSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/grid": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book List", "description": "Provides endpoints for managing firearms.", "operationId": "GetBoundBookGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/{identifier}": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book", "description": "Provides endpoints for managing firearms.", "operationId": "GetBoundBook", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Firearms" ], "summary": "Bound Book", "description": "Updates an editable bound-book.", "operationId": "SaveBoundBook", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Firearms" ], "summary": "Bound Book", "description": "Updates a bound book. Returns the saved bound book result.", "operationId": "SaveBoundBookAsyncWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/status/{identifier}": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Status", "description": "Provides endpoints for managing firearms.", "operationId": "GetBoundBooktatusById", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookStatusDto" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/items/grid": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Item List", "description": "Returns the firearm items available to the authenticated tenant and user.", "operationId": "GetBoundBookItemGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/items/{identifier}": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Item", "description": "Returns a single firearm item belonging to the authenticated tenant.", "operationId": "GetBoundBookItem", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Firearms" ], "summary": "Create Bound Book Item", "description": "Creates a firearm item using the route identifier as the Bound Book Item identifier.", "operationId": "CreateBoundBookItem", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookItemSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Firearms" ], "summary": "Update Bound Book Item", "description": "Updates an existing firearm item belonging to the authenticated tenant.", "operationId": "UpdateBoundBookItem", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookItemSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/items/evaluate": { "post": { "tags": [ "Firearms" ], "summary": "Evaluate Bound Book Item", "description": "Evaluates a firearm identity within a bound book and returns duplicate, lifecycle, count, and allowed-action information.", "operationId": "EvaluateBoundBookItem", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookItemEvaluateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookItemEvaluateDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/items/receive": { "post": { "tags": [ "Firearms" ], "summary": "Receive Bound Book Item", "description": "Receives a firearm into a bound book, creating a firearm identity when required or creating a new acquisition for an existing firearm.", "operationId": "ReceiveBoundBookItem", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookItemReceiveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookItemReceiveResultDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/items/{identifier}/state": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Item State", "description": "Returns the current lifecycle state, lifecycle counts, allowed actions, and specific readiness issues that must be resolved before the firearm can be received.", "operationId": "GetBoundBookItemState", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookItemStateDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/items/{identifier}/history": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Item History", "description": "Returns the complete acquisition, disposition, custody, and correction history for a firearm.", "operationId": "GetBoundBookItemHistory", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookItemHistoryDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/acquisitions/grid": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Acquisition List", "description": "Provides endpoints for managing firearms.", "operationId": "GetBoundBookAcquisitionGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/acquisitions/{identifier}": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Acquisition", "description": "Provides endpoints for managing firearms.", "operationId": "GetBoundBookAcquisition", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Firearms" ], "summary": "Bound Book Acquisition", "description": "Updates an editable bound-book acquisition.", "operationId": "SaveBoundBookAcquisition", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookAcquisitionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Firearms" ], "summary": "Bound Book Acquisition", "description": "Updates a bound book acquisition. Returns the saved bound book acquisition result.", "operationId": "SaveBoundBookAcquisitionAsyncWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookAcquisitionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/corrections/grid": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Correction List", "description": "Provides endpoints for managing firearms.", "operationId": "GetBoundBookCorrectionGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/corrections/{identifier}": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Correction", "description": "Provides endpoints for managing firearms.", "operationId": "GetBoundBookCorrection", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Firearms" ], "summary": "Bound Book Correction", "description": "Updates an editable bound-book Correction.", "operationId": "SaveBoundBookCorrection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookCorrectionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Firearms" ], "summary": "Bound Book Correction", "description": "Updates a bound book Correction. Returns the saved bound book Correction result.", "operationId": "SaveBoundBookCorrectionAsyncWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookCorrectionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/dispositions/grid": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Disposition List", "description": "Provides endpoints for managing firearms.", "operationId": "GetBoundBookDispositionGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/dispositions/{identifier}": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Disposition", "description": "Provides endpoints for managing firearms.", "operationId": "GetBoundBookDisposition", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Firearms" ], "summary": "Bound Book Disposition", "description": "Creates a bound-book disposition.", "operationId": "SaveBoundBookDisposition", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookDispositionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "500": { "description": "Internal Server Error" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Firearms" ], "summary": "Bound Book Disposition", "description": "Updates an editable bound-book disposition.", "operationId": "SaveBoundBookDispositionAsyncWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookDispositionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/item-custody/grid": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Item Custody List", "description": "Provides endpoints for managing firearms.", "operationId": "GetBoundBookItemCustodyGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/firearms/bound-books/item-custody/{identifier}": { "get": { "tags": [ "Firearms" ], "summary": "Bound Book Item Custody", "description": "Provides endpoints for managing firearms.", "operationId": "GetBoundBookItemCustody", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Firearms" ], "summary": "Bound Book Item Custody", "description": "Updates an editable bound-book item custody.", "operationId": "SaveBoundBookItemCustody", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookItemCustodySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Firearms" ], "summary": "Bound Book Item Custody", "description": "Updates a bound book item custody. Returns the saved bound book item custody result.", "operationId": "SaveBoundBookItemCustodyAsyncWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundBookItemCustodySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/hr/employees": { "get": { "tags": [ "Human Resources" ], "summary": "Employee List", "description": "Retrieves a filtered grid of Employee records for the current tenant.", "operationId": "GetEmployeeGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GridResponseOfEmployeeGridDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Human Resources" ], "summary": "Employee", "description": "Creates a Employee record.", "operationId": "SaveEmployee", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/hr/employees/{identifier}": { "get": { "tags": [ "Human Resources" ], "summary": "Employee", "description": "Retrieves the full details for a specific Employee record.", "operationId": "GetEmployee", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Human Resources" ], "summary": "Employee", "description": "Updates a Employee record.", "operationId": "SaveEmployeeWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/images/{identifier}": { "get": { "tags": [ "Images" ], "summary": "Image", "description": "Serves stored images with optional transformations. Requests must use either a valid signed URL or a valid API key.", "operationId": "GetImage", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/images/generate-signed-url": { "post": { "tags": [ "Images" ], "summary": "Generate Signed Image URL", "description": "Generates a time-limited signed URL for public image access without API key headers.", "operationId": "GenerateSignedUrl", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUrlRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUrlResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/insights/Feedbacks": { "get": { "tags": [ "Insights" ], "summary": "Feedback List", "description": "Retrieves a filtered grid of Feedback records for the current tenant.", "operationId": "GetFeedbackGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Insights" ], "summary": "Feedback", "description": "Creates a Feedback record.", "operationId": "SaveFeedback", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/insights/Feedbacks/{identifier}": { "get": { "tags": [ "Insights" ], "summary": "Feedback", "description": "Retrieves the full details for a specific Feedback record.", "operationId": "GetFeedback", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Insights" ], "summary": "Feedback", "description": "Updates a Feedback record.", "operationId": "SaveFeedbackWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/insights/kb-articles": { "get": { "tags": [ "Insights" ], "summary": "KB Article List", "description": "Retrieves a filtered grid of knowledge base articles for the current tenant.", "operationId": "GetKbArticleGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KbArticleDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Insights" ], "summary": "KB Article", "description": "Creates a knowledge base article.", "operationId": "SaveKbArticle", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KbArticleSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/insights/kb-articles/{identifier}": { "get": { "tags": [ "Insights" ], "summary": "KB Article", "description": "Retrieves the full details for a specific knowledge base article.", "operationId": "GetKbArticle", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KbArticleDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Insights" ], "summary": "KB Article", "description": "Updates a knowledge base article.", "operationId": "SaveKbArticleWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KbArticleSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/insights/kb-articles/details": { "get": { "tags": [ "Insights" ], "summary": "KB Article Detail List", "description": "Retrieves a filtered grid of knowledge base article detail records for the current tenant.", "operationId": "GetKbArticleDetailGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KbArticleDetailDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Insights" ], "summary": "KB Article Detail", "description": "Creates a knowledge base article detail record.", "operationId": "SaveKbArticleDetail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KbArticleDetailSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/insights/kb-articles/details/{identifier}": { "get": { "tags": [ "Insights" ], "summary": "KB Article Detail", "description": "Retrieves the full details for a specific knowledge base article detail record.", "operationId": "GetKbArticleDetail", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KbArticleDetailDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Insights" ], "summary": "KB Article Detail", "description": "Updates a knowledge base article detail record.", "operationId": "SaveKbArticleDetailWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KbArticleDetailSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/intelligence/document-processing": { "get": { "tags": [ "Intelligence" ], "summary": "Document Processing Job List", "description": "Retrieves document processing jobs.", "operationId": "GetDocumentProcessingJobGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GridResponseOfDocumentProcessingJobGridDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Intelligence" ], "summary": "Document Processing Job Queue", "description": "Queues a document version for processing.", "operationId": "SaveDocumentProcessingJob", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentProcessingJobSaveRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/intelligence/document-processing/{identifier}": { "get": { "tags": [ "Intelligence" ], "summary": "Document Processing Job", "description": "Retrieves a document processing job.", "operationId": "GetDocumentProcessingJob", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentProcessingJobDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/lookups/info": { "get": { "tags": [ "Lookups" ], "summary": "Module Info", "description": "Retrieves lookup information for a specific module record.", "operationId": "GetInfo", "parameters": [ { "name": "identifier", "in": "query", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "moduleName", "in": "query", "description": "Target module logical name used for lookup/authorization context.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/lookups/lookups": { "get": { "tags": [ "Lookups" ], "summary": "Lookup List", "description": "Retrieves lookup items for a requested module and optional filter.", "operationId": "LookupAccounts", "parameters": [ { "name": "moduleName", "in": "query", "description": "Target module logical name used for lookup/authorization context.", "required": true, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/lookups/lookups/exists": { "get": { "tags": [ "Lookups" ], "summary": "Lookup Exists", "description": "Checks whether a lookup value exists within the requested module.", "operationId": "LookupExists", "parameters": [ { "name": "searchCriteria", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "moduleName", "in": "query", "description": "Target module logical name used for lookup/authorization context.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/lookups/lookups/name": { "get": { "tags": [ "Lookups" ], "summary": "Lookup Name", "description": "Retrieves the display name for a single lookup item by identifier.", "operationId": "LookupName", "parameters": [ { "name": "identifier", "in": "query", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "moduleName", "in": "query", "description": "Target module logical name used for lookup/authorization context.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/lookups/postal-code": { "get": { "tags": [ "Lookups" ], "summary": "Postal Code Lookup", "description": "Retrieves one or more localities based on the supplied country and postal code.", "operationId": "LookupPostalCode", "parameters": [ { "name": "country", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "postalCode", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/marketing/local-search/research": { "post": { "tags": [ "Marketing" ], "summary": "Local Search Research", "description": "Lookup and compare your ranking information.", "operationId": "Research", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalSearchResearchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "408": { "description": "Request Timeout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "413": { "description": "Payload Too Large", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/marketing/local-search/{localSearchQueryIdentifier}/history": { "get": { "tags": [ "Marketing" ], "summary": "Local Search History", "description": "Retrieve historical local search ranking information.", "operationId": "GetHistory", "parameters": [ { "name": "localSearchQueryIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/marketing/local-search/grid": { "post": { "tags": [ "Marketing" ], "summary": "Local Search Grid", "description": "Runs a geographic local search ranking grid around a postal code.", "operationId": "RunGrid", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalSearchGridRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/marketing/local-search/{localSearchQueryIdentifier}/grid-history": { "get": { "tags": [ "Marketing" ], "summary": "Local Search Grid History", "description": "Compare the most recent local search grid against the previous grid.", "operationId": "GetGridHistory", "parameters": [ { "name": "localSearchQueryIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/marketing/local-search/grid/{localSearchRunIdentifier}/point/{gridRow}/{gridColumn}": { "get": { "tags": [ "Marketing" ], "summary": "Local Search Grid Point Detail", "description": "Retrieve the ranking and competitor detail for one local search grid point.", "operationId": "GetGridPointDetail", "parameters": [ { "name": "localSearchRunIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "gridRow", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "gridColumn", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/marketing/local-search/{localSearchQueryIdentifier}/tracking": { "post": { "tags": [ "Marketing" ], "summary": "Local Search Tracking", "description": "Enable or update scheduled local search grid tracking.", "operationId": "SaveTracking", "parameters": [ { "name": "localSearchQueryIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalSearchTrackingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/marketing/local-search/{localSearchProfileIdentifier}/gbp-audit": { "get": { "tags": [ "Marketing" ], "summary": "Google Business Profile Audit", "description": "Audit the Google Business Profile associated with a local search profile.", "operationId": "GetBusinessProfileAudit", "parameters": [ { "name": "localSearchProfileIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/marketing/local-search/{localSearchProfileIdentifier}/gbp-audit/competitive": { "get": { "tags": [ "Marketing" ], "summary": "Competitive Google Business Profile Audit", "description": "Compare a Google Business Profile against its strongest local competitors.", "operationId": "GetCompetitiveBusinessProfileAudit", "parameters": [ { "name": "localSearchProfileIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/marketing/local-search/{localSearchProfileIdentifier}/gbp-audit/history": { "get": { "tags": [ "Marketing" ], "summary": "Google Business Profile Audit History", "description": "Retrieve historical Google Business Profile audit and competitive benchmark results.", "operationId": "GetGoogleBusinessProfileAuditHistory", "parameters": [ { "name": "localSearchProfileIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/marketing/local-search/grid/{localSearchRunIdentifier}": { "get": { "tags": [ "Marketing" ], "summary": "Local Search Grid Run", "description": "Retrieve a previously saved local search geo-grid run.", "operationId": "GetLocalSearchGridRun", "parameters": [ { "name": "localSearchRunIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/marketing/downloader": { "post": { "tags": [ "Marketing" ], "summary": "Video Downloader", "description": "Downloads authorized public video or audio from supported platforms including YouTube, Facebook, Instagram, TikTok, X, Vimeo, Twitch, Reddit, and LinkedIn. Supports Native, MP4, WebM, MKV, MOV, MP3, M4A, and WAV output. Requires an authenticated Brilliance One user with Marketing access.", "operationId": "DownloadVideo", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VideoDownloadRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "408": { "description": "Request Timeout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "413": { "description": "Payload Too Large", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/media/download/{identifier}": { "get": { "tags": [ "Media" ], "summary": "Media Download", "description": "Returns the requested media blob as a downloadable file.", "operationId": "GetApiV1MediaDownloadIdentifierGuid", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/media/uploads/image": { "post": { "tags": [ "Media" ], "summary": "Upload Image", "description": "Validates image headers and dimensions before saving media.", "operationId": "UploadImage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfGuid" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/media/uploads/image/{identifier}": { "put": { "tags": [ "Media" ], "summary": "Update Image", "description": "Validates image headers and dimensions before updating media.", "operationId": "UploadImageWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfGuid" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/media/uploads/document": { "post": { "tags": [ "Media" ], "summary": "Upload Document", "description": "Saves documents after validation and sanitization.", "operationId": "UploadDocument", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfGuid" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/media/uploads/document/{identifier}": { "put": { "tags": [ "Media" ], "summary": "Update Document", "description": "Updates documents after validation and sanitization.", "operationId": "UploadDocumentWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfGuid" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/media/uploads/chunk": { "post": { "tags": [ "Media" ], "summary": "Upload File Chunk", "description": "Handles sequential file chunks for large uploads.", "operationId": "UploadChunk", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaChunkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfGuid" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/portal/filter-menu": { "get": { "tags": [ "Portal" ], "summary": "Filter Menu List", "description": "Retrieves filter menu items for the requested module.", "operationId": "GetFilterMenu", "parameters": [ { "name": "ModulName", "in": "query", "schema": { "maxLength": 50, "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FilterMenuDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/portal/grid-settings": { "get": { "tags": [ "Portal" ], "summary": "Grid Page Settings", "description": "Retrieves grid page settings for the requested module.", "operationId": "GetGridSettings", "parameters": [ { "name": "ModulName", "in": "query", "schema": { "maxLength": 50, "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GridDefaultDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/portal/portal-access": { "get": { "tags": [ "Portal" ], "summary": "Portal Access", "description": "Retrieves the portal access menu and permissions for the authenticated user.", "operationId": "GetPortalAccess", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/portal/quick-access": { "get": { "tags": [ "Portal" ], "summary": "Quick Access Menu", "description": "Retrieves the quick access menu items for the authenticated user.", "operationId": "GetQuickAccessItems", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QuickAccessItemDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/portal/account-menu": { "get": { "tags": [ "Portal" ], "summary": "My Account Menu", "description": "Retrieves the menu items for the authenticated user's account.", "operationId": "GetAccountMenuItems", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyAccountMenuItemDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/categories": { "get": { "tags": [ "Products" ], "summary": "Category List", "description": "Retrieves a filtered grid of product categories for the current tenant.", "operationId": "GetProductCategoryGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCategoryDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Products" ], "summary": "Category", "description": "Creates a product category.", "operationId": "SaveProductCategory", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategorySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/categories/{identifier}": { "get": { "tags": [ "Products" ], "summary": "Category", "description": "Retrieves the full details for a specific product category.", "operationId": "GetProductCategory", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategoryDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Products" ], "summary": "Category", "description": "Updates a product category.", "operationId": "SaveProductCategoryWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategorySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/details": { "get": { "tags": [ "Products" ], "summary": "Product Detail List", "description": "Retrieves a filtered grid of product detail records for the current tenant.", "operationId": "GetProductDetailGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDetailDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Products" ], "summary": "Product Detail", "description": "Creates a product detail record.", "operationId": "SaveProductDetail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/details/{identifier}": { "get": { "tags": [ "Products" ], "summary": "Product Detail", "description": "Retrieves the full details for a specific product detail record.", "operationId": "GetProductDetail", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Products" ], "summary": "Product Detail", "description": "Updates a product detail record.", "operationId": "SaveProductDetailWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products": { "get": { "tags": [ "Products" ], "summary": "Product List", "description": "Retrieves a filtered grid of products for the current tenant.", "operationId": "GetProductGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Products" ], "summary": "Product", "description": "Creates a product.", "operationId": "SaveProduct", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/{identifier}": { "get": { "tags": [ "Products" ], "summary": "Product", "description": "Retrieves the full details for a specific product.", "operationId": "GetProduct", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Products" ], "summary": "Product", "description": "Updates a product.", "operationId": "SaveProductWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/inventories": { "get": { "tags": [ "Products" ], "summary": "Inventory List", "description": "Retrieves a filtered grid of product inventory records for the current tenant.", "operationId": "GetProductInventoryGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductInventoryDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Products" ], "summary": "Inventory", "description": "Creates a product inventory record.", "operationId": "SaveProductInventory", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInventorySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/inventories/{identifier}": { "get": { "tags": [ "Products" ], "summary": "Inventory", "description": "Retrieves the full details for a specific product inventory record.", "operationId": "GetProductInventory", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInventoryDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Products" ], "summary": "Inventory", "description": "Updates a product inventory record.", "operationId": "SaveProductInventoryWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInventorySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/serial-numbers": { "get": { "tags": [ "Products" ], "summary": "Serial Number List", "description": "Retrieves a filtered grid of product serial numbers for the current tenant.", "operationId": "GetProductSerialNumberGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSerialNumberDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Products" ], "summary": "Serial Number", "description": "Creates a product serial number.", "operationId": "SaveProductSerialNumber", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSerialNumberSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/serial-numbers/{identifier}": { "get": { "tags": [ "Products" ], "summary": "Serial Number", "description": "Retrieves the full details for a specific product serial number.", "operationId": "GetProductSerialNumber", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSerialNumberDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Products" ], "summary": "Serial Number", "description": "Updates a product serial number.", "operationId": "SaveProductSerialNumberWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSerialNumberSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/serial-number-transactions": { "get": { "tags": [ "Products" ], "summary": "Serial Number Transaction List", "description": "Retrieves a filtered grid of product serial number transactions for the current tenant.", "operationId": "GetProductSerialNumberTransactionGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSerialNumberTransactionDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Products" ], "summary": "Serial Number Transaction", "description": "Creates a product serial number transaction.", "operationId": "SaveProductSerialNumberTransaction", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSerialNumberTransactionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/serial-number-transactions/{identifier}": { "get": { "tags": [ "Products" ], "summary": "Serial Number Transaction", "description": "Retrieves the full details for a specific product serial number transaction.", "operationId": "GetProductSerialNumberTransaction", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSerialNumberTransactionDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Products" ], "summary": "Serial Number Transaction", "description": "Updates a product serial number transaction.", "operationId": "SaveProductSerialNumberTransactionWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSerialNumberTransactionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/warehouses": { "get": { "tags": [ "Products" ], "summary": "Warehouse List", "description": "Retrieves a filtered grid of product warehouses for the current tenant.", "operationId": "GetProductWarehouseGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductWarehouseDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Products" ], "summary": "Warehouse", "description": "Creates a product warehouse.", "operationId": "SaveProductWarehouse", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductWarehouseSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/products/warehouses/{identifier}": { "get": { "tags": [ "Products" ], "summary": "Warehouse", "description": "Retrieves the full details for a specific product warehouse.", "operationId": "GetProductWarehouse", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductWarehouseDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Products" ], "summary": "Warehouse", "description": "Updates a product warehouse.", "operationId": "SaveProductWarehouseWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductWarehouseSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/projects/projects": { "get": { "tags": [ "Projects" ], "summary": "Project List", "description": "Retrieves a paginated, filterable, and sortable list of projects. Supports search, filtering, sorting, and customizable page size.", "operationId": "GetProjectGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Projects" ], "summary": "Project", "description": "Creates a project.", "operationId": "SaveProject", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/projects/projects/{identifier}": { "get": { "tags": [ "Projects" ], "summary": "Project", "description": "Retrieves the full details for a specific project.", "operationId": "GetProject", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Projects" ], "summary": "Project", "description": "Updates a project.", "operationId": "SaveProjectWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/projects/tasks": { "get": { "tags": [ "Projects" ], "summary": "Task List", "description": "Retrieves a paginated, filterable, and sortable list of tasks. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetTaskGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Projects" ], "summary": "Task", "description": "Creates a new task. Validates all required fields and business rules before creation. Returns the created task with its assigned identifier.", "operationId": "SaveTask", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/projects/tasks/{identifier}": { "get": { "tags": [ "Projects" ], "summary": "Task", "description": "Retrieves a single task by its unique identifier. Returns the full task details including all related data.", "operationId": "GetTask", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Projects" ], "summary": "Task", "description": "Updates an existing task. Validates all required fields and business rules before saving.", "operationId": "SaveTaskWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/projects/task-notes": { "get": { "tags": [ "Projects" ], "summary": "Task Note List", "description": "Retrieves a paginated, filterable, and sortable list of task notes. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetTaskNoteGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskNoteDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Projects" ], "summary": "Task Note", "description": "Creates a new task note. Validates all required fields and business rules before creation.", "operationId": "SaveTaskNote", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskNoteSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/projects/task-notes/{identifier}": { "get": { "tags": [ "Projects" ], "summary": "Task Note", "description": "Retrieves a single task note by its unique identifier. Returns the full task note details including all related data.", "operationId": "GetTaskNote", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskNoteDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Projects" ], "summary": "Task Note", "description": "Updates an existing task note. Validates all required fields and business rules before saving.", "operationId": "SaveTaskNoteWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskNoteSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/projects/task-smtp": { "get": { "tags": [ "Projects" ], "summary": "Task SMTP List", "description": "Retrieves a paginated, filterable, and sortable list of task SMTP records. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetTaskSmtpGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskSmtpDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Projects" ], "summary": "Task SMTP", "description": "Creates a new task SMTP record. Validates all required fields and business rules before creation.", "operationId": "SaveTaskSmtp", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSmtpSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/projects/task-smtp/{identifier}": { "get": { "tags": [ "Projects" ], "summary": "Task SMTP", "description": "Retrieves a single task SMTP record by its unique identifier. Returns the full task SMTP details including all related data.", "operationId": "GetTaskSmtp", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSmtpDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Projects" ], "summary": "Task SMTP", "description": "Updates an existing task SMTP record. Validates all required fields and business rules before saving.", "operationId": "SaveTaskSmtpWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSmtpSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/projects/task-status-histories": { "get": { "tags": [ "Projects" ], "summary": "Task Status History List", "description": "Retrieves a paginated, filterable, and sortable list of task status history records. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetTaskStatusHistoryGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskStatusHistoryDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Projects" ], "summary": "Task Status History", "description": "Creates a new task status history record. Validates all required fields and business rules before creation.", "operationId": "SaveTaskStatusHistory", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusHistorySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/projects/task-status-histories/{identifier}": { "get": { "tags": [ "Projects" ], "summary": "Task Status History", "description": "Retrieves a single task status history record by its unique identifier. Returns the full task status history details including all related data.", "operationId": "GetTaskStatusHistory", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusHistoryDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Projects" ], "summary": "Task Status History", "description": "Updates an existing task status history record. Validates all required fields and business rules before saving.", "operationId": "SaveTaskStatusHistoryWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusHistorySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/public-tools/conversions/conversions/temperature": { "post": { "tags": [ "Public Tools: Conversion Tools" ], "summary": "Temperature Converter", "description": "Precision conversion between Celsius, Fahrenheit, and Kelvin with Absolute Zero validation.", "operationId": "ConvertTemperature", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversionRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/conversions/conversions/volume": { "post": { "tags": [ "Public Tools: Conversion Tools" ], "summary": "Liquid Volume Converter", "description": "Precision conversion across Metric, US Customary, and Imperial liquid systems using a JSON payload.", "operationId": "ConvertVolume", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversionRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/conversions/conversions/weight": { "post": { "tags": [ "Public Tools: Conversion Tools" ], "summary": "Weight/Mass Converter", "description": "Precision conversion across various weight and mass units using a JSON payload.", "operationId": "ConvertWeight", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversionRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/dev/base64/encode": { "post": { "tags": [ "Public Tools: Developer Tools" ], "summary": "Base64 Encode", "description": "Encodes a string to standard or URL-safe Base64.", "operationId": "EncodeToBase64", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base64Request" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/dev/base64/decode": { "post": { "tags": [ "Public Tools: Developer Tools" ], "summary": "Base64 Decode", "description": "Decodes a standard or URL-safe Base64 string back to plain text.", "operationId": "DecodeFromBase64", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base64Request" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/dev/binary/encode": { "post": { "tags": [ "Public Tools: Developer Tools" ], "summary": "File to Base64", "description": "Accepts raw binary data and returns a Base64 Data URI for CSS or Database storage.", "operationId": "ConvertImageToBase64", "parameters": [ { "name": "mimeType", "in": "query", "schema": { "type": "string", "default": "image/png" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/dev/binary/decode": { "post": { "tags": [ "Public Tools: Developer Tools" ], "summary": "Base64 to File", "description": "Takes a Base64 string and returns a binary file download.", "operationId": "ConvertBase64ToImage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Base64ToImageRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/dev/format-json": { "post": { "tags": [ "Public Tools: Developer Tools" ], "summary": "JSON Formatter & Validator", "description": "Validates and 'Pretty Prints' JSON. Provides precise line/column details for syntax errors.", "operationId": "FormatJson", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/dev/svg-to-css": { "post": { "tags": [ "Public Tools: Developer Tools" ], "summary": "SVG to CSS Generator", "description": "Converts raw SVG into CSS Data URIs with five specific formatting modes.", "operationId": "ConvertSvgToCss", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SvgToCssRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/dev/svg-to-css-raw": { "post": { "tags": [ "Public Tools: Developer Tools" ], "summary": "SVG to CSS (RAW)", "description": "Accepts raw SVG text in the request body for direct conversion to CSS Data URIs.", "operationId": "ConvertRawSvgToCss", "parameters": [ { "name": "mode", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "compress", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/dev/xml-to-json": { "post": { "tags": [ "Public Tools: Developer Tools" ], "summary": "XML to JSON Converter", "description": "Converts legacy XML configuration nodes into modern JSON. Hardened against XXE attacks.", "operationId": "ConvertXmlToJson", "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/email/generate-bimi": { "post": { "tags": [ "Public Tools: Email Tools" ], "summary": "BIMI Record Generator", "description": "Generates standardized BIMI DNS TXT records with DMARC compliance checks.", "operationId": "GenerateBimiRecord", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BimiOptions" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/email/check-spam-score": { "post": { "tags": [ "Public Tools: Email Tools" ], "summary": "Email Spam Score Auditor", "description": "Analyzes subject lines and message bodies for 2026 spam trigger patterns and formatting red flags.", "operationId": "CheckSpamScore", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpamScoreRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/email/generate-dkim": { "post": { "tags": [ "Public Tools: Email Tools" ], "summary": "DKIM Key Pair Generator", "description": "Generates a public/private RSA key pair and the corresponding DNS TXT record for DKIM signing.", "operationId": "GenerateDkimKeyPair", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DkimOptions" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/email/generate-dmarc": { "post": { "tags": [ "Public Tools: Email Tools" ], "summary": "DMARC Record Generator", "description": "Generates an enterprise-grade, hacker-resilient DMARC record based on specified security policies.", "operationId": "GenerateDmarc", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmarcOptions" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/email/mail-check": { "post": { "tags": [ "Public Tools: Email Tools" ], "summary": "Mail Server Checks", "description": "Checks and validates your mail server setup using enterprise standards.", "operationId": "MailCheck", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailCheckRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/email/message-header": { "post": { "tags": [ "Public Tools: Email Tools" ], "summary": "Message Header Analyzer", "description": "Parses raw email headers to analyze routing hops, source IP, authentication results, and anti-spam metadata.", "operationId": "AnalyzeHeader", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageHeaderRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/email/generate-mta-sts": { "post": { "tags": [ "Public Tools: Email Tools" ], "summary": "MTA-STS Generator", "description": "Generates the DNS TXT record and the required HTTPS policy file content to enforce TLS encryption for incoming mail.", "operationId": "GenerateMtaSts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MtaStsOptions" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/email/generate-spf": { "post": { "tags": [ "Public Tools: Email Tools" ], "summary": "SPF Record Generator", "description": "Generates a recommended SPF record based on provided domain options and lookup requirements.", "operationId": "GenerateSpfRecord", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpfOptions" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/email/generate-tls-rpt": { "post": { "tags": [ "Public Tools: Email Tools" ], "summary": "TLS Reporting Generator", "description": "Generates the DNS record required to receive reports about TLS encryption failures and downgrade attacks.", "operationId": "GenerateTlsRpt", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TlsRptOptions" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/financial/card-generator": { "post": { "tags": [ "Public Tools: Financial Tools" ], "summary": "Card Generator", "description": "Generates synthetic, Luhn-compliant numbers for testing (Visa, Mastercard, Amex, Discover).", "operationId": "GenerateCreditCard", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CardGeneratorRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/geo/continents": { "get": { "tags": [ "Public Tools: Geography Tools" ], "summary": "Continent Lookup", "description": "Returns a standardized list of the seven continents with ISO-style codes and name mapping.", "operationId": "GetContinents", "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/geo/countries": { "get": { "tags": [ "Public Tools: Geography Tools" ], "summary": "Country Lookup", "description": "Complete ISO 3166-1 set (249 entities) with numeric offsets for high-speed scheduling math.", "operationId": "GetCountries", "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/geo/geo/regions": { "post": { "tags": [ "Public Tools: Geography Tools" ], "summary": "States/Provinces by Country", "description": "Returns standardized regions for US (ISO-2), Canada, and Mexico.", "operationId": "GetRegionsByCountry", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RegionRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/geo/geo/subregions": { "post": { "tags": [ "Public Tools: Geography Tools" ], "summary": "Global Sub-Regions", "description": "Returns a standardized list of UN M49 sub-regions grouped by parent continent code.", "operationId": "GetSubRegions", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SubRegionRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/geo/time-zones": { "get": { "tags": [ "Public Tools: Geography Tools" ], "summary": "Global Time Zones", "description": "High-performance lookup for standard global time zones with decimal offsets for scheduling arithmetic.", "operationId": "GetTimeZones", "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/images/scrub-metadata": { "post": { "tags": [ "Public Tools: Image Tools" ], "summary": "EXIF Metadata Scrubber", "description": "Privacy tool: Strips GPS, camera info, and personal metadata from images.", "operationId": "ScrubImageMetadata", "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/images/generate-favicon-pack": { "post": { "tags": [ "Public Tools: Image Tools" ], "summary": "Favicon Pack Generator", "description": "Generates a production-ready ZIP containing PNG favicons for iOS, Android, and Web.", "operationId": "GenerateFaviconPack", "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/images/placeholder": { "post": { "tags": [ "Public Tools: Image Tools" ], "summary": "SVG Placeholder Generator", "description": "Generates customizable SVG placeholders for UI/UX prototyping.", "operationId": "GeneratePlaceholder", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlaceholderRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/marketing/qr/text": { "post": { "tags": [ "Public Tools: Marketing Tools" ], "summary": "Text QR", "description": "Provides public endpoints that are freely available to all.", "operationId": "GenerateText", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TextQrRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/marketing/qr/url": { "post": { "tags": [ "Public Tools: Marketing Tools" ], "summary": "URL QR", "description": "Provides public endpoints that are freely available to all.", "operationId": "GenerateUrl", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UrlQrRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/marketing/qr/wifi": { "post": { "tags": [ "Public Tools: Marketing Tools" ], "summary": "WiFi QR", "description": "Provides public endpoints that are freely available to all.", "operationId": "GenerateWifi", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WifiQrRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/marketing/qr/vcard": { "post": { "tags": [ "Public Tools: Marketing Tools" ], "summary": "vCard QR", "description": "Provides public endpoints that are freely available to all.", "operationId": "GenerateVCard", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VCardQrRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/marketing/qr/utm": { "post": { "tags": [ "Public Tools: Marketing Tools" ], "summary": "UTM QR", "description": "Provides public endpoints that are freely available to all.", "operationId": "GenerateUtm", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UtmRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/marketing/generate-utm": { "post": { "tags": [ "Public Tools: Marketing Tools" ], "summary": "UTM Link Builder", "description": "Generates standardized tracking URLs with optional high-ECC QR codes for 2026 attribution standards.", "operationId": "PostApiV1PublicToolsMarketingGenerateUtm", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UtmGeneratorOptions" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/marketing/local-search-grid": { "post": { "tags": [ "Public Tools: Marketing Tools" ], "summary": "Public Local Search Grid", "description": "Runs a fixed 5 x 5 local search ranking grid using a 5 mile width and saves the results for reporting, analytics, advertising, and program improvement.", "operationId": "RunLocalSearchGrid", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PublicLocalSearchGridRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalSearchGridResult" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/security/decode-token": { "post": { "tags": [ "Public Tools: Security Tools" ], "summary": "JWT Inspector", "description": "Displays JWT claims and metadata. Note: This does not verify the signature.", "operationId": "CreateDecodeToken", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TokenRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/security/internal/diagnostic-config": { "get": { "tags": [ "Public Tools: Security Tools" ], "summary": "Internal: System Diagnostic", "description": "System restricted. Unauthorized access attempts are logged and sanctioned.", "operationId": "CatchMaliciousActor", "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/security/generate-id": { "get": { "tags": [ "Public Tools: Security Tools" ], "summary": "Enterprise Identifier Generator", "description": "Generates UUID v4/v7, ULID, NanoID, Snowflake (64-bit), and CUID2 identifiers.", "operationId": "GenerateId", "parameters": [ { "name": "format", "in": "query", "schema": { "type": "string", "default": "v7" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/security/generate-key": { "get": { "tags": [ "Public Tools: Security Tools" ], "summary": "JWT Secret Key Generator", "description": "Generates a CSPRNG secure base64 key for HS256, HS384, or HS512 algorithms.", "operationId": "GenerateKey", "parameters": [ { "name": "bits", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 256 } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/security/password-generator": { "post": { "tags": [ "Public Tools: Security Tools" ], "summary": "Password Generator", "description": "Generates high-entropy, cryptographically secure passwords using CSPRNG.", "operationId": "GeneratePassword", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PasswordRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/wcag/wcag/simulate-cvd": { "post": { "tags": [ "Public Tools: WCAG Tools" ], "summary": "Color Blindness Simulator", "description": "Simulates how a specific HEX color appears to users with Protanopia, Deuteranopia, and Tritanopia.", "operationId": "SimulateColorBlindness", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CvdSimulationRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/wcag/wcag/contrast-ratio": { "post": { "tags": [ "Public Tools: WCAG Tools" ], "summary": "WCAG Contrast Checker", "description": "Calculates contrast ratios and WCAG 2.1 compliance status using a JSON payload.", "operationId": "GetContrastRatio", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContrastRequest" } ] } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/web/css/compress": { "post": { "tags": [ "Public Tools: Web Tools" ], "summary": "Single-Line CSS Compressor", "description": "Upload a .css or .txt file. Returns raw text formatted with one selector group per line for Notepad++ compatibility.", "operationId": "CompressCssFile", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/web/css/minify": { "post": { "tags": [ "Public Tools: Web Tools" ], "summary": "CSS Minifier", "description": "Strips comments and whitespace from CSS for production optimization.", "operationId": "MinifyCss", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MarkupRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/web/css/unminify": { "post": { "tags": [ "Public Tools: Web Tools" ], "summary": "CSS Unminify", "description": "Restores structure and indentation to minified CSS for human readability.", "operationId": "UnminifyCss", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MarkupRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/web/html/entities": { "post": { "tags": [ "Public Tools: Web Tools" ], "summary": "HTML Entity Encoder/Decoder", "description": "Encodes or Decodes special characters (e.g., <, >, &) for safe HTML rendering.", "operationId": "HandleHtmlEntities", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EntityRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/web/html/minify": { "post": { "tags": [ "Public Tools: Web Tools" ], "summary": "HTML Minifier", "description": "High-performance utility to strip comments and collapse whitespace for production HTML optimization.", "operationId": "MinifyHtml", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MinifyMarkupRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/web/markup/escape-script": { "post": { "tags": [ "Public Tools: Web Tools" ], "summary": "JavaScript String Escaper", "description": "Escapes characters for safe inclusion inside JavaScript string literals (handles quotes, backslashes, etc.).", "operationId": "EscapeForScript", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MarkupRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/web/html/unminify": { "post": { "tags": [ "Public Tools: Web Tools" ], "summary": "HTML Pretty-Printer", "description": "Restores hierarchy, indentation, and readability to minified HTML markup.", "operationId": "UnminifyHtml", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/HtmlUnminifyRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/web/inspect-request": { "get": { "tags": [ "Public Tools: Web Tools" ], "summary": "Request Inspector", "description": "Echoes the caller's IP, protocol, and selected request metadata to debug connectivity and proxy configurations.", "operationId": "CreateInspectRequest", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/web/generate-robots": { "post": { "tags": [ "Public Tools: Web Tools" ], "summary": "Robots.txt Generator", "description": "Generates a secure, standards-compliant robots.txt file with smart defaults for empty inputs.", "operationId": "GenerateRobotsTxt", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RobotsTxtRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/web/validate-sitemap": { "post": { "tags": [ "Public Tools: Web Tools" ], "summary": "Sitemap Validator", "description": "Validates sitemap.xml structure and accessibility against Sitemaps.org 0.9 standards.", "operationId": "ValidateSitemap", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SitemapRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/web/url-slug": { "post": { "tags": [ "Public Tools: Web Tools" ], "summary": "SEO URL Slug Generator", "description": "Transforms titles into clean, lowercase, URL-safe strings with diacritic normalization.", "operationId": "GenerateSlug", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SlugRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/public-tools/web/whois": { "get": { "tags": [ "Public Tools: Web Tools" ], "summary": "Domain WHOIS Lookup", "description": "Queries authoritative WHOIS/RDAP servers and returns structured domain registration data.", "operationId": "GetWhoisRecord", "parameters": [ { "name": "domain", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeRaw", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhoisLookupResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/reports-public/invoices/{identifier}": { "get": { "tags": [ "Reports - Public" ], "summary": "Invoice", "description": "Fetches the complete invoice profile, including line items, tax breakdowns, and current payment status.", "operationId": "GetApiV1ReportsPublicInvoicesIdentifierGuid", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/reports-public/invoices/totals/{identifier}": { "get": { "tags": [ "Reports - Public" ], "summary": "Invoice Total", "description": "Fetches the overall totals of the invoice.", "operationId": "GetApiV1ReportsPublicInvoicesTotalsIdentifierGuid", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/reports-public/invoice-line-items/{identifier}": { "get": { "tags": [ "Reports - Public" ], "summary": "Invoice Line Item", "description": "Fetches invoice line items for a specific invoice. Used for reporting, review, recalculation, or invoice detail display.", "operationId": "GetApiV1ReportsPublicInvoiceLineItemsIdentifierGuid", "parameters": [ { "name": "identifier", "in": "path", "description": "Optional record identifier used by some grid endpoints for context filtering.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineItemDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/security/darkweb/{emailAddress}": { "get": { "tags": [ "Security" ], "summary": "Darkweb", "description": "Retrieves a list of breach or dark web findings for a specific email address.", "operationId": "GetDarkwebByEmailAddress", "parameters": [ { "name": "emailAddress", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityUserSecurityDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/entity-changes": { "get": { "tags": [ "Security" ], "summary": "Entity Change List", "description": "Retrieves a paginated, filterable, and sortable list of security entity changes. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetSecurityEntityChangeGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntityChangeGridDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/entity-changes/{identifier}": { "get": { "tags": [ "Security" ], "summary": "Entity Change", "description": "Retrieves a single security entity change by its unique identifier.", "operationId": "GetSecurityEntityChange", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityChangeDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/entity-changes/{identifier}/evidence": { "get": { "tags": [ "Security" ], "summary": "Entity Change Evidence", "description": "Retrieves a single security entity evidence by its unique identifier.", "operationId": "GetEvidence", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityChangeDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/intrusion-detections": { "get": { "tags": [ "Security" ], "summary": "Intrusion Detection List", "description": "Retrieves a paginated, filterable, and sortable list of intrusion detection records. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetSecurityIntrusionDetectionGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityIntrusionDetectionDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Security" ], "summary": "Intrusion Detection", "description": "Creates a new intrusion detection record. Validates required fields and business rules before creation.", "operationId": "SaveSecurityIntrusionDetection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityIntrusionDetectionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/intrusion-detections/{identifier}": { "get": { "tags": [ "Security" ], "summary": "Intrusion Detection", "description": "Retrieves a single intrusion detection record by its unique identifier.", "operationId": "GetSecurityIntrusionDetection", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityIntrusionDetectionDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Security" ], "summary": "Intrusion Detection", "description": "Updates an existing intrusion detection record. Validates required fields and business rules before saving.", "operationId": "SaveSecurityIntrusionDetectionWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityIntrusionDetectionSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/logs": { "get": { "tags": [ "Security" ], "summary": "Log List", "description": "Retrieves a paginated, filterable, and sortable list of security logs. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetSecurityLogGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityLogDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Security" ], "summary": "Log", "description": "Creates a new security log entry. Validates required fields and business rules before creation.", "operationId": "SaveSecurityLog", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityLogSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/logs/{identifier}": { "get": { "tags": [ "Security" ], "summary": "Log", "description": "Retrieves a single security log by its unique identifier.", "operationId": "GetSecurityLog", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityLogDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/modules": { "get": { "tags": [ "Security" ], "summary": "Module List", "description": "Retrieves a paginated, filterable, and sortable list of security modules. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetSecurityModuleGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityModuleDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Security" ], "summary": "Module", "description": "Creates a new security module. Validates required fields and business rules before creation.", "operationId": "SaveSecurityModule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityModuleSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/modules/{identifier}": { "get": { "tags": [ "Security" ], "summary": "Module", "description": "Retrieves a single security module by its unique identifier.", "operationId": "GetSecurityModule", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityModuleDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Security" ], "summary": "Module", "description": "Updates an existing security module. Validates required fields and business rules before saving.", "operationId": "SaveSecurityModuleWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityModuleSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/users": { "get": { "tags": [ "Security" ], "summary": "User List", "description": "\r\n Retrieves a list of security users for the current account/tenant with filtering and pagination.\r\n\r\n Query Parameters:\r\n - statusFilter: Filter by status (Active, Inactive, All) - Default: Active\r\n - searchText: Search across security user fields (max 100 chars)\r\n - pageNumber: Page number (1-based, min: 1) - Default: 1\r\n - pageSize: Items per page (1-1000 to prevent DoS) - Default: 25\r\n - sortColumn: Column to sort by (validated against whitelist)\r\n - sortDirection: Sort direction (asc/desc) - Default: asc\r\n - clearCache: Force refresh from database - Default: false\r\n\r\n Security:\r\n - Requires SecurityUser view permission\r\n - All queries are audit logged\r\n - Input is validated to help prevent DoS and unsafe filtering\r\n ", "operationId": "GetSecurityUserGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityUserDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Security" ], "summary": "User", "description": "Creates a new security user. If a password is provided, the password is hashed and saved.", "operationId": "SaveSecurityUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityUserSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/users/{identifier}": { "get": { "tags": [ "Security" ], "summary": "User", "description": "Retrieves the full security user profile for viewing or editing.", "operationId": "GetSecurityUser", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityUserDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Security" ], "summary": "User", "description": "Updates an existing security user. If a password is provided, the password is hashed and saved.", "operationId": "SaveSecurityUserWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityUserSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/users/update-password": { "post": { "tags": [ "Security" ], "summary": "User Password Update", "description": "Updates the password of a security user.", "operationId": "UpdateSecurityUserPassword", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSavePasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/user-groups": { "get": { "tags": [ "Security" ], "summary": "User Group List", "description": "Retrieves a paginated, filterable, and sortable list of user security/group assignments. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetSecurityUserSecurityGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityUserSecurityDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Security" ], "summary": "User Group", "description": "Creates a new user security/group assignment. Validates required fields and business rules before creation.", "operationId": "SaveSecurityUserSecurity", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityUserSecuritySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/user-groups/{identifier}": { "get": { "tags": [ "Security" ], "summary": "User Group", "description": "Retrieves a single user security/group assignment by its unique identifier.", "operationId": "GetSecurityUserSecurity", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityUserSecurityDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Security" ], "summary": "User Group", "description": "Updates an existing user security/group assignment. Validates required fields and business rules before saving.", "operationId": "SaveSecurityUserSecurityWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityUserSecuritySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/user-groups/security-groups": { "get": { "tags": [ "Security" ], "summary": "Security Groups", "description": "Retrieves all available security groups for the authenticated tenant, including inactive groups.", "operationId": "GetSecurityGroups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityGroupOptionDto" } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/user-groups/{identifier}/assigned-groups": { "get": { "tags": [ "Security" ], "summary": "Assigned Security Groups", "description": "Retrieves the active security groups currently assigned to the specified user.", "operationId": "GetAssignedSecurityGroups", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserAssignedSecurityGroupDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/user-groups/details": { "get": { "tags": [ "Security" ], "summary": "User Group Detail List", "description": "Retrieves a paginated, filterable, and sortable list of user security/group detail records. Supports search, filtering by various criteria, and customizable page size.", "operationId": "GetSecurityUserSecurityDetailGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityUserSecurityDetailDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Security" ], "summary": "User Group Detail", "description": "Creates a new user security/group detail record. Validates required fields and business rules before creation.", "operationId": "SaveSecurityUserSecurityDetail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityUserSecurityDetailSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/security/user-groups/details/{identifier}": { "get": { "tags": [ "Security" ], "summary": "User Group Detail", "description": "Retrieves a single user security/group detail record by its unique identifier.", "operationId": "GetSecurityUserSecurityDetail", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityUserSecurityDetailDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Security" ], "summary": "User Group Detail", "description": "Updates an existing user security/group detail record. Validates required fields and business rules before saving.", "operationId": "SaveSecurityUserSecurityDetailWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityUserSecurityDetailSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/scheduling/schedule-attendees": { "get": { "tags": [ "Scheduling" ], "summary": "Schedule Attendee List", "description": "Retrieves a list of schedule attendees for the current account/tenant.", "operationId": "GetScheduleAttendeeGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleAttendeeDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Scheduling" ], "summary": "Schedule Attendee", "description": "Creates a schedule attendee.", "operationId": "SaveScheduleAttendee", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleAttendeeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/scheduling/schedule-attendees/{identifier}": { "get": { "tags": [ "Scheduling" ], "summary": "Schedule Attendee", "description": "Retrieves the full schedule attendee profile for editing.", "operationId": "GetScheduleAttendee", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleAttendeeDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Scheduling" ], "summary": "Schedule Attendee", "description": "Updates a schedule attendee.", "operationId": "SaveScheduleAttendeeWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleAttendeeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/scheduling/schedule-availability": { "get": { "tags": [ "Scheduling" ], "summary": "Schedule Availability List", "description": "Retrieves a list of schedule availability records for the current account/tenant.", "operationId": "GetScheduleAvailabilityGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleAvailabilityDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Scheduling" ], "summary": "Schedule Availability", "description": "Creates a schedule availability record.", "operationId": "SaveScheduleAvailability", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleAvailabilitySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/scheduling/schedule-availability/{identifier}": { "get": { "tags": [ "Scheduling" ], "summary": "Schedule Availability", "description": "Retrieves the full schedule availability record for editing.", "operationId": "GetScheduleAvailability", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleAvailabilityDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Scheduling" ], "summary": "Schedule Availability", "description": "Updates a schedule availability record.", "operationId": "SaveScheduleAvailabilityWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleAvailabilitySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/scheduling/schedules": { "get": { "tags": [ "Scheduling" ], "summary": "Schedule List", "description": "Retrieves a list of schedules for the current account/tenant.", "operationId": "GetScheduleGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Scheduling" ], "summary": "Schedule", "description": "Creates a schedule. Returns the saved schedule result.", "operationId": "SaveSchedule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/scheduling/schedules/{identifier}": { "get": { "tags": [ "Scheduling" ], "summary": "Schedule", "description": "Retrieves the full schedule profile for editing. Middleware handles the BrillianceApiResult wrapper.", "operationId": "GetSchedule", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Scheduling" ], "summary": "Schedule", "description": "Updates a schedule. Returns the saved schedule result.", "operationId": "SaveScheduleWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/scheduling/schedule-hosts": { "get": { "tags": [ "Scheduling" ], "summary": "Schedule Host List", "description": "Retrieves a list of schedule hosts for the current account/tenant.", "operationId": "GetScheduleHostGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleHostDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Scheduling" ], "summary": "Schedule Host", "description": "Creates a schedule host.", "operationId": "SaveScheduleHost", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleHostSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/scheduling/schedule-hosts/{identifier}": { "get": { "tags": [ "Scheduling" ], "summary": "Schedule Host", "description": "Retrieves the full schedule host profile for editing.", "operationId": "GetScheduleHost", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleHostDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Scheduling" ], "summary": "Schedule Host", "description": "Updates a schedule host.", "operationId": "SaveScheduleHostWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleHostSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/scheduling/schedule-types": { "get": { "tags": [ "Scheduling" ], "summary": "Schedule Type List", "description": "Retrieves a list of schedule types for the current account/tenant.", "operationId": "GetScheduleTypeGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleTypeDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Scheduling" ], "summary": "Schedule Type", "description": "Creates a schedule type.", "operationId": "SaveScheduleType", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleTypeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/scheduling/schedule-types/{identifier}": { "get": { "tags": [ "Scheduling" ], "summary": "Schedule Type", "description": "Retrieves the full schedule type profile for editing.", "operationId": "GetScheduleType", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleTypeDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Scheduling" ], "summary": "Schedule Type", "description": "Updates a schedule type.", "operationId": "SaveScheduleTypeWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleTypeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/seo/ai-policy.txt": { "get": { "tags": [ "SEO" ], "summary": "ai-policy.txt", "description": "Retrieves the ai-policy.txt file for the current tenant.", "operationId": "GetAiPolicyTxt", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/seo/llms.txt": { "get": { "tags": [ "SEO" ], "summary": "llms.txt", "description": "Retrieves the llms.txt file for the current tenant.", "operationId": "GetLlmsTxt", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/seo/llms-full.txt": { "get": { "tags": [ "SEO" ], "summary": "llms-full.txt", "description": "Retrieves the llms-full.txt file for the current tenant.", "operationId": "GetLlmsFullTxt", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/seo/robots.txt": { "get": { "tags": [ "SEO" ], "summary": "robots.txt", "description": "Retrieves the robots.txt file for the current tenant.", "operationId": "GetRobotsTxt", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/seo/.well-known/security.txt": { "get": { "tags": [ "SEO" ], "summary": "security.txt", "description": "Retrieves the security.txt file for the current tenant.", "operationId": "GetSecurityTxt", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/seo/page-header/{pageSlug}": { "get": { "tags": [ "SEO" ], "summary": "Resolved SEO Header", "description": "Retrieves fully resolved SEO HTML head tags using template waterfall logic via stored procedure.", "operationId": "GetSeoPageHeader", "parameters": [ { "name": "pageSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeoHeadResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/seo/stylesheet/{themeName}.css": { "get": { "tags": [ "SEO" ], "summary": "Public Theme Stylesheet", "description": "Returns the combined stylesheet and icon CSS for a tenant theme.", "operationId": "GetPublicStylesheet", "parameters": [ { "name": "themeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/seo/sitemap.xml": { "get": { "tags": [ "SEO" ], "summary": "Sitemap", "description": "Retrieves the dynamic sitemap.xml for the current tenant.", "operationId": "GetSiteMapXml", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/sessions/current-token": { "post": { "tags": [ "Sessions" ], "operationId": "GetCurrentSessionToken", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionDto" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/settings/api-keys": { "get": { "tags": [ "Settings" ], "summary": "API Key List", "description": "Retrieves a paginated, filterable, and sortable list of API keys. API key values should be masked or omitted.", "operationId": "GetSettingApiKeyGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingApiKeyDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "API Key", "description": "Creates a new API key configuration. Validates required fields, scope, and tenant ownership before saving.", "operationId": "SaveSettingApiKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingApiKeySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/api-keys/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "API Key", "description": "Retrieves a single API key configuration by its unique identifier. API key values should be masked or omitted.", "operationId": "GetSettingApiKey", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingApiKeyDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "API Key", "description": "Updates an existing API key configuration. Validates required fields, scope, and tenant ownership before saving.", "operationId": "SaveSettingApiKeyWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingApiKeySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/applications": { "get": { "tags": [ "Settings" ], "summary": "Application List", "description": "Retrieves a paginated, filterable, and sortable list of application settings.", "operationId": "GetSettingApplicationGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingApplicationDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "Application", "description": "Creates a new application setting. Validates required fields and business rules before creation.", "operationId": "SaveSettingApplication", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingApplicationSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/applications/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "Application", "description": "Retrieves a single application setting by its unique identifier.", "operationId": "GetSettingApplication", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingApplicationDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "Application", "description": "Updates an existing application setting. Validates required fields and business rules before saving.", "operationId": "SaveSettingApplicationWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingApplicationSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/applications/{category}/{fieldName}": { "get": { "tags": [ "Settings" ], "summary": "Application by Key", "description": "Retrieves an application setting using the category and field name natural keys.", "operationId": "GetSettingApplicationByKey", "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingApplicationDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/applications/setup": { "get": { "tags": [ "Settings" ], "summary": "App Setup", "description": "Retrieves all application setup settings for the current tenant.", "operationId": "GetApplicationSetup", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GridResponseOfApplicationSettingDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "App Setup", "description": "Saves the overall application setup settings for the current tenant.", "operationId": "SaveApplicationSetup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingApplicationSetupDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/content-variables/resolve": { "post": { "tags": [ "Settings" ], "summary": "Resolve Content Variables", "description": "Resolves authenticated tenant-specific @VARIABLE@ values in supplied content.", "operationId": "ResolveContentVariables", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentVariableResolveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfContentVariableResolveResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfContentVariableResolveResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfContentVariableResolveResponse" } } } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/categories": { "get": { "tags": [ "Settings" ], "summary": "Category List", "description": "Retrieves a paginated, filterable, and sortable list of setting categories.", "operationId": "GetSettingCategoryGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingCategoryDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "Category", "description": "Creates a new setting category. Validates required fields and business rules before creation.", "operationId": "SaveSettingCategory", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingCategorySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/categories/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "Category", "description": "Retrieves a single setting category by its unique identifier.", "operationId": "GetSettingCategory", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingCategoryDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "Category", "description": "Updates an existing setting category. Validates required fields and business rules before saving.", "operationId": "SaveSettingCategoryWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingCategorySaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/datasets": { "get": { "tags": [ "Settings" ], "summary": "DataSet List", "description": "Retrieves a paginated, filterable, and sortable list of setting datasets.", "operationId": "GetSettingDataSetGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingDataSetDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "DataSet", "description": "Creates a new setting dataset. Validates required fields and business rules before creation.", "operationId": "SaveSettingDataSet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingDataSetSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/datasets/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "DataSet", "description": "Retrieves a single setting dataset by its unique identifier.", "operationId": "GetSettingDataSet", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingDataSetDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "DataSet", "description": "Updates an existing setting dataset. Validates required fields and business rules before saving.", "operationId": "SaveSettingDataSetWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingDataSetSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/datasets/category": { "get": { "tags": [ "Settings" ], "summary": "DataSet Category List", "description": "Retrieves a paginated, filterable, and sortable list of setting datasets for a specific category.", "operationId": "GetSettingDataSetByCategoryGrid", "parameters": [ { "name": "CategoryName", "in": "query", "schema": { "maxLength": 50, "type": "string" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied to searchable grid fields.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh read instead of cached category data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingDataSetDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/email-templates": { "get": { "tags": [ "Settings" ], "summary": "Email Template List", "description": "Retrieves a paginated, filterable, and sortable list of email templates.", "operationId": "GetSettingEmailTemplateGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingEmailTemplateDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "Email Template", "description": "Creates a new email template. Validates required fields and template safety rules before creation.", "operationId": "SaveSettingEmailTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingEmailTemplateSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/email-templates/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "Email Template", "description": "Retrieves a single email template by its unique identifier.", "operationId": "GetSettingEmailTemplate", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingEmailTemplateDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "Email Template", "description": "Updates an existing email template. Validates required fields and template safety rules before saving.", "operationId": "SaveSettingEmailTemplateWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingEmailTemplateSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/icons": { "get": { "tags": [ "Settings" ], "summary": "Icon List", "description": "Retrieves a paginated, filterable, and sortable list of setting icons.", "operationId": "GetSettingIconGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingIconDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "Icon", "description": "Creates a new setting icon. Validates required fields and icon safety rules before creation.", "operationId": "SaveSettingIcon", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingIconSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/icons/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "Icon", "description": "Retrieves a single setting icon by its unique identifier.", "operationId": "GetSettingIcon", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingIconDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "Icon", "description": "Updates an existing setting icon. Validates required fields and icon safety rules before saving.", "operationId": "SaveSettingIconWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingIconSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/languages": { "get": { "tags": [ "Settings" ], "summary": "Language List", "description": "Retrieves a paginated, filterable, and sortable list of configured site languages.", "operationId": "GetSettingLanguageGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingLanguageDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "Language", "description": "Creates a new site language configuration. Validates required fields and localization rules before creation.", "operationId": "SaveSettingLanguage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingLanguageSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/languages/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "Language", "description": "Retrieves a single configured site language by its unique identifier.", "operationId": "GetSettingLanguage", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingLanguageDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "Language", "description": "Updates an existing site language configuration. Validates required fields and localization rules before saving.", "operationId": "SaveSettingLanguageWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingLanguageSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/payment-providers": { "get": { "tags": [ "Settings" ], "summary": "Payment Provider List", "description": "Retrieves a paginated, filterable, and sortable list of configured payment providers. Sensitive provider credentials should be masked or omitted.", "operationId": "GetSettingPaymentProviderGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingPaymentProviderDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "Payment Provider", "description": "Creates a new payment provider configuration. Validates required fields, provider rules, tenant ownership, and credential handling before creation.", "operationId": "SaveSettingPaymentProvider", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingPaymentProviderSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/payment-providers/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "Payment Provider", "description": "Retrieves a single payment provider configuration by its unique identifier. Sensitive provider credentials should be masked or omitted.", "operationId": "GetSettingPaymentProvider", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingPaymentProviderDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "Payment Provider", "description": "Updates an existing payment provider configuration. Validates required fields, provider rules, tenant ownership, and credential handling before saving.", "operationId": "SaveSettingPaymentProviderWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingPaymentProviderSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/smtp": { "get": { "tags": [ "Settings" ], "summary": "SMTP List", "description": "Retrieves a paginated, filterable, and sortable list of configured SMTP providers. Sensitive credentials should be masked or omitted.", "operationId": "GetSettingSmtpGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingSmtpDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "SMTP", "description": "Creates a new SMTP configuration. Validates required fields, tenant ownership, sender rules, and credential handling before creation.", "operationId": "SaveSettingSmtp", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSmtpSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/smtp/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "SMTP", "description": "Retrieves a single SMTP configuration by its unique identifier. Sensitive credentials should be masked or omitted.", "operationId": "GetSettingSmtp", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSmtpDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "SMTP", "description": "Updates an existing SMTP configuration. Validates required fields, tenant ownership, sender rules, and credential handling before saving.", "operationId": "SaveSettingSmtpWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSmtpSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/suppression-lists": { "get": { "tags": [ "Settings" ], "summary": "Suppression List", "description": "Retrieves a paginated, filterable, and sortable list of suppressed email addresses, phone numbers, or contact destinations.", "operationId": "GetSettingSuppressionListGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingSuppressionListDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "Suppression", "description": "Creates a new suppression-list record. Validates destination, tenant ownership, consent state, and compliance rules before creation.", "operationId": "SaveSettingSuppressionList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSuppressionListSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/suppression-lists/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "Suppression", "description": "Retrieves a single suppression-list record by its unique identifier.", "operationId": "GetSettingSuppressionList", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSuppressionListDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "Suppression", "description": "Updates an existing suppression-list record. Validates destination, tenant ownership, consent state, and compliance rules before saving.", "operationId": "SaveSettingSuppressionListWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSuppressionListSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/system-alerts": { "get": { "tags": [ "Settings" ], "summary": "System Alert List", "description": "Retrieves a paginated, filterable, and sortable list of configured system alerts.", "operationId": "GetSettingSystemAlertGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingSystemAlertDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "System Alert", "description": "Creates a new system alert configuration. Validates required fields, tenant ownership, visibility, and alert rules before creation.", "operationId": "SaveSettingSystemAlert", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSystemAlertSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/system-alerts/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "System Alert", "description": "Retrieves a single system alert configuration by its unique identifier.", "operationId": "GetSettingSystemAlert", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSystemAlertDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "System Alert", "description": "Updates an existing system alert configuration. Validates required fields, tenant ownership, visibility, and alert rules before saving.", "operationId": "SaveSettingSystemAlertWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSystemAlertSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/templates": { "get": { "tags": [ "Settings" ], "summary": "Template List", "description": "Retrieves a paginated, filterable, and sortable list of configured templates.", "operationId": "GetSettingTemplateGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingTemplateDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "Template", "description": "Creates a new template. Validates required fields, tenant ownership, and template safety rules before creation.", "operationId": "SaveSettingTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingTemplateSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/templates/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "Template", "description": "Retrieves a single template by its unique identifier.", "operationId": "GetSettingTemplate", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingTemplateDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "Template", "description": "Updates an existing template. Validates required fields, tenant ownership, and template safety rules before saving.", "operationId": "SaveSettingTemplateWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingTemplateSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/themes": { "get": { "tags": [ "Settings" ], "summary": "Theme List", "description": "Retrieves a paginated, filterable, and sortable list of configured themes.", "operationId": "GetSettingThemeGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingThemeDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Settings" ], "summary": "Theme", "description": "Creates a new theme. Validates required fields, tenant ownership, branding assets, and stylesheet safety before creation.", "operationId": "SaveSettingTheme", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingThemeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/settings/themes/{identifier}": { "get": { "tags": [ "Settings" ], "summary": "Theme", "description": "Retrieves a single theme by its unique identifier.", "operationId": "GetSettingTheme", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingThemeDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Settings" ], "summary": "Theme", "description": "Updates an existing theme. Validates required fields, tenant ownership, branding assets, and stylesheet safety before saving.", "operationId": "SaveSettingThemeWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingThemeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/shared/page-contents/{pageSlug}": { "post": { "tags": [ "Shared" ], "summary": "Get Page Content", "description": "Retrieves dynamic page content by its URL slug.", "operationId": "GetPageBySlug", "parameters": [ { "name": "pageSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PageLookupRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageContentResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/forms": { "get": { "tags": [ "Shared" ], "summary": "Form List", "description": "Retrieves a grid/list of CMS forms for the current tenant.", "operationId": "GetFormGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FormDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] }, "post": { "tags": [ "Shared" ], "summary": "Form", "description": "Creates or saves a CMS form.", "operationId": "SaveForm", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/forms/{identifier}": { "get": { "tags": [ "Shared" ], "summary": "Form", "description": "Retrieves a specific CMS form by identifier.", "operationId": "GetForm", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FormDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] }, "put": { "tags": [ "Shared" ], "summary": "Form", "description": "Updates a CMS form.", "operationId": "SaveFormWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/status/{identifier}": { "get": { "tags": [ "Shared" ], "summary": "Form 4473 Status", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "GetFormStatusById", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form4473StatusDto" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{identifier}": { "get": { "tags": [ "Shared" ], "summary": "Form 4473", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "GetApiV1SharedForm4473IdentifierGuid", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form4473StatusDto" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{identifier}/access": { "get": { "tags": [ "Shared" ], "summary": "Form 4473 Access", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "GetFormAccessById", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form4473JurisdictionValidationDto" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{identifier}/buyer": { "get": { "tags": [ "Shared" ], "summary": "Form 4473 Buyer", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "GetBuyer", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form4473JurisdictionValidationDto" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{formIdentifier}/buyer": { "post": { "tags": [ "Shared" ], "summary": "Form 4473 Buyer Draft", "description": "Submits public form data for a specific Form 4473 buyer form.", "operationId": "SaveBuyerDraft", "parameters": [ { "name": "formIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicForm4473DraftSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{formIdentifier}/buyer/certify": { "post": { "tags": [ "Shared" ], "summary": "Certify Form 4473 Buyer", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "CertifyBuyer", "parameters": [ { "name": "formIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicForm4473BuyerCertificationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{formIdentifier}/buyer/recertify": { "post": { "tags": [ "Shared" ], "summary": "Recertify Form 4473 Buyer", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "RecertifyBuyer", "parameters": [ { "name": "formIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicForm4473BuyerRecertificationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{identifier}/questions": { "get": { "tags": [ "Shared" ], "summary": "Form 4473 Questions", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "GetQuestions", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form4473JurisdictionValidationDto" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{formIdentifier}/questions": { "post": { "tags": [ "Shared" ], "summary": "Form 4473 Questions Draft", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "SaveQuestionsDraft", "parameters": [ { "name": "formIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicForm4473DraftSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{identifier}/seller": { "get": { "tags": [ "Shared" ], "summary": "Form 4473 Seller", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "GetSeller", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form4473JurisdictionValidationDto" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{identifier}/firearms": { "get": { "tags": [ "Shared" ], "summary": "Form 4473 Firearms", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "GetFirearms", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form4473JurisdictionValidationDto" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{identifier}/attachments": { "get": { "tags": [ "Shared" ], "summary": "Form 4473 Attachments", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "GetAttachments", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form4473JurisdictionValidationDto" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{identifier}/certification-status": { "get": { "tags": [ "Shared" ], "summary": "Form 4473 Certification Status", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "GetCertificationStatus", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form4473JurisdictionValidationDto" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/form4473/{identifier}/jurisdiction-validation": { "get": { "tags": [ "Shared" ], "summary": "Form 4473 Jurisdiction Validation", "description": "Shared endpoints for managing content, accessibility components, forms, pages, and structured site data.", "operationId": "GetJurisdictionValidation", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form4473JurisdictionValidationDto" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests. Retry after the indicated delay." }, "500": { "description": "Internal Server Error." } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/language-page/{pageName}": { "post": { "tags": [ "Shared" ], "summary": "Language Page", "description": "Retrieves language settings for the current resolved tenant and user.", "operationId": "GetSettingsLanguage", "parameters": [ { "name": "pageName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageItemDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/payment-vaults": { "post": { "tags": [ "Shared" ], "summary": "Save Public Payment Vault", "description": "Saves a new payment vault entry from a public invoice report. Stores masked card/ACH metadata and token for future payments.", "operationId": "SavePublicPaymentVault", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentVaultSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfGuid" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/payments": { "post": { "tags": [ "Shared" ], "summary": "Save Public Payment", "description": "Records a payment against an invoice from a public invoice report, reducing the outstanding balance.", "operationId": "SavePublicPayment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/portal-settings": { "get": { "tags": [ "Shared" ], "summary": "Portal Settings", "description": "Returns the effective portal settings for the authenticated tenant and user.", "operationId": "GetPortalSettings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalSettingsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/scheduling/{slug}": { "get": { "tags": [ "Shared" ], "summary": "Get Public Schedule", "description": "Retrieves a public schedule type by its URL slug.", "operationId": "GetScheduleBySlug", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicScheduleDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/scheduling/{slug}/availability/{inputDate}": { "get": { "tags": [ "Shared" ], "summary": "Get Public Schedule Availability", "description": "Retrieves available appointment times for a public schedule.", "operationId": "GetApiV1SharedSchedulingSlugAvailabilityInputDate", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "inputDate", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicScheduleSlotDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/scheduling/{slug}/book": { "post": { "tags": [ "Shared" ], "summary": "Book Public Schedule", "description": "Books an available appointment from a public scheduling link.", "operationId": "BookSchedule", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PublicScheduleBookingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicScheduleBookingResult" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/templates/{templateName}": { "post": { "tags": [ "Shared" ], "summary": "Template Detail", "description": "Retrieves the full template configuration with resolved variables, including header, detail, and footer.", "operationId": "GetSettingsTemplate", "parameters": [ { "name": "templateName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/themes/{themeName}/css": { "get": { "tags": [ "Shared" ], "summary": "Theme CSS", "description": "Retrieves the processed CSS and icon variables for the specified theme.", "operationId": "GetThemeCss", "parameters": [ { "name": "themeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/themes/{themeName}/layout": { "post": { "tags": [ "Shared" ], "summary": "Theme Layout", "description": "Retrieves the resolved HTML layout and theme metadata.", "operationId": "GetThemeLayout", "parameters": [ { "name": "themeName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/unsubscribe": { "post": { "tags": [ "Shared" ], "summary": "Unsubscribe", "description": "Unsubscribes a communication subscriber using a validated unsubscribe token.", "operationId": "UnSubscriber", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnsubscribeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/virtual-card/{userIdentifier}": { "get": { "tags": [ "Shared" ], "summary": "Generate VCard File", "description": "Generates a vCard file for the specified user including contact information such as name, email addresses, phone numbers, addresses, and URLs.", "operationId": "GetVCard", "parameters": [ { "name": "userIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/shared/virtual-card/{username}": { "get": { "tags": [ "Shared" ], "summary": "Generate VCard Profile", "description": "Gets the user's virtual card site information.", "operationId": "GetProfileByUsername", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/technology/assets": { "get": { "tags": [ "Technology" ], "summary": "Asset List", "description": "Retrieves a high-level summary of all registered technology assets.", "operationId": "GetAssetGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Technology" ], "summary": "Asset", "description": "Creates technology asset metadata.", "operationId": "SaveAsset", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/technology/assets/{identifier}": { "get": { "tags": [ "Technology" ], "summary": "Asset", "description": "Retrieves the full configuration for a specific technology asset.", "operationId": "GetAsset", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Technology" ], "summary": "Asset", "description": "Updates technology asset metadata.", "operationId": "SaveAssetWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/technology/site-monitors": { "get": { "tags": [ "Technology" ], "summary": "Site Monitor List", "description": "Retrieves a high-level summary of all registered site monitors.", "operationId": "GetSiteMonitorGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GridResponseOfSiteMonitorGridDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Technology" ], "summary": "Site Monitor", "description": "Creates site monitor metadata.", "operationId": "SaveSiteMonitor", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteMonitorSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/technology/site-monitors/{identifier}": { "get": { "tags": [ "Technology" ], "summary": "Site Monitor", "description": "Retrieves the full configuration for a specific site monitor.", "operationId": "GetSiteMonitor", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteMonitorDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Technology" ], "summary": "Site Monitor", "description": "Updates site monitor metadata.", "operationId": "SaveSiteMonitorWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteMonitorSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/technology/site-monitors/details": { "get": { "tags": [ "Technology" ], "summary": "Site Monitor Detail List", "description": "Retrieves a high-level summary of site monitor details.", "operationId": "GetSiteMonitorDetailGrid", "parameters": [ { "name": "Identifier", "in": "query", "description": "Optional record identifier used by some grid endpoints for context filtering.", "schema": { "type": "string", "format": "uuid" } }, { "name": "StatusFilter", "in": "query", "description": "Status filter for grid records. Common values: Active, Inactive, All.", "schema": { "maxLength": 50, "type": "string", "default": "Active" } }, { "name": "SearchText", "in": "query", "description": "Free-text search term applied across relevant grid columns.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "1-based page number for paginated grid responses.", "schema": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "Page size for paginated grid responses. Allowed range: 1-1000.", "schema": { "maximum": 1000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "SortColumn", "in": "query", "description": "Column name used for sorting.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction. Allowed values: asc or desc.", "schema": { "pattern": "^(asc|desc)$", "type": "string", "default": "asc" } }, { "name": "ClearCache", "in": "query", "description": "Optional cache-bypass hint. True requests a fresh database read instead of cached grid data.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GridResponseOfSiteMonitorDetailGridDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "post": { "tags": [ "Technology" ], "summary": "Site Monitor Detail", "description": "Creates site monitor detail metadata.", "operationId": "SaveSiteMonitorDetail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteMonitorDetailSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/technology/site-monitors/details/{identifier}": { "get": { "tags": [ "Technology" ], "summary": "Site Monitor Detail", "description": "Retrieves the full detail record for a specific site monitor.", "operationId": "GetSiteMonitorDetail", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteMonitorDetailDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }, "put": { "tags": [ "Technology" ], "summary": "Site Monitor Detail", "description": "Updates site monitor detail metadata.", "operationId": "SaveSiteMonitorDetailWithId", "parameters": [ { "name": "identifier", "in": "path", "description": "Primary record identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteMonitorDetailSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrillianceApiResultOfboolean" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/widgets/weather": { "post": { "tags": [ "Widgets" ], "summary": "Weather", "description": "Retrieves weather for the specified location in the units requested.", "operationId": "GetWeather", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WeatherRequestDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WeatherDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } }, "/api/v1/widgets/widget": { "post": { "tags": [ "Widgets" ], "summary": "Widgets", "description": "Retrieves widget information.", "operationId": "GetWidget", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetRequestDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] } } }, "components": { "schemas": { "AccountDto": { "type": "object", "properties": { "accountIdentifier": { "type": "string", "format": "uuid" }, "parentAccountIdentifier": { "type": "string", "format": "uuid" }, "accountCode": { "type": "string" }, "accountName": { "type": "string" }, "websiteDomain": { "type": "string" }, "isParent": { "type": "boolean" }, "active": { "type": "boolean" }, "portalActive": { "type": "boolean" }, "isInvestor": { "type": "boolean" }, "isLead": { "type": "boolean" }, "isVendor": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "AccountSaveRequest": { "required": [ "accountCode", "accountName" ], "type": "object", "properties": { "accountIdentifier": { "type": "string", "format": "uuid" }, "parentAccountIdentifier": { "type": "string", "format": "uuid" }, "ownerIdentifier": { "type": "string", "format": "uuid" }, "businessTypeIdentifier": { "type": "string", "format": "uuid" }, "accountCode": { "maxLength": 50, "minLength": 0, "type": "string" }, "accountName": { "maxLength": 250, "minLength": 0, "type": "string" }, "websiteDomain": { "maxLength": 250, "minLength": 0, "type": "string" }, "isParent": { "type": "boolean" }, "active": { "type": "boolean" }, "portalActive": { "type": "boolean" }, "isInvestor": { "type": "boolean" }, "isLead": { "type": "boolean" }, "isVendor": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "AdaComponentDto": { "type": "object", "properties": { "adaComponentIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "componentName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "iconAccessible": { "type": "string" }, "iconClose": { "type": "string" }, "iconContrast": { "type": "string" }, "iconCursor": { "type": "string" }, "iconDyslexia": { "type": "string" }, "iconFooter": { "type": "string" }, "iconHighlight": { "type": "string" }, "iconImageNone": { "type": "string" }, "iconLineHeight": { "type": "string" }, "iconMagnifier": { "type": "string" }, "iconPause": { "type": "string" }, "iconReadingMask": { "type": "string" }, "IconSaturation": { "type": "string" }, "iconText": { "type": "string" }, "iconTextSpacing": { "type": "string" }, "cookieName": { "type": "string" }, "cookieDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "gridColumns": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerWidthNormal1": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerWidthExpanded1": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerWidthNormal2": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerWidthExpanded2": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerWidthNormal3": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerWidthExpanded3": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "footerText": { "type": "string" }, "footerUrl": { "type": "string" }, "active": { "type": "boolean" }, "showAnimations": { "type": "boolean" }, "showContrast": { "type": "boolean" }, "showCursor": { "type": "boolean" }, "showDyslexiaFont": { "type": "boolean" }, "showFontSize": { "type": "boolean" }, "showFooter": { "type": "boolean" }, "showHideImages": { "type": "boolean" }, "showLetterSpacing": { "type": "boolean" }, "showLineHeight": { "type": "boolean" }, "showLinks": { "type": "boolean" }, "showMagnifier": { "type": "boolean" }, "showReadingMask": { "type": "boolean" }, "showSaturation": { "type": "boolean" }, "showAccessibilityStatement": { "type": "boolean" }, "accessibilityStatement": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "AdaComponentSaveRequest": { "type": "object", "properties": { "adaComponentIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "componentName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "iconAccessible": { "type": "string" }, "iconClose": { "type": "string" }, "iconContrast": { "type": "string" }, "iconCursor": { "type": "string" }, "iconDyslexia": { "type": "string" }, "iconFooter": { "type": "string" }, "iconHighlight": { "type": "string" }, "iconImageNone": { "type": "string" }, "iconLineHeight": { "type": "string" }, "iconMagnifier": { "type": "string" }, "iconPause": { "type": "string" }, "iconReadingMask": { "type": "string" }, "IconSaturation": { "type": "string" }, "iconText": { "type": "string" }, "iconTextSpacing": { "type": "string" }, "cookieName": { "type": "string" }, "cookieDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "gridColumns": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerWidthNormal1": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerWidthExpanded1": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerWidthNormal2": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerWidthExpanded2": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerWidthNormal3": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerWidthExpanded3": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "footerText": { "type": "string" }, "footerUrl": { "type": "string" }, "active": { "type": "boolean" }, "showAnimations": { "type": "boolean" }, "showContrast": { "type": "boolean" }, "showCursor": { "type": "boolean" }, "showDyslexiaFont": { "type": "boolean" }, "showFontSize": { "type": "boolean" }, "showFooter": { "type": "boolean" }, "showHideImages": { "type": "boolean" }, "showLetterSpacing": { "type": "boolean" }, "showLineHeight": { "type": "boolean" }, "showLinks": { "type": "boolean" }, "showMagnifier": { "type": "boolean" }, "showReadingMask": { "type": "boolean" }, "showSaturation": { "type": "boolean" }, "showAccessibilityStatement": { "type": "boolean" }, "accessibilityStatement": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "AddressDto": { "type": "object", "properties": { "addressIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "addressType": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "displayName": { "type": "string" }, "companyName": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "latitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "longitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "timeZone": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "ModifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "AddressSaveRequest": { "type": "object", "properties": { "addressIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "addressType": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "displayName": { "type": "string" }, "companyName": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "latitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "longitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "timeZone": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "AgencyAdminTaskRequest": { "type": "object", "properties": { "agency_identifier": { "type": "string", "format": "uuid" }, "task_name": { "type": "string" }, "database_name": { "type": "string" }, "user_password": { "type": "string" } } }, "AgencyAdminTaskResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "task_name": { "type": "string" }, "message": { "type": "string" }, "started_at": { "type": [ "null", "string" ], "format": "date-time" }, "completed_at": { "type": [ "null", "string" ], "format": "date-time" } } }, "AgencyApiKeyDto": { "type": "object", "properties": { "apiKeyIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "apiKeyString": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "requestsPerDay": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "revokedDate": { "type": "string", "format": "date-time" }, "revokedReason": { "type": "string" }, "denyAll": { "type": "boolean" }, "rateLimitPerMinute": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "preferredAlgorithm": { "type": "string" }, "active": { "type": "boolean" }, "createdDate": { "type": [ "null", "string" ], "format": "date-time" }, "modifiedDate": { "type": [ "null", "string" ], "format": "date-time" } } }, "AgencyApiKeySaveRequest": { "type": "object", "properties": { "apiKeyIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "apiKeyString": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "requestsPerDay": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "revokedDate": { "type": "string", "format": "date-time" }, "revokedReason": { "type": "string" }, "denyAll": { "type": "boolean" }, "rateLimitPerMinute": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "preferredAlgorithm": { "type": "string" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "AgencyConnectionDto": { "type": "object", "properties": { "connectionStringIdentifier": { "type": "string", "format": "uuid" }, "apiKeyIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "sqlServer": { "type": "string" }, "sqlDatabase": { "type": "string" }, "sqlUsername": { "type": "string" }, "sqlPassword": { "type": "string" }, "sslHostName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "AgencyConnectionSaveRequest": { "type": "object", "properties": { "connectionStringIdentifier": { "type": "string", "format": "uuid" }, "apiKeyIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "sqlServer": { "type": "string" }, "sqlDatabase": { "type": "string" }, "sqlUsername": { "type": "string" }, "sqlPassword": { "type": "string" }, "sslHostName": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "AgencyDto": { "type": "object", "properties": { "agencyAccountIdentifier": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "AgencyLicenseGridDto": { "type": "object", "properties": { "licenseIdentifier": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "descriptionShort": { "type": "string" } } }, "AgencyLicenseSaveRequest": { "type": "object", "properties": { "regardingIdentifier": { "type": "string", "format": "uuid" }, "licenseIdentifier": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "AgencySaveRequest": { "required": [ "descriptionShort", "descriptionLong" ], "type": "object", "properties": { "agencyAccountIdentifier": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "maxLength": 250, "minLength": 0, "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ApiMetadata": { "required": [ "version", "processed_utc", "execution_time_ms", "trace_id" ], "type": "object", "properties": { "version": { "type": "string" }, "processed_utc": { "type": "string", "format": "date-time" }, "execution_time_ms": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "trace_id": { "type": "string" } } }, "ApplicationSettingDto": { "type": "object", "properties": { "category": { "type": "string" }, "fieldName": { "type": "string" }, "fieldValue": { "type": "string" } } }, "AssetDto": { "type": "object", "properties": { "assetIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "groupIdentifier": { "type": "string", "format": "uuid" }, "manufacturerIdentifier": { "type": "string", "format": "uuid" }, "productIdentifier": { "type": "string", "format": "uuid" }, "assetStatusIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "assetLinkIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "otherNotes": { "type": "string" }, "ipAddress": { "type": "string", "format": "byte" }, "warningExpirationDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "retailPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "purchasePrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "inInventory": { "type": "boolean" }, "warnOnWarrantyExpiration": { "type": "boolean" }, "active": { "type": "boolean" }, "CreatedBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "AssetSaveRequest": { "type": "object", "properties": { "assetIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "groupIdentifier": { "type": "string", "format": "uuid" }, "manufacturerIdentifier": { "type": "string", "format": "uuid" }, "productIdentifier": { "type": "string", "format": "uuid" }, "assetStatusIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "assetLinkIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "otherNotes": { "type": "string" }, "ipAddress": { "type": "string", "format": "byte" }, "warningExpirationDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "retailPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "purchasePrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "inInventory": { "type": "boolean" }, "warnOnWarrantyExpiration": { "type": "boolean" }, "active": { "type": "boolean" }, "CreatedBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "AuthRefreshRequestDto": { "required": [ "refreshToken" ], "type": "object", "properties": { "refreshToken": { "maxLength": 512, "minLength": 32, "type": "string" }, "clientFingerprint": { "maxLength": 256, "type": [ "null", "string" ] } } }, "AutomationDto": { "type": "object", "properties": { "automationIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "moduleIdentifier": { "type": "string", "format": "uuid" }, "automationTypeIdentifier": { "type": "string", "format": "uuid" }, "automationName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "rowVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "AutomationRequest": { "type": "object", "properties": { "regardingIdentifier": { "type": "string", "format": "uuid" }, "automationName": { "type": "string" } } }, "AutoNumberResponseDto": { "type": "object", "properties": { "regardingIdentifier": { "type": "string", "format": "uuid" }, "prefix": { "type": "string" }, "identifier": { "type": "string" }, "suffix": { "type": "string" }, "separator": { "type": [ "null", "string" ] }, "startingNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "currentNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "formattedValue": { "type": "string" } } }, "BankingDto": { "type": "object", "properties": { "bankingIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "accountTypeIdentifier": { "type": "string", "format": "uuid" }, "accountType": { "type": "string" }, "externalProviderIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "accountNumber": { "type": "string" }, "routingNumber": { "type": "string" }, "phoneNumber": { "type": "string" }, "startingBalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currentBalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "availableBalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currencyCode": { "type": "string" }, "active": { "type": "boolean" }, "openDate": { "type": "string", "format": "date-time" }, "closeDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "BankingSaveRequest": { "type": "object", "properties": { "bankingIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "accountTypeIdentifier": { "type": "string", "format": "uuid" }, "externalProviderIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "accountNumber": { "type": "string" }, "routingNumber": { "type": "string" }, "phoneNumber": { "type": "string" }, "startingBalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currentBalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "availableBalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currencyCode": { "type": "string" }, "active": { "type": "boolean" }, "openDate": { "type": "string", "format": "date-time" }, "closeDate": { "type": "string", "format": "date-time" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "BankingTransactionDto": { "type": "object", "properties": { "bankingTransactionIdentifier": { "type": "string", "format": "uuid" }, "bankingIdentifier": { "type": "string", "format": "uuid" }, "transactionDate": { "type": "string", "format": "date-time" }, "postedDate": { "type": "string", "format": "date-time" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "merchantName": { "type": "string" }, "categoryName": { "type": "string" }, "pending": { "type": "boolean" }, "externalTrackingIdentifier": { "type": "string" }, "closeDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "BankingTransactionSaveRequest": { "type": "object", "properties": { "bankingTransactionIdentifier": { "type": "string", "format": "uuid" }, "bankingIdentifier": { "type": "string", "format": "uuid" }, "transactionDate": { "type": "string", "format": "date-time" }, "postedDate": { "type": "string", "format": "date-time" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "merchantName": { "type": "string" }, "categoryName": { "type": "string" }, "pending": { "type": "boolean" }, "externalTrackingIdentifier": { "type": "string" }, "closeDate": { "type": "string", "format": "date-time" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "BankReconciliationDto": { "type": "object", "properties": { "reconciliationIdentifier": { "type": "string", "format": "uuid" }, "bankingIdentifier": { "type": "string", "format": "uuid" }, "bankName": { "type": "string" }, "statementDate": { "type": "string", "format": "date-time" }, "startingBalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "endingBalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "isCompleted": { "type": "boolean" }, "completedDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "BankReconciliationItemDto": { "type": "object", "properties": { "reconciliationItemIdentifier": { "type": "string", "format": "uuid" }, "reconciliationIdentifier": { "type": "string", "format": "uuid" }, "bankingTransactionIdentifier": { "type": "string", "format": "uuid" }, "cleared": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "BankReconciliationItemSaveRequest": { "type": "object", "properties": { "reconciliationItemIdentifier": { "type": "string", "format": "uuid" }, "reconciliationIdentifier": { "type": "string", "format": "uuid" }, "bankingTransactionIdentifier": { "type": "string", "format": "uuid" }, "cleared": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "BankReconciliationSaveRequest": { "type": "object", "properties": { "reconciliationIdentifier": { "type": "string", "format": "uuid" }, "bankingIdentifier": { "type": "string", "format": "uuid" }, "statementDate": { "type": "string", "format": "date-time" }, "startingBalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "endingBalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "isCompleted": { "type": "boolean" }, "completedDate": { "type": "string", "format": "date-time" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "Base64Request": { "required": [ "input" ], "type": "object", "properties": { "input": { "type": "string" }, "url_safe": { "type": "boolean", "default": false } } }, "Base64ToImageRequest": { "required": [ "base64_string", "mime_type", "file_name" ], "type": "object", "properties": { "base64_string": { "type": "string" }, "mime_type": { "type": [ "null", "string" ] }, "file_name": { "type": [ "null", "string" ] } } }, "BillDto": { "type": "object", "properties": { "billIdentifier": { "type": "string", "format": "uuid" }, "vendorIdentifier": { "type": "string", "format": "uuid" }, "vendorName": { "type": "string" }, "billNumber": { "type": "string" }, "billDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "totalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "statusName": { "type": "string" }, "isApproved": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "BillSaveRequest": { "type": "object", "properties": { "billIdentifier": { "type": "string", "format": "uuid" }, "vendorIdentifier": { "type": "string", "format": "uuid" }, "billNumber": { "type": "string" }, "billDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "totalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "isApproved": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "BimiOptions": { "required": [ "domain", "logo_url" ], "type": "object", "properties": { "domain": { "type": "string", "default": "example.com" }, "logo_url": { "type": "string", "default": "https://example.com/logo.svg" }, "vmc_url": { "type": [ "null", "string" ], "default": "" } } }, "BlogPostDto": { "type": "object", "properties": { "blogAuthorFirstName": { "type": "string" }, "blogAuthorLastName": { "type": "string" }, "blogPostIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "blogAuthor": { "type": "string", "format": "uuid" }, "pageSlug": { "type": "string" }, "blogTitle": { "type": "string" }, "blogContent": { "type": "string" }, "blogContentSmall": { "type": "string" }, "blogStatus": { "type": "string" }, "blogPostDate": { "type": "string", "format": "date-time" }, "aiGenerated": { "type": "boolean" }, "aiAssisted": { "type": "boolean" }, "pillarContent": { "type": "boolean" }, "tags": { "type": "string" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "BlogPostSaveRequest": { "type": "object", "properties": { "blogPostIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "blogAuthor": { "type": "string", "format": "uuid" }, "pageSlug": { "type": "string" }, "blogTitle": { "type": "string" }, "blogContent": { "type": "string" }, "blogContentSmall": { "type": "string" }, "blogStatus": { "type": "string" }, "blogPostDate": { "type": "string", "format": "date-time" }, "aIGenerated": { "type": "boolean" }, "aIAssisted": { "type": "boolean" }, "pillarContent": { "type": "boolean" }, "tags": { "type": "string" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "BoundBookAcquisitionDto": { "type": "object", "properties": { "boundBookAcquisitionIdentifier": { "type": "string", "format": "uuid" }, "boundBookIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "acquisitionStatusIdentifier": { "type": "string", "format": "uuid" }, "acquisitionTypeIdentifier": { "type": "string", "format": "uuid" }, "receiptGroupIdentifier": { "type": "string", "format": "uuid" }, "sourceUserIdentifier": { "type": "string", "format": "uuid" }, "sourceFederalFirearmsLicenseIdentifier": { "type": "string", "format": "uuid" }, "receivedByUserIdentifier": { "type": "string", "format": "uuid" }, "committedByUserIdentifier": { "type": "string", "format": "uuid" }, "acquisitionNumber": { "type": "string" }, "receiptReferenceNumber": { "type": "string" }, "sourceLicenseNumberSnapshot": { "type": "string" }, "invoiceNumber": { "type": "string" }, "purchaseOrderNumber": { "type": "string" }, "descriptionLong": { "type": "string" }, "receivedDate": { "type": "string", "format": "date-time" }, "acquisitionDate": { "type": "string", "format": "date-time" }, "sourceNameSnapshot": { "type": "string" }, "sourceTradeNameSnapshot": { "type": "string" }, "sourceAddress1Snapshot": { "type": "string" }, "sourceAddress2Snapshot": { "type": "string" }, "sourceCitySnapshot": { "type": "string" }, "sourceStateSnapshot": { "type": "string" }, "sourcePostalCodeSnapshot": { "type": "string" }, "sourceCountrySnapshot": { "type": "string" }, "sourceLicenseTypeSnapshot": { "type": "string" }, "sourceLicenseExpirationDateSnapshot": { "type": "string", "format": "date-time" }, "sourceIsLicensee": { "type": "boolean" }, "externalIdentifier": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "CreatedDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "BoundBookAcquisitionHistoryDto": { "type": "object", "properties": { "acquisition": { "$ref": "#/components/schemas/BoundBookAcquisitionDto" }, "disposition": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BoundBookDispositionDto" } ] }, "custody": { "type": "array", "items": { "$ref": "#/components/schemas/BoundBookItemCustodyDto" } } } }, "BoundBookAcquisitionSaveRequest": { "type": "object", "properties": { "boundBookAcquisitionIdentifier": { "type": "string", "format": "uuid" }, "boundBookIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "acquisitionStatusIdentifier": { "type": "string", "format": "uuid" }, "acquisitionTypeIdentifier": { "type": "string", "format": "uuid" }, "receiptGroupIdentifier": { "type": "string", "format": "uuid" }, "sourceUserIdentifier": { "type": "string", "format": "uuid" }, "sourceFederalFirearmsLicenseIdentifier": { "type": "string", "format": "uuid" }, "receivedByUserIdentifier": { "type": "string", "format": "uuid" }, "committedByUserIdentifier": { "type": "string", "format": "uuid" }, "acquisitionNumber": { "type": "string" }, "receiptReferenceNumber": { "type": "string" }, "sourceLicenseNumberSnapshot": { "type": "string" }, "invoiceNumber": { "type": "string" }, "purchaseOrderNumber": { "type": "string" }, "descriptionLong": { "type": "string" }, "receivedDate": { "type": "string", "format": "date-time" }, "acquisitionDate": { "type": "string", "format": "date-time" }, "sourceNameSnapshot": { "type": "string" }, "sourceTradeNameSnapshot": { "type": "string" }, "sourceAddress1Snapshot": { "type": "string" }, "sourceAddress2Snapshot": { "type": "string" }, "sourceCitySnapshot": { "type": "string" }, "sourceStateSnapshot": { "type": "string" }, "sourcePostalCodeSnapshot": { "type": "string" }, "sourceCountrySnapshot": { "type": "string" }, "sourceLicenseTypeSnapshot": { "type": "string" }, "sourceLicenseExpirationDateSnapshot": { "type": "string", "format": "date-time" }, "sourceIsLicensee": { "type": "boolean" }, "externalIdentifier": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "BoundBookCorrectionDto": { "type": "object", "properties": { "boundBookCorrectionIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "federalFirearmsLicenseIdentifier": { "type": "string", "format": "uuid" }, "correctionStatusIdentifier": { "type": "string", "format": "uuid" }, "correctionTypeIdentifier": { "type": "string", "format": "uuid" }, "correctionEntityTypeIdentifier": { "type": "string", "format": "uuid" }, "correctionEntityIdentifier": { "type": "string", "format": "uuid" }, "correctionNumber": { "type": "string" }, "correctionReferenceNumber": { "type": "string" }, "correctionReason": { "type": "string" }, "correctionExplanation": { "type": "string" }, "originalValuesJson": { "type": "string" }, "correctedValuesJson": { "type": "string" }, "changedFieldsJson": { "type": "string" }, "requestedByUserIdentifier": { "type": "string", "format": "uuid" }, "requestedDate": { "type": "string", "format": "date-time" }, "reviewedByUserIdentifier": { "type": "string", "format": "uuid" }, "reviewedDate": { "type": "string", "format": "date-time" }, "reviewNotes": { "type": "string" }, "approvedByUserIdentifier": { "type": "string", "format": "uuid" }, "approvedDate": { "type": "string", "format": "date-time" }, "appliedByUserIdentifier": { "type": "string", "format": "uuid" }, "appliedDate": { "type": "string", "format": "date-time" }, "rejectedByUserIdentifier": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" }, "rejectionReason": { "type": "string" }, "cancelledByUserIdentifier": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" }, "cancellationReason": { "type": "string" }, "externalIdentifier": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "CreatedDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "BoundBookCorrectionSaveRequest": { "type": "object", "properties": { "boundBookCorrectionIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "federalFirearmsLicenseIdentifier": { "type": "string", "format": "uuid" }, "correctionStatusIdentifier": { "type": "string", "format": "uuid" }, "correctionTypeIdentifier": { "type": "string", "format": "uuid" }, "correctionEntityTypeIdentifier": { "type": "string", "format": "uuid" }, "correctionEntityIdentifier": { "type": "string", "format": "uuid" }, "correctionNumber": { "type": "string" }, "correctionReferenceNumber": { "type": "string" }, "correctionReason": { "type": "string" }, "correctionExplanation": { "type": "string" }, "originalValuesJson": { "type": "string" }, "correctedValuesJson": { "type": "string" }, "changedFieldsJson": { "type": "string" }, "requestedByUserIdentifier": { "type": "string", "format": "uuid" }, "requestedDate": { "type": "string", "format": "date-time" }, "reviewedByUserIdentifier": { "type": "string", "format": "uuid" }, "reviewedDate": { "type": "string", "format": "date-time" }, "reviewNotes": { "type": "string" }, "approvedByUserIdentifier": { "type": "string", "format": "uuid" }, "approvedDate": { "type": "string", "format": "date-time" }, "appliedByUserIdentifier": { "type": "string", "format": "uuid" }, "appliedDate": { "type": "string", "format": "date-time" }, "rejectedByUserIdentifier": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" }, "rejectionReason": { "type": "string" }, "cancelledByUserIdentifier": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" }, "cancellationReason": { "type": "string" }, "externalIdentifier": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "BoundBookDispositionDto": { "type": "object", "properties": { "boundBookDispositionIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "federalFirearmsLicenseIdentifier": { "type": "string", "format": "uuid" }, "dispositionStatusIdentifier": { "type": "string", "format": "uuid" }, "dispositionTypeIdentifier": { "type": "string", "format": "uuid" }, "recipientUserIdentifier": { "type": "string", "format": "uuid" }, "recipientContactLicenseIdentifier": { "type": "string", "format": "uuid" }, "form4473Identifier": { "type": "string", "format": "uuid" }, "disposedByUserIdentifier": { "type": "string", "format": "uuid" }, "dispositionNumber": { "type": "string" }, "dispositionReferenceNumber": { "type": "string" }, "recipientNameSnapshot": { "type": "string" }, "recipientTradeNameSnapshot": { "type": "string" }, "recipientAddress1Snapshot": { "type": "string" }, "recipientAddress2Snapshot": { "type": "string" }, "recipientCitySnapshot": { "type": "string" }, "recipientStateSnapshot": { "type": "string" }, "recipientPostalCodeSnapshot": { "type": "string" }, "recipientCountrySnapshot": { "type": "string" }, "recipientLicenseNumberSnapshot": { "type": "string" }, "recipientLicenseTypeSnapshot": { "type": "string" }, "recipientLicenseExpirationDateSnapshot": { "type": "string", "format": "date-time" }, "form4473TransactionNumberSnapshot": { "type": "string" }, "backgroundCheckReferenceNumberSnapshot": { "type": "string" }, "backgroundCheckStatusSnapshot": { "type": "string" }, "invoiceNumber": { "type": "string" }, "salesOrderNumber": { "type": "string" }, "carrierName": { "type": "string" }, "trackingNumber": { "type": "string" }, "descriptionLong": { "type": "string" }, "dispositionDate": { "type": "string", "format": "date-time" }, "releasedDate": { "type": "string", "format": "date-time" }, "recipientIsLicensee": { "type": "boolean" }, "physicalReleaseConfirmed": { "type": "boolean" }, "committedByUserIdentifier": { "type": "string", "format": "uuid" }, "committedDate": { "type": "string", "format": "date-time" }, "cancelledByUserIdentifier": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" }, "cancellationReason": { "type": "string" }, "externalIdentifier": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "CreatedDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "BoundBookDispositionSaveRequest": { "type": "object", "properties": { "boundBookDispositionIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "federalFirearmsLicenseIdentifier": { "type": "string", "format": "uuid" }, "dispositionStatusIdentifier": { "type": "string", "format": "uuid" }, "dispositionTypeIdentifier": { "type": "string", "format": "uuid" }, "recipientUserIdentifier": { "type": "string", "format": "uuid" }, "recipientContactLicenseIdentifier": { "type": "string", "format": "uuid" }, "form4473Identifier": { "type": "string", "format": "uuid" }, "disposedByUserIdentifier": { "type": "string", "format": "uuid" }, "dispositionNumber": { "type": "string" }, "dispositionReferenceNumber": { "type": "string" }, "recipientNameSnapshot": { "type": "string" }, "recipientTradeNameSnapshot": { "type": "string" }, "recipientAddress1Snapshot": { "type": "string" }, "recipientAddress2Snapshot": { "type": "string" }, "recipientCitySnapshot": { "type": "string" }, "recipientStateSnapshot": { "type": "string" }, "recipientPostalCodeSnapshot": { "type": "string" }, "recipientCountrySnapshot": { "type": "string" }, "recipientLicenseNumberSnapshot": { "type": "string" }, "recipientLicenseTypeSnapshot": { "type": "string" }, "recipientLicenseExpirationDateSnapshot": { "type": "string", "format": "date-time" }, "form4473TransactionNumberSnapshot": { "type": "string" }, "backgroundCheckReferenceNumberSnapshot": { "type": "string" }, "backgroundCheckStatusSnapshot": { "type": "string" }, "invoiceNumber": { "type": "string" }, "salesOrderNumber": { "type": "string" }, "carrierName": { "type": "string" }, "trackingNumber": { "type": "string" }, "descriptionLong": { "type": "string" }, "dispositionDate": { "type": "string", "format": "date-time" }, "releasedDate": { "type": "string", "format": "date-time" }, "recipientIsLicensee": { "type": "boolean" }, "physicalReleaseConfirmed": { "type": "boolean" }, "committedByUserIdentifier": { "type": "string", "format": "uuid" }, "committedDate": { "type": "string", "format": "date-time" }, "cancelledByUserIdentifier": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" }, "cancellationReason": { "type": "string" }, "externalIdentifier": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "BoundBookItemCustodyDto": { "type": "object", "properties": { "boundBookItemCustodyIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "federalFirearmsLicenseIdentifier": { "type": "string", "format": "uuid" }, "custodyStatusIdentifier": { "type": "string", "format": "uuid" }, "custodyTypeIdentifier": { "type": "string", "format": "uuid" }, "fromUserIdentifier": { "type": "string", "format": "uuid" }, "toUserIdentifier": { "type": "string", "format": "uuid" }, "fromLocationIdentifier": { "type": "string", "format": "uuid" }, "toLocationIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingTypeIdentifier": { "type": "string", "format": "uuid" }, "custodyNumber": { "type": "string" }, "referenceNumber": { "type": "string" }, "fromLocationSnapshot": { "type": "string" }, "toLocationSnapshot": { "type": "string" }, "fromPersonSnapshot": { "type": "string" }, "toPersonSnapshot": { "type": "string" }, "descriptionLong": { "type": "string" }, "custodyDate": { "type": "string", "format": "date-time" }, "requiresAcknowledgement": { "type": "boolean" }, "acknowledgedByUserIdentifier": { "type": "string", "format": "uuid" }, "acknowledgedDate": { "type": "string", "format": "date-time" }, "completedByUserIdentifier": { "type": "string", "format": "uuid" }, "completedDate": { "type": "string", "format": "date-time" }, "cancelledByUserIdentifier": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" }, "cancellationReason": { "type": "string" }, "externalIdentifier": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "CreatedDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "BoundBookItemCustodySaveRequest": { "type": "object", "properties": { "boundBookItemCustodyIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "federalFirearmsLicenseIdentifier": { "type": "string", "format": "uuid" }, "custodyStatusIdentifier": { "type": "string", "format": "uuid" }, "custodyTypeIdentifier": { "type": "string", "format": "uuid" }, "fromUserIdentifier": { "type": "string", "format": "uuid" }, "toUserIdentifier": { "type": "string", "format": "uuid" }, "fromLocationIdentifier": { "type": "string", "format": "uuid" }, "toLocationIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingTypeIdentifier": { "type": "string", "format": "uuid" }, "custodyNumber": { "type": "string" }, "referenceNumber": { "type": "string" }, "fromLocationSnapshot": { "type": "string" }, "toLocationSnapshot": { "type": "string" }, "fromPersonSnapshot": { "type": "string" }, "toPersonSnapshot": { "type": "string" }, "descriptionLong": { "type": "string" }, "custodyDate": { "type": "string", "format": "date-time" }, "requiresAcknowledgement": { "type": "boolean" }, "acknowledgedByUserIdentifier": { "type": "string", "format": "uuid" }, "acknowledgedDate": { "type": "string", "format": "date-time" }, "completedByUserIdentifier": { "type": "string", "format": "uuid" }, "completedDate": { "type": "string", "format": "date-time" }, "cancelledByUserIdentifier": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" }, "cancellationReason": { "type": "string" }, "externalIdentifier": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "BoundBookItemDto": { "type": "object", "properties": { "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "boundBookIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemStatusIdentifier": { "type": "string", "format": "uuid" }, "firearmTypeIdentifier": { "type": "string", "format": "uuid" }, "firearmClassificationIdentifier": { "type": "string", "format": "uuid" }, "boundBookAcquisitionIdentifier": { "type": "string", "format": "uuid" }, "boundBookDispositionIdentifier": { "type": "string", "format": "uuid" }, "entryNumber": { "type": "string" }, "manufacturerName": { "type": "string" }, "importerName": { "type": "string" }, "countryOfManufacture": { "type": "string" }, "model": { "type": "string" }, "serialNumber": { "type": "string" }, "serialNumberNormalized": { "type": "string" }, "caliberOrGauge": { "type": "string" }, "descriptionLong": { "type": "string" }, "acquisitionDate": { "type": "string", "format": "date-time" }, "dispositionDate": { "type": "string", "format": "date-time" }, "isFrameOrReceiver": { "type": "boolean" }, "isPrivatelyMadeFirearm": { "type": "boolean" }, "isNfaFirearm": { "type": "boolean" }, "isCurioOrRelic": { "type": "boolean" }, "isAntiqueFirearm": { "type": "boolean" }, "isOpen": { "type": "boolean" }, "isOnPremises": { "type": "boolean" }, "isPendingCorrection": { "type": "boolean" }, "hasComplianceException": { "type": "boolean" }, "hasTheftOrLoss": { "type": "boolean" }, "externalIdentifier": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "BoundBookItemEvaluateDto": { "type": "object", "properties": { "boundBookIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "result": { "type": "string" }, "message": { "type": "string" }, "exists": { "type": "boolean" }, "isDuplicate": { "type": "boolean" }, "isPossibleDuplicate": { "type": "boolean" }, "currentState": { "type": "string" }, "currentAcquisitionIdentifier": { "type": "string", "format": "uuid" }, "currentAcquisitionDate": { "type": "string", "format": "date-time" }, "lastDispositionDate": { "type": "string", "format": "date-time" }, "hasOpenAcquisition": { "type": "boolean" }, "hasDisposition": { "type": "boolean" }, "isOnPremises": { "type": "boolean" }, "hasPendingCorrection": { "type": "boolean" }, "hasTheftOrLoss": { "type": "boolean" }, "acquisitionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dispositionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "custodyCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "correctionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "canCreateFirearm": { "type": "boolean" }, "canCreateAcquisition": { "type": "boolean" }, "canCreateDisposition": { "type": "boolean" }, "canCreateCustody": { "type": "boolean" }, "canCreateCorrection": { "type": "boolean" } } }, "BoundBookItemEvaluateRequest": { "type": "object", "properties": { "boundBookIdentifier": { "type": "string", "format": "uuid" }, "manufacturerName": { "type": "string" }, "importerName": { "type": "string" }, "model": { "type": "string" }, "serialNumber": { "type": "string" } } }, "BoundBookItemHistoryDto": { "type": "object", "properties": { "boundBookIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "firearm": { "$ref": "#/components/schemas/BoundBookItemDto" }, "currentState": { "type": "string" }, "currentAcquisitionIdentifier": { "type": "string", "format": "uuid" }, "currentAcquisitionDate": { "type": "string", "format": "date-time" }, "lastDispositionDate": { "type": "string", "format": "date-time" }, "acquisitionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dispositionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "custodyCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "correctionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "acquisitions": { "type": "array", "items": { "$ref": "#/components/schemas/BoundBookAcquisitionHistoryDto" } }, "corrections": { "type": "array", "items": { "$ref": "#/components/schemas/BoundBookCorrectionDto" } } } }, "BoundBookItemReceiveRequest": { "type": "object", "properties": { "boundBookIdentifier": { "type": "string", "format": "uuid" }, "firearm": { "$ref": "#/components/schemas/BoundBookItemSaveRequest" }, "acquisition": { "$ref": "#/components/schemas/BoundBookAcquisitionSaveRequest" } } }, "BoundBookItemReceiveResultDto": { "type": "object", "properties": { "success": { "type": "boolean" }, "result": { "type": "string" }, "message": { "type": "string" }, "boundBookIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "boundBookAcquisitionIdentifier": { "type": "string", "format": "uuid" }, "createdFirearm": { "type": "boolean" }, "createdAcquisition": { "type": "boolean" }, "currentState": { "type": "string" } } }, "BoundBookItemSaveRequest": { "type": "object", "properties": { "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "boundBookIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemStatusIdentifier": { "type": "string", "format": "uuid" }, "firearmTypeIdentifier": { "type": "string", "format": "uuid" }, "firearmClassificationIdentifier": { "type": "string", "format": "uuid" }, "boundBookAcquisitionIdentifier": { "type": "string", "format": "uuid" }, "boundBookDispositionIdentifier": { "type": "string", "format": "uuid" }, "entryNumber": { "type": "string" }, "manufacturerName": { "type": "string" }, "importerName": { "type": "string" }, "countryOfManufacture": { "type": "string" }, "model": { "type": "string" }, "serialNumber": { "type": "string" }, "serialNumberNormalized": { "type": "string" }, "caliberOrGauge": { "type": "string" }, "descriptionLong": { "type": "string" }, "acquisitionDate": { "type": "string", "format": "date-time" }, "dispositionDate": { "type": "string", "format": "date-time" }, "isFrameOrReceiver": { "type": "boolean" }, "isPrivatelyMadeFirearm": { "type": "boolean" }, "isNfaFirearm": { "type": "boolean" }, "isCurioOrRelic": { "type": "boolean" }, "isAntiqueFirearm": { "type": "boolean" }, "isOpen": { "type": "boolean" }, "isOnPremises": { "type": "boolean" }, "isPendingCorrection": { "type": "boolean" }, "hasComplianceException": { "type": "boolean" }, "hasTheftOrLoss": { "type": "boolean" }, "externalIdentifier": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "BoundBookItemStateDto": { "type": "object", "properties": { "boundBookIdentifier": { "type": "string", "format": "uuid" }, "boundBookItemIdentifier": { "type": "string", "format": "uuid" }, "currentState": { "type": "string" }, "identityStatus": { "type": "string" }, "identityComplete": { "type": "boolean" }, "identityIssueCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "identityIssueSummary": { "type": "string" }, "identityIssues": { "type": "array", "items": { "type": "string" } }, "currentAcquisitionIdentifier": { "type": "string", "format": "uuid" }, "currentAcquisitionDate": { "type": "string", "format": "date-time" }, "lastDispositionDate": { "type": "string", "format": "date-time" }, "hasOpenAcquisition": { "type": "boolean" }, "hasDisposition": { "type": "boolean" }, "isOnPremises": { "type": "boolean" }, "hasPendingCorrection": { "type": "boolean" }, "hasComplianceException": { "type": "boolean" }, "hasTheftOrLoss": { "type": "boolean" }, "acquisitionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dispositionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "custodyCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "correctionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "canEditFirearm": { "type": "boolean" }, "canReceiveFirearm": { "type": "boolean" }, "requiresCorrection": { "type": "boolean" }, "canCreateAcquisition": { "type": "boolean" }, "canCreateDisposition": { "type": "boolean" }, "canCreateCustody": { "type": "boolean" }, "canCreateCorrection": { "type": "boolean" } } }, "BoundBookSaveRequest": { "type": "object", "properties": { "boundBookIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "bookStatusIdentifier": { "type": "string", "format": "uuid" }, "bookTypeIdentifier": { "type": "string", "format": "uuid" }, "federalFirearmsLicenseIdentifier": { "type": "string", "format": "uuid" }, "bookEnvironmentIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "boundBookNumber": { "type": "string" }, "licenseNumber": { "type": "string" }, "licenseTypeCode": { "type": "string" }, "licenseeName": { "type": "string" }, "tradeName": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "closedDate": { "type": "string", "format": "date-time" }, "lastReconciliationDate": { "type": "string", "format": "date-time" }, "defaultBook": { "type": "boolean" }, "officialBook": { "type": "boolean" }, "testBook": { "type": "boolean" }, "locked": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "BoundBookStatusDto": { "type": "object", "properties": { "boundBookIdentifier": { "type": "string", "format": "uuid" }, "wasFound": { "type": "boolean" }, "found": { "type": "boolean" }, "isAvailableForUse": { "type": "boolean" }, "availableForUse": { "type": "boolean" }, "canCreateAcquisition": { "type": "boolean" }, "canCreateDisposition": { "type": "boolean" }, "canRecordCustody": { "type": "boolean" }, "canCreateCorrection": { "type": "boolean" }, "canUseForForm4473": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "availabilityStatus": { "type": "string" }, "availabilityMessage": { "type": "string" }, "boundBookNumber": { "type": "string" }, "descriptionShort": { "type": "string" }, "bookType": { "type": "string" }, "bookStatus": { "type": "string" }, "federalFirearmsLicenseIdentifier": { "type": "string", "format": "uuid" }, "federalFirearmsLicenseNumber": { "type": "string" }, "locationIdentifier": { "type": "string", "format": "uuid" }, "locationName": { "type": "string" }, "isActive": { "type": "boolean" }, "isDefaultBook": { "type": "boolean" }, "isTestBook": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "isClosed": { "type": "boolean" }, "effectiveDate": { "type": "string", "format": "date-time" }, "closedDate": { "type": "string", "format": "date-time" }, "visibleSections": { "type": "array", "items": { "type": "string" } }, "lockedSections": { "type": "array", "items": { "type": "string" } }, "allowedOperations": { "type": "array", "items": { "type": "string" } } } }, "BrillianceApiResultOfAgencyAdminTaskResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AgencyAdminTaskResult" } ] }, "errors": { "type": "array", "items": { "type": "string" } }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ApiMetadata" } ] } } }, "BrillianceApiResultOfboolean": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ApiMetadata" } ] } } }, "BrillianceApiResultOfContentVariableResolveResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContentVariableResolveResponse" } ] }, "errors": { "type": "array", "items": { "type": "string" } }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ApiMetadata" } ] } } }, "BrillianceApiResultOfGuid": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string", "format": "uuid" }, "errors": { "type": "array", "items": { "type": "string" } }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ApiMetadata" } ] } } }, "BrillianceApiResultOfInvoiceEmailResultDto": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/InvoiceEmailResultDto" } ] }, "errors": { "type": "array", "items": { "type": "string" } }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ApiMetadata" } ] } } }, "BrillianceApiResultOfPhoneLookupData": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PhoneLookupData" } ] }, "errors": { "type": "array", "items": { "type": "string" } }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ApiMetadata" } ] } } }, "CampaignDto": { "type": "object", "properties": { "campaignIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "campaignName": { "type": "string" }, "campaignType": { "type": "string" }, "messageSubject": { "type": "string" }, "messageBody": { "type": "string" }, "templateIdentifier": { "type": "string", "format": "uuid" }, "scheduledDate": { "type": "string", "format": "date-time" }, "useUtm": { "type": "boolean" }, "utmSource": { "type": "string" }, "utmMedium": { "type": "string" }, "utmCampaign": { "type": "string" }, "utmContent": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "CampaignSaveRequest": { "type": "object", "properties": { "campaignIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "campaignName": { "type": "string" }, "campaignType": { "type": "string" }, "messageSubject": { "type": "string" }, "messageBody": { "type": "string" }, "templateIdentifier": { "type": "string", "format": "uuid" }, "scheduledDate": { "type": "string", "format": "date-time" }, "useUtm": { "type": "boolean" }, "utmSource": { "type": "string" }, "utmMedium": { "type": "string" }, "utmCampaign": { "type": "string" }, "utmContent": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "CampaignSendTestRequest": { "type": "object", "properties": { "toAddresses": { "type": "array", "items": { "type": "string" } }, "sendMode": { "type": "string" }, "campaignNote": { "type": "string" } } }, "CardDto": { "type": "object", "properties": { "cardIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "imageFrontIdentifier": { "type": "string", "format": "uuid" }, "imageBackIdentifier": { "type": "string", "format": "uuid" }, "heightUnitIdentifier": { "type": "string", "format": "uuid" }, "weightUnitIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "cardNumber": { "type": "string" }, "cardName": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time" }, "issuingAuthority": { "type": "string" }, "placeOfBirth": { "type": "string" }, "birthday": { "type": "string", "format": "date-time" }, "height": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isDonor": { "type": "boolean" }, "eyeColor": { "type": "string" }, "HairColor": { "type": "string" }, "bloodType": { "type": "string" }, "classification": { "type": "string" }, "restrictions": { "type": "string" }, "active": { "type": "boolean" }, "isProtected": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "CardGeneratorRequest": { "required": [ "brand" ], "type": "object", "properties": { "brand": { "type": "string", "default": "visa" }, "quantity": { "maximum": 10, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } } }, "CardSaveRequest": { "type": "object", "properties": { "cardIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "imageFrontIdentifier": { "type": "string", "format": "uuid" }, "imageBackIdentifier": { "type": "string", "format": "uuid" }, "heightUnitIdentifier": { "type": "string", "format": "uuid" }, "weightUnitIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "cardNumber": { "type": "string" }, "cardName": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time" }, "issuingAuthority": { "type": "string" }, "placeOfBirth": { "type": "string" }, "birthday": { "type": "string", "format": "date-time" }, "height": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isDonor": { "type": "boolean" }, "eyeColor": { "type": "string" }, "HairColor": { "type": "string" }, "bloodType": { "type": "string" }, "classification": { "type": "string" }, "restrictions": { "type": "string" }, "active": { "type": "boolean" }, "isProtected": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "CaseStudyDto": { "type": "object", "properties": { "caseStudyIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "templateIdentifier": { "type": "string", "format": "uuid" }, "pageName": { "type": "string" }, "descriptionShort": { "type": "string" }, "primaryUrl": { "type": "string" }, "descriptionIntroduction": { "type": "string" }, "descriptionChallenge": { "type": "string" }, "descriptionSolution": { "type": "string" }, "descriptionBenefit": { "type": "string" }, "descriptionResults": { "type": "string" }, "caseDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "ModifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "CaseStudySaveRequest": { "type": "object", "properties": { "caseStudyIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "templateIdentifier": { "type": "string", "format": "uuid" }, "pageName": { "type": "string" }, "descriptionShort": { "type": "string" }, "primaryUrl": { "type": "string" }, "descriptionIntroduction": { "type": "string" }, "descriptionChallenge": { "type": "string" }, "descriptionSolution": { "type": "string" }, "descriptionBenefit": { "type": "string" }, "descriptionResults": { "type": "string" }, "caseDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ChartOfAccountDto": { "type": "object", "properties": { "chartOfAccountIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "subAccountIdentifier": { "type": "string", "format": "uuid" }, "accountTypeIdentifier": { "type": "string", "format": "uuid" }, "accountType": { "type": "string" }, "normalBalanceTypeIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "accountNumber": { "type": "string" }, "accountNumberRules": { "type": "string" }, "regulatoryMappingId": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "balanceDate": { "type": "string", "format": "date-time" }, "startingBalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "isParent": { "type": "boolean" }, "isControlAccount": { "type": "boolean" }, "currencyCode": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "Active": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ChartOfAccountSaveRequest": { "type": "object", "properties": { "chartOfAccountIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "subAccountIdentifier": { "type": "string", "format": "uuid" }, "accountTypeIdentifier": { "type": "string", "format": "uuid" }, "normalBalanceTypeIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "accountNumber": { "type": "string" }, "accountNumberRules": { "type": "string" }, "regulatoryMappingId": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "balanceDate": { "type": "string", "format": "date-time" }, "startingBalance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "isParent": { "type": "boolean" }, "isControlAccount": { "type": "boolean" }, "currencyCode": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "Active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ContentVariableResolveRequest": { "type": "object", "properties": { "user_identifier": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "page_number": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "force_refresh": { "type": "boolean" } } }, "ContentVariableResolveResponse": { "type": "object", "properties": { "resolvedContent": { "type": "string" } } }, "ContrastRequest": { "required": [ "foreground", "background" ], "type": "object", "properties": { "foreground": { "type": "string" }, "background": { "type": "string" } } }, "ConversionRequest": { "required": [ "value", "from", "to" ], "type": "object", "properties": { "value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "from": { "type": [ "null", "string" ] }, "to": { "type": [ "null", "string" ] } } }, "CourseAttendeeDto": { "type": "object", "properties": { "attendeeIdentifier": { "type": "string", "format": "uuid" }, "courseIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "attendeeTypeIdentifier": { "type": "string", "format": "uuid" }, "registeredDate": { "type": "string", "format": "date-time" }, "paid": { "type": "boolean" }, "attended": { "type": "boolean" }, "passed": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "CourseAttendeeSaveRequest": { "type": "object", "properties": { "attendeeIdentifier": { "type": "string", "format": "uuid" }, "courseIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "attendeeTypeIdentifier": { "type": "string", "format": "uuid" }, "registeredDate": { "type": "string", "format": "date-time" }, "paid": { "type": "boolean" }, "attended": { "type": "boolean" }, "passed": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "CourseDto": { "type": "object", "properties": { "courseIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "courseNumber": { "type": "string" }, "courseInstructor": { "type": "string" }, "descriptionMaterials": { "type": "string" }, "courseInstructions": { "type": "string" }, "courseDays": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "courseHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "participantsMin": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "participantsMax": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cost": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "costNonMember": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "hideRegisterButton": { "type": "boolean" }, "mandatedTraining": { "type": "boolean" }, "OnlineCourse": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "CourseSaveRequest": { "type": "object", "properties": { "courseIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "courseNumber": { "type": "string" }, "courseInstructor": { "type": "string" }, "descriptionMaterials": { "type": "string" }, "courseInstructions": { "type": "string" }, "courseDays": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "courseHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "participantsMin": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "participantsMax": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cost": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "costNonMember": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "hideRegisterButton": { "type": "boolean" }, "mandatedTraining": { "type": "boolean" }, "OnlineCourse": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "CreditMemoDto": { "type": "object", "properties": { "creditMemoIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "referenceInvoiceIdentifier": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": "string" }, "memoNumber": { "type": "string" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "reason": { "type": "string" }, "isApplied": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "CreditMemoSaveRequest": { "type": "object", "properties": { "creditMemoIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "referenceInvoiceIdentifier": { "type": "string", "format": "uuid" }, "memoNumber": { "type": "string" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "reason": { "type": "string" }, "isApplied": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "CustomFieldDto": { "type": "object", "properties": { "customFieldIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "frequencyIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "iconName": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isPrivate": { "type": "boolean" }, "displayGrid": { "type": "boolean" }, "displayPublicly": { "type": "boolean" }, "active": { "type": "boolean" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "isProtected": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "CustomFieldSaveRequest": { "type": "object", "properties": { "customFieldIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "frequencyIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "iconName": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isPrivate": { "type": "boolean" }, "displayGrid": { "type": "boolean" }, "displayPublicly": { "type": "boolean" }, "active": { "type": "boolean" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "isProtected": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "CustomTrigger": { "required": [ "phrase", "reason" ], "type": "object", "properties": { "phrase": { "maxLength": 100, "type": "string" }, "points": { "maximum": 100, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "reason": { "maxLength": 200, "type": "string" } } }, "CvdSimulationRequest": { "required": [ "hex" ], "type": "object", "properties": { "hex": { "type": "string" } } }, "DateDto": { "type": "object", "properties": { "dateIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "recurringFrequencyIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "eventDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "iconName": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isHoliday": { "type": "boolean" }, "active": { "type": "boolean" }, "recurring": { "type": "boolean" }, "remindBeforeDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lastSentDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "ModifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DateSaveRequest": { "type": "object", "properties": { "dateIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "recurringFrequencyIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "eventDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "iconName": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isHoliday": { "type": "boolean" }, "active": { "type": "boolean" }, "recurring": { "type": "boolean" }, "remindBeforeDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lastSentDate": { "type": "string", "format": "date-time" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "DefaultItem": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldValue": { "type": "string" } } }, "DefaultSaveRequest": { "type": "object", "properties": { "category": { "type": "string" }, "generalSettings": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultItem" } }, "defaultValues": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultItem" } } } }, "DefaultSingleItem": { "type": "object", "properties": { "category": { "type": "string" }, "fieldName": { "type": "string" }, "fieldValue": { "type": "string" } } }, "DkimOptions": { "required": [ "domain", "selector" ], "type": "object", "properties": { "domain": { "type": "string", "default": "example.com" }, "selector": { "type": "string", "default": "brilliance" }, "key_length": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 2048 } } }, "DmarcOptions": { "required": [ "domain" ], "type": "object", "properties": { "domain": { "type": "string", "default": "example.com" }, "policy": { "default": 1, "$ref": "#/components/schemas/DmarcPolicyType" }, "subdomain_policy": { "default": 1, "$ref": "#/components/schemas/DmarcPolicyType" }, "strict_spf": { "type": "boolean", "default": false }, "strict_dkim": { "type": "boolean", "default": false }, "rua_email": { "type": [ "null", "string" ] }, "ruf_email": { "type": [ "null", "string" ] }, "forensic_options": { "type": "string", "default": "0" }, "rollout_percentage": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 }, "reporting_interval": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 86400 } } }, "DmarcPolicyType": { "type": "integer" }, "DocumentDto": { "type": "object", "properties": { "documentIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "documentDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "externalUrl": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DocumentProcessingJobDto": { "type": "object", "properties": { "documentProcessingJobIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "documentIdentifier": { "type": "string", "format": "uuid" }, "documentVersionIdentifier": { "type": "string", "format": "uuid" }, "blobIdentifier": { "type": "string", "format": "uuid" }, "processingType": { "type": "string" }, "status": { "type": "string" }, "priority": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "attemptCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxAttempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "queuedDate": { "type": "string", "format": "date-time" }, "startedDate": { "type": [ "null", "string" ], "format": "date-time" }, "completedDate": { "type": [ "null", "string" ], "format": "date-time" }, "nextAttemptDate": { "type": [ "null", "string" ], "format": "date-time" }, "processingProvider": { "type": "string" }, "processingModel": { "type": "string" }, "processingModelVersion": { "type": "string" }, "externalProcessingUsed": { "type": "boolean" }, "processingBoundary": { "type": "string" }, "resultCode": { "type": "string" }, "errorCode": { "type": "string" }, "errorMessage": { "type": "string" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DocumentProcessingJobGridDto": { "type": "object", "properties": { "documentProcessingJobIdentifier": { "type": "string", "format": "uuid" }, "documentIdentifier": { "type": "string", "format": "uuid" }, "documentVersionIdentifier": { "type": "string", "format": "uuid" }, "blobIdentifier": { "type": "string", "format": "uuid" }, "processingType": { "type": "string" }, "status": { "type": "string" }, "priority": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "attemptCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxAttempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "queuedDate": { "type": "string", "format": "date-time" }, "startedDate": { "type": [ "null", "string" ], "format": "date-time" }, "completedDate": { "type": [ "null", "string" ], "format": "date-time" }, "processingProvider": { "type": "string" }, "processingBoundary": { "type": "string" }, "active": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DocumentProcessingJobSaveRequest": { "type": "object", "properties": { "documentProcessingJobIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "documentIdentifier": { "type": "string", "format": "uuid" }, "documentVersionIdentifier": { "type": "string", "format": "uuid" }, "blobIdentifier": { "type": "string", "format": "uuid" }, "processingType": { "type": "string" }, "priority": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxAttempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "DocumentRelationshipDto": { "type": "object", "properties": { "documentRelationshipIdentifier": { "type": "string", "format": "uuid" }, "documentIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingType": { "type": "string" }, "isPrimary": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DocumentRelationshipGridDto": { "type": "object", "properties": { "documentRelationshipIdentifier": { "type": "string", "format": "uuid" }, "documentIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingType": { "type": "string" }, "isPrimary": { "type": "boolean" }, "active": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DocumentRelationshipSaveRequest": { "type": "object", "properties": { "documentRelationshipIdentifier": { "type": "string", "format": "uuid" }, "documentIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingType": { "type": "string" }, "isPrimary": { "type": "boolean" }, "active": { "type": "boolean" } } }, "DocumentSaveRequest": { "type": "object", "properties": { "documentIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "documentDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "documentViews": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "externalUrl": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "DocumentVersionDto": { "type": "object", "properties": { "documentVersionIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "documentIdentifier": { "type": "string", "format": "uuid" }, "blobIdentifier": { "type": "string", "format": "uuid" }, "versionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "versionLabel": { "type": "string" }, "isCurrent": { "type": "boolean" }, "originalFileName": { "type": "string" }, "storedFileName": { "type": "string" }, "mimeType": { "type": "string" }, "fileExtension": { "type": "string" }, "fileSizeBytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "storageProvider": { "type": "string" }, "storageReference": { "type": "string" }, "checksumSha256": { "type": "string" }, "checksumAlgorithm": { "type": "string" }, "virusScanStatus": { "type": "string" }, "virusScanUtc": { "type": [ "null", "string" ], "format": "date-time" }, "ocrStatus": { "type": "string" }, "textExtractionStatus": { "type": "string" }, "uploadedUtc": { "type": "string", "format": "date-time" }, "uploadedByUserIdentifier": { "type": [ "null", "string" ], "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DocumentVersionSaveRequest": { "type": "object", "properties": { "documentVersionIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "documentIdentifier": { "type": "string", "format": "uuid" }, "blobIdentifier": { "type": "string", "format": "uuid" }, "versionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "versionLabel": { "type": "string" }, "isCurrent": { "type": "boolean" }, "originalFileName": { "type": "string" }, "storedFileName": { "type": "string" }, "mimeType": { "type": "string" }, "fileExtension": { "type": "string" }, "fileSizeBytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "storageProvider": { "type": "string" }, "storageReference": { "type": "string" }, "checksumSha256": { "type": "string" }, "checksumAlgorithm": { "type": "string" }, "virusScanStatus": { "type": "string" }, "ocrStatus": { "type": "string" }, "textExtractionStatus": { "type": "string" } } }, "DrugTestingClientDto": { "type": "object", "properties": { "drugTestingClientIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "groupIdentifier": { "type": "string", "format": "uuid" }, "caseManagerIdentifier": { "type": "string", "format": "uuid" }, "miscId": { "type": "string" }, "ssnNumber": { "type": "string" }, "caseNumber": { "type": "string" }, "active": { "type": "boolean" }, "clientNumber": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "otherNotes": { "type": "string" }, "offenseType": { "type": "string" }, "offenseTypeOther": { "type": "string" }, "officerId": { "type": "string" }, "medicine": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "ModifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DrugTestingClientSaveRequest": { "type": "object", "properties": { "drugTestingClientIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "groupIdentifier": { "type": "string", "format": "uuid" }, "caseManagerIdentifier": { "type": "string", "format": "uuid" }, "miscId": { "type": "string" }, "ssnNumber": { "type": "string" }, "caseNumber": { "type": "string" }, "active": { "type": "boolean" }, "clientNumber": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "otherNotes": { "type": "string" }, "offenseType": { "type": "string" }, "offenseTypeOther": { "type": "string" }, "officerId": { "type": "string" }, "medicine": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "DrugTestingCocDto": { "type": "object", "properties": { "drugTestingCocIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "clientIdentifier": { "type": "string", "format": "uuid" }, "clientInstantTest": { "type": "boolean" }, "clientScheduled": { "type": "boolean" }, "clientTestTaken": { "type": "boolean" }, "clientMissed": { "type": "boolean" }, "clientMissedNotes": { "type": "string" }, "descriptionLong": { "type": "string" }, "chainNumber": { "type": "string" }, "testTakenDate": { "type": "string", "format": "date-time" }, "testTakenBy": { "type": "string" }, "labReceivedDate": { "type": "string", "format": "date-time" }, "labReceivedBy": { "type": "string" }, "screeningDate": { "type": "string", "format": "date-time" }, "screeningAnalyst": { "type": "string" }, "resultReleaseDate": { "type": "string", "format": "date-time" }, "resultReleaseBy": { "type": "string" }, "Results": { "type": "string" }, "active": { "type": "boolean" }, "callMade": { "type": "boolean" }, "callMadeDate": { "type": "string", "format": "date-time" }, "testResultIdentifier": { "type": "string", "format": "uuid" }, "manualTestResults": { "type": "string" }, "manualTest": { "type": "string" }, "specimenReleasedTo": { "type": "string" }, "specimenTemperature": { "type": "boolean" }, "testCancelled": { "type": "boolean" }, "sendToLab": { "type": "boolean" }, "specimenType": { "type": "string" }, "footerMessage": { "type": "string" }, "labNumber": { "type": "string" }, "cocViews": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cocPrintChain": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cocPrintResult": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "drugTests": { "type": "string" }, "relatedDrugTestingCOCIdentifier": { "type": "string", "format": "uuid" }, "processed": { "type": "boolean" }, "processedBatchName": { "type": "string" }, "processedDate": { "type": "string", "format": "date-time" }, "processedBy": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DrugTestingCocResultDto": { "type": "object", "properties": { "drugTestingCocResultIdentifier": { "type": "string", "format": "uuid" }, "drugTestingCocIdentifier": { "type": "string", "format": "uuid" }, "fieldName": { "type": "string" }, "fieldValue": { "type": "string" }, "descriptionLong": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DrugTestingCocResultSaveRequest": { "type": "object", "properties": { "drugTestingCocResultIdentifier": { "type": "string", "format": "uuid" }, "drugTestingCocIdentifier": { "type": "string", "format": "uuid" }, "fieldName": { "type": "string" }, "fieldValue": { "type": "string" }, "descriptionLong": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "DrugTestingCocSaveRequest": { "type": "object", "properties": { "drugTestingCocIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "clientIdentifier": { "type": "string", "format": "uuid" }, "clientInstantTest": { "type": "boolean" }, "clientScheduled": { "type": "boolean" }, "clientTestTaken": { "type": "boolean" }, "clientMissed": { "type": "boolean" }, "clientMissedNotes": { "type": "string" }, "descriptionLong": { "type": "string" }, "chainNumber": { "type": "string" }, "testTakenDate": { "type": "string", "format": "date-time" }, "testTakenBy": { "type": "string" }, "labReceivedDate": { "type": "string", "format": "date-time" }, "labReceivedBy": { "type": "string" }, "screeningDate": { "type": "string", "format": "date-time" }, "screeningAnalyst": { "type": "string" }, "resultReleaseDate": { "type": "string", "format": "date-time" }, "resultReleaseBy": { "type": "string" }, "Results": { "type": "string" }, "active": { "type": "boolean" }, "callMade": { "type": "boolean" }, "callMadeDate": { "type": "string", "format": "date-time" }, "testResultIdentifier": { "type": "string", "format": "uuid" }, "manualTestResults": { "type": "string" }, "manualTest": { "type": "string" }, "specimenReleasedTo": { "type": "string" }, "specimenTemperature": { "type": "boolean" }, "testCancelled": { "type": "boolean" }, "sendToLab": { "type": "boolean" }, "specimenType": { "type": "string" }, "footerMessage": { "type": "string" }, "labNumber": { "type": "string" }, "cocViews": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cocPrintChain": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cocPrintResult": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "drugTests": { "type": "string" }, "relatedDrugTestingCOCIdentifier": { "type": "string", "format": "uuid" }, "processed": { "type": "boolean" }, "processedBatchName": { "type": "string" }, "processedDate": { "type": "string", "format": "date-time" }, "processedBy": { "type": "string", "format": "uuid" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "DrugTestingDrugDto": { "type": "object", "properties": { "drugTestingDrugIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "parentDrugTestingDrugIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "abbreviation": { "type": "string" }, "thresholdUrine": { "type": "string" }, "thresholdUrineMeasurement": { "type": "string" }, "thresholdOral": { "type": "string" }, "thresholdOralMeasurement": { "type": "string" }, "active": { "type": "boolean" }, "isParent": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "specimenType": { "type": "string" }, "alwaysShowResult": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "ModifiedDate": { "type": "string", "format": "date-time" } } }, "DrugTestingDrugSaveRequest": { "type": "object", "properties": { "drugTestingDrugIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "parentDrugTestingDrugIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "abbreviation": { "type": "string" }, "thresholdUrine": { "type": "string" }, "thresholdUrineMeasurement": { "type": "string" }, "thresholdOral": { "type": "string" }, "thresholdOralMeasurement": { "type": "string" }, "active": { "type": "boolean" }, "isParent": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "specimenType": { "type": "string" }, "alwaysShowResult": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "DrugTestingGroupDto": { "type": "object", "properties": { "drugTestingGroupIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "complianceDrugTests": { "type": "boolean" }, "complianceTestNoShow": { "type": "boolean" }, "complianceTestMissed": { "type": "boolean" }, "mustCallInSun": { "type": "boolean" }, "mustCallInMon": { "type": "boolean" }, "mustCallInTue": { "type": "boolean" }, "mustCallInWed": { "type": "boolean" }, "mustCallInThu": { "type": "boolean" }, "mustCallInFri": { "type": "boolean" }, "mustCallInSat": { "type": "boolean" }, "skipHolidays": { "type": "boolean" }, "pullFrequency": { "type": "string" }, "maxPerDay": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "RandomTestSun": { "type": "boolean" }, "randomTestMon": { "type": "boolean" }, "randomTestTue": { "type": "boolean" }, "randomTestWed": { "type": "boolean" }, "randomTestThu": { "type": "boolean" }, "randomTestFri": { "type": "boolean" }, "randomTestSat": { "type": "boolean" }, "maxPerMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "pullFirstDay": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DrugTestingGroupSaveRequest": { "type": "object", "properties": { "drugTestingGroupIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "complianceDrugTests": { "type": "boolean" }, "complianceTestNoShow": { "type": "boolean" }, "complianceTestMissed": { "type": "boolean" }, "mustCallInSun": { "type": "boolean" }, "mustCallInMon": { "type": "boolean" }, "mustCallInTue": { "type": "boolean" }, "mustCallInWed": { "type": "boolean" }, "mustCallInThu": { "type": "boolean" }, "mustCallInFri": { "type": "boolean" }, "mustCallInSat": { "type": "boolean" }, "skipHolidays": { "type": "boolean" }, "pullFrequency": { "type": "string" }, "maxPerDay": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "RandomTestSun": { "type": "boolean" }, "randomTestMon": { "type": "boolean" }, "randomTestTue": { "type": "boolean" }, "randomTestWed": { "type": "boolean" }, "randomTestThu": { "type": "boolean" }, "randomTestFri": { "type": "boolean" }, "randomTestSat": { "type": "boolean" }, "maxPerMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "pullFirstDay": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "DrugTestingInformationDto": { "type": "object", "properties": { "drugTestingInformationIdentifier": { "type": "string", "format": "uuid" }, "drugTestingCocIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "fieldName": { "type": "string" }, "fieldValue": { "type": "string" }, "active": { "type": "boolean" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DrugTestingInformationSaveRequest": { "type": "object", "properties": { "drugTestingInformationIdentifier": { "type": "string", "format": "uuid" }, "drugTestingCocIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "fieldName": { "type": "string" }, "fieldValue": { "type": "string" }, "active": { "type": "boolean" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "DrugTestingPanelDrugDto": { "type": "object", "properties": { "drugTestingPanelDrugIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "drugTestingDrugIdentifier": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DrugTestingPanelDrugSaveRequest": { "type": "object", "properties": { "drugTestingPanelDrugIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "drugTestingDrugIdentifier": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "DrugTestingPanelDto": { "type": "object", "properties": { "drugTestingPanelIdentifier": { "type": "string", "format": "uuid" }, "drugTestingTypeIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "panelSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DrugTestingPanelSaveRequest": { "type": "object", "properties": { "drugTestingPanelIdentifier": { "type": "string", "format": "uuid" }, "drugTestingTypeIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "panelSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "DrugTestingQuickResultCodeDto": { "type": "object", "properties": { "drugTestingQuickResultCodeIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DrugTestingQuickResultCodeSaveRequest": { "type": "object", "properties": { "drugTestingQuickResultCodeIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "DrugTestingResultDto": { "type": "object", "properties": { "drugTestingResultIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "drugTestingDrugIdentifier": { "type": "string", "format": "uuid" }, "resultStatusIdentifier": { "type": "string", "format": "uuid" }, "confirmationAmount": { "type": "string" }, "reportingLevel": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "DrugTestingResultSaveRequest": { "type": "object", "properties": { "drugTestingResultIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "drugTestingDrugIdentifier": { "type": "string", "format": "uuid" }, "resultStatusIdentifier": { "type": "string", "format": "uuid" }, "confirmationAmount": { "type": "string" }, "reportingLevel": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ECCLevel": { }, "EmailAddressDto": { "type": "object", "properties": { "emailAddressIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "emailAddress": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "displayName": { "type": "string" }, "allowNewsletter": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "EmailAddressSaveRequest": { "type": "object", "properties": { "emailAddressIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "emailAddress": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "displayName": { "type": "string" }, "allowNewsletter": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "EmployeeDto": { "type": "object", "properties": { "employeeIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "managerIdentifier": { "type": "string", "format": "uuid" }, "employeeTypeIdentifier": { "type": "string", "format": "uuid" }, "taxClassificationIdentifier": { "type": "string", "format": "uuid" }, "workClassificationIdentifier": { "type": "string", "format": "uuid" }, "timeZoneIdentifier": { "type": "string", "format": "uuid" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "maxHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "dateOfBirth": { "type": [ "null", "string" ], "format": "date-time" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "EmployeeGridDto": { "type": "object", "properties": { "employeeIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "userDisplayName": { "type": "string" }, "managerDisplayName": { "type": "string" }, "departmentName": { "type": "string" }, "statusName": { "type": "string" }, "positionName": { "type": "string" }, "employeeType": { "type": "string" }, "taxClassification": { "type": "string" }, "workClassification": { "type": "string" }, "timeZone": { "type": "string" }, "language": { "type": "string" }, "maxHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "activeYn": { "type": "boolean" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "EmployeeSaveRequest": { "type": "object", "properties": { "employeeIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "managerIdentifier": { "type": "string", "format": "uuid" }, "employeeTypeIdentifier": { "type": "string", "format": "uuid" }, "taxClassificationIdentifier": { "type": "string", "format": "uuid" }, "workClassificationIdentifier": { "type": "string", "format": "uuid" }, "timeZoneIdentifier": { "type": "string", "format": "uuid" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "maxHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "dateOfBirth": { "type": [ "null", "string" ], "format": "date-time" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "EntityChangeDto": { "type": "object", "properties": { "entityChangeIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifierName": { "type": "string" }, "moduleIdentifier": { "type": "string", "format": "uuid" }, "moduleIdentifierName": { "type": "string" }, "entityIdentifier": { "type": "string", "format": "uuid" }, "entityIdentifierName": { "type": "string" }, "correlationIdentifier": { "type": "string", "format": "uuid" }, "correlationIdentifierName": { "type": "string" }, "entityType": { "type": "string" }, "changeType": { "type": "string" }, "jsonBefore": { "type": "string" }, "jsonAfter": { "type": "string" }, "jsonChangeFields": { "type": "string" }, "reason": { "type": "string" }, "source": { "type": "string" }, "ipAddress": { "type": "string", "format": "byte" }, "userAgent": { "type": "string" }, "integrityHash": { "type": "string", "format": "byte" }, "integrityIsValid": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdByName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } } }, "EntityChangeGridDto": { "type": "object", "properties": { "entityChangeIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "moduleIdentifier": { "type": "string", "format": "uuid" }, "entityIdentifier": { "type": "string", "format": "uuid" }, "entityType": { "type": "string" }, "changeType": { "type": "string" }, "source": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" } } }, "EntityRequest": { "required": [ "input" ], "type": "object", "properties": { "input": { "type": "string" }, "mode": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } }, "EventDto": { "type": "object", "properties": { "eventIdentifier": { "type": "string", "format": "uuid" }, "messageIdentifier": { "type": "string", "format": "uuid" }, "subscriberIdentifier": { "type": "string", "format": "uuid" }, "triggerTypeIdentifier": { "type": "string", "format": "uuid" }, "eventType": { "type": "string" }, "eventDate": { "type": "string", "format": "date-time" }, "ipAddress": { "type": "string", "format": "byte" }, "userAgent": { "type": "string" }, "urlClicked": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "EventSaveRequest": { "type": "object", "properties": { "eventIdentifier": { "type": "string", "format": "uuid" }, "messageIdentifier": { "type": "string", "format": "uuid" }, "subscriberIdentifier": { "type": "string", "format": "uuid" }, "eventType": { "type": "string" }, "eventDate": { "type": "string", "format": "date-time" }, "ipAddress": { "type": "string", "format": "byte" }, "userAgent": { "type": "string" }, "urlClicked": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ExpenseDto": { "type": "object", "properties": { "expenseIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "paymentMethodIdentifier": { "type": "string", "format": "uuid" }, "paymentMethod": { "type": "string" }, "coaExpenseTypeIdentifier": { "type": "string", "format": "uuid" }, "expenseType": { "type": "string" }, "coaSalesTaxIdentifier": { "type": "string", "format": "uuid" }, "coaSalesTax": { "type": "string" }, "coaShippingIdentifier": { "type": "string", "format": "uuid" }, "shippingName": { "type": "string" }, "expenseStatusIdentifier": { "type": "string", "format": "uuid" }, "expenseStatusName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "costCenter": { "type": "string" }, "referenceId": { "type": "string" }, "expenseDate": { "type": "string", "format": "date-time" }, "expenseAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "expenseTax": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "expenseShipping": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currencyCode": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "regulatoryMappingId": { "type": "string" }, "StartDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "billable": { "type": "boolean" }, "paid": { "type": "boolean" }, "recurring": { "type": "boolean" }, "recurringFrequency": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "recurringTypeIdentifier": { "type": "string", "format": "uuid" }, "recurringNextRunDate": { "type": "string", "format": "date-time" }, "recurringLastRunDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ExpenseSaveRequest": { "type": "object", "properties": { "expenseIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "paymentMethodIdentifier": { "type": "string", "format": "uuid" }, "coaExpenseTypeIdentifier": { "type": "string", "format": "uuid" }, "coaSalesTaxIdentifier": { "type": "string", "format": "uuid" }, "coaShippingIdentifier": { "type": "string", "format": "uuid" }, "expenseStatusIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "costCenter": { "type": "string" }, "referenceId": { "type": "string" }, "expenseDate": { "type": "string", "format": "date-time" }, "expenseAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "expenseTax": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "expenseShipping": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currencyCode": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "regulatoryMappingId": { "type": "string" }, "StartDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "billable": { "type": "boolean" }, "paid": { "type": "boolean" }, "recurring": { "type": "boolean" }, "recurringFrequency": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "recurringTypeIdentifier": { "type": "string", "format": "uuid" }, "recurringNextRunDate": { "type": "string", "format": "date-time" }, "recurringLastRunDate": { "type": "string", "format": "date-time" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ExternalEmailValidation": { "type": "object", "properties": { "checked": { "type": "boolean" }, "provider": { "type": "string" }, "isDeliverable": { "type": "boolean" }, "isDisposable": { "type": "boolean" }, "isFreeEmail": { "type": "boolean" }, "isRoleAccount": { "type": "boolean" }, "status": { "type": "string" }, "subStatus": { "type": "string" }, "score": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "error": { "type": [ "null", "string" ] } } }, "FaqDetailDto": { "type": "object", "properties": { "faqDetailIdentifier": { "type": "string", "format": "uuid" }, "faqHeaderIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "FaqDetailSaveRequest": { "type": "object", "properties": { "faqDetailIdentifier": { "type": "string", "format": "uuid" }, "faqHeaderIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "FaqHeaderDto": { "type": "object", "properties": { "faqHeaderIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "categoryName": { "type": "string" }, "openPosition": { "type": "boolean" }, "positionNumberToOpen": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "FaqHeaderSaveRequest": { "type": "object", "properties": { "faqHeaderIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "categoryName": { "type": "string" }, "openPosition": { "type": "boolean" }, "positionNumberToOpen": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "FeedbackDto": { "type": "object", "properties": { "feedbackIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "projectIdentifier": { "type": "string", "format": "uuid" }, "moduleIdentifier": { "type": "string", "format": "uuid" }, "typeIdentifier": { "type": "string", "format": "uuid" }, "severityIdentifier": { "type": "string", "format": "uuid" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "reportedByIdentifier": { "type": "string", "format": "uuid" }, "changeTypeIdentifier": { "type": "string", "format": "uuid" }, "trackingNumber": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "versionNumber": { "type": "string" }, "reportedDate": { "type": "string", "format": "date-time" }, "accepted": { "type": "boolean" }, "acceptedDate": { "type": "string", "format": "date-time" }, "acceptedByIdentifier": { "type": "string", "format": "uuid" }, "reproducibility": { "type": "boolean" }, "stepsToReproduce": { "type": "string" }, "AdditionalInformation": { "type": "string" }, "estimatedHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "actualHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "assignedToIdentifier": { "type": "string", "format": "uuid" }, "cveId": { "type": "string" }, "cveAssignerOrgId": { "type": "string", "format": "uuid" }, "cvePublishDate": { "type": "string", "format": "date-time" }, "showOnWebsite": { "type": "boolean" }, "allowVoting": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "FeedbackSaveRequest": { "type": "object", "properties": { "feedbackIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "projectIdentifier": { "type": "string", "format": "uuid" }, "moduleIdentifier": { "type": "string", "format": "uuid" }, "typeIdentifier": { "type": "string", "format": "uuid" }, "severityIdentifier": { "type": "string", "format": "uuid" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "reportedByIdentifier": { "type": "string", "format": "uuid" }, "changeTypeIdentifier": { "type": "string", "format": "uuid" }, "trackingNumber": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "versionNumber": { "type": "string" }, "reportedDate": { "type": "string", "format": "date-time" }, "accepted": { "type": "boolean" }, "acceptedDate": { "type": "string", "format": "date-time" }, "acceptedByIdentifier": { "type": "string", "format": "uuid" }, "reproducibility": { "type": "boolean" }, "stepsToReproduce": { "type": "string" }, "AdditionalInformation": { "type": "string" }, "estimatedHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "actualHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "assignedToIdentifier": { "type": "string", "format": "uuid" }, "cveId": { "type": "string" }, "cveAssignerOrgId": { "type": "string", "format": "uuid" }, "cvePublishDate": { "type": "string", "format": "date-time" }, "showOnWebsite": { "type": "boolean" }, "allowVoting": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "FilterMenuDto": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldValue": { "type": "string" }, "selected": { "type": "boolean" } } }, "Form4473BuyerSaveRequest": { "type": "object", "properties": { "form4473_buyer_identifier": { "type": "string", "format": "uuid" }, "form4473_identifier": { "type": "string", "format": "uuid" }, "last_name_including_suffix": { "maxLength": 150, "type": "string" }, "first_name": { "maxLength": 100, "type": "string" }, "middle_name_or_nmn": { "maxLength": 100, "type": "string" }, "residence_street_address": { "maxLength": 250, "type": "string" }, "residence_city": { "maxLength": 100, "type": "string" }, "resides_in_city_limits": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "uint8" }, "residence_state": { "maxLength": 2, "type": "string" }, "residence_zip_code": { "maxLength": 10, "type": "string" }, "residence_county_parish_or_borough": { "maxLength": 150, "type": "string" }, "place_of_birth": { "maxLength": 200, "type": "string" }, "height_feet": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "uint8" }, "height_inches": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "uint8" }, "weight_pounds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int16" }, "gender": { "maxLength": 20, "type": "string" }, "birth_date": { "type": [ "null", "string" ], "format": "date-time" }, "social_security_number": { "maxLength": 20, "type": "string" }, "upin": { "maxLength": 30, "type": "string" }, "ethnicity": { "maxLength": 50, "type": "string" }, "race": { "maxLength": 150, "type": "string" }, "non_immigrant_alien": { "type": "boolean" }, "country_of_citizenship1": { "maxLength": 100, "type": "string" }, "country_of_citizenship2": { "maxLength": 100, "type": "string" }, "country_of_citizenship3": { "maxLength": 100, "type": "string" }, "country_of_citizenship4": { "maxLength": 100, "type": "string" }, "state_of_residence": { "maxLength": 2, "type": "string" }, "state_of_residence_issued_id_type": { "maxLength": 100, "type": "string" }, "state_of_residence_issued_id_number": { "maxLength": 100, "type": "string" }, "state_of_residence_issued_id_expiration_date": { "type": [ "null", "string" ], "format": "date-time" }, "state_of_residence_issued_id_issuing_authority": { "maxLength": 150, "type": "string" }, "alien_registration_number": { "maxLength": 100, "type": "string" }, "non_immigrant_visa_number": { "maxLength": 100, "type": "string" } } }, "Form4473JurisdictionValidationDto": { "type": "object", "properties": { "form4473Identifier": { "type": "string", "format": "uuid" }, "canProceed": { "type": "boolean" }, "hasBlockingErrors": { "type": "boolean" }, "hasWarnings": { "type": "boolean" }, "hasReviewItems": { "type": "boolean" }, "summary": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Form4473JurisdictionValidationMessageDto" } } } }, "Form4473JurisdictionValidationMessageDto": { "type": "object", "properties": { "severity": { "type": "string" }, "ruleCode": { "type": "string" }, "ruleName": { "type": "string" }, "section": { "type": "string" }, "fieldName": { "type": "string" }, "jurisdictionType": { "type": "string" }, "jurisdictionName": { "type": "string" }, "message": { "type": "string" }, "blocking": { "type": "boolean" }, "overrideAllowed": { "type": "boolean" } } }, "Form4473QuestionsSaveRequest": { "type": "object", "properties": { "form4473_questions_identifier": { "type": "string", "format": "uuid" }, "actual_transferee_buyer": { "type": [ "null", "boolean" ] }, "under_indictment_or_information": { "type": [ "null", "boolean" ] }, "felony_conviction": { "type": [ "null", "boolean" ] }, "fugitive_from_justice": { "type": [ "null", "boolean" ] }, "unlawful_controlled_substance_user": { "type": [ "null", "boolean" ] }, "adjudicated_mental_defective_or_committed": { "type": [ "null", "boolean" ] }, "dishonorable_discharge": { "type": [ "null", "boolean" ] }, "restraining_order": { "type": [ "null", "boolean" ] }, "misdemeanor_domestic_violence_conviction": { "type": [ "null", "boolean" ] }, "renounced_united_states_citizenship": { "type": [ "null", "boolean" ] }, "illegal_or_unlawful_alien": { "type": [ "null", "boolean" ] }, "nonimmigrant_alien": { "type": [ "null", "boolean" ] }, "qualifying_nonimmigrant_alien_exception": { "type": [ "null", "boolean" ] } } }, "Form4473SignatureCaptureRequest": { "required": [ "signature_method", "signature_data" ], "type": "object", "properties": { "signature_method": { "maxLength": 50, "type": "string" }, "signature_data": { "maxLength": 500000, "type": "string" }, "device_identifier": { "maxLength": 100, "type": "string" }, "signature_intent_version": { "maxLength": 100, "type": "string" } } }, "Form4473StatusDto": { "type": "object", "properties": { "form4473Identifier": { "type": "string", "format": "uuid" }, "wasFound": { "type": "boolean" }, "found": { "type": "boolean" }, "isAvailableForFilling": { "type": "boolean" }, "availableForFilling": { "type": "boolean" }, "availabilityStatus": { "type": "string" }, "availabilityMessage": { "type": "string" }, "signatureRequirementMode": { "type": "string" }, "visibleSections": { "type": "array", "items": { "type": "string" } }, "lockedSections": { "type": "array", "items": { "type": "string" } }, "formNumber": { "type": "string" }, "formRevision": { "type": "string" }, "ombNumber": { "type": "string" } } }, "FormDto": { "type": "object", "properties": { "formIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "googleCaptcha": { "type": "boolean" }, "spamFilter": { "type": "boolean" }, "hideLabels": { "type": "boolean" }, "displayInline": { "type": "boolean" }, "inlineButtonMinWidth": { "type": "string" }, "includeHoneypot": { "type": "boolean" }, "honeyPotFieldname": { "type": "string" }, "settingsJson": { "type": "string" }, "processingText": { "type": "string" }, "submitButtonText": { "type": "string" }, "successMessage": { "type": "string" }, "complianceFlags": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "CreatedDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "FormFieldDto": { "type": "object", "properties": { "formFieldIdentifier": { "type": "string", "format": "uuid" }, "formIdentifier": { "type": "string", "format": "uuid" }, "brillianceId": { "type": "string" }, "fieldType": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean" }, "encrypted": { "type": "boolean" }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "configJson": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "FormFieldSaveRequest": { "type": "object", "properties": { "formFieldIdentifier": { "type": "string", "format": "uuid" }, "formIdentifier": { "type": "string", "format": "uuid" }, "brillianceId": { "type": "string" }, "fieldType": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean" }, "encrypted": { "type": "boolean" }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "configJson": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "FormModuleDto": { "type": "object", "properties": { "formModuleIdentifier": { "type": "string", "format": "uuid" }, "formIdentifier": { "type": "string", "format": "uuid" }, "moduleName": { "type": "string" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "FormModuleSaveRequest": { "type": "object", "properties": { "formModuleIdentifier": { "type": "string", "format": "uuid" }, "formIdentifier": { "type": "string", "format": "uuid" }, "moduleName": { "type": "string" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "FormSaveRequest": { "type": "object", "properties": { "formIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "googleCaptcha": { "type": "boolean" }, "spamFilter": { "type": "boolean" }, "hideLabels": { "type": "boolean" }, "displayInline": { "type": "boolean" }, "inlineButtonMinWidth": { "type": "string" }, "includeHoneypot": { "type": "boolean" }, "honeyPotFieldname": { "type": "string" }, "settingsJson": { "type": "string" }, "processingText": { "type": "string" }, "submitButtonText": { "type": "string" }, "successMessage": { "type": "string" }, "complianceFlags": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "GlobalSystemConfigDetail": { "type": "object", "properties": { "businessName": { "type": "string" }, "businessEmailAddress": { "type": "string" }, "operatingMode": { "type": "string" }, "enableDeveloperLogging": { "type": "boolean" }, "enableHipaaLogging": { "type": "boolean" } } }, "GridDefaultDto": { "type": "object", "properties": { "accessAllowed": { "type": "boolean" }, "showSettings": { "type": "boolean" }, "showExport": { "type": "boolean" }, "showImport": { "type": "boolean" }, "filter": { "type": "string" }, "urlAddNew": { "type": "string" }, "urlSettings": { "type": "string" }, "urlImport": { "type": "string" }, "urlExport": { "type": "string" }, "gridName": { "type": "string" }, "apiEndPoint": { "type": "string" }, "searchPlaceholder": { "type": "string" }, "defaultSortColumn": { "type": "string" }, "defaultPageSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "showSearch": { "type": "boolean" }, "showPagination": { "type": "boolean" }, "showActions": { "type": "boolean" } } }, "GridResponseOfApplicationSettingDto": { "required": [ "data", "total_records", "page_number", "page_size", "total_pages", "from_cache" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationSettingDto" } }, "total_records": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page_number": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page_size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total_pages": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "from_cache": { "type": "boolean" }, "generated_at": { "type": "string", "format": "date-time" } } }, "GridResponseOfDocumentProcessingJobGridDto": { "required": [ "data", "total_records", "page_number", "page_size", "total_pages", "from_cache" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentProcessingJobGridDto" } }, "total_records": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page_number": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page_size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total_pages": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "from_cache": { "type": "boolean" }, "generated_at": { "type": "string", "format": "date-time" } } }, "GridResponseOfEmployeeGridDto": { "required": [ "data", "total_records", "page_number", "page_size", "total_pages", "from_cache" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeGridDto" } }, "total_records": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page_number": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page_size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total_pages": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "from_cache": { "type": "boolean" }, "generated_at": { "type": "string", "format": "date-time" } } }, "GridResponseOfInvoiceLineItemGridDto": { "required": [ "data", "total_records", "page_number", "page_size", "total_pages", "from_cache" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineItemGridDto" } }, "total_records": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page_number": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page_size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total_pages": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "from_cache": { "type": "boolean" }, "generated_at": { "type": "string", "format": "date-time" } } }, "GridResponseOfSiteMonitorDetailGridDto": { "required": [ "data", "total_records", "page_number", "page_size", "total_pages", "from_cache" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SiteMonitorDetailGridDto" } }, "total_records": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page_number": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page_size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total_pages": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "from_cache": { "type": "boolean" }, "generated_at": { "type": "string", "format": "date-time" } } }, "GridResponseOfSiteMonitorGridDto": { "required": [ "data", "total_records", "page_number", "page_size", "total_pages", "from_cache" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SiteMonitorGridDto" } }, "total_records": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page_number": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page_size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total_pages": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "from_cache": { "type": "boolean" }, "generated_at": { "type": "string", "format": "date-time" } } }, "GroupDto": { "type": "object", "properties": { "groupIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "GroupSaveRequest": { "type": "object", "properties": { "groupIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "GroupSubscriberAddRemoveDto": { "type": "object", "properties": { "groupIdentifier": { "type": "string", "format": "uuid" }, "subscriberIdentifier": { "type": "string", "format": "uuid" } } }, "HtmlUnminifyRequest": { "required": [ "content" ], "type": "object", "properties": { "content": { "type": "string" } } }, "HttpValidationProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "IconMetadata": { "type": "object", "properties": { "faviconUrl": { "type": [ "null", "string" ] }, "appleTouchIconUrl": { "type": [ "null", "string" ] } } }, "IFormFile": { "type": "string", "format": "binary" }, "InvestorDetailDto": { "type": "object", "properties": { "investorDetailIdentifier": { "type": "string", "format": "uuid" }, "investorIdentifier": { "type": "string", "format": "uuid" }, "shareTypeIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "investmentDate": { "type": "string", "format": "date-time" }, "investmentAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "investmentShares": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currencyCode": { "type": "string" }, "votingRights": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "InvestorDetailSaveRequest": { "type": "object", "properties": { "investorDetailIdentifier": { "type": "string", "format": "uuid" }, "investorIdentifier": { "type": "string", "format": "uuid" }, "shareTypeIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "investmentDate": { "type": "string", "format": "date-time" }, "investmentAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "investmentShares": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currencyCode": { "type": "string" }, "votingRights": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "InvestorDto": { "type": "object", "properties": { "investorIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "InvestorSaveRequest": { "type": "object", "properties": { "investorIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "InvoiceDto": { "type": "object", "properties": { "invoiceIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "invoiceTypeIdentifier": { "type": "string", "format": "uuid" }, "invoiceType": { "type": "string" }, "assignedToUserIdentifier": { "type": "string", "format": "uuid" }, "assignedToUserName": { "type": "string" }, "invoiceNumber": { "type": "string" }, "invoiceDate": { "type": "string", "format": "date-time" }, "acceptedDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "referenceNumber": { "type": "string" }, "recurring": { "type": "boolean" }, "recurringMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "recurringDay": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "recurringFrequencyIdentifier": { "type": "string", "format": "uuid" }, "lastSentDate": { "type": "string", "format": "date-time" }, "acceptOnlinePayments": { "type": "boolean" }, "acceptCards": { "type": "boolean" }, "acceptAch": { "type": "boolean" }, "allowPartialPayments": { "type": "boolean" }, "StatusIdentifier": { "type": "string", "format": "uuid" }, "overallDiscountAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overallDiscountPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "taxable": { "type": "boolean" }, "shipping": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "securityViewQuote": { "type": "boolean" }, "securityViewInvoice": { "type": "boolean" }, "sync": { "type": "boolean" }, "syncIdentifier": { "type": "string", "format": "uuid" }, "syncInformation": { "type": "string" }, "notes": { "type": "string" }, "internalNotes": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "InvoiceEmailResultDto": { "type": "object", "properties": { "invoiceIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": "string" }, "recipientCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "sentCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "failedCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "failedRecipients": { "type": "array", "items": { "type": "string" } } } }, "InvoiceLineItemDto": { "type": "object", "properties": { "invoiceLineItemIdentifier": { "type": "string", "format": "uuid" }, "invoiceIdentifier": { "type": "string", "format": "uuid" }, "qty": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "productIdentifier": { "type": "string", "format": "uuid" }, "productNumber": { "type": "string" }, "productDescription": { "type": "string" }, "productPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "shipping": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allowCashDiscount": { "type": "boolean" }, "taxable": { "type": "boolean" }, "isGift": { "type": "boolean" }, "alternateShippingAddress": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "overallDiscountAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overallDiscountPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "sync": { "type": "boolean" }, "syncIdentifier": { "type": "string", "format": "uuid" }, "syncInformation": { "type": "string" }, "CreatedBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "InvoiceLineItemGridDto": { "type": "object", "properties": { "invoiceLineItemIdentifier": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": "string" }, "qty": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "productNumber": { "type": "string" }, "descriptionShort": { "type": "string" }, "productDescription": { "type": "string" }, "productPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "shipping": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allowCashDiscount": { "type": "boolean" }, "taxable": { "type": "boolean" }, "isGift": { "type": "boolean" }, "alternateShippingAddress": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "overallDiscountAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overallDiscountPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "grossLineSubtotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalLineDiscount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "netLineSubtotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lineTax": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lineTotalWithTax": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "InvoiceLineItemSaveRequest": { "type": "object", "properties": { "invoiceLineItemIdentifier": { "type": "string", "format": "uuid" }, "invoiceIdentifier": { "type": "string", "format": "uuid" }, "qty": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "productIdentifier": { "type": "string", "format": "uuid" }, "productNumber": { "type": "string" }, "productDescription": { "type": "string" }, "productPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "shipping": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allowCashDiscount": { "type": "boolean" }, "taxable": { "type": "boolean" }, "isGift": { "type": "boolean" }, "alternateShippingAddress": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "overallDiscountAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overallDiscountPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "sync": { "type": "boolean" }, "syncIdentifier": { "type": "string", "format": "uuid" }, "syncInformation": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "InvoiceNoteDto": { "type": "object", "properties": { "invoiceNoteIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "quoteNumber": { "type": "string" }, "quoteAcceptedByName": { "type": "string" }, "quoteTermsAccepted": { "type": "boolean" }, "quoteTerms": { "type": "string" }, "ipAddress": { "type": "string", "format": "byte" }, "geoLatitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "geoLongitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descriptionLong": { "type": "string" }, "sync": { "type": "boolean" }, "syncIdentifier": { "type": "string", "format": "uuid" }, "syncInformation": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "InvoiceNoteSaveRequest": { "type": "object", "properties": { "invoiceNoteIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "quoteNumber": { "type": "string" }, "quoteAcceptedByName": { "type": "string" }, "quoteTermsAccepted": { "type": "boolean" }, "quoteTerms": { "type": "string" }, "ipAddress": { "type": "string", "format": "byte" }, "geoLatitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "geoLongitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descriptionLong": { "type": "string" }, "sync": { "type": "boolean" }, "syncIdentifier": { "type": "string", "format": "uuid" }, "syncInformation": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "InvoiceSaveRequest": { "type": "object", "properties": { "invoiceIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "invoiceTypeIdentifier": { "type": "string", "format": "uuid" }, "assignedToUserIdentifier": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": "string" }, "invoiceDate": { "type": "string", "format": "date-time" }, "acceptedDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "referenceNumber": { "type": "string" }, "recurring": { "type": "boolean" }, "recurringMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "recurringDay": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "recurringFrequencyIdentifier": { "type": "string", "format": "uuid" }, "lastSentDate": { "type": "string", "format": "date-time" }, "acceptOnlinePayments": { "type": "boolean" }, "acceptCards": { "type": "boolean" }, "acceptAch": { "type": "boolean" }, "allowPartialPayments": { "type": "boolean" }, "StatusIdentifier": { "type": "string", "format": "uuid" }, "statusName": { "type": "string" }, "overallDiscountAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overallDiscountPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "taxable": { "type": "boolean" }, "shipping": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "securityViewQuote": { "type": "boolean" }, "securityViewInvoice": { "type": "boolean" }, "sync": { "type": "boolean" }, "syncIdentifier": { "type": "string", "format": "uuid" }, "syncInformation": { "type": "string" }, "notes": { "type": "string" }, "internalNotes": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "JournalEntryDto": { "type": "object", "properties": { "journalEntryIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "entryDate": { "type": "string", "format": "date-time" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "processed": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "JournalEntrySaveRequest": { "type": "object", "properties": { "journalEntryIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "entryDate": { "type": "string", "format": "date-time" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "processed": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "JournalEntryTransactionDto": { "type": "object", "properties": { "journalEntryTransactionIdentifier": { "type": "string", "format": "uuid" }, "journalEntryIdentifier": { "type": "string", "format": "uuid" }, "chartOfAccountIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "debitAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "creditAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "JournalEntryTransactionSaveRequest": { "type": "object", "properties": { "journalEntryTransactionIdentifier": { "type": "string", "format": "uuid" }, "journalEntryIdentifier": { "type": "string", "format": "uuid" }, "chartOfAccountIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "debitAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "creditAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "JsonArray": { "type": "array" }, "JsonRequest": { "required": [ "raw_json" ], "type": "object", "properties": { "raw_json": { "type": "string" } } }, "KbArticleDetailDto": { "type": "object", "properties": { "kbArticleDetailsIdentifier": { "type": "string", "format": "uuid" }, "kbArticleIdentifier": { "type": "string", "format": "uuid" }, "userLevelIdentifier": { "type": "string", "format": "uuid" }, "authorIdentifier": { "type": "string", "format": "uuid" }, "publishStatus": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionSummary": { "type": "string" }, "descriptionLong": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "string" }, "aiGenerated": { "type": "boolean" }, "aiAssisted": { "type": "boolean" }, "aiTraining": { "type": "boolean" }, "requireLoginToView": { "type": "boolean" }, "askForFeedback": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "EndDate": { "type": "string", "format": "date-time" }, "lastUpdatedDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "KbArticleDetailSaveRequest": { "type": "object", "properties": { "kbArticleDetailsIdentifier": { "type": "string", "format": "uuid" }, "kbArticleIdentifier": { "type": "string", "format": "uuid" }, "userLevelIdentifier": { "type": "string", "format": "uuid" }, "authorIdentifier": { "type": "string", "format": "uuid" }, "publishStatus": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionSummary": { "type": "string" }, "descriptionLong": { "type": "string" }, "pageHeaderEmbed": { "type": "string" }, "pageFooterEmbed": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "string" }, "aiGenerated": { "type": "boolean" }, "aiAssisted": { "type": "boolean" }, "aiTraining": { "type": "boolean" }, "requireLoginToView": { "type": "boolean" }, "askForFeedback": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "EndDate": { "type": "string", "format": "date-time" }, "lastUpdatedDate": { "type": "string", "format": "date-time" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "KbArticleDto": { "type": "object", "properties": { "kbArticleIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "internalUseOnly": { "type": "boolean" }, "active": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "KbArticleSaveRequest": { "type": "object", "properties": { "kbArticleIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "siteMapInclude": { "type": "boolean" }, "internalUseOnly": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "KeywordDto": { "type": "object", "properties": { "keywordIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "templateIdentifier": { "type": "string", "format": "uuid" }, "templateName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "keyword": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "termsUrl": { "type": "string" }, "privacyUrl": { "type": "string" }, "addKeywordAsTag": { "type": "boolean" }, "dripInitialMessageSend": { "type": "boolean" }, "dripInitialMessageMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dripInitialMessageIdentifier": { "type": "string", "format": "uuid" }, "dripNameSend": { "type": "boolean" }, "dripNameMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dripNameIdentifier": { "type": "string", "format": "uuid" }, "dripEmailSend": { "type": "boolean" }, "DripEmailMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dripEmailIdentifier": { "type": "string", "format": "uuid" }, "dripBirthdaySend": { "type": "boolean" }, "dripBirthdayMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dripBirthdayIdentifier": { "type": "string", "format": "uuid" }, "dripFinalMessageSend": { "type": "boolean" }, "dripFinalMessageMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dripFinalMessageIdentifier": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "KeywordSaveRequest": { "type": "object", "properties": { "keywordIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "templateIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "keyword": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "termsUrl": { "type": "string" }, "privacyUrl": { "type": "string" }, "addKeywordAsTag": { "type": "boolean" }, "dripInitialMessageSend": { "type": "boolean" }, "dripInitialMessageMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dripInitialMessageIdentifier": { "type": "string", "format": "uuid" }, "dripNameSend": { "type": "boolean" }, "dripNameMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dripNameIdentifier": { "type": "string", "format": "uuid" }, "dripEmailSend": { "type": "boolean" }, "DripEmailMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dripEmailIdentifier": { "type": "string", "format": "uuid" }, "dripBirthdaySend": { "type": "boolean" }, "dripBirthdayMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dripBirthdayIdentifier": { "type": "string", "format": "uuid" }, "dripFinalMessageSend": { "type": "boolean" }, "dripFinalMessageMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dripFinalMessageIdentifier": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "LanguageItemDto": { "type": "object", "properties": { "fieldName": { "type": "string" }, "descriptionLong": { "type": "string" } } }, "LinkDto": { "type": "object", "properties": { "linkIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "url": { "type": "string" }, "descriptionShort": { "type": "string" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "LinkSaveRequest": { "type": "object", "properties": { "linkIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "url": { "type": "string" }, "descriptionShort": { "type": "string" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "LocalSearchGridPointResult": { "type": "object", "properties": { "row": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "column": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "latitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "longitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "targetFound": { "type": "boolean" }, "position": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "targetRating": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "targetReviewCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "placesAnalyzed": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "competitorsAnalyzed": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "topCompetitorPlaceId": { "type": "string" }, "topCompetitorName": { "type": "string" }, "topCompetitorRating": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "topCompetitorReviewCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "LocalSearchGridRequest": { "type": "object", "properties": { "domain": { "type": "string" }, "keywordPhrase": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" }, "gridSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "gridDistanceMiles": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "LocalSearchGridResult": { "type": "object", "properties": { "domain": { "type": "string" }, "normalizedDomain": { "type": "string" }, "keywordPhrase": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "centerLatitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "centerLongitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "gridSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "gridDistanceMiles": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pointCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "foundCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "notFoundCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "averageMapRank": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "bestPosition": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "worstPosition": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "topThreePercentage": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "topTenPercentage": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "topTwentyPercentage": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "notFoundPercentage": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/LocalSearchGridPointResult" } }, "localSearchProfileIdentifier": { "type": "string", "format": "uuid" }, "localSearchQueryIdentifier": { "type": "string", "format": "uuid" }, "localSearchRunIdentifier": { "type": "string", "format": "uuid" } } }, "LocalSearchResearchRequest": { "type": "object", "properties": { "domain": { "type": "string" }, "keywordPhrase": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" } } }, "LocalSearchTrackingRequest": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "frequency": { "type": "string" }, "gridSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "gridDistanceMiles": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "LoginRequestDto": { "required": [ "accountCode", "emailAddress", "password" ], "type": "object", "properties": { "accountCode": { "maxLength": 50, "pattern": "^[a-zA-Z0-9\\-]+$", "type": "string" }, "emailAddress": { "maxLength": 250, "type": "string" }, "password": { "maxLength": 250, "minLength": 8, "type": "string" }, "userAgent": { "maxLength": 512, "type": [ "null", "string" ] }, "sessionIdentifier": { "maxLength": 512, "type": [ "null", "string" ] }, "requestVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "MailCheckRequest": { "required": [ "domain", "check_blacklists", "full_scan", "auto_guess" ], "type": "object", "properties": { "domain": { "type": "string", "default": "example.com" }, "selectors": { "type": "array", "items": { "type": "string" } }, "check_blacklists": { "type": "boolean", "default": false }, "full_scan": { "type": "boolean", "default": false }, "auto_guess": { "type": "boolean", "default": false } } }, "MarkupRequest": { "required": [ "content" ], "type": "object", "properties": { "content": { "type": "string" } } }, "MediaChunkRequest": { "type": "object", "properties": { "uploadSessionIdentifier": { "type": "string", "format": "uuid" }, "existingBlobIdentifier": { "type": [ "null", "string" ], "format": "uuid" }, "targetModule": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "chunkData": { "type": "string", "format": "byte" }, "chunkIndex": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isFinal": { "type": "boolean" } } }, "MediaSaveRequest": { "type": "object", "properties": { "blobIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "blobCategoryIdentifier": { "type": "string", "format": "uuid" }, "targetModule": { "type": "string" }, "blobFilename": { "type": "string" }, "blobDescription": { "type": "string" }, "blobContentType": { "type": "string" }, "blobFilesize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "blobData": { "type": "string", "format": "byte" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "MessageDto": { "type": "object", "properties": { "messageIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "sourceTypeIdentifier": { "type": "string", "format": "uuid" }, "sourceIdentifier": { "type": "string", "format": "uuid" }, "providerMessageIdentifier": { "type": "string", "format": "uuid" }, "deliveryStatus": { "type": "string" }, "messageType": { "type": "string" }, "messageFrom": { "type": "string" }, "messageFromEmailAddress": { "type": "string" }, "messageReplyTo": { "type": "string" }, "messageSubject": { "type": "string" }, "messageBody": { "type": "string" }, "messageMailTo": { "type": "string" }, "messageMailCc": { "type": "string" }, "messageMailBcc": { "type": "string" }, "messageImage": { "type": "string" }, "logTask": { "type": "boolean" }, "messageSent": { "type": "boolean" }, "messageSentDate": { "type": "string", "format": "date-time" }, "skipBadWords": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "MessageHeaderRequest": { "type": "object", "properties": { "raw_header": { "type": "string" } } }, "MessageSaveRequest": { "type": "object", "properties": { "messageIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "messageType": { "type": "string" }, "messageFrom": { "type": "string" }, "messageFromEmailAddress": { "type": "string" }, "messageReplyTo": { "type": "string" }, "messageSubject": { "type": "string" }, "messageBody": { "type": "string" }, "messageMailTo": { "type": "string" }, "messageMailCc": { "type": "string" }, "messageMailBcc": { "type": "string" }, "messageImage": { "type": "string" }, "logTask": { "type": "boolean" }, "scheduledSendDate": { "type": "string", "format": "date-time" }, "messageSent": { "type": "boolean" }, "messageSentDate": { "type": "string", "format": "date-time" }, "skipBadWords": { "type": "boolean" }, "useUtm": { "type": "boolean" }, "UtmSource": { "type": "string" }, "utmMedium": { "type": "string" }, "utmCampaign": { "type": "string" }, "utmContent": { "type": "string" }, "utmTerm": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "MinifyMarkupRequest": { "required": [ "content" ], "type": "object", "properties": { "content": { "type": "string" } } }, "MtaStsOptions": { "required": [ "domain", "mx_hosts" ], "type": "object", "properties": { "domain": { "type": "string", "default": "example.com" }, "mode": { "type": "string", "default": "testing" }, "max_age": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 604800 }, "mx_hosts": { "type": "array", "items": { "type": "string" } } } }, "MyAccountMenuItemDto": { "type": "object", "properties": { "identifier": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "url": { "type": "string" }, "iconClass": { "type": "string" }, "hasSeparator": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "NoteDto": { "type": "object", "properties": { "noteIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "sourceIdentifier": { "type": "string", "format": "uuid" }, "noteGuid": { "type": "string", "format": "uuid" }, "noteDescription": { "type": "string" }, "noteDescriptionLong": { "type": "string" }, "noteBoolean": { "type": "boolean" }, "noteInteger": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "noteMoney": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "noteDate": { "type": "string", "format": "date-time" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "ModifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "NoteSaveRequest": { "type": "object", "properties": { "noteIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "sourceIdentifier": { "type": "string", "format": "uuid" }, "noteGuid": { "type": "string", "format": "uuid" }, "noteDescription": { "type": "string" }, "noteDescriptionLong": { "type": "string" }, "noteBoolean": { "type": "boolean" }, "noteInteger": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "noteMoney": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "noteDate": { "type": "string", "format": "date-time" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "OpenGraphMetadata": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "url": { "type": [ "null", "string" ] }, "siteName": { "type": "string" }, "locale": { "type": "string" }, "imageUrl": { "type": [ "null", "string" ] } } }, "PageContentDto": { "type": "object", "properties": { "pageContentIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "componentIdentifier": { "type": "string", "format": "uuid" }, "templateIdentifier": { "type": "string", "format": "uuid" }, "publishStatusIdentifier": { "type": "string", "format": "uuid" }, "pageSlug": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "pageHeaderEmbed": { "type": "string" }, "pageFooterEmbed": { "type": "string" }, "enableSecurity": { "type": "boolean" }, "deleted": { "type": "boolean" }, "pageVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "ModifiedDate": { "type": "string", "format": "date-time" } } }, "PageContentResponse": { "type": "object", "properties": { "pageContentIdentifier": { "type": "string", "format": "uuid" }, "pageSlug": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "pageHeaderEmbed": { "type": "string" }, "pageFooterEmbed": { "type": "string" }, "componentIdentifier": { "type": [ "null", "string" ], "format": "uuid" }, "componentName": { "type": [ "null", "string" ] }, "templateIdentifier": { "type": "string", "format": "uuid" }, "enableSecurity": { "type": "boolean" }, "metaTitle": { "type": "string" }, "metaDescription": { "type": "string" }, "canonicalUrl": { "type": "string" } } }, "PageContentSaveRequest": { "type": "object", "properties": { "pageContentIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "componentIdentifier": { "type": "string", "format": "uuid" }, "templateIdentifier": { "type": "string", "format": "uuid" }, "publishStatusIdentifier": { "type": "string", "format": "uuid" }, "pageSlug": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "pageHeaderEmbed": { "type": "string" }, "pageFooterEmbed": { "type": "string" }, "enableSecurity": { "type": "boolean" }, "deleted": { "type": "boolean" }, "pageVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "PageLookupRequest": { "required": [ "pageSlug" ], "type": "object", "properties": { "pageSlug": { "type": "string" }, "page": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "PasswordRequest": { "type": "object", "properties": { "length": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 16 }, "use_upper": { "type": "boolean", "default": true }, "use_lower": { "type": "boolean", "default": true }, "use_digits": { "type": "boolean", "default": true }, "use_symbols": { "type": "boolean", "default": true } } }, "PaymentDto": { "type": "object", "properties": { "paymentIdentifier": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "paymentVaultIdentifier": { "type": "string", "format": "uuid" }, "paymentVaultName": { "type": "string" }, "paymentMethodIdentifier": { "type": "string", "format": "uuid" }, "paymentMethod": { "type": "string" }, "coaDebitIdentifier": { "type": "string", "format": "uuid" }, "debitName": { "type": "string" }, "coaCreditIdentifier": { "type": "string", "format": "uuid" }, "creditName": { "type": "string" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "checkNumber": { "type": "string" }, "descriptionLong": { "type": "string" }, "paymentDate": { "type": "string", "format": "date-time" }, "processed": { "type": "boolean" }, "processedDate": { "type": "string", "format": "date-time" }, "transactionId": { "type": "string" }, "authorizationCode": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "PaymentSaveRequest": { "type": "object", "properties": { "paymentIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "paymentVaultIdentifier": { "type": "string", "format": "uuid" }, "paymentMethodIdentifier": { "type": "string", "format": "uuid" }, "coaDebitIdentifier": { "type": "string", "format": "uuid" }, "coaCreditIdentifier": { "type": "string", "format": "uuid" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "checkNumber": { "type": "string" }, "descriptionLong": { "type": "string" }, "paymentDate": { "type": "string", "format": "date-time" }, "processed": { "type": "boolean" }, "processedDate": { "type": "string", "format": "date-time" }, "transactionId": { "type": "string" }, "authorizationCode": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "PaymentVaultDto": { "type": "object", "properties": { "paymentVaultIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "nameOnCard": { "type": "string" }, "postalCode": { "type": "string" }, "cardBrandIdentifier": { "type": "string", "format": "uuid" }, "cardBrand": { "type": "string" }, "cardNumber": { "type": "string" }, "cardCvv": { "type": "string" }, "cardLast4": { "type": "string" }, "cardExpireMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cardExpireYear": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cardPaymentToken": { "type": "string" }, "achNameOnAccount": { "type": "string" }, "achBankName": { "type": "string" }, "achBankAccount": { "type": "string" }, "achBankRouting": { "type": "string" }, "primaryCard": { "type": "boolean" }, "active": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "ModifiedDate": { "type": "string", "format": "date-time" } } }, "PaymentVaultSaveRequest": { "type": "object", "properties": { "paymentVaultIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "cardBrandIdentifier": { "type": "string", "format": "uuid" }, "nameOnCard": { "type": "string" }, "postalCode": { "type": "string" }, "cardNumber": { "type": "string" }, "cardLast4": { "type": "string" }, "cardExpireMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cardExpireYear": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "CardCvv": { "type": "string" }, "cardPaymentToken": { "type": "string" }, "providerName": { "type": "string" }, "achNameOnAccount": { "type": "string" }, "achBankName": { "type": "string" }, "AchBankAccount": { "type": "string" }, "AchBankRouting": { "type": "string" }, "primaryCard": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "PhoneDto": { "type": "object", "properties": { "phoneIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "phoneNumber": { "type": "string" }, "extension": { "type": "string" }, "numberType": { "type": "string" }, "isPrimary": { "type": "boolean" }, "consentSource": { "type": "string" }, "consentDate": { "type": "string", "format": "date-time" }, "carrier": { "type": "string" }, "allowPhone": { "type": "boolean" }, "timeZone": { "type": "string" }, "doNotCallRegistry": { "type": "boolean" }, "dncVerificationDate": { "type": "string", "format": "date-time" }, "dnrVerificationDate": { "type": "string", "format": "date-time" }, "allowSms": { "type": "boolean" }, "allowMms": { "type": "boolean" }, "smsCapable": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "PhoneLookupData": { "type": "object", "properties": { "is_valid": { "type": "boolean" }, "is_available": { "type": "boolean" }, "is_blocked": { "type": "boolean" }, "message": { "type": "string" }, "formatted_number": { "type": "string" } } }, "PhoneSaveRequest": { "type": "object", "properties": { "phoneIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "phoneNumber": { "type": "string" }, "extension": { "type": "string" }, "numberType": { "type": "string" }, "isPrimary": { "type": "boolean" }, "consentSource": { "type": "string" }, "consentDate": { "type": "string", "format": "date-time" }, "allowPhone": { "type": "boolean" }, "doNotCallRegistry": { "type": "boolean" }, "allowSms": { "type": "boolean" }, "allowMms": { "type": "boolean" }, "smsCapable": { "type": "boolean" }, "timeZone": { "type": "string" }, "carrier": { "type": "string" }, "dncVerificationDate": { "type": "string", "format": "date-time" }, "dnrVerificationDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "PlaceholderRequest": { "type": "object", "properties": { "width": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 300 }, "height": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 200 }, "text": { "type": [ "null", "string" ] }, "background_color": { "type": [ "null", "string" ], "default": "#cccccc" }, "text_color": { "type": [ "null", "string" ], "default": "#333333" } } }, "PortalExperienceSettingsDto": { "type": "object", "properties": { "theme": { "type": "string" }, "defaultLandingPage": { "type": "string" }, "defaultPageSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "sidebarCollapsed": { "type": "boolean" }, "compactMode": { "type": "boolean" } } }, "PortalLocalizationSettingsDto": { "type": "object", "properties": { "languageCode": { "type": "string" }, "timeZoneId": { "type": "string" }, "dateFormat": { "type": "string" }, "timeFormat": { "type": "string" } } }, "PortalNotificationSettingsDto": { "type": "object", "properties": { "inAppEnabled": { "type": "boolean" }, "emailEnabled": { "type": "boolean" }, "smsEnabled": { "type": "boolean" } } }, "PortalSettingsDto": { "type": "object", "properties": { "sessionSecurity": { "$ref": "#/components/schemas/SessionSecurityPolicy" }, "experience": { "$ref": "#/components/schemas/PortalExperienceSettingsDto" }, "localization": { "$ref": "#/components/schemas/PortalLocalizationSettingsDto" }, "notifications": { "$ref": "#/components/schemas/PortalNotificationSettingsDto" }, "systemConfig": { "$ref": "#/components/schemas/GlobalSystemConfigDetail" }, "settingsVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "generatedUtc": { "type": "string", "format": "date-time" } } }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } }, "ProcessPaymentRequest": { "type": "object", "properties": { "paymentIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descriptionShort": { "type": "string" }, "cardNumber": { "type": "string" }, "cardCvv": { "type": "string" }, "cardExpireMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cardExpireYear": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cardholderName": { "type": "string" }, "billingZip": { "type": "string" }, "paymentVaultIdentifier": { "type": "string", "format": "uuid" } } }, "ProcessPaymentResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "providerName": { "type": "string" }, "transactionId": { "type": "string" }, "providerToken": { "type": "string" }, "cardLast4": { "type": "string" }, "cardExpireMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cardExpireYear": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "authCode": { "type": "string" }, "errorMessage": { "type": "string" }, "responseCode": { "type": "string" } } }, "ProductCategoryDto": { "type": "object", "properties": { "productCategoryIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "relatedCategoryIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "descriptionInternal": { "type": "string" }, "primaryImageIdentifier": { "type": "string", "format": "uuid" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "featuredCategory": { "type": "boolean" }, "isParent": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ProductCategorySaveRequest": { "type": "object", "properties": { "productCategoryIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "relatedCategoryIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "descriptionInternal": { "type": "string" }, "primaryImageIdentifier": { "type": "string", "format": "uuid" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "featuredCategory": { "type": "boolean" }, "isParent": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ProductDetailDto": { "type": "object", "properties": { "productDetailIdentifier": { "type": "string", "format": "uuid" }, "productIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "primaryImageIdentifier": { "type": "string", "format": "uuid" }, "warehouseIdentifier": { "type": "string", "format": "uuid" }, "coaIncomeIdentifier": { "type": "string", "format": "uuid" }, "coaCogsIdentifier": { "type": "string", "format": "uuid" }, "coaInventoryAssetIdentifier": { "type": "string", "format": "uuid" }, "coaExpenseIdentifier": { "type": "string", "format": "uuid" }, "coaLiabilityIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "sku": { "type": "string" }, "manufacturerPartNumber": { "type": "string" }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "priceSurcharge": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "priceDiscount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "shipping": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "Handling": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "priceActual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "markAsNewStartDate": { "type": "string", "format": "date-time" }, "markAsNewEndDate": { "type": "string", "format": "date-time" }, "hours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "length": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "width": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "height": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "minimumOrderQuantity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maximumOrderQuantity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "leadTimeDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "trackSerialNumbers": { "type": "boolean" }, "taxable": { "type": "boolean" }, "nonRefundable": { "type": "boolean" }, "disableBuyButton": { "type": "boolean" }, "disableWishlistButton": { "type": "boolean" }, "markAsNew": { "type": "boolean" }, "isPreOrderAllowed": { "type": "boolean" }, "isBackorderAllowed": { "type": "boolean" }, "showOnWebsite": { "type": "boolean" }, "isFeatured": { "type": "boolean" }, "trackInventory": { "type": "boolean" }, "stockQuantityDisplay": { "type": "boolean" }, "stockQuantityCurrent": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "stockQuantityMinimum": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "stockQuantityNotifyOnMin": { "type": "boolean" }, "allowReviews": { "type": "boolean" }, "isDownload": { "type": "boolean" }, "maxDownloads": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "isFirearmRelated": { "type": "boolean" }, "minimumAge": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "firearmTypeIdentifier ": { "type": "string", "format": "uuid" }, "firearmClassificationIdentifier ": { "type": "string", "format": "uuid" }, "caliberGauge": { "type": "string" }, "requires4473": { "type": "boolean" }, "requiresFflTransfer": { "type": "boolean" }, "isNfaItem": { "type": "boolean" }, "isAmmunition ": { "type": "boolean" }, "ageRequirementOverride": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ProductDetailSaveRequest": { "type": "object", "properties": { "productDetailIdentifier": { "type": "string", "format": "uuid" }, "productIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "primaryImageIdentifier": { "type": "string", "format": "uuid" }, "warehouseIdentifier": { "type": "string", "format": "uuid" }, "coaIncomeIdentifier": { "type": "string", "format": "uuid" }, "coaCogsIdentifier": { "type": "string", "format": "uuid" }, "coaInventoryAssetIdentifier": { "type": "string", "format": "uuid" }, "coaExpenseIdentifier": { "type": "string", "format": "uuid" }, "coaLiabilityIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "sKU": { "type": "string" }, "manufacturerPartNumber": { "type": "string" }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "priceSurcharge": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "priceDiscount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "shipping": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "Handling": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "priceActual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "markAsNewStartDate": { "type": "string", "format": "date-time" }, "markAsNewEndDate": { "type": "string", "format": "date-time" }, "hours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "length": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "width": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "height": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "minimumOrderQuantity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maximumOrderQuantity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "leadTimeDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "trackSerialNumbers": { "type": "boolean" }, "taxable": { "type": "boolean" }, "nonRefundable": { "type": "boolean" }, "disableBuyButton": { "type": "boolean" }, "disableWishlistButton": { "type": "boolean" }, "markAsNew": { "type": "boolean" }, "isPreOrderAllowed": { "type": "boolean" }, "isBackorderAllowed": { "type": "boolean" }, "showOnWebsite": { "type": "boolean" }, "isFeatured": { "type": "boolean" }, "trackInventory": { "type": "boolean" }, "stockQuantityDisplay": { "type": "boolean" }, "stockQuantityCurrent": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "stockQuantityMinimum": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "stockQuantityNotifyOnMin": { "type": "boolean" }, "allowReviews": { "type": "boolean" }, "isDownload": { "type": "boolean" }, "maxDownloads": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "isFirearmRelated": { "type": "boolean" }, "minimumAge": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "firearmTypeIdentifier ": { "type": "string", "format": "uuid" }, "firearmClassificationIdentifier ": { "type": "string", "format": "uuid" }, "caliberGauge": { "type": "string" }, "requires4473": { "type": "boolean" }, "requiresFflTransfer": { "type": "boolean" }, "isNfaItem": { "type": "boolean" }, "isAmmunition ": { "type": "boolean" }, "ageRequirementOverride": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ProductDto": { "type": "object", "properties": { "productIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "productTypeIdentifier": { "type": "string", "format": "uuid" }, "vendorIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "descriptionInternal": { "type": "string" }, "productCode": { "type": "string" }, "sku": { "type": "string" }, "barCode": { "type": "string" }, "upc": { "type": "string" }, "brand": { "type": "string" }, "manufacturer": { "type": "string" }, "primaryImageIdentifier": { "type": "string", "format": "uuid" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "showOnWebsite": { "type": "boolean" }, "IsFeatured": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ProductInventoryDto": { "type": "object", "properties": { "productInventoryIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "descriptionInternal": { "type": "string" }, "primaryImageIdentifier": { "type": "string", "format": "uuid" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ProductInventorySaveRequest": { "type": "object", "properties": { "productInventoryIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "descriptionInternal": { "type": "string" }, "primaryImageIdentifier": { "type": "string", "format": "uuid" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ProductSaveRequest": { "type": "object", "properties": { "productIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "productTypeIdentifier": { "type": "string", "format": "uuid" }, "vendorIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "descriptionInternal": { "type": "string" }, "productCode": { "type": "string" }, "sku": { "type": "string" }, "barCode": { "type": "string" }, "upc": { "type": "string" }, "brand": { "type": "string" }, "manufacturer": { "type": "string" }, "primaryImageIdentifier": { "type": "string", "format": "uuid" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "showOnWebsite": { "type": "boolean" }, "IsFeatured": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ProductSerialNumberDto": { "type": "object", "properties": { "productSerialNumberIdentifier": { "type": "string", "format": "uuid" }, "productIdentifier": { "type": "string", "format": "uuid" }, "warehouseIdentifier": { "type": "string", "format": "uuid" }, "serialNumber": { "type": "string" }, "manufacturerSerialNumber": { "type": "string" }, "barcode": { "type": "string" }, "status": { "type": "string" }, "condition": { "type": "string" }, "receivedDate": { "type": "string", "format": "date-time" }, "soldDate": { "type": "string", "format": "date-time" }, "lastMovementDate": { "type": "string", "format": "date-time" }, "purchaseReferenceIdentifier": { "type": "string", "format": "uuid" }, "invoiceIdentifier": { "type": "string", "format": "uuid" }, "notes": { "type": "string" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "ModifiedDate": { "type": "string", "format": "date-time" } } }, "ProductSerialNumberSaveRequest": { "type": "object", "properties": { "productSerialNumberIdentifier": { "type": "string", "format": "uuid" }, "productIdentifier": { "type": "string", "format": "uuid" }, "warehouseIdentifier": { "type": "string", "format": "uuid" }, "serialNumber": { "type": "string" }, "manufacturerSerialNumber": { "type": "string" }, "barcode": { "type": "string" }, "status": { "type": "string" }, "condition": { "type": "string" }, "receivedDate": { "type": "string", "format": "date-time" }, "soldDate": { "type": "string", "format": "date-time" }, "lastMovementDate": { "type": "string", "format": "date-time" }, "purchaseReferenceIdentifier": { "type": "string", "format": "uuid" }, "invoiceIdentifier": { "type": "string", "format": "uuid" }, "notes": { "type": "string" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ProductSerialNumberTransactionDto": { "type": "object", "properties": { "productSerialNumberTransactionIdentifier": { "type": "string", "format": "uuid" }, "productSerialNumberIdentifier": { "type": "string", "format": "uuid" }, "productIdentifier": { "type": "string", "format": "uuid" }, "warehouseIdentifier": { "type": "string", "format": "uuid" }, "transactionType": { "type": "string" }, "referenceTable": { "type": "string" }, "referenceIdentifier": { "type": "string", "format": "uuid" }, "referenceNumber": { "type": "string" }, "transactionDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ProductSerialNumberTransactionSaveRequest": { "type": "object", "properties": { "productSerialNumberTransactionIdentifier": { "type": "string", "format": "uuid" }, "productSerialNumberIdentifier": { "type": "string", "format": "uuid" }, "productIdentifier": { "type": "string", "format": "uuid" }, "warehouseIdentifier": { "type": "string", "format": "uuid" }, "transactionType": { "type": "string" }, "referenceTable": { "type": "string" }, "referenceIdentifier": { "type": "string", "format": "uuid" }, "referenceNumber": { "type": "string" }, "transactionDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ProductWarehouseDto": { "type": "object", "properties": { "productWarehouseIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "descriptionInternal": { "type": "string" }, "primaryImageIdentifier": { "type": "string", "format": "uuid" }, "warehouseCode": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isDefault": { "type": "boolean" }, "allowSales": { "type": "boolean" }, "allowPurchases": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ProductWarehouseSaveRequest": { "type": "object", "properties": { "productWarehouseIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "descriptionInternal": { "type": "string" }, "primaryImageIdentifier": { "type": "string", "format": "uuid" }, "warehouseCode": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isDefault": { "type": "boolean" }, "allowSales": { "type": "boolean" }, "allowPurchases": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ProjectDto": { "type": "object", "properties": { "projectIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "priorityIdentifier": { "type": "string", "format": "uuid" }, "ownerIdentifier": { "type": "string", "format": "uuid" }, "projectNumber": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "recurrenceInterval": { "type": "string" }, "recurrenceNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "billable": { "type": "boolean" }, "internalUseOnly": { "type": "boolean" }, "recurring": { "type": "boolean" }, "emailCustomerOnCompletion": { "type": "boolean" }, "requireImagesToComplete": { "type": "boolean" }, "pullTimeFromSystem": { "type": "boolean" }, "ProjectDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "approvedDate": { "type": "string", "format": "date-time" }, "approvedBy": { "type": "string" }, "invoiceIdentifier": { "type": "string", "format": "uuid" }, "poNumber": { "type": "string" }, "percentComplete": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "hoursEstimated": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "hoursActual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "squareFeet": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "costCode": { "type": "string" }, "accountingSystemId": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ProjectSaveRequest": { "type": "object", "properties": { "projectIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "priorityIdentifier": { "type": "string", "format": "uuid" }, "ownerIdentifier": { "type": "string", "format": "uuid" }, "projectNumber": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "recurrenceInterval": { "type": "string" }, "recurrenceNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "billable": { "type": "boolean" }, "internalUseOnly": { "type": "boolean" }, "recurring": { "type": "boolean" }, "emailCustomerOnCompletion": { "type": "boolean" }, "requireImagesToComplete": { "type": "boolean" }, "pullTimeFromSystem": { "type": "boolean" }, "ProjectDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "approvedDate": { "type": "string", "format": "date-time" }, "approvedBy": { "type": "string" }, "invoiceIdentifier": { "type": "string", "format": "uuid" }, "poNumber": { "type": "string" }, "percentComplete": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "hoursEstimated": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "hoursActual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "squareFeet": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "costCode": { "type": "string" }, "accountingSystemId": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "PublicForm4473BuyerCertificationRequest": { "required": [ "form4473_identifier", "signature", "certification_accepted" ], "type": "object", "properties": { "form4473_identifier": { "type": "string", "format": "uuid" }, "expected_version": { "maximum": 9223372036854776000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "signature": { "$ref": "#/components/schemas/Form4473SignatureCaptureRequest" }, "certification_accepted": { "type": "boolean" } } }, "PublicForm4473BuyerRecertificationRequest": { "required": [ "form4473_identifier", "signature", "certification_accepted" ], "type": "object", "properties": { "form4473_identifier": { "type": "string", "format": "uuid" }, "expected_version": { "maximum": 9223372036854776000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "signature": { "$ref": "#/components/schemas/Form4473SignatureCaptureRequest" }, "certification_accepted": { "type": "boolean" } } }, "PublicForm4473DraftSaveRequest": { "required": [ "form4473_identifier" ], "type": "object", "properties": { "form4473_identifier": { "type": "string", "format": "uuid" }, "expected_version": { "maximum": 9223372036854776000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "buyer": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Form4473BuyerSaveRequest" } ] }, "questions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Form4473QuestionsSaveRequest" } ] } } }, "PublicFormConfirmationDto": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" } } }, "PublicFormDefinitionDto": { "type": "object", "properties": { "formIdentifier": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormFieldDto" } }, "settings": { "$ref": "#/components/schemas/PublicFormSettingsDto" }, "template": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PublicFormTemplateDto" } ] } } }, "PublicFormDefinitionResponseDto": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PublicFormDefinitionDto" } ] }, "errors": { "type": "array", "items": { "type": "string" } }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PublicFormResponseMetadataDto" } ] } } }, "PublicFormFieldConfigDto": { "type": "object", "properties": { "ariaDescription": { "type": "string" }, "ariaLabel": { "type": "string" }, "autocomplete": { "type": "string" }, "label": { "type": "string" }, "placeholder": { "type": "string" }, "validaton": { "type": "string" }, "subFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PublicFormSubFieldDto" } } } }, "PublicFormFieldDto": { "type": "object", "properties": { "formFieldIdentifier": { "type": "string", "format": "uuid" }, "type": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean" }, "encrypted": { "type": "boolean" }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "config": { "$ref": "#/components/schemas/PublicFormFieldConfigDto" } } }, "PublicFormModuleDto": { "type": "object", "properties": { "moduleName": { "type": "string" }, "moduleSave": { "type": "boolean" } } }, "PublicFormResponseMetadataDto": { "type": "object", "properties": { "version": { "type": "string" }, "processedUtc": { "type": "string", "format": "date-time" }, "executionTimeMs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "traceId": { "type": "string" } } }, "PublicFormSecuritySettingsDto": { "type": "object", "properties": { "recaptchaV2": { "type": "boolean" }, "includeHoneypot": { "type": "boolean" }, "honeypotFieldName": { "type": "string" }, "spamFilter": { "type": "boolean" } } }, "PublicFormSettingsDto": { "type": "object", "properties": { "title": { "type": "string" }, "showTitle": { "type": "boolean" }, "hideLabels": { "type": "boolean" }, "displayInline": { "type": "boolean" }, "inlineButtonMinWidth": { "type": "string" }, "processingText": { "type": "string" }, "submitButtonText": { "type": "string" }, "compliance": { "type": "array", "items": { "type": "string" } }, "saveModules": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormModuleDto" } }, "security": { "$ref": "#/components/schemas/PublicFormSecuritySettingsDto" }, "confirmation": { "$ref": "#/components/schemas/PublicFormConfirmationDto" }, "theme": { "$ref": "#/components/schemas/PublicFormThemeDto" } } }, "PublicFormSubFieldDto": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "autocomplete": { "type": [ "null", "string" ] }, "visible": { "type": "boolean" } } }, "PublicFormSubmissionFieldDto": { "type": "object", "properties": { "formFieldIdentifier": { "type": "string", "format": "uuid" }, "fieldType": { "type": "string" }, "fieldKey": { "type": "string" }, "isEncrypted": { "type": "boolean" }, "value": { "type": "string" } } }, "PublicFormSubmissionMetaDto": { "type": "object", "properties": { "userAgent": { "type": "string" }, "culture": { "type": "string" }, "timeZone": { "type": "string" }, "pageUrl": { "type": "string" }, "referrer": { "type": "string" } } }, "PublicFormSubmissionRequestDto": { "type": "object", "properties": { "formIdentifier": { "type": "string", "format": "uuid" }, "submittedAtUtc": { "type": "string", "format": "date-time" }, "startedUtc": { "type": "string", "format": "date-time" }, "submittedUtc": { "type": "string", "format": "date-time" }, "elapsedMilliseconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "honeypot": { "type": [ "null", "string" ] }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormSubmissionFieldDto" } }, "meta": { "$ref": "#/components/schemas/PublicFormSubmissionMetaDto" } } }, "PublicFormTemplateDto": { "type": "object", "properties": { "templateKey": { "type": "string" }, "headerHtml": { "type": "string" }, "footerHtml": { "type": "string" } } }, "PublicFormThemeDto": { "type": "object", "properties": { "validationSummaryClass": { "type": "string" }, "pageWrapperClass": { "type": "string" }, "sectionBodyClass": { "type": "string" }, "inputWrapperClass": { "type": "string" }, "buttonClass": { "type": "string" }, "subFieldGridClass": { "type": "string" }, "sectionHeaderClass": { "type": "string" }, "checkboxWrapperClass": { "type": "string" }, "checkboxInputClass": { "type": "string" }, "inputClass": { "type": "string" }, "formContainerClass": { "type": "string" }, "fieldGroupClass": { "type": "string" }, "sectionClass": { "type": "string" }, "successMessageClass": { "type": "string" }, "requiredIndicatorClass": { "type": "string" }, "validationMessageClass": { "type": "string" }, "showSubFieldLabels": { "type": "boolean" }, "subLabelClass": { "type": "string" }, "sectionTitleClass": { "type": "string" }, "descriptionClass": { "type": "string" }, "buttonContainerClass": { "type": "string" }, "sectionDescriptionClass": { "type": "string" }, "labelClass": { "type": "string" }, "requiredIndicator": { "type": "string" }, "mainContentClass": { "type": "string" } } }, "PublicLocalSearchGridRequest": { "type": "object", "properties": { "domain": { "type": "string" }, "keywordPhrase": { "type": "string" }, "postalCode": { "type": "string" } } }, "PublicScheduleBookingRequest": { "required": [ "firstName", "lastName", "emailAddress" ], "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string" }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string" }, "emailAddress": { "maxLength": 250, "minLength": 0, "type": "string" }, "phoneNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "descriptionLong": { "maxLength": 2000, "minLength": 0, "type": "string" } } }, "PublicScheduleBookingResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "scheduleIdentifier": { "type": "string", "format": "uuid" }, "scheduleAttendeeIdentifier": { "type": "string", "format": "uuid" }, "message": { "type": "string" } } }, "PublicScheduleDto": { "type": "object", "properties": { "scheduleTypeIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "durationMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "minimumNoticeMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maximumAdvanceDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maximumAttendees": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "locationType": { "type": "string" }, "location": { "type": "string" }, "color": { "type": "string" }, "slug": { "type": "string" }, "isPublic": { "type": "boolean" }, "active": { "type": "boolean" } } }, "PublicScheduleSlotDto": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } } }, "QrIconOptions": { "type": "object", "properties": { "base64_image": { "type": [ "null", "string" ] }, "size_percent": { "maximum": 35, "minimum": 5, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 15 }, "border_width": { "maximum": 20, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 6 }, "use_background_color_behind_icon": { "type": "boolean", "default": true } } }, "QrOutputFormat": { }, "QrRendererMode": { }, "QuickAccessItemDto": { "type": "object", "properties": { "identifier": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "url": { "type": "string" }, "iconClass": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "RecoveryRequestDto": { "required": [ "accountCode", "emailAddress" ], "type": "object", "properties": { "accountCode": { "maxLength": 50, "pattern": "^[a-zA-Z0-9\\-]+$", "type": "string" }, "emailAddress": { "maxLength": 250, "type": "string" }, "riskToken": { "maxLength": 512, "type": [ "null", "string" ] }, "requestVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "RedirectUrlDto": { "type": "object", "properties": { "redirectUrlIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "redirectFrom": { "type": "string" }, "redirectTo": { "type": "string" }, "responseStatusCode": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "descriptionShort": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "pageViews": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lastPageViewDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "RedirectUrlSaveRequest": { "type": "object", "properties": { "redirectUrlIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "redirectFrom": { "type": "string" }, "redirectTo": { "type": "string" }, "responseStatusCode": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "descriptionShort": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "pageViews": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lastPageViewDate": { "type": "string", "format": "date-time" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "RegionRequest": { "required": [ "country_code" ], "type": "object", "properties": { "country_code": { "type": "string" } } }, "RegisterRequestDto": { "required": [ "userIdentifier", "firstName", "lastName", "accountCode", "emailAddress", "password" ], "type": "object", "properties": { "userIdentifier": { "type": "string", "format": "uuid" }, "firstName": { "maxLength": 100, "pattern": "^[a-zA-Z\\-\\s']+$", "type": "string" }, "lastName": { "maxLength": 100, "pattern": "^[a-zA-Z\\-\\s']+$", "type": "string" }, "accountCode": { "maxLength": 50, "pattern": "^[a-zA-Z0-9\\-]+$", "type": "string" }, "emailAddress": { "maxLength": 250, "type": "string" }, "password": { "maxLength": 250, "minLength": 12, "type": "string" }, "userAgent": { "maxLength": 512, "type": [ "null", "string" ] }, "riskToken": { "maxLength": 512, "type": [ "null", "string" ] }, "requestVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "RelationDto": { "type": "object", "properties": { "relationIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "descriptionShort": { "type": "string" }, "birthDate": { "type": "string", "format": "date-time" }, "remindBeforeDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "RelationSaveRequest": { "type": "object", "properties": { "relationIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "descriptionShort": { "type": "string" }, "birthDate": { "type": "string", "format": "date-time" }, "remindBeforeDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "RobotsRule": { "required": [ "path", "allow" ], "type": "object", "properties": { "path": { "type": "string" }, "allow": { "type": "boolean" } } }, "RobotsTxtRequest": { "required": [ "user_agents", "rules" ], "type": "object", "properties": { "user_agents": { "type": "array", "items": { "type": "string" } }, "rules": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/RobotsRule" } }, "sitemap_url": { "type": [ "null", "string" ] } } }, "ScheduleAttendeeDto": { "type": "object", "properties": { "scheduleAttendeeIdentifier": { "type": "string", "format": "uuid" }, "scheduleIdentifier": { "type": "string", "format": "uuid" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "emailAddress": { "type": "string" }, "phoneNumber": { "type": "string" }, "descriptionLong": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ScheduleAttendeeSaveRequest": { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "scheduleAttendeeIdentifier": { "type": "string", "format": "uuid" }, "scheduleIdentifier": { "type": "string", "format": "uuid" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string" }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string" }, "emailAddress": { "maxLength": 250, "minLength": 0, "type": "string" }, "phoneNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "descriptionLong": { "maxLength": 2000, "minLength": 0, "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ScheduleAvailabilityDto": { "type": "object", "properties": { "scheduleAvailabilityIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "timeZoneIdentifier": { "type": "string", "format": "uuid" }, "dayOfWeek": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "uint8" }, "startTime": { "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", "type": "string" }, "endTime": { "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", "type": "string" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ScheduleAvailabilitySaveRequest": { "type": "object", "properties": { "scheduleAvailabilityIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "timeZoneIdentifier": { "type": "string", "format": "uuid" }, "dayOfWeek": { "maximum": 6, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "uint8" }, "startTime": { "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", "type": "string" }, "endTime": { "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", "type": "string" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ScheduleDto": { "type": "object", "properties": { "scheduleIdentifier": { "type": "string", "format": "uuid" }, "scheduleTypeIdentifier": { "type": "string", "format": "uuid" }, "timeZoneIdentifier": { "type": "string", "format": "uuid" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "locationType": { "type": "string" }, "location": { "type": "string" }, "meetingUrl": { "type": "string" }, "maximumAttendees": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cancellationReason": { "type": "string" }, "cancelledBy": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ScheduleHostDto": { "type": "object", "properties": { "scheduleHostIdentifier": { "type": "string", "format": "uuid" }, "scheduleIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "isPrimary": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ScheduleHostSaveRequest": { "type": "object", "properties": { "scheduleHostIdentifier": { "type": "string", "format": "uuid" }, "scheduleIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "isPrimary": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ScheduleSaveRequest": { "required": [ "descriptionShort" ], "type": "object", "properties": { "scheduleIdentifier": { "type": "string", "format": "uuid" }, "scheduleTypeIdentifier": { "type": "string", "format": "uuid" }, "timeZoneIdentifier": { "type": "string", "format": "uuid" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "maxLength": 250, "minLength": 0, "type": "string" }, "descriptionLong": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "locationType": { "maxLength": 50, "minLength": 0, "type": "string" }, "location": { "maxLength": 500, "minLength": 0, "type": "string" }, "meetingUrl": { "maxLength": 2000, "minLength": 0, "type": "string" }, "maximumAttendees": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cancellationReason": { "maxLength": 2000, "minLength": 0, "type": "string" }, "cancelledBy": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "ScheduleTypeDto": { "type": "object", "properties": { "scheduleTypeIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "durationMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "bufferBeforeMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "bufferAfterMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "minimumNoticeMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maximumAdvanceDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maximumAttendees": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "locationType": { "type": "string" }, "location": { "type": "string" }, "color": { "type": "string" }, "slug": { "type": "string" }, "isPublic": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "ScheduleTypeSaveRequest": { "required": [ "descriptionShort" ], "type": "object", "properties": { "scheduleTypeIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "maxLength": 150, "minLength": 0, "type": "string" }, "descriptionLong": { "type": "string" }, "durationMinutes": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "bufferBeforeMinutes": { "maximum": 2147483647, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "bufferAfterMinutes": { "maximum": 2147483647, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "minimumNoticeMinutes": { "maximum": 2147483647, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maximumAdvanceDays": { "maximum": 2147483647, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maximumAttendees": { "maximum": 2147483647, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "locationType": { "maxLength": 50, "minLength": 0, "type": "string" }, "location": { "maxLength": 500, "minLength": 0, "type": "string" }, "color": { "maxLength": 25, "minLength": 0, "type": "string" }, "slug": { "maxLength": 150, "minLength": 0, "type": "string" }, "isPublic": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SecurityGroupOptionDto": { "type": "object", "properties": { "fieldValue": { "type": "string", "format": "uuid" }, "fieldName": { "type": "string" } } }, "SecurityIntrusionDetectionDto": { "type": "object", "properties": { "intrusionDetectionIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "fieldValue": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SecurityIntrusionDetectionSaveRequest": { "type": "object", "properties": { "intrusionDetectionIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "fieldValue": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SecurityLogDto": { "type": "object", "properties": { "logIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifierName": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantIdentifierName": { "type": "string" }, "moduleIdentifier": { "type": "string", "format": "uuid" }, "moduleIdentifierName": { "type": "string" }, "entityIdentifier": { "type": "string", "format": "uuid" }, "entityIdentifierName": { "type": "string" }, "correlationIdentifier": { "type": "string", "format": "uuid" }, "correlationIdentifierName": { "type": "string" }, "userIdentifier": { "type": "string", "format": "uuid" }, "userIdentifierName": { "type": "string" }, "categoryName": { "type": "string" }, "actionName": { "type": "string" }, "moduleName": { "type": "string" }, "entityName": { "type": "string" }, "procedureName": { "type": "string" }, "message": { "type": "string" }, "sourceType": { "type": "string" }, "eventType": { "type": "string" }, "severity": { "type": "string" }, "errorNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "errorMessage": { "type": "string" }, "isSuccess": { "type": "boolean" }, "ipAddress": { "type": "string", "format": "byte" }, "userAgent": { "type": "string" }, "payloadXml": { "type": "string" }, "payloadString": { "type": "string" }, "integrityHash": { "type": "string", "format": "byte" }, "integrityHashAlgorithm": { "type": "string" }, "integrityHashVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int16" }, "integrityIsValid": { "type": "boolean" }, "eventDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "createdByName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } } }, "SecurityLogSaveRequest": { "type": "object", "properties": { "logIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "categoryName": { "type": "string" }, "actionName": { "type": "string" }, "isSuccess": { "type": "boolean" }, "ipAddress": { "type": "string", "format": "byte" }, "userAgent": { "type": "string" }, "payloadXml": { "type": [ "null", "string" ] }, "payloadString": { "type": "string" }, "integrityHash": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SecurityModuleDto": { "type": "object", "properties": { "moduleIdentifier": { "type": "string", "format": "uuid" }, "parentModuleIdentifier": { "type": "string", "format": "uuid" }, "licenseIdentifier": { "type": "string", "format": "uuid" }, "iconIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "moduleSecurity": { "type": "string" }, "url": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isParent": { "type": "boolean" }, "hrBefore": { "type": "boolean" }, "hrAfter": { "type": "boolean" }, "displayInMenu": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SecurityModuleSaveRequest": { "type": "object", "properties": { "moduleIdentifier": { "type": "string", "format": "uuid" }, "parentModuleIdentifier": { "type": "string", "format": "uuid" }, "licenseIdentifier": { "type": "string", "format": "uuid" }, "iconIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "moduleSecurity": { "type": "string" }, "url": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isParent": { "type": "boolean" }, "hrBefore": { "type": "boolean" }, "hrAfter": { "type": "boolean" }, "displayInMenu": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SecurityUserDto": { "type": "object", "properties": { "userIdentifier": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": "string", "format": "uuid" }, "themeIdentifier": { "type": "string", "format": "uuid" }, "userSecurityGroupIdentifier": { "type": "string", "format": "uuid" }, "accountCode": { "type": "string" }, "accountName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "emailAddress": { "type": "string" }, "roles": { "type": "string" }, "active": { "type": "boolean" }, "accountActive": { "type": "boolean" }, "portalActive": { "type": "boolean" }, "passwordExpired": { "type": "boolean" }, "birthday": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time" }, "passwordLastChanged": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "ModifiedDate": { "type": "string", "format": "date-time" } } }, "SecurityUserSaveRequest": { "type": "object", "properties": { "userIdentifier": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "emailAddress": { "type": "string" }, "active": { "type": "boolean" }, "passwordExpired": { "type": "boolean" }, "birthday": { "type": "string", "format": "date-time" }, "userPasswordBase64": { "type": [ "null", "string" ] }, "sendWelcomeEmail": { "type": "boolean" }, "sendPasswordReset": { "type": "boolean" } } }, "SecurityUserSecurityDetailDto": { "type": "object", "properties": { "userSecurityDetailIdentifier": { "type": "string", "format": "uuid" }, "userSecurityIdentifier": { "type": "string", "format": "uuid" }, "moduleIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "allowViewing": { "type": "boolean" }, "allowEdit": { "type": "boolean" }, "allowDelete": { "type": "boolean" }, "allowSettings": { "type": "boolean" }, "allowReports": { "type": "boolean" }, "allowExport": { "type": "boolean" }, "createdByMe": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SecurityUserSecurityDetailSaveRequest": { "type": "object", "properties": { "userSecurityDetailIdentifier": { "type": "string", "format": "uuid" }, "userSecurityIdentifier": { "type": "string", "format": "uuid" }, "moduleIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "allowViewing": { "type": "boolean" }, "allowEdit": { "type": "boolean" }, "allowDelete": { "type": "boolean" }, "allowSettings": { "type": "boolean" }, "allowReports": { "type": "boolean" }, "allowExport": { "type": "boolean" }, "createdByMe": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SecurityUserSecurityDto": { "type": "object", "properties": { "userSecurityIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "isGlobalAdmin": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SecurityUserSecuritySaveRequest": { "type": "object", "properties": { "userSecurityIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "isGlobalAdmin": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SeoDto": { "type": "object" }, "SeoHeadMetadata": { "type": "object", "properties": { "slug": { "type": "string" }, "language": { "type": "string" }, "locale": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "canonicalUrl": { "type": [ "null", "string" ] }, "robots": { "type": "string" }, "author": { "type": [ "null", "string" ] }, "schemaType": { "type": "string" }, "openGraph": { "$ref": "#/components/schemas/OpenGraphMetadata" }, "xCard": { "$ref": "#/components/schemas/XCardMetadata" }, "icons": { "$ref": "#/components/schemas/IconMetadata" }, "createdDate": { "type": [ "null", "string" ], "format": "date-time" }, "modifiedDate": { "type": [ "null", "string" ], "format": "date-time" }, "structuredData": { "$ref": "#/components/schemas/JsonArray" } } }, "SeoHeadResponse": { "type": "object", "properties": { "title": { "type": "string" }, "seoHeader": { "type": "string" }, "headerHtml": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/SeoHeadMetadata" }, "validation": { "$ref": "#/components/schemas/SeoHeadValidation" } } }, "SeoHeadValidation": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } }, "warnings": { "type": "array", "items": { "type": "string" } }, "OmittedFields": { "type": "array", "items": { "type": "string" } } } }, "SeoMetaDataSaveRequest": { "type": "object", "properties": { "seoMetadataIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "templateIdentifier": { "type": "string", "format": "uuid" }, "schemaTypeIdentifier": { "type": "string", "format": "uuid" }, "ogImageIdentifier": { "type": "string", "format": "uuid" }, "seoRobotIdentifier": { "type": "string", "format": "uuid" }, "seoTitle": { "type": "string" }, "seoDescription": { "type": "string" }, "seoCanonicalUrl": { "type": "string" }, "primaryFocusKeyword": { "type": "string" }, "secondaryKeywords": { "type": "string" }, "hrefLangLocale": { "type": "string" }, "customHeaderScripts": { "type": "string" }, "breadcrumbTitle": { "type": "string" }, "ogTypeIdentifier": { "type": "string", "format": "uuid" }, "twitterCardTypeIdentifier": { "type": "string", "format": "uuid" }, "isNoIndex": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "searchIntentTypeIdentifier": { "type": "string", "format": "uuid" }, "targetReadabilityLevelIdentifier": { "type": "string", "format": "uuid" }, "missingSubtopics": { "type": "string" }, "imageAltTextNotes": { "type": "string" }, "stalenessThresholdDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "requireHumanApproval": { "type": "boolean" }, "primaryEntityName": { "type": "string" }, "geographicServiceArea": { "type": "string" }, "directAnswerSnippet": { "type": "string" }, "eeatProofSource": { "type": "string" }, "factDensityRatingIdentifier": { "type": "string", "format": "uuid" }, "allowLlmIndexing": { "type": "boolean" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SessionSecurityPolicy": { "type": "object", "properties": { "idleTimeoutEnabled": { "type": "boolean" }, "idleTimeoutMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "warningBeforeTimeoutMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "keepAliveIntervalMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "absoluteSessionTimeoutMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "requireReauthentication": { "type": "boolean" }, "requireMfaOnReauthentication": { "type": "boolean" }, "synchronizeAcrossTabs": { "type": "boolean" }, "policyVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "policySource": { "type": [ "null", "string" ] } } }, "SettingApiKeyDto": { "type": "object", "properties": { "apiKeyIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "providerIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "apiUsername": { "type": "string" }, "apiPassword": { "type": "string" }, "tokenUrlProduction": { "type": "string" }, "tokenUrlSandbox": { "type": "string" }, "apiUrlProduction": { "type": "string" }, "apiUrlSandbox": { "type": "string" }, "encryptionMethod": { "type": "string" }, "lastKeyDate": { "type": "string", "format": "date-time" }, "monthMax": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "monthResetDay": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "AccountSid": { "type": "string" }, "authToken": { "type": "string" }, "apiKey": { "type": "string" }, "phoneNumberFrom": { "type": "string" }, "bearer": { "type": "string" }, "sendSms": { "type": "boolean" }, "sendMms": { "type": "boolean" }, "sendRobot": { "type": "boolean" }, "phoneVerification": { "type": "boolean" }, "modelName": { "type": "string" }, "contextWindowSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "tokenCost": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "trainingDate": { "type": "string", "format": "date-time" }, "generatesImages": { "type": "boolean" }, "generatesSpeech": { "type": "boolean" }, "generatesText": { "type": "boolean" }, "systemKey": { "type": "boolean" }, "isProduction": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingApiKeySaveRequest": { "type": "object", "properties": { "apiKeyIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "providerIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "apiUsername": { "type": "string" }, "apiPassword": { "type": "string" }, "tokenUrlProduction": { "type": "string" }, "tokenUrlSandbox": { "type": "string" }, "apiUrlProduction": { "type": "string" }, "apiUrlSandbox": { "type": "string" }, "encryptionMethod": { "type": "string" }, "lastKeyDate": { "type": "string", "format": "date-time" }, "monthMax": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "monthResetDay": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "AccountSid": { "type": "string" }, "authToken": { "type": "string" }, "apiKey": { "type": "string" }, "phoneNumberFrom": { "type": "string" }, "bearer": { "type": "string" }, "sendSms": { "type": "boolean" }, "sendMms": { "type": "boolean" }, "sendRobot": { "type": "boolean" }, "phoneVerification": { "type": "boolean" }, "modelName": { "type": "string" }, "contextWindowSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "tokenCost": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "trainingDate": { "type": "string", "format": "date-time" }, "generatesImages": { "type": "boolean" }, "generatesSpeech": { "type": "boolean" }, "generatesText": { "type": "boolean" }, "systemKey": { "type": "boolean" }, "isProduction": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SettingApplicationDto": { "type": "object", "properties": { "appSettingIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "category": { "type": "string" }, "fieldName": { "type": "string" }, "fieldValue": { "type": "string" }, "hasHtml": { "type": "boolean" }, "active": { "type": "boolean" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "isProtected": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "inSetup": { "type": "boolean" }, "showInAdvanced": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingApplicationSaveRequest": { "type": "object", "properties": { "appSettingIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "category": { "type": "string" }, "fieldName": { "type": "string" }, "fieldValue": { "type": "string" }, "hasHtml": { "type": "boolean" }, "active": { "type": "boolean" }, "isProtected": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "inSetup": { "type": "boolean" }, "showInAdvanced": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SettingApplicationSetupDto": { "type": "object", "properties": { "accountCode": { "type": "string" }, "businessName": { "type": "string" }, "businessDescription": { "type": "string" }, "businessUrl": { "type": "string" }, "businessEmailAddress": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneTollfree": { "type": "string" }, "businessFax": { "type": "string" }, "businessCity": { "type": "string" }, "businessState": { "type": "string" }, "businessPostalCode": { "type": "string" }, "businessCounty": { "type": "string" }, "businessCountry": { "type": "string" }, "businessLatitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "businessLongitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "defaultTimeZone": { "type": "string", "format": "uuid" }, "einNumber": { "type": "string" }, "dunsNumber": { "type": "string" }, "businessPriceRange": { "type": "string" }, "socialFacebook": { "type": "string" }, "socialInstagram": { "type": "string" }, "socialLinkedIn": { "type": "string" }, "socialX": { "type": "string" }, "socialYouTube": { "type": "string" }, "socialPinterest": { "type": "string" } } }, "SettingCategoryDto": { "type": "object", "properties": { "categoryIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "parentCategoryIdentifier": { "type": "string", "format": "uuid" }, "categoryTypeIdentifier": { "type": "string", "format": "uuid" }, "relatedCategoryIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "descriptionInternal": { "type": "string" }, "googleCategoryName": { "type": "string" }, "categoryIcon": { "type": "string" }, "primaryImageIdentifier": { "type": "string", "format": "uuid" }, "categoryColorBack": { "type": "string" }, "categoryColorFore": { "type": "string" }, "shortName": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "EndDate": { "type": "string", "format": "date-time" }, "featuredCategory": { "type": "boolean" }, "isParent": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingCategorySaveRequest": { "type": "object", "properties": { "categoryIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "parentCategoryIdentifier": { "type": "string", "format": "uuid" }, "categoryTypeIdentifier": { "type": "string", "format": "uuid" }, "relatedCategoryIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "descriptionInternal": { "type": "string" }, "googleCategoryName": { "type": "string" }, "categoryIcon": { "type": "string" }, "primaryImageIdentifier": { "type": "string", "format": "uuid" }, "categoryColorBack": { "type": "string" }, "categoryColorFore": { "type": "string" }, "shortName": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "EndDate": { "type": "string", "format": "date-time" }, "featuredCategory": { "type": "boolean" }, "isParent": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SettingDataSetDto": { "type": "object", "properties": { "dataSetIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "category": { "type": "string" }, "fieldName": { "type": "string" }, "fieldValue": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingDataSetSaveRequest": { "type": "object", "properties": { "dataSetIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "category": { "type": "string" }, "fieldName": { "type": "string" }, "fieldValue": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SettingEmailTemplateDto": { "type": "object", "properties": { "emailTemplateIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "templateKey": { "type": "string" }, "templateName": { "type": "string" }, "htmlTemplate": { "type": "string" }, "textTemplate": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "isSystemTemplate": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingEmailTemplateSaveRequest": { "type": "object", "properties": { "emailTemplateIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "templateKey": { "type": "string" }, "templateName": { "type": "string" }, "htmlTemplate": { "type": "string" }, "textTemplate": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "isSystemTemplate": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SettingIconDto": { "type": "object", "properties": { "iconIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "themeIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "iconName": { "type": "string" }, "iconSvg": { "type": "string" }, "usePortal": { "type": "boolean" }, "usePublic": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingIconSaveRequest": { "type": "object", "properties": { "iconIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "themeIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "iconName": { "type": "string" }, "iconSvg": { "type": "string" }, "usePortal": { "type": "boolean" }, "usePublic": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SettingLanguageDto": { "type": "object", "properties": { "siteLanguageIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "pageName": { "type": "string" }, "fieldName": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "descriptionLong": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingLanguageSaveRequest": { "type": "object", "properties": { "siteLanguageIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "module": { "type": "string" }, "fieldName": { "type": "string" }, "pageName": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "descriptionLong": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SettingPaymentProviderDto": { "type": "object", "properties": { "paymentProviderIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "providerName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "liveMode": { "type": "boolean" }, "clientId": { "type": "string" }, "privateKey": { "type": "string" }, "token": { "type": "string" }, "liveUrl": { "type": "string" }, "sandboxUrl": { "type": "string" }, "merchantId": { "type": "string" }, "apiVersion": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingPaymentProviderSaveRequest": { "type": "object", "properties": { "paymentProviderIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "providerName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "active": { "type": "boolean" }, "liveMode": { "type": "boolean" }, "clientId": { "type": "string" }, "privateKey": { "type": "string" }, "token": { "type": "string" }, "liveUrl": { "type": "string" }, "sandboxUrl": { "type": "string" }, "merchantId": { "type": "string" }, "apiVersion": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SettingSmtpDto": { "type": "object", "properties": { "smtpIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxPerMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "monthStartDay": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "useApi": { "type": "boolean" }, "apiKey": { "type": "string" }, "apiUrl": { "type": "string" }, "smtpUsername": { "type": "string" }, "smtpPassword": { "type": "string" }, "smtpServer": { "type": "string" }, "smtpPort": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "smtpTimeout": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "smtpUseSsl": { "type": "boolean" }, "domainName": { "type": "string" }, "smtpMailFrom": { "type": "string" }, "SmtpMailTo": { "type": "string" }, "smtpMailToUnknown": { "type": "string" }, "smtpMailCc": { "type": "string" }, "smtpMailBcc": { "type": "string" }, "smtpAlwaysUseUTM": { "type": "boolean" }, "smtpDefaultUtmSource": { "type": "string" }, "smtpDefaultUtmMedium": { "type": "string" }, "smtpDefaultUtmCampaign": { "type": "string" }, "smtpDefaultUtmTermAlwaysAdd": { "type": "boolean" }, "smtpDefaultUtmTerm": { "type": "string" }, "smtpDefaultUtmContentAlwaysAdd": { "type": "boolean" }, "smtpDefaultUtmContent": { "type": "string" }, "smtpDefaultUtmFirstName": { "type": "string" }, "smtpDefaultUtmLastName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "useEmailUnsubscribeLink": { "type": "boolean" }, "allowEmailUnsubscribeLinkOverride": { "type": "boolean" }, "emailUnsubscribeLink": { "type": "string" }, "useEmailPrecedence": { "type": "boolean" }, "emailPrecedence": { "type": "string" }, "useEmailReturnPath": { "type": "boolean" }, "emailReturnPath": { "type": "string" }, "useEmailSpam": { "type": "boolean" }, "emailSpam": { "type": "string" }, "useEmailAbuse": { "type": "boolean" }, "emailAbuse": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingSmtpSaveRequest": { "type": "object", "properties": { "smtpIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "providerIdentifier": { "type": "string", "format": "uuid" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxPerMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "monthStartDay": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "useApi": { "type": "boolean" }, "apiKey": { "type": "string" }, "apiUrl": { "type": "string" }, "smtpUsername": { "type": "string" }, "smtpPassword": { "type": "string" }, "smtpServer": { "type": "string" }, "smtpPort": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "smtpTimeout": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "smtpUseSsl": { "type": "boolean" }, "domainName": { "type": "string" }, "smtpMailFrom": { "type": "string" }, "SmtpMailTo": { "type": "string" }, "smtpMailToUnknown": { "type": "string" }, "smtpMailCc": { "type": "string" }, "smtpMailBcc": { "type": "string" }, "smtpAlwaysUseUTM": { "type": "boolean" }, "smtpDefaultUtmSource": { "type": "string" }, "smtpDefaultUtmMedium": { "type": "string" }, "smtpDefaultUtmCampaign": { "type": "string" }, "smtpDefaultUtmTermAlwaysAdd": { "type": "boolean" }, "smtpDefaultUtmTerm": { "type": "string" }, "smtpDefaultUtmContentAlwaysAdd": { "type": "boolean" }, "smtpDefaultUtmContent": { "type": "string" }, "smtpDefaultUtmFirstName": { "type": "string" }, "smtpDefaultUtmLastName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "useEmailUnsubscribeLink": { "type": "boolean" }, "allowEmailUnsubscribeLinkOverride": { "type": "boolean" }, "emailUnsubscribeLink": { "type": "string" }, "useEmailPrecedence": { "type": "boolean" }, "emailPrecedence": { "type": "string" }, "useEmailReturnPath": { "type": "boolean" }, "emailReturnPath": { "type": "string" }, "useEmailSpam": { "type": "boolean" }, "emailSpam": { "type": "string" }, "useEmailAbuse": { "type": "boolean" }, "emailAbuse": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SettingSuppressionListDto": { "type": "object", "properties": { "suppressionIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "reasonIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "reason": { "type": "string" }, "emailAddress": { "type": "string" }, "cellPhone": { "type": "string" }, "active": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingSuppressionListSaveRequest": { "type": "object", "properties": { "suppressionIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "reasonIdentifier": { "type": "string", "format": "uuid" }, "emailAddress": { "type": "string" }, "cellPhone": { "type": "string" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SettingSystemAlertDto": { "type": "object", "properties": { "systemAlertIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "alertTypeIdentifier": { "type": "string", "format": "uuid" }, "alertLocationIdentifier": { "type": "string", "format": "uuid" }, "alertColor": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingSystemAlertSaveRequest": { "type": "object", "properties": { "systemAlertIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "alertTypeIdentifier": { "type": "string", "format": "uuid" }, "alertLocationIdentifier": { "type": "string", "format": "uuid" }, "alertColor": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SettingTemplateDto": { "type": "object", "properties": { "templateIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "moduleIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "templateName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "templateHeader": { "type": "string" }, "templateDetail": { "type": "string" }, "templateFooter": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingTemplateSaveRequest": { "type": "object", "properties": { "templateIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "moduleIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "templateName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "templateHeader": { "type": "string" }, "templateDetail": { "type": "string" }, "templateFooter": { "type": "string" }, "languageIdentifier": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SettingThemeDto": { "type": "object", "properties": { "themeIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "themeName": { "type": "string" }, "stylesheet": { "type": "string" }, "stylesheetFonts": { "type": "string" }, "iconPrimaryColor": { "type": "string" }, "iconSecondaryColor": { "type": "string" }, "usePortal": { "type": "boolean" }, "usePublic": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "ModifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SettingThemeSaveRequest": { "type": "object", "properties": { "themeIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "themeName": { "type": "string" }, "stylesheet": { "type": "string" }, "stylesheetFonts": { "type": "string" }, "iconPrimaryColor": { "type": "string" }, "iconSecondaryColor": { "type": "string" }, "usePortal": { "type": "boolean" }, "usePublic": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SignedUrlRequest": { "type": "object", "properties": { "image_identifier": { "type": "string", "format": "uuid" }, "validity_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "width": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "height": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "quality": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "format": { "type": [ "null", "string" ] } } }, "SignedUrlResponse": { "type": "object", "properties": { "signed_url": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "valid_for": { "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", "type": "string" } } }, "SitemapRequest": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string" } } }, "SiteMonitorDetailDto": { "type": "object", "properties": { "siteMonitorDetailIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "statusMessage": { "type": "string" }, "siteHost": { "type": "string" }, "monitorError": { "type": "boolean" }, "iPMismatch": { "type": "boolean" }, "portResponded": { "type": "boolean" }, "sslException": { "type": "boolean" }, "sslExpiration": { "type": "boolean" }, "sslExpirationDate": { "type": "string", "format": "date-time" }, "domainExpired": { "type": "boolean" }, "domainExpirationDate": { "type": "string", "format": "date-time" }, "textError": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SiteMonitorDetailGridDto": { "type": "object", "properties": { "siteMonitorDetailIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "siteHost": { "type": "string" }, "siteUrl": { "type": "string" }, "statusMessage": { "type": "string" }, "statusSeverity": { "type": "string" }, "monitorError": { "type": "boolean" }, "hasAnyIssue": { "type": "boolean" }, "ipMismatch": { "type": "boolean" }, "currentIpAddress": { "type": "string" }, "expectedIpAddress": { "type": "string" }, "portResponded": { "type": "boolean" }, "portNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "sslException": { "type": "boolean" }, "sslExceptionMessage": { "type": "string" }, "sslExpiration": { "type": "boolean" }, "sslExpirationDate": { "type": [ "null", "string" ], "format": "date-time" }, "daysUntilSslExpires": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isSslExpired": { "type": "boolean" }, "isSslExpiringSoon": { "type": "boolean" }, "domainExpired": { "type": "boolean" }, "domainExpirationDate": { "type": [ "null", "string" ], "format": "date-time" }, "daysUntilDomainExpires": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isDomainExpired": { "type": "boolean" }, "isDomainExpiringSoon": { "type": "boolean" }, "textError": { "type": "boolean" }, "expectedText": { "type": "string" }, "responseTimeMs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "responseCode": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isResponseCodeSuccess": { "type": "boolean" }, "checksPerformed": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" }, "minutesSinceCheck": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "SiteMonitorDetailSaveRequest": { "type": "object", "properties": { "siteMonitorDetailIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "statusMessage": { "type": "string" }, "siteHost": { "type": "string" }, "monitorError": { "type": "boolean" }, "iPMismatch": { "type": "boolean" }, "portResponded": { "type": "boolean" }, "sslException": { "type": "boolean" }, "sslExpiration": { "type": "boolean" }, "sslExpirationDate": { "type": "string", "format": "date-time" }, "domainExpired": { "type": "boolean" }, "domainExpirationDate": { "type": "string", "format": "date-time" }, "textError": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SiteMonitorDto": { "type": "object", "properties": { "siteMonitorIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "siteHost": { "type": "string" }, "sitePort": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "frequency": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "frequencyLastCheck": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "monitorSSLErrors": { "type": "boolean" }, "monitorSSLExpiration": { "type": "boolean" }, "monitorDomainExpiration": { "type": "boolean" }, "sendEmail": { "type": "boolean" }, "sendSms": { "type": "boolean" }, "notifyOnError": { "type": "boolean" }, "NotifyOnIpMismatch": { "type": "boolean" }, "notifyOnDomainExpired": { "type": "boolean" }, "notifyOnSslErrors": { "type": "boolean" }, "notifyOnSslExpiration": { "type": "boolean" }, "notifyOnTextError": { "type": "boolean" }, "phraseToCheck": { "type": "string" }, "domainLastCheck": { "type": "string", "format": "date-time" }, "domainExpiration": { "type": "string", "format": "date-time" }, "sSLExpiration": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SiteMonitorGridDto": { "type": "object", "properties": { "siteMonitorIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "categoryName": { "type": "string" }, "siteHost": { "type": "string" }, "sitePort": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "siteUrl": { "type": "string" }, "active": { "type": "boolean" }, "startDate": { "type": [ "null", "string" ], "format": "date-time" }, "endDate": { "type": [ "null", "string" ], "format": "date-time" }, "isCurrentlyActive": { "type": "boolean" }, "daysRemaining": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "frequency": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "frequencyText": { "type": "string" }, "frequencyLastCheck": { "type": [ "null", "string" ], "format": "date-time" }, "minutesSinceLastCheck": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isOverdue": { "type": "boolean" }, "monitorSSLErrors": { "type": "boolean" }, "monitorSSLExpiration": { "type": "boolean" }, "monitorDomainExpiration": { "type": "boolean" }, "sslExpiration": { "type": [ "null", "string" ], "format": "date-time" }, "daysUntilSSLExpires": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isSSLExpiring": { "type": "boolean" }, "isSSLExpired": { "type": "boolean" }, "domainExpiration": { "type": [ "null", "string" ], "format": "date-time" }, "daysUntilDomainExpires": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isDomainExpiring": { "type": "boolean" }, "isDomainExpired": { "type": "boolean" }, "domainLastCheck": { "type": [ "null", "string" ], "format": "date-time" }, "sendEmail": { "type": "boolean" }, "sendSms": { "type": "boolean" }, "notificationCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "hasPhraseCheck": { "type": "boolean" }, "phraseToCheck": { "type": "string" }, "healthScore": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lastCheckStatus": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SiteMonitorSaveRequest": { "type": "object", "properties": { "siteMonitorIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "siteHost": { "type": "string" }, "sitePort": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "frequency": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "frequencyLastCheck": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "monitorSSLErrors": { "type": "boolean" }, "monitorSSLExpiration": { "type": "boolean" }, "monitorDomainExpiration": { "type": "boolean" }, "sendEmail": { "type": "boolean" }, "sendSms": { "type": "boolean" }, "notifyOnError": { "type": "boolean" }, "NotifyOnIpMismatch": { "type": "boolean" }, "notifyOnDomainExpired": { "type": "boolean" }, "notifyOnSslErrors": { "type": "boolean" }, "notifyOnSslExpiration": { "type": "boolean" }, "notifyOnTextError": { "type": "boolean" }, "phraseToCheck": { "type": "string" }, "domainLastCheck": { "type": "string", "format": "date-time" }, "domainExpiration": { "type": "string", "format": "date-time" }, "sSLExpiration": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SlugRequest": { "required": [ "title" ], "type": "object", "properties": { "title": { "type": "string" } } }, "SocialProfileDto": { "type": "object", "properties": { "socialProfileIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "providerName": { "type": "string" }, "profileUrl": { "type": "string" }, "profileHandle": { "type": "string" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SocialProfileSaveRequest": { "type": "object", "properties": { "socialProfileIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "providerName": { "type": "string" }, "profileUrl": { "type": "string" }, "profileHandle": { "type": "string" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SpamScoreRequest": { "required": [ "subject", "body" ], "type": "object", "properties": { "subject": { "maxLength": 2000, "type": "string" }, "body": { "maxLength": 15000, "type": "string" }, "custom_triggers": { "maxItems": 100, "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CustomTrigger" } }, "custom_suggestions": { "maxLength": 100, "type": [ "null", "object" ], "additionalProperties": { "type": "string" } } } }, "SpfOptions": { "required": [ "domain" ], "type": "object", "properties": { "domain": { "type": "string", "default": "example.com" }, "include_mx": { "type": "boolean", "default": true }, "include_a": { "type": "boolean", "default": true }, "ip_addresses": { "type": "array", "items": { "type": "string" } }, "includes": { "type": "array", "items": { "type": "string" } }, "is_relaxed": { "type": "boolean", "default": false } } }, "SubRegionRequest": { "type": "object", "properties": { "continent": { "type": [ "null", "string" ] } } }, "SubscriberDto": { "type": "object", "properties": { "subscriberIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "userIdentifier": { "type": "string", "format": "uuid" }, "userDisplayName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "emailAddress": { "type": "string" }, "cellPhone": { "type": "string" }, "referredBy": { "type": "string" }, "primaryUrl": { "type": "string" }, "signupIpAddress": { "type": "string", "format": "byte" }, "active": { "type": "boolean" }, "confirmed": { "type": "boolean" }, "confirmedDate": { "type": "string", "format": "date-time" }, "testUser": { "type": "boolean" }, "referringDomains": { "type": "string" }, "firstSeen": { "type": "string", "format": "date-time" }, "DomainAuthority": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "backlinks": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "notes": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "SubscriberEmailLookupResponse": { "type": "object", "properties": { "isAvailable": { "type": "boolean" }, "isValid": { "type": "boolean" }, "existsInSubscribers": { "type": "boolean" }, "existsInUsers": { "type": "boolean" }, "existsInSuppressionList": { "type": "boolean" }, "isBlocked": { "type": "boolean" }, "blockReason": { "type": "string" }, "message": { "type": "string" }, "externalValidation": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ExternalEmailValidation" } ] } } }, "SubscriberSaveRequest": { "type": "object", "properties": { "subscriberIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "emailAddress": { "type": "string" }, "cellPhone": { "type": "string" }, "referredBy": { "type": "string" }, "primaryUrl": { "type": "string" }, "signupIpAddress": { "type": "string", "format": "byte" }, "active": { "type": "boolean" }, "confirmed": { "type": "boolean" }, "confirmedDate": { "type": "string", "format": "date-time" }, "testUser": { "type": "boolean" }, "referringDomains": { "type": "string" }, "firstSeen": { "type": "string", "format": "date-time" }, "DomainAuthority": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "backlinks": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "notes": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "SvgToCssRequest": { "required": [ "svg_content" ], "type": "object", "properties": { "svg_content": { "type": "string" }, "mode": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 }, "compress": { "type": "boolean", "default": false } } }, "TagDto": { "type": "object", "properties": { "tagIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "tagName": { "type": "string" }, "tagColor": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "TagSaveRequest": { "type": "object", "properties": { "tagIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "tagName": { "type": "string" }, "tagColor": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "TaskDto": { "type": "object", "properties": { "taskIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "priorityIdentifier": { "type": "string", "format": "uuid" }, "projectIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "taskNumber": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "completeDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "percentComplete": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "estimatedHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "billableHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "taskComplete": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "ModifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "TaskNoteDto": { "type": "object", "properties": { "taskNoteIdentifier": { "type": "string", "format": "uuid" }, "taskIdentifier": { "type": "string", "format": "uuid" }, "taskCommentInternal": { "type": "string" }, "taskCommentPublic": { "type": "string" }, "workHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "TaskNoteSaveRequest": { "type": "object", "properties": { "taskNoteIdentifier": { "type": "string", "format": "uuid" }, "taskIdentifier": { "type": "string", "format": "uuid" }, "taskCommentInternal": { "type": "string" }, "taskCommentPublic": { "type": "string" }, "workHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "TaskSaveRequest": { "type": "object", "properties": { "taskIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "categoryIdentifier": { "type": "string", "format": "uuid" }, "statusIdentifier": { "type": "string", "format": "uuid" }, "priorityIdentifier": { "type": "string", "format": "uuid" }, "projectIdentifier": { "type": "string", "format": "uuid" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "taskNumber": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "completeDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "percentComplete": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "estimatedHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "billableHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "taskComplete": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "TaskSmtpDto": { "type": "object", "properties": { "taskSmtpIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "assignTaskToIdentifier": { "type": "string", "format": "uuid" }, "popUsername": { "type": "string" }, "popPassword": { "type": "string" }, "popServer": { "type": "string" }, "popPort": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "popUseSsl": { "type": "boolean" }, "sendSmsNumber": { "type": "string" }, "sendSmsFormat": { "type": "string" }, "deleteMessage": { "type": "boolean" }, "markBadWordsAsComplete": { "type": "boolean" }, "markSpamAsComplete": { "type": "boolean" }, "saveTask": { "type": "boolean" }, "sendEmailNotice": { "type": "boolean" }, "sendSmsMessage": { "type": "boolean" }, "active": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "CreatedDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "TaskSmtpSaveRequest": { "type": "object", "properties": { "taskSmtpIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "assignTaskToIdentifier": { "type": "string", "format": "uuid" }, "popUsername": { "type": "string" }, "popPassword": { "type": "string" }, "popServer": { "type": "string" }, "popPort": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "popUseSsl": { "type": "boolean" }, "sendSmsNumber": { "type": "string" }, "sendSmsFormat": { "type": "string" }, "deleteMessage": { "type": "boolean" }, "markBadWordsAsComplete": { "type": "boolean" }, "markSpamAsComplete": { "type": "boolean" }, "saveTask": { "type": "boolean" }, "sendEmailNotice": { "type": "boolean" }, "sendSmsMessage": { "type": "boolean" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "TaskStatusHistoryDto": { "type": "object", "properties": { "taskStatusHistoryIdentifier": { "type": "string", "format": "uuid" }, "taskIdentifier": { "type": "string", "format": "uuid" }, "oldStatusIdentifier": { "type": "string", "format": "uuid" }, "newStatusIdentifier": { "type": "string", "format": "uuid" }, "changedByIdentifier": { "type": "string", "format": "uuid" }, "changedDate": { "type": "string", "format": "date-time" }, "reason": { "type": "string" }, "notes": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "format": "uuid" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "TaskStatusHistorySaveRequest": { "type": "object", "properties": { "taskStatusHistoryIdentifier": { "type": "string", "format": "uuid" }, "taskIdentifier": { "type": "string", "format": "uuid" }, "oldStatusIdentifier": { "type": "string", "format": "uuid" }, "newStatusIdentifier": { "type": "string", "format": "uuid" }, "changedByIdentifier": { "type": "string", "format": "uuid" }, "changedDate": { "type": "string", "format": "date-time" }, "reason": { "type": "string" }, "notes": { "type": "string" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "TaxAuthorityDto": { "type": "object", "properties": { "taxAuthorityIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "taxTypeIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "taxIdNumber": { "type": "string" }, "taxRate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "active": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "TaxAuthoritySaveRequest": { "type": "object", "properties": { "taxAuthorityIdentifier": { "type": "string", "format": "uuid" }, "regardingIdentifier": { "type": "string", "format": "uuid" }, "taxTypeIdentifier": { "type": "string", "format": "uuid" }, "regardingName": { "type": "string" }, "descriptionShort": { "type": "string" }, "descriptionLong": { "type": "string" }, "taxIdNumber": { "type": "string" }, "taxRate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "active": { "type": "boolean" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "tenantUserIdentifier": { "type": "string", "format": "uuid" } } }, "TextQrRequest": { "required": [ "text" ], "type": "object", "properties": { "text": { "type": "string" }, "ecc_level": { "default": 2, "$ref": "#/components/schemas/ECCLevel" }, "output_format": { "default": 0, "$ref": "#/components/schemas/QrOutputFormat" }, "pixels_per_module": { "format": "int32", "default": 10 }, "draw_quiet_zones": { "type": "boolean", "default": true }, "dark_color_hex": { "type": "string", "default": "#000000" }, "light_color_hex": { "type": "string", "default": "#FFFFFF" }, "max_image_pixels": { "format": "int32", "default": 2048 }, "icon": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/QrIconOptions" } ] }, "force_version": { "format": "int32" }, "renderer": { "default": 0, "$ref": "#/components/schemas/QrRendererMode" } } }, "TlsRptOptions": { "required": [ "domain", "report_email" ], "type": "object", "properties": { "domain": { "type": "string", "default": "example.com" }, "report_email": { "type": "string", "default": "tls-reports@example.com" } } }, "TokenRequest": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string" } } }, "TwoFactorToggleDto": { "required": [ "enable", "code" ], "type": "object", "properties": { "enable": { "type": "boolean" }, "code": { "pattern": "^\\d{6,8}$", "type": "string" }, "reauthToken": { "maxLength": 128, "type": [ "null", "string" ] }, "setupChallengeToken": { "maxLength": 128, "type": [ "null", "string" ] }, "requestVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "TwoFactorVerifyDto": { "required": [ "challengeToken", "code" ], "type": "object", "properties": { "challengeToken": { "maxLength": 128, "type": "string" }, "code": { "pattern": "^\\d{6,8}$", "type": "string" }, "requestVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "UnsubscribeRequest": { "type": "object", "properties": { "tenantIdentifier": { "type": "string", "format": "uuid" }, "emailAddress": { "type": "string" }, "token": { "type": "string" }, "reason": { "type": "string" } } }, "UpdatePasswordDto": { "required": [ "token", "newPassword", "confirmPassword" ], "type": "object", "properties": { "token": { "maxLength": 128, "type": "string" }, "newPassword": { "maxLength": 250, "minLength": 12, "type": "string" }, "confirmPassword": { "type": "string" }, "requestVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "riskToken": { "maxLength": 512, "type": [ "null", "string" ] } } }, "UrlQrRequest": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string" }, "ecc_level": { "default": 2, "$ref": "#/components/schemas/ECCLevel" }, "output_format": { "default": 0, "$ref": "#/components/schemas/QrOutputFormat" }, "pixels_per_module": { "format": "int32", "default": 10 }, "draw_quiet_zones": { "type": "boolean", "default": true }, "dark_color_hex": { "type": "string", "default": "#000000" }, "light_color_hex": { "type": "string", "default": "#FFFFFF" }, "max_image_pixels": { "format": "int32", "default": 2048 }, "icon": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/QrIconOptions" } ] }, "force_version": { "format": "int32" }, "renderer": { "default": 0, "$ref": "#/components/schemas/QrRendererMode" } } }, "UserAssignedSecurityGroupDto": { "type": "object", "properties": { "fieldValue": { "type": "string", "format": "uuid" } } }, "UserSavePasswordRequest": { "required": [ "userIdentifier", "newPassword", "emailAddress" ], "type": "object", "properties": { "userIdentifier": { "type": "string", "format": "uuid" }, "newPassword": { "maxLength": 100, "minLength": 0, "type": "string" }, "sendEmail": { "type": "boolean" }, "emailAddress": { "maxLength": 250, "minLength": 0, "type": "string" } } }, "UserSessionDto": { "type": "object", "properties": { "userSessionIdentifier": { "type": "string", "format": "uuid" }, "tenantIdentifier": { "type": "string", "format": "uuid" }, "userIdentifier": { "type": "string", "format": "uuid" }, "sessionIdentifier": { "type": "string" }, "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "ipAddress": { "type": "string", "format": "byte" }, "userAgent": { "type": [ "null", "string" ] }, "lastSeenDate": { "type": "string", "format": "date-time" }, "expiresDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" } } }, "UtmGeneratorOptions": { "required": [ "destination_url", "source", "medium", "campaign" ], "type": "object", "properties": { "destination_url": { "type": "string", "format": "uri", "default": "https://example.com" }, "source": { "type": "string", "default": "google" }, "medium": { "type": "string", "default": "cpc" }, "campaign": { "type": "string", "default": "spring_sale_2026" }, "term": { "type": [ "null", "string" ] }, "content": { "type": [ "null", "string" ] }, "force_lowercase": { "type": "boolean", "default": true }, "include_qr_code": { "type": "boolean", "default": false }, "qr_format": { "oneOf": [ { "type": "null" }, { "default": 0, "$ref": "#/components/schemas/QrOutputFormat" } ] }, "qr_version": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 3 }, "qr_color": { "type": "string", "default": "#000000" } } }, "UtmRequest": { "required": [ "url", "source", "medium", "campaign" ], "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "medium": { "type": "string" }, "campaign": { "type": "string" }, "term": { "type": [ "null", "string" ] }, "content": { "type": [ "null", "string" ] }, "ecc_level": { "default": 2, "$ref": "#/components/schemas/ECCLevel" }, "output_format": { "default": 0, "$ref": "#/components/schemas/QrOutputFormat" }, "pixels_per_module": { "format": "int32", "default": 10 }, "draw_quiet_zones": { "type": "boolean", "default": true }, "dark_color_hex": { "type": "string", "default": "#000000" }, "light_color_hex": { "type": "string", "default": "#FFFFFF" }, "max_image_pixels": { "format": "int32", "default": 2048 }, "icon": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/QrIconOptions" } ] }, "force_version": { "format": "int32" }, "renderer": { "default": 0, "$ref": "#/components/schemas/QrRendererMode" } } }, "VCardQrRequest": { "required": [ "first", "last" ], "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "ecc_level": { "default": 2, "$ref": "#/components/schemas/ECCLevel" }, "output_format": { "default": 0, "$ref": "#/components/schemas/QrOutputFormat" }, "pixels_per_module": { "format": "int32", "default": 10 }, "draw_quiet_zones": { "type": "boolean", "default": true }, "dark_color_hex": { "type": "string", "default": "#000000" }, "light_color_hex": { "type": "string", "default": "#FFFFFF" }, "max_image_pixels": { "format": "int32", "default": 2048 }, "icon": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/QrIconOptions" } ] }, "force_version": { "format": "int32" }, "renderer": { "default": 0, "$ref": "#/components/schemas/QrRendererMode" } } }, "VideoDownloadFormat": { "type": "integer" }, "VideoDownloadRequest": { "type": "object", "properties": { "url": { "type": "string" }, "format": { "$ref": "#/components/schemas/VideoDownloadFormat" }, "confirmRights": { "type": "boolean" } } }, "WeatherDto": { "type": "object", "properties": { "location": { "type": "string" }, "zip_code": { "type": "string" }, "temperature": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "feels_like": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "temp_min": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "temp_max": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "humidity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "pressure": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "description": { "type": "string" }, "icon": { "type": "string" }, "wind_speed": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "wind_direction": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cloudiness": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "units": { "type": "string" }, "retrieved_at": { "type": "string", "format": "date-time" } } }, "WeatherRequestDto": { "required": [ "zipCode", "units" ], "type": "object", "properties": { "zipCode": { "maxLength": 50, "type": "string" }, "units": { "maxLength": 50, "type": "string" } } }, "WhoisContactInfo": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "organization": { "type": [ "null", "string" ] }, "street": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "postal_code": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "is_redacted": { "type": "boolean" } } }, "WhoisDnssecInfo": { "type": "object", "properties": { "is_signed": { "type": "boolean" } } }, "WhoisLookupResponse": { "required": [ "domain" ], "type": "object", "properties": { "domain": { "type": "string" }, "tld": { "type": [ "null", "string" ] }, "protocol": { "type": [ "null", "string" ] }, "created_date": { "type": [ "null", "string" ], "format": "date-time" }, "expiration_date": { "type": [ "null", "string" ], "format": "date-time" }, "updated_date": { "type": [ "null", "string" ], "format": "date-time" }, "statuses": { "type": "array", "items": { "type": "string" } }, "registrar": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WhoisRegistrarInfo" } ] }, "registrant": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WhoisContactInfo" } ] }, "admin_contact": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WhoisContactInfo" } ] }, "tech_contact": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WhoisContactInfo" } ] }, "name_servers": { "type": "array", "items": { "type": "string" } }, "dnssec": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WhoisDnssecInfo" } ] }, "raw_whois_response": { "type": [ "null", "string" ] }, "raw_rdap_response": { "type": [ "null", "string" ] }, "lookup_utc": { "type": "string", "format": "date-time" } } }, "WhoisRegistrarInfo": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "iana_id": { "type": [ "null", "string" ] }, "url": { "type": [ "null", "string" ] }, "whois_server": { "type": [ "null", "string" ] }, "abuse_contact_email": { "type": [ "null", "string" ] }, "abuse_contact_phone": { "type": [ "null", "string" ] } } }, "WidgetRequestDto": { "required": [ "widgetName", "startDate", "endDate", "includePreviousPeriod" ], "type": "object", "properties": { "widgetName": { "maxLength": 50, "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "includePreviousPeriod": { "type": "boolean", "default": false } } }, "WifiAuth": { }, "WifiQrRequest": { "required": [ "ssid" ], "type": "object", "properties": { "ssid": { "type": "string" }, "password": { "type": [ "null", "string" ] }, "auth": { "$ref": "#/components/schemas/WifiAuth" }, "hidden": { "type": "boolean" }, "ecc_level": { "default": 2, "$ref": "#/components/schemas/ECCLevel" }, "output_format": { "default": 0, "$ref": "#/components/schemas/QrOutputFormat" }, "pixels_per_module": { "format": "int32", "default": 10 }, "draw_quiet_zones": { "type": "boolean", "default": true }, "dark_color_hex": { "type": "string", "default": "#000000" }, "light_color_hex": { "type": "string", "default": "#FFFFFF" }, "max_image_pixels": { "format": "int32", "default": 2048 }, "icon": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/QrIconOptions" } ] }, "force_version": { "format": "int32" }, "renderer": { "default": 0, "$ref": "#/components/schemas/QrRendererMode" } } }, "XCardMetadata": { "type": "object", "properties": { "card": { "type": "string" }, "title": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "imageUrl": { "type": [ "null", "string" ] }, "site": { "type": [ "null", "string" ] } } } }, "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "ApiKey": { "type": "apiKey", "name": "X-API-Key", "in": "header" } } }, "tags": [ { "name": "Accounting" }, { "name": "Accounts" }, { "name": "Agency" }, { "name": "Auth" }, { "name": "Automations" }, { "name": "CMS" }, { "name": "Communications" }, { "name": "Core" }, { "name": "Courses" }, { "name": "Documents" }, { "name": "Drug Testing" }, { "name": "Firearms" }, { "name": "Health" }, { "name": "Human Resources" }, { "name": "Images" }, { "name": "Insights" }, { "name": "Intelligence" }, { "name": "Lookups" }, { "name": "Marketing" }, { "name": "Media" }, { "name": "Portal" }, { "name": "Products" }, { "name": "Projects" }, { "name": "Public Tools: Conversion Tools" }, { "name": "Public Tools: Developer Tools" }, { "name": "Public Tools: Email Tools" }, { "name": "Public Tools: Financial Tools" }, { "name": "Public Tools: Geography Tools" }, { "name": "Public Tools: Image Tools" }, { "name": "Public Tools: Marketing Tools" }, { "name": "Public Tools: Security Tools" }, { "name": "Public Tools: WCAG Tools" }, { "name": "Public Tools: Web Tools" }, { "name": "Reports - Public" }, { "name": "SEO" }, { "name": "Scheduling" }, { "name": "Security" }, { "name": "Sessions" }, { "name": "Settings" }, { "name": "Shared" }, { "name": "Technology" }, { "name": "Widgets" } ] }